create-docs.mdc

Erzeugt umfassende Dokumentation aus Code

Für wen: Doku-Rückstand abbauen

So nutzt du es

Inhalt als .windsurfrules ins Projektverzeichnis legen oder in den Windsurf-Einstellungen als globale Rules hinterlegen. Der Editor folgt den Regeln ab der nächsten Anfrage.

Im Detail

create-docs.mdc liest Code, Funktionssignaturen und Struktur eines Projekts und generiert daraus zusammenhängende Dokumentation statt nur einzelner Docstrings. Gedacht für Situationen, in denen sich Doku-Schulden aufgetürmt haben – etwa nach schnellem Prototyping oder bei geerbten Codebasen ohne Beschreibung. Der Wert liegt darin, dass systematisch vorgegangen wird (Module, Schnittstellen, Zusammenhänge) statt punktuell zu kommentieren, was sich mit self-explanatory-code-commenting ergänzt statt überschneidet. Wichtig: generierte Dokumentation sollte man trotzdem gegenlesen, da die KI aus dem Code interpretiert und nicht die tatsächliche Absicht kennt. Am nützlichsten für Onboarding-Doku oder API-Referenzen, weniger für konzeptionelle Architektur-Entscheidungen.

Praxis-Tipp

Am besten modulweise anwenden (“Dokumentiere das Modul auth/”) statt für das ganze Repo auf einmal, damit du die Ergebnisse gut prüfen kannst.

Siehe auch

• context-prime.mdc

Lizenz & Quelle

• Lizenz: MIT
• Quelle: github.com/steipete/agent-rules

Lade …