docs-system — v1.0.0
Installiert und pflegt ein vollständiges Dokumentationssystem in jedem Repository. Verwenden Sie dieses Skill, wenn ein Projekt seine Dokumente organisiert, klassifiziert, indiziert und synchron halten muss – oder wenn Sie aufgefordert werden, „das Dokumentationssystem / die Dokumenttaxonomie / die Dokumentkompendien einzurichten“.
Das Skill wird durch vier Skripte (in scripts/) implementiert; Sie rufen sie in der richtigen Reihenfolge auf. Alle sind idempotent und bewahren den Verlauf (git mv); die Migration ist überprüfungsgesteuert (zuerst --dry-run).
Wann verwenden
- Ein Repository hat lose, unklassifizierte Dokumente → System installieren und diese migrieren.
- Ein Dokument wurde erstellt/bearbeitet → Kompendium dieses Ordners neu erstellen (obligatorischer Schritt).
- Jemand fragt nach einem Dokumentindex / Glossar / „Memorial“ / Taxonomie.
Befehle (Skripte)
| Befehl | Skript | Zweck |
|---|---|---|
| bootstrap | scripts/docs-bootstrap.sh <repo> | Kit installieren: Kategorie-Ordner anlegen, Governance-Dokumente kopieren (Taxonomie/Vorlagen/Schnellstart/Register/Glossar), die 4 Skripte installieren, die Dokumentregel in die Agentendatei einfügen. Idempotent. |
| migrate | `scripts/docs-migrate.sh [--dry-run | --apply] ` |
| compile | scripts/docs-compile.sh <ordner> | Erstellt <ordner>/MEMORIAL.md neu – ein datumsgeordnetes Kompendium jedes Dokuments mit Index + Glossarlink + vollständigen Inhalten. Deterministische Neuerstellung: idempotent / automatisch anhängen / Duplikate entfernen / neu ordnen. --clean <ordner> entfernt es. |
| append | scripts/docs-append.sh <dokument> ["zusammenfassung"] | Fügt eine Linkzeile für ein Dokument zur README.md des Ordners hinzu (idempotent). |
Standard-Workflow
# 1. konfigurieren (einmal pro Repository)
cp docs-system.conf.example .docs-system.conf # PROJECT_NAME, AGENT_RULES, PLAN_BUCKET bearbeiten
# 2. installieren
scripts/docs-bootstrap.sh .
# 3. vorhandene Dokumente migrieren – ZUERST TROCKENLAUF, prüfen, dann anwenden
scripts/docs-migrate.sh --dry-run .
scripts/docs-migrate.sh --apply .
# 4. Kompendien erstellen
for d in documentation features testing reviews changes PLANS; do
scripts/docs-compile.sh "docs/$d"
done
# 5. abschließen: docs/documentation/DOCUMENTATION-REGISTRY.md neu befüllen, GLOSSARY.md mit Projektbegriffen bearbeiten
OBLIGATORISCHE DAUERREGEL
Nachdem Sie ein Dokument unter docs/<ordner>/ erstellt oder bearbeitet haben, führen Sie
scripts/docs-compile.sh docs/<ordner> aus und committen Sie das neu erstellte MEMORIAL.md zusammen mit dem Dokument.
Bearbeiten Sie MEMORIAL.md nicht von Hand (es wird generiert). Diese Regel wird auch durch bootstrap in die Agenten-Regeldatei des Ziel-Repositorys geschrieben.
Dokumentkopf-Marker (erzwungen)
Jede .md-Datei enthält unter ihrer Überschrift H1:
<!-- version --> · <!-- classification: TYPE --> · <!-- date --> · <!-- last-updated -->.
date wird einmalig gesetzt (bei Erstellung); nur last-updated ändert sich bei Bearbeitungen. Typen:
FEATURE / TESTING / DESIGN / GAPS / ANALYSIS / CHANGE / STUDY / REVIEW / ARCHITECTURE / SUMMARY / PLAN.
Sicherheit / Rückgängigmachen
docs-migrate.shverwendet standardmäßig--dry-run; vor--applydie Tabelle prüfen.- Kompendien rückgängig machen:
scripts/docs-compile.sh --clean docs/<ordner>oderfind docs -name MEMORIAL.md -delete. - Alles ist Git-verfolgt;
git revertmacht einen Durchlauf rückgängig. Verschiebungen sind Umbenennungen (Verlauf bleibt erhalten).
Referenzen
references/PLAYBOOK.md— vollständige Vorgehensweise, Konfigurationsparameter, Überprüfung, Rückgängigmachen.