Dokumentationsregel

Diese Regel ist aus den bestehenden Webapps-/Gitea-Routinen abgeleitet.

Orte

Repository = maßgebliche Dokumentation
Wiki       = lesbare Browserfassung
Issues     = steuerbare Arbeit
Boards     = Statusdarstellung
Chats      = laufende Klärung

Reihenfolge

Bei technischen oder betrieblichen Änderungen:

Änderung durchführen.
Funktion prüfen.
Maßgebliche Repo-Dokumentation aktualisieren.
Committen und pushen.
Falls sinnvoll: Wiki als lesbare Ableitung nachziehen.

Was ins Repository gehört

Ins Repository gehören:

Betriebsnotizen
konkrete Pfade und Dienstnamen
Wiederanlauf- und Backup-Logik
SSH- und Git-Zugriffsregeln
Änderungsprotokoll
technische Entscheidungen

Was in die Wiki gehört

In die Wiki gehören:

Überblick und Einstieg
lesbare Herleitung
Querverweise
kurze Arbeitsabläufe
nicht-sensitive Zugriffsinformationen
Zusammenfassungen für Menschen, die nicht direkt auf dem Server arbeiten

Was nirgends öffentlich dokumentiert wird

Nicht in Wiki oder Repository:

Passwörter
private Schlüssel
Tokens
geheime Zertifikatsschlüssel
vollständige Server-Backups
personenbezogene Zugangsdaten über das notwendige Maß hinaus

Grundsatz

Wenn ein Inhalt für Störung, Wiederanlauf oder Sicherheit gebraucht wird, gehört die maßgebliche Fassung ins Repository oder in ein geschütztes Backup, nicht nur in die Wiki.