Dokumentation pflegen

Die Dokumentation liegt getrennt vom Produkt-Repository. Sie darf den Funktionsstand nicht aus Landingpage oder Demo ableiten.

Bevorzugte Quellen

1. Code und Tests in projets/tradoc.
2. Aktuelle Ausgabe der --help-Befehle.
3. .env.example, Dockerfile und Compose-Dateien.
4. Produktoberfläche.
5. README nach Abgleich mit dem Code.

Validierung

npm run check:content
npm run check:links
npm run lint
npm run typecheck
npm run build

Bei einer Produktänderung

• Neuer Anbieter: Anbieter und Verbindungstests aktualisieren.
• Neues Format: Extraktion, Vorschau, Rekonstruktion und MIME-Typ dokumentieren.
• Neue Variable: Standardwert, Grenzen und Sicherheitsfolgen ergänzen.
• Neuer Befehl: Vor Veröffentlichung der Syntax --help ausführen.
• Neue Domain: Erst nach echter HTTPS-Prüfung als aktiv darstellen.

Pflege der vier Sprachen

Englisch ist kanonisch. Jede englische Seite benötigt vor der Veröffentlichung vollständige französische, spanische und deutsche Fassungen. Eine Produktänderung mit Dokumentationswirkung aktualisiert alle vier Dateien im selben Pull Request; keine Sprache darf unbemerkt auf Englisch zurückfallen oder trotz veraltetem Inhalt als übersetzt gelten.

Markdown für Assistenten

Jede Seite stellt über das Seitenmenü verarbeitetes Markdown bereit. Es wird aus demselben lokalisierten MDX erzeugt, damit keine zweite, abweichende Dokumentation entsteht.