Command Reference
Befehle, Parameter und erwartete Ausgaben.
Documentation / Reference
Documentation Reference
Reference stellt technische Informationen kompakt, eindeutig und dauerhaft auffindbar bereit.
ACTIVE DOCUMENTATION AREA
Technische Referenzinformationen
Referenzen dienen der gezielten Suche nach konkreten Befehlen, Pfaden, Datenformaten, Statuswerten und technischen Definitionen.
Documentation Components
Kernbereiche
File Reference
Dateien, Verzeichnisse und technische Verantwortlichkeiten.
Route Reference
Lokale und öffentliche Webseitenrouten.
Data Reference
JSON-Strukturen, Felder und Datenbedeutungen.
Status Reference
PASS-, FAIL- und weitere technische Zustände.
Naming Reference
Benennungsregeln für Dateien, Bereiche und Artefakte.
Dokumentationsgrundsätze
- Referenzen kurz und eindeutig halten
- Pfade und Bezeichnungen exakt angeben
- Parameter und Einheiten vollständig nennen
- Beispiele klar von Regeln unterscheiden
- Veraltete Referenzen sichtbar aktualisieren
Datenquelle
Dieser Bereich verwendet gemeinsame, lokal validierte Documentation-Daten.
Qualitätssicherung
Dokumentationsseiten, JSON-Dateien, interne Links, Routen und Asset-Verweise werden vor der Veröffentlichung geprüft.
DOCUMENTATION