Softwaredokumentation mit KI erstellen

Das Problem

In Ihrem Betrieb läuft ein internes Programm, etwa eine Auftragsverwaltung oder ein Auswertungswerkzeug. Es wurde vor Jahren von einer einzelnen Person gebaut. Eine Anleitung gibt es nicht. Wenn etwas hakt, fragen alle dieselbe Person.

Das ist ein echtes Betriebsrisiko. Wird diese Person krank, wechselt die Stelle oder geht in Pension, weiss niemand mehr, wie das Programm funktioniert und was man bei Störungen tun muss. Die Einarbeitung neuer Mitarbeitender dauert lange, weil alles mündlich weitergegeben wird.

Dokumentation wird oft aufgeschoben, weil sie mühsam ist. KI nimmt Ihnen einen Teil dieser Arbeit ab: Sie formuliert, gliedert und vereinheitlicht. Das Wissen selbst müssen aber Menschen liefern.

So lösen Sie es mit KI – Schritt für Schritt

1. Zwei Leserkreise unterscheiden: Eine Bedienungsanleitung (für Anwenderinnen, ohne Technik) und eine technische Dokumentation (für Fachleute: Aufbau, Daten, Betrieb). Schreiben Sie beide getrennt.
2. Wissen einsammeln: Bitten Sie die Person, die das Programm kennt, 30 bis 60 Minuten zu erzählen oder aufzunehmen. Notieren Sie typische Abläufe, Stolpersteine und «Dinge, die man wissen muss».
3. Material bereinigen: Entfernen Sie Passwörter, Kundennamen und Zugangsdaten aus Notizen und Bildschirmfotos. Verwenden Sie Beispieldaten.
4. Anleitung entwerfen lassen: Geben Sie die Notizen mit der Vorlage unten in ein freigegebenes KI-Programm. Lassen Sie eine Gliederung und dann Abschnitt für Abschnitt die Texte erstellen.
5. Von Anwenderinnen testen lassen: Eine Person, die das Programm nicht kennt, arbeitet nur nach der Anleitung eine Aufgabe durch. Wo sie stockt, ist der Text unklar.
6. Technische Übersicht ergänzen: Fachleute beschreiben, wo das Programm läuft, wo die Daten liegen, wer Zugriff hat und wie Sicherungen erfolgen. Die KI kann den Programmtext erklären, siehe Wie lasse ich mir unbekannten Programmcode mit KI erklären?.
7. Verantwortung und Ablage festlegen: Bestimmen Sie, wer die Dokumentation pflegt und wo sie liegt, zum Beispiel im gemeinsamen Laufwerk mit Datum und Version.
8. Aktualisierung einplanen: Prüfen Sie nach jeder Änderung am Programm und mindestens einmal pro Jahr, ob die Texte noch stimmen.

Vorlage zum Kopieren

Ich möchte eine Bedienungsanleitung für ein internes Programm schreiben.
Zielgruppe: [z. B. Sachbearbeiterinnen ohne IT-Kenntnisse]
Programm: [Name und Zweck in 2 Sätzen]

Hier sind meine Notizen zu den wichtigsten Abläufen (bereinigt, ohne Passwörter und Kundendaten):
[Notizen einfügen]

Erstelle:
1. Eine Gliederung mit maximal 8 Kapiteln.
2. Zu jedem Kapitel nummerierte Schritte in einfachem Deutsch, Anrede «Sie».
3. Eine Liste «Wenn etwas nicht klappt» mit den typischen Störungen aus meinen Notizen.
4. Eine Liste der Informationen, die dir noch fehlen.
Erfinde keine Funktionen. Was in den Notizen nicht steht, markierst du mit [offen].

Passen Sie Zielgruppe, Programm und Notizen an. Für die technische Dokumentation ändern Sie die Zielgruppe in «IT-Fachpersonen» und verlangen Aufbau, Datenablage und Betrieb.

Was gehört in welche Dokumentation?

Auch Übergaben im Team spielen eine Rolle. Hinweise dazu finden Sie unter Wie sichern wir Arbeitswissen vor einem Personalwechsel?. Wer mit einem Coding-Werkzeug arbeitet, findet unter Mit Claude Code eine verständliche Projektdokumentation erstellen einen Weg für den technischen Teil.

Worauf Sie achten müssen

• Datenschutz: Notizen, Bildschirmfotos und Code können vertrauliche Angaben enthalten. Prüfen Sie jedes Material, bevor Sie es in die KI geben.
• Erfundene Inhalte: Die KI ergänzt Lücken gern mit Dingen, die plausibel klingen. Jede Funktion, jeder Menüpunkt und jeder Pfad muss am echten Programm überprüft werden.
• Veraltete Dokumentation: Eine falsche Anleitung ist schlimmer als keine. Vermerken Sie Datum und Programmversion auf der ersten Seite.
• Abhängigkeit bleibt: Die Dokumentation ersetzt nicht das Gespräch mit der Fachperson. Ziel ist, dass mindestens eine zweite Person das Programm versteht.
• Zugangsdaten gehören nicht hinein: Passwörter verwalten Sie in einem Passwortmanager, nicht in Anleitungen.

Ein Beispiel aus der Praxis

Ein Beispiel: In einer Schreinerei bei Olten steuert ein selbst gebautes Programm die Materialbestellung. Vorher kennt nur der Werkstattleiter, Herr Gasser, die Abläufe. Als er zwei Wochen krank ist, bestellt niemand Material.

Nachher lässt sich die Büroleiterin von ihm eine Stunde lang die Abläufe erzählen und macht Notizen mit Beispielwerten. Die KI strukturiert daraus eine sechsseitige Anleitung. Ein Lernender arbeitet sie am Computer durch und meldet drei unklare Stellen, die ergänzt werden. Seither kennen zwei Personen das Programm, und die Anleitung wird jährlich geprüft.

So hilft Ihnen Alpasana

Wenn Sie in Ihrem Betrieb Software pflegen und Dokumentation, Tests und Review besser organisieren möchten, bietet absofort den Kurs KI für Developer mit Claude und Codex an. Beschrieben sind LLM-Grundlagen, Codegenerierung, Debugging und Review sowie ein Entwickler-Playbook mit Prompts und Review-Regeln.

Der Kurs richtet sich an Entwickelnde. Für Anwenderinnen eines internen Programms hilft das Vorgehen oben, das Sie auch ohne Programmierkenntnisse umsetzen können.

Häufige Fragen

Kann die KI die Dokumentation direkt aus dem Programmcode erzeugen?

Zu einem Teil ja: Sie kann erklären, was ein Code vermutlich tut. Das ersetzt aber nicht die Sicht der Anwender und die Betriebserfahrung. Die Ergebnisse müssen von Menschen geprüft werden, die das Programm kennen.

Wie lang muss eine Anleitung sein?

So kurz wie möglich. Für ein internes Werkzeug genügen oft fünf bis zehn Seiten mit den wichtigsten Abläufen. Besser eine kurze, aktuelle Anleitung als ein langes Dokument, das niemand liest.

Wer soll die Dokumentation pflegen?

Bestimmen Sie eine verantwortliche Person und eine Stellvertretung. Planen Sie die Pflege als feste Aufgabe, etwa bei jeder Programmänderung und einmal im Jahr.