repo-doku
Installation
SKILL.md
Repo-Doku: Dokumentation im Quell-Repo erstellen
Zweck
Dieser Skill erzeugt oder aktualisiert die Dokumentation direkt im Quell-Repo — als
Source of Truth, aus der nachgelagerte Doku-Systeme (Doku-Portal, Website) sie übernehmen können.
Geschrieben wird in die README.md, bei größeren Projekten zusätzlich in eine DEVELOPMENT.md.
- Output bleibt im Repo:
README.mdimmer;DEVELOPMENT.mdnur bei größeren Projekten. - Kein Auto-Commit: Niemals selbstständig committen oder pushen — nur einen Conventional-Commit vorschlagen.
Workflow
1. Doku-Ziel bestimmen
- Projekt-Typ und Umfang einschätzen (Bibliothek/Client, größere Anwendung, CLI, …).
- Doku-Ziel festlegen: nur
README.mdoderREADME.md+DEVELOPMENT.md. - → Details in references/doku-ziel.md.