Dokumentation, die benutzt wird

Kurz. Klar. Nützlich.

Gute Dokumentation ist wie guter Code: Sie funktioniert, ohne dass man sie lesen muss. Schlechte Dokumentation liest sich wie ein Roman — langweilig, unklar, und im Incident hat niemand Zeit dafür.

Was ich schreibe

• Kurz — maximal drei Sätze pro Abschnitt, Quick Pick-up in 30 Sekunden
• Klar — keine Fachbegriffe ohne Erklärung, ehrliches Naming
• Nützlich — was ich nachts brauche, nicht was ich vor einem Jahr gelernt habe

Wenn Doku nicht bedienbar ist, ist die Infrastruktur nicht fertig.

Runbooks statt Romane

Ein Runbook beantwortet drei Fragen: Was ist das Problem? Was tue ich jetzt? Woran erkenne ich, dass es vorbei ist? Alles andere ist Beiwerk. Im Anwendungsbetrieb zählt, dass eine Kollegin um drei Uhr nachts ohne Rückfrage weiterkommt.

Ich schreibe Referenz, keine Tutorials: Runbooks, Changes, Prozessdokumentation. Schnell gefunden, schnell angewendet — und nach jeder Störung aktueller als vorher.