Dokumentations-Generator

Das Problem

Dokumentation ist das Erste, das bei Zeitdruck gestrichen wird. Funktionen bleiben undokumentiert, READMEs veralten, und neue Teammitglieder verbringen Tage damit, Code rueckwaerts zu analysieren. Dokumentation von Grund auf zu schreiben ist langsam, aber KI kann Ihren Code analysieren und praezise Dokumentation in Sekunden erstellen.

Der Prompt

Du bist ein Experte fuer technische Dokumentation. Erstelle umfassende Dokumentation fuer folgenden Code:

CODE:
[fuege deine Funktion, Klasse, dein Modul oder deinen API-Endpunkt hier ein]

SPRACHE: [z.B. TypeScript, Python, Go]
DOKU-FORMAT: [z.B. JSDoc, Python Docstring, GoDoc]

Erstelle:
1. **Inline-Dokumentation**: Vollstaendige JSDoc/Docstring mit @param, @returns, @throws, @example
2. **README-Abschnitt**: Markdown-Abschnitt, der erklaert, was der Code tut, wann er verwendet wird, und ein Schnellstart-Beispiel
3. **Nutzungsbeispiele**: 3 praktische Beispiele fuer Grundnutzung, Sonderfall und Fehlerbehandlung
4. **Typ-Signaturen**: Falls noch nicht typisiert, schlage die vollstaendige Typ-Signatur vor

Halte Beschreibungen praegnant aber praezise. Bevorzuge konkrete Beispiele gegenueber abstrakten Erklaerungen.

Beispielausgabe

/**
 * Wiederholt eine asynchrone Operation mit exponentiellem Backoff.
 *
 * @param fn - Die zu wiederholende async-Funktion
 * @param options - Konfiguration fuer das Wiederholungsverhalten
 * @param options.maxRetries - Maximale Anzahl Versuche (Standard: 3)
 * @param options.baseDelay - Initiale Verzoegerung in ms (Standard: 1000)
 * @param options.maxDelay - Maximale Verzoegerungsobergrenze in ms (Standard: 30000)
 * @returns Der aufgeloeste Wert von fn
 * @throws Den letzten Fehler, nachdem alle Wiederholungen erschoepft sind
 *
 * @example
 * const data = await retry(() => fetch('/api/users'), { maxRetries: 5 });
 */

Wann verwenden

Verwenden Sie diesen Skill, wenn Sie eine Funktion, ein Modul oder einen API-Endpunkt fertiggestellt haben und dokumentieren muessen, bevor Sie weitermachen. Ebenso wirkungsvoll fuer die Dokumentation von Legacy-Code, den Sie reviewen oder von einem anderen Team uebernehmen.

Profi-Tipps

• Fuegen Sie die gesamte Datei ein, nicht nur eine Funktion — KI erstellt bessere Dokumentation, wenn sie den umgebenden Kontext versteht und erkennt, wie Funktionen zusammenhaengen.
• Geben Sie den Styleguide Ihres Teams an — ergaenzen Sie “Folge dem Google TypeScript Style Guide” oder “Verwende das NumPy-Docstring-Format”, um bestehende Konventionen einzuhalten.
• Lassen Sie auch einen Changelog-Eintrag erstellen — ergaenzen Sie “Schreibe ausserdem einen CHANGELOG.md-Eintrag fuer diese Aenderung”, um Release Notes gleich mitzuliefern.