IDE-Tools · Foto: Homedust, CC BY 2.0

RuleWindsurf Rules & Cross-IDE-RulesLizenz: MITfrei kopierbar

create-docs.mdc

Zuletzt aktualisiert: 20. September 2026

⬇ Als Datei laden

⧉ –× kopiert⬇ –× heruntergeladenBewertung:

Typ

Rule

Lizenz

MIT

Quelle

github.com/steipete/agent-rules ↗

Anwendungsfeld

Windsurf Rules & Cross-IDE-Rules

Doku-Rückstand abbauen

Voraussetzungen

Vorhandener Code, aus dem die Dokumentation abgeleitet werden soll
KI-Editor/Agent mit Unterstützung für Custom-Regeln

Einordnung

Die Erstellung ist schnell erledigt, der eigentliche Aufwand liegt in der nötigen redaktionellen Nacharbeit.

Erzeugt umfassende Dokumentation aus Code

Für wen: Doku-Rückstand abbauen

Im Detail

Eine Regel, die aus vorhandenem Code automatisch eine umfassende Dokumentation ableitet, etwa zu Struktur, Funktionen und Zusammenhängen im Projekt. Der Mehrwert liegt darin, bestehenden Dokumentationsrückstand schnell in einen brauchbaren ersten Entwurf zu überführen, statt bei null anzufangen. Sinnvoll für Teams, deren Doku mit dem Code nicht mitgewachsen ist. Wichtig zu wissen: Das Ergebnis ist ein solider Startpunkt, der vor Veröffentlichung noch redaktionell geprüft und an projektspezifische Gegebenheiten angepasst werden sollte, keine fertige Endfassung.

Schritt für Schritt

Regel auf ein Projekt mit erkennbarem Dokumentationsrückstand anwenden
Agenten Struktur, Funktionen und Zusammenhänge aus dem Code ableiten lassen
entstandenen Dokumentationsentwurf redaktionell prüfen
Inhalte an projektspezifische Gegebenheiten anpassen, die der Code nicht abbildet
fertige Version erst nach dieser Prüfung veröffentlichen

Beispiel aus der Praxis

Für ein Projekt ohne aktuelle Dokumentation lässt man create-docs.mdc laufen; der Agent erzeugt einen ersten Entwurf zu Modulstruktur und Funktionen, den das Team anschließend gegenliest und um projektspezifische Hinweise ergänzt, bevor er veröffentlicht wird.

Praxis-Tipp

Setzen Sie die Regel nach größeren Feature-Merges ein, um die Doku laufend aktuell zu halten, statt sie erst kurz vor einem Release in einem großen Schritt nachzuziehen.

Stolperfallen

Das Ergebnis ist laut Quelle nur ein solider Startpunkt, keine fertige Endfassung - wird der Entwurf ungeprüft veröffentlicht, können veraltete oder unpassende Aussagen stehen bleiben.

Siehe auch

context-prime.mdc

Lizenz & Quelle

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

Häufige Fragen.

Kann man den generierten Entwurf direkt veröffentlichen?

Nein, laut Quelle sollte er vor Veröffentlichung redaktionell geprüft und angepasst werden.

Für wen eignet sich die Regel besonders?

Für Teams, deren Dokumentation mit dem Code nicht mitgewachsen ist.

Was leistet die Regel konkret?

Sie leitet aus vorhandenem Code automatisch eine Dokumentation zu Struktur, Funktionen und Zusammenhängen ab.

Inhalt ansehen (create-docs.mdc)

Lade …

Erfahrungen & Kommentare.

Funktioniert der Rule bei Ihnen? Tipps, Stolperfallen, Varianten — teilen Sie es mit der Community.

Lade Kommentare …