Dokumentationspflege¶
Dokumentation pflegen¶
Grundprinzip¶
Die Markdown-Dateien sind die Quelle. Quellcode-Links zeigen bewusst auf den dokumentierten Commit, damit alte Dokumentationsstände reproduzierbar bleiben.
Wann welche Seite aktualisiert werden muss¶
| Codeänderung | Dokumentationsseite |
|---|---|
| neuer Store oder Persistenzpfad | Datenmodell, Systemarchitektur |
| neuer Feldtyp oder Zielmodus | Bereich/Feld/Typ/Wert |
Änderung an VERSIONED_PROPERTIES |
Versionierung |
| neue Eventart | Dynamische Ereignisse, Analytics |
Änderung an RADAR_SCORE_CONFIG oder Formeln |
Lebensrad |
| neue Explorer-Aggregation | Analytics-Pipeline |
| neue Korrelation | Explorer und Korrelationen |
| neue native Sicherheitsgrenze | Sicherheit |
| neuer Companion-Provider | AI Companion |
Aktualisierungsablauf¶
- aktuellen
main-Commit notieren, - Quellenlinks auf diesen Commit setzen,
- betroffene Diagramme und Tabellen ändern,
- interne Links prüfen,
- Markdown in GitHub kontrollieren.
Mermaid-Diagramme¶
Diagramme bleiben als Text im Markdown und können dadurch gemeinsam mit dem Code reviewed werden. Keine binären Diagrammdateien erforderlich.
Formeln¶
Formeln verwenden LaTeX/MathJax-Syntax. Variablennamen sollten unmittelbar unter der Formel erklärt werden; Nachvollziehbarkeit ist wichtiger als reine mathematische Eleganz.