← Übersicht

Tastenkürzel

Nächste Folie
Vorherige Folie
ESC Zurück zur Übersicht
F Vollbild
? Diese Hilfe
Lernportal

KI für Dokumentation

🎧 Artikel anhören

Vom Skript zur fertigen Doku in Minuten

Das Problem: Dokumentation bleibt liegen

Die Konfiguration ist fertig, das System läuft – aber die Dokumentation fehlt. Dieses Muster kennt jeder im IT-Alltag. KI kann diesen Engpass deutlich verkleinern.

Zeitmangel Keine Zeit nach dem Projekt Dokumentation kommt immer am Ende – wenn das nächste Projekt schon wartet. Erster Entwurf entsteht nie.
Aufwand Stunden für Basics Struktur finden, Fachbegriffe erklären, Schritt für Schritt formulieren – kostet mehr Zeit als die eigentliche Arbeit.
Aktualität Doku veraltet schnell Änderungen am System werden nicht nachgezogen. Doku stimmt nicht mehr – und wird nicht mehr genutzt.
Qualität Inkonsistenz im Team Jeder dokumentiert anders – Struktur, Tiefe und Sprache variieren. KI liefert konsistente Ergebnisse.
Gute Dokumentation ist keine Frage der Zeit mehr – sondern eine Frage der Disziplin, KI einzusetzen.

Was KI aus technischen Inputs erstellt

Input: Bash-Skript → Verständliche Beschreibung KI erklärt, was das Skript tut, welche Parameter es erwartet und was zu beachten ist – in klarem Deutsch.
Input: Konfigurationsdatei → Strukturierte Doku-Seite Nginx.conf, sshd_config, docker-compose.yml – KI erklärt jeden relevanten Parameter mit Kontext.
Input: Stichpunkte → Betriebshandbuch Aus kurzen Notizen entsteht ein vollständiges Handbuch mit Einleitung, Abschnitten und Fazit.
Input: Git-Commits → Changelog KI fasst Commit-Nachrichten zu einem lesbaren Changelog zusammen – gruppiert nach Features, Fixes, Breaking Changes.
Input: Meeting-Notizen → Protokoll Stichpunkte aus dem Call werden zu einem strukturierten Protokoll mit Beschlüssen und Aufgaben.
Input: Fehler-Log → Incident-Bericht Aus Logzeilen und Notizen erstellt KI einen nachvollziehbaren Incident-Report inklusive Timeline.

Vorgehen: Input → Prompt → Entwurf → Prüfung

Schritt 1 Relevanten Input einfügen Konfiguration, Code, Stichpunkte oder Log-Auszug direkt in den Chat einfügen. Je vollständiger der Input, desto besser der Entwurf.
Schritt 2 Zielgruppe und Format angeben „Schreib für neue Kollegen ohne Linux-Erfahrung" oder „Erstelle ein Markdown-Dokument mit Überschriften und Codeblöcken."
Schritt 3 KI erstellt den Entwurf KI strukturiert, formuliert und erklärt – erster vollständiger Entwurf in Sekunden. Kein leeres Blatt mehr.
Schritt 4 Prüfen, ergänzen, freigeben Fachliche Richtigkeit prüfen, firmenspezifische Details ergänzen, freigeben. Verantwortung bleibt beim Menschen.
Gut formulierter Prompt-Zusatz: „Erstelle eine technische Dokumentation für Administratoren. Markdown-Format, mit Abschnitten: Zweck, Voraussetzungen, Konfiguration, Betrieb, Fehlerbehebung."

Praxisbeispiel: Bash-Skript dokumentieren

Input an KI Skript + Anweisung Prompt: „Dokumentiere dieses Backup-Skript für neue Administratoren. Erkläre was es tut, welche Variablen gesetzt werden müssen und was bei Fehlern zu prüfen ist."

[Bash-Skript hier einfügen]

Format: Markdown, Sprache: Deutsch.
Output der KI Fertige Dokumentation backup.sh – Dokumentation

Zweck: Tägliche Sicherung von /etc und /var/www auf ein NFS-Share.

Voraussetzungen: NFS-Mount unter /mnt/backup, cron-Berechtigung.

Konfiguration: BACKUP_DIR, RETENTION_DAYS anpassen.

Fehlerbehebung: Bei „Permission denied" – Benutzer prüfen.

Praxisbeispiel: Changelog aus Git-History

Git-Commit-Nachrichten sind oft technisch und knapp. KI fasst sie zu einem lesbaren Changelog für Endnutzer und Management zusammen.

Prompt: „Erstelle einen Changelog aus diesen Git-Commits. Gruppiere nach: Neue Features, Fehlerbehebungen, Breaking Changes. Sprache: Deutsch, Zielgruppe: Endnutzer."

Input: fix: correct null pointer in auth handler / feat: add TOTP 2FA support / refactor: move user model to separate module / fix: login redirect loop on timeout

Output:
Version 2.3.0
Neue Features: Zwei-Faktor-Authentifizierung (TOTP) jetzt verfügbar
Fehlerbehebungen: Login-Weiterleitung nach Sitzungsablauf korrigiert · Stabilitätsverbesserungen in der Anmeldung

Praxisbeispiel: Betriebshandbuch aus Stichpunkten

Input: Rohe Stichpunkte 10 Zeilen Notizen – Nginx läuft auf Port 80/443
– Config unter /etc/nginx/sites-enabled/
– Logs: /var/log/nginx/
– Neustart: systemctl restart nginx
– Zertifikat: Let's Encrypt, erneuert sich automatisch
– Backup täglich um 2 Uhr
– Monitoring: Zabbix, Agent auf Port 10050
– Ansprechpartner: IT-Team, Ticket im Helpdesk
Output: Strukturiertes Handbuch Fertige Doku-Seite Betriebshandbuch: Webserver

1. Systemübersicht – Nginx, Ports, Zertifikate
2. Konfiguration – Pfade, Syntax-Prüfung, Reload
3. Betrieb – Start/Stop/Restart, Log-Analyse
4. Monitoring – Zabbix-Integration, Alarme
5. Backup & Wiederherstellung – Zeitplan, Speicherort
6. Kontakt & Eskalation – Helpdesk-Prozess

Was menschliche Aufgabe bleibt

KI erstellt schnell brauchbare Entwürfe – aber die inhaltliche Verantwortung bleibt beim Menschen. Drei Bereiche dürfen nie delegiert werden.

Fachliche Prüfung Inhalt auf Richtigkeit kontrollieren KI halluziniert gelegentlich Details. Befehle, Pfade und Parameter müssen gegen das echte System geprüft werden – vor der Freigabe.
Firmenspezifika Eigene Details ergänzen IP-Adressen, interne Hostnamen, Ansprechpartner, Eskalationswege – diese kennt die KI nicht und muss manuell eingepflegt werden.
Freigabe Verantwortung übernehmen Wer die Dokumentation freigibt, trägt die Verantwortung. KI ist Werkzeug – kein Autor. Qualitätssicherung bleibt Menschenaufgabe.
Sicherheitsinhalte Sensibles nicht blindlings übernehmen Keine Passwörter, Zertifikatsdetails oder Schwachstellenbeschreibungen ungeprüft in Doku übernehmen – auch wenn die KI es vorschlägt.

Zusammenfassung

KI schreibt den ersten Entwurf – der Mensch prüft, ergänzt und verantwortet das Ergebnis.
Nächstes Kapitel

KI und Active Directory

PowerShell, LDAP und AD-Verwaltung mit KI-Unterstützung