Während umfassende Dokumentation ideal ist, sollte Umfang und Formalität mit der Kritikalität, Komplexität und Lebenszyklusphase der Anwendung übereinstimmen.
Wann Dokumentation essenziell ist
- Mission-kritische Systeme: Ausfallzeiten verursachen Umsatzverluste, Sicherheitsrisiken oder Compliance-Verstöße.
- Regulierte Umgebungen: SOX, HIPAA, FDA 21 CFR Part 11, GDPR erfordern Audit-Trails.
- Komplexe Integrationen: Mehrsystem-Abhängigkeiten benötigen Runbooks für Fehlerbehebung.
- Teams mit hoher Fluktuation: Wissenserhalt durch Dokumentation reduziert Onboarding-Risiko.
- Disaster Recovery: Schritt-für-Schritt-Wiederherstellungsverfahren sind unverhandelbar.
Wann leichte Ansätze ausreichen
- Legacy-Systeme nahe dem Ruhestand: Investieren in Migrationsdokumentation, nicht Wartungsdokumentation.
- Open-Source/COTS mit Herstellerdokumentation: Herstellerdokumentation referenzieren; nur Lücken ergänzen.
- Einfache, niedrig risikobehaftete Dienstprogramme: README + Inline-Kommentare mögen ausreichen.
- Agile/DevOps-Kontexte: Lebende Dokumente (Architektur-Entscheidungsprotokolle, Runbooks im Repository) > statische Handbücher.
Minimales lebensfähiges Dokumentationsset
- Architekturübersicht + Datenflussdiagramm.
- Bereitstellungs-/Release-Verfahren (automatisiert bevorzugt).
- Konfigurationsmanagement (Parameter, Geheimnisbehandlung).
- Wichtige operative Runbooks: Start/Stopp, Backup/Wiederherstellung, Skalierung, gängige Warnungen.
- Incident-Response-Playbooks für die 5 häufigsten Fehlerszenarien.
- Sicherheits-Härtungs-Checkliste.
Governance
- Dokumentenverantwortung zuweisen; vierteljährlich oder nach größeren Änderungen überprüfen.
- Versionskontrolle neben dem Code.
- Kennzahlen: Dokumentationsabdeckung %, Zeit zur Lösung mit/ohne Dokumentation.
Dokumentation richtig dimensionieren — genug, um sicher zu arbeiten, nicht so viel, dass sie veraltet.
