Dokumentationsprozess

Dieses Dokument beschreibt, wie jinflow-Dokumentation erstellt, verifiziert, gepflegt und mit der Codebasis synchron gehalten wird. Das Dokumentationssystem ist Infrastruktur — es hat denselben Status wie Compiler, Validatoren und Testsuiten.

Prinzipien

1. Code ist die Wahrheitsquelle. Dokumentation beschreibt, was Code tut, nicht was wir wuenschen.
2. Jede Behauptung ist verifizierbar. CLI-Befehle koennen gegen cli.py geprueft werden. Explorer-Seiten gegen Route-Verzeichnisse.
3. Aspirativer Inhalt ist gekennzeichnet. Design-Dokumente die nicht implementierte Features beschreiben tragen status: aspirational.
4. Ein autoritativer Ort, synchronisierte Kopien. User Guides leben in docs/guide/ (EN, DE, FR).
5. Wachstumsphase-Bewusstsein. Das Produkt liefert Features schneller als Docs folgen koennen.

Der Drift-Detektor

scripts/docsdrift.py ist ein automatischer Check, der Code gegen Dokumentation in vier Dimensionen vergleicht: CLI-Befehle, Explorer-Seiten, Signal-Typen und Frontmatter-Stempel.

python3 scripts/docsdrift.py              # vollstaendiger Bericht
python3 scripts/docsdrift.py --quiet      # nur Drift anzeigen (Exit 1 wenn gefunden)

Der Audit-Prozess

Ein Dokumentations-Audit ist eine manuelle, gruendliche Verifikation aller Markdown-Dokumente gegen Quellcode.

Siehe die englische Referenz fuer vollstaendige Details zum Audit-Prozess, Inventar und Historie.