README

Dokumentationswerkzeuge#

Zweck#

Dieser Bereich beschreibt die Werkzeuge und Verträge für reproduzierbare Nutzer-, Betriebs- und Entwicklerdokumentation der Engineering-Werkzeuge.

Kanonische Quellen#

1. Documentation Tooling Architecture
2. Publisher Contract
3. Deutscher Anzeige-Titel Vertrag
4. Deutscher Navigationslabel Vertrag
5. Navigation and Link Contract
6. Report and Evidence Contract
7. Verification
8. Workspace-Migrationsinventar als historische ⌘EvidenceTechnical documentation artifact. für die kontrollierte Folge-Evolution
9. Landing-Page-Interaktionsvertrag

Verantwortungsgrenze#

97-documentation besitzt Dokumentationsmechanik und ihre stabilen Verträge. Fachliche Wahrheit verbleibt beim jeweiligen Eigentümer. Generierte Veröffentlichungen, Vorschauen, Logs und Laufreports werden nicht als führende Repositoryquellen behandelt.

Beziehungen#

• 50-reporting erzeugt reproduzierbare Reports und Evidence.
• 40-validation prüft Struktur, Links und dokumentierte Verträge.
• 55-generators materialisiert Dokumente aus freigegebenen Vorlagen.
• 95-templates enthält nicht produktive Ausgangsvorlagen.
• 17-workbench-editors darf Dokumente bearbeiten, ohne Identität oder unbekannte zulässige Metadaten zu verlieren.

Implementierungsstatus#

◆publish-semantic-landing.py erzeugt eine deterministische HTML-Landing-Page aus einem expliziten JSON-Modell. Der Elevator Pitch wird vor der Navigation ausgegeben; Glossar- und Beziehungshinweise bleiben verständlich sichtbar und technische Detailreports bleiben verlinkt. Generierte Ergebnisse gehören in den Runtime-Reportbereich und werden nicht zu kanonischen Quellen.

Für sichtbare Links verwendet der Publisher vorrangig displayTitle. Ein H1 darf nur mit headingLanguage: "de" als kontrollierter Fallback dienen. Fehlende, technische oder als nichtdeutsch deklarierte sichtbare Linktexte blockieren die Veröffentlichung und erscheinen im Laufreport.