Technische Dokumentation mit KI: Handbücher, Anleitungen und API-Doku

Technische Dokumentation mit KI zu erstellen löst ein altes Problem: Dokumentation schreibt niemand gern, und sie veraltet schnell. Sprachmodelle können aus Code, Notizen, Screenshots und Ticket-Verläufen Entwürfe für Anleitungen, Handbücher und API-Dokumentation erstellen. Die fachliche Richtigkeit muss trotzdem jemand prüfen, der das System kennt.

Arten technischer Dokumentation

• Anleitungen: Schritt-für-Schritt-Beschreibungen für eine Aufgabe.
• Referenz: vollständige Beschreibung von Funktionen, Parametern, Einstellungen.
• Erklärungen: Hintergründe und Zusammenhänge, etwa die Architektur eines Systems.
• Fehlerbehebung: typische Probleme und Lösungen.

Sagen Sie der KI, welche Art Sie brauchen. Eine Anleitung, die gleichzeitig alle Parameter erklären will, wird unübersichtlich.

Aus Code dokumentieren

Für Entwickler ist das der häufigste Einsatz: Die KI liest Funktionen, Klassen oder Schnittstellen und erzeugt Kommentare, README-Dateien oder API-Beschreibungen.

Erstelle eine README für das folgende Modul.
Abschnitte: Zweck in 2 Sätzen, Installation, Konfiguration
(Tabelle der Umgebungsvariablen), Beispielaufruf, bekannte
Einschränkungen. Beschreibe nur, was im Code zu sehen ist.
Wenn etwas unklar ist, liste es unter „Offene Fragen“ auf.
<code>
...
</code>

Der Abschnitt „Offene Fragen“ ist wertvoll: Er zeigt, wo der Code allein nicht reicht und Wissen aus dem Team gebraucht wird. Mehr Prompts für Entwickler stehen im Ratgeber Prompts für Code.

Anleitungen aus Erfahrungswissen

Viele Abläufe kennen nur einzelne Kollegen. Lassen Sie sie den Ablauf einmal frei erzählen oder Stichpunkte aufschreiben, und die KI macht daraus eine nummerierte Anleitung. Danach führt eine andere Person die Anleitung Schritt für Schritt aus. Wo sie hängen bleibt, fehlt etwas. Dieser Test ist wichtiger als jede sprachliche Überarbeitung.

Format und Werkzeuge

Technische Dokumentation wird oft in Markdown geschrieben und in Wikis, Repositories oder Dokumentationsseiten veröffentlicht. Sprachmodelle schreiben Markdown zuverlässig. Wenn Sie den Text in Word, Confluence oder als HTML brauchen, hilft Markdown umwandeln. JSON-Beispiele in API-Dokumentationen prüfen Sie mit JSON formatieren auf gültige Syntax.

Verständlich schreiben

Gute Dokumentation ist kurz, aktiv und konkret. Bitten Sie die KI um Imperativ in Anleitungen („Klicken Sie auf ...“), einheitliche Begriffe und kurze Sätze. Einheitliche Begriffe sind besonders wichtig: Wenn ein Bedienelement einmal „Schaltfläche“, einmal „Button“ und einmal „Knopf“ heißt, verwirrt das. Geben Sie der KI ein kleines Glossar mit, und prüfen Sie lange Sätze mit dem Satzlängen-Prüfer.

Dokumentation aktuell halten

Die größte Stärke der KI liegt vielleicht im Aktualisieren: Geben Sie ihr die bestehende Dokumentation und die Änderungen an Code oder Ablauf, und lassen Sie die betroffenen Stellen anpassen. Die KI kann auch prüfen, ob Dokumentation und Code noch zusammenpassen. Ein Mensch entscheidet, welche Änderungen übernommen werden.

Was Sie nicht abgeben sollten

Sicherheitshinweise, Warnungen und rechtlich relevante Angaben in Bedienungsanleitungen für Produkte müssen fachlich geprüft werden; hier gelten je nach Produkt eigene Vorschriften. Vertraulichen Quellcode geben Sie nur in Dienste, die Ihr Unternehmen freigegeben hat. Wie man API-Schlüssel und Geheimnisse vor dem Teilen aus dem Code entfernt, zeigt das Werkzeug API-Schlüssel im Code finden.