Anwenderdokumentation generieren

Was du vorbereiten solltest

• Die Einstiegspunkte des Programms: Selektionsbild, Hauptmethode, relevante Validierungen und Stellen, an denen Nachrichten oder Fehler erzeugt werden.
• Die Zielgruppe und das gewünschte Format, zum Beispiel Key-User-Anleitung, Support-Runbook oder technische Betriebsnotiz.
• Bekannte Systemgrenzen: Customizing-Abhängigkeiten, Berechtigungen, Job-Kontext oder externe Schnittstellen, die im Code nur indirekt sichtbar sind.

Empfohlener Ablauf

1. Kontext bereitstellenÖffne die Dateien, die den fachlichen Ablauf enthalten. Relevante Texte, Selektionsparameter und Fehlermeldungen sind wichtiger als technische Hilfsklassen, solange diese keine Fachentscheidung treffen.
2. Aufgabe konkret formulierenGib Zielgruppe, gewünschte Sprache und Dokumentationsformat vor. Fordere explizit, dass gesicherte Aussagen, Code-Indizien und offene Annahmen getrennt werden.
3. Änderungen prüfenPrüfe, ob die Dokumentation keine falschen Prozessversprechen macht und ob unklare Stellen als Annahmen markiert sind. Besonders wichtig sind Defaultwerte, Berechtigungen und Sonderfälle.

Beispiel-Prompt

Ein guter Dokumentations-Prompt nennt Zielgruppe und Format.

Erstelle aus ZREP_DUNNING_PREVIEW eine Anwenderdokumentation für Key User.
Beschreibe Zweck, Selektionsparameter, Validierungen und typische Fehlermeldungen.
Markiere Stellen, bei denen der Code keine eindeutige fachliche Aussage zulässt.

Review-Checkliste

• Sind fachliche Aussagen auf erkennbare Codepfade, Selektionsparameter oder Meldungen zurückführbar?
• Sind technische Details dort weggelassen, wo sie Anwendern keinen Mehrwert bieten?
• Sind Annahmen und offene Punkte klar markiert, statt als gesichertes Verhalten formuliert?