Betriebsdokumentation
Die Betriebsdokumentation beschreibt ein laufendes System so, dass eine fachkundige Person es ohne Rückfrage beim Ersteller betreiben, ändern und nach einem Ausfall wiederherstellen kann.
Die Betriebsdokumentation ist die Unterlage, auf die jeder Eingriff am laufenden System zurückgreift, von der Störung bis zum Dienstleisterwechsel.
In einfachen Worten
Die Betriebsdokumentation unterscheidet sich von der Entwicklungsdokumentation durch ihren Adressaten. Sie richtet sich an die Person, die das System am Laufen hält, und beantwortet deren Fragen. Fünf Bestandteile tragen sie. Die Systemübersicht benennt die Bestandteile und ihr Zusammenspiel: Anwendung, Datenbank, Speicher, vorgelagerte Dienste, Aufgaben, die zeitgesteuert laufen. Die Abhängigkeiten halten fest, welche fremden Dienste eingebunden sind und was bei deren Ausfall geschieht. Die Ablageorte nennen, wo Quellcode, Daten, Sicherungskopien und Zugangsdaten liegen, einschließlich der Stellen außerhalb der Produktivumgebung. Die Betriebsabläufe beschreiben wiederkehrende Handgriffe: das Einspielen einer neuen Fassung, das Einspielen von Aktualisierungen, den Umgang mit einem vollgelaufenen Speicher. Der Wiederanlaufplan beschreibt die Reihenfolge nach einem Ausfall. Der Maßstab für die Qualität ist einfach: Die Dokumentation ist ausreichend, wenn eine fachkundige Person mit ihr allein arbeiten kann.
Wozu brauche ich das?
Gebraucht wird sie in drei Lagen, die alle ungeplant eintreten. Bei einer Störung außerhalb der Arbeitszeit, wenn die Person mit dem Wissen nicht erreichbar ist. Beim Ausfall oder Ausscheiden dieser Person, wenn eine Vertretung übernehmen muss. Beim Wechsel des Dienstleisters, wenn der Nachfolger ohne Mitwirkung des Vorgängers anfangen soll. In allen drei Lagen ist die Dokumentation der Unterschied zwischen einer Stunde Arbeit und einer Woche Rekonstruktion.
Beispiel aus der Praxis
Bei einem mittelständischen Betrieb fällt am Wochenende die Website aus. Der zuständige Entwickler ist im Urlaub. Die Betriebsdokumentation nennt den Hoster samt Zugang, den Standort der Datenbank, den zeitgesteuerten Auftrag, der nachts den Artikelabgleich fährt, und den Hinweis, dass ein Abbruch dieses Auftrags eine Datei zurücklässt, die den Start der Anwendung blockiert. Ein Vertreter findet die Datei in wenigen Minuten, entfernt sie und startet die Anwendung neu. Ohne diese Beschreibung wäre dieselbe Ursache nur durch Suchen im Quellcode zu finden gewesen.
Wirtschaftlicher Nutzen
Die Dokumentation verkürzt die Zeit vom Auftreten einer Störung bis zu ihrer Behebung, und diese Zeit ist die Größe, die den Schaden bestimmt. Sie löst zugleich die Bindung des Betriebs an eine einzelne Person, denn Wissen, das nur in einem Kopf liegt, ist bei Krankheit, Urlaub und Kündigung nicht verfügbar. Für die Übergabefähigkeit ist sie der Bestandteil, der sich am schwersten nachträglich herstellen lässt: Code und Zugänge sind vorhanden oder nicht, eine Beschreibung des Zusammenspiels muss jemand schreiben, der es noch kennt.
Typische Fehler
- Die Dokumentation beschreibt den Aufbau zum Zeitpunkt der Fertigstellung und wird bei Änderungen nicht fortgeschrieben.
- Sie liegt in der Umgebung, die sie beschreibt, und ist bei deren Ausfall nicht erreichbar.
- Zugangsdaten stehen im Klartext im selben Dokument, statt in einem Kennwort-Verwalter mit Verweis.
- Beschrieben wird der Normalbetrieb, aber nicht der Wiederanlauf nach einem Ausfall.
- Bekannte Eigenheiten und frühere Störungsursachen fehlen, obwohl sie die häufigsten Fälle betreffen.
Worauf achten?
- Die Dokumentation außerhalb der beschriebenen Umgebung ablegen und den Zugriff unabhängig davon sichern.
- Bei jeder Änderung am System die betroffene Stelle mitschreiben, statt eine jährliche Sammelpflege zu planen.
- Auf Kennwörter im Dokument verzichten und stattdessen auf den Ablageort im Kennwort-Verwalter verweisen.
- Einmal jährlich prüfen lassen, ob eine fachkundige Person mit der Unterlage allein zurechtkommt.
- Frühere Störungen mit Ursache und Behebung aufnehmen; sie wiederholen sich häufiger als neue Fälle auftreten.
Häufig gestellte Fragen
Was gehört in eine Betriebsdokumentation?
Systemübersicht mit allen Bestandteilen und ihrem Zusammenspiel, die Abhängigkeiten von fremden Diensten, alle Ablageorte für Code, Daten und Sicherungen, die wiederkehrenden Betriebsabläufe und der Wiederanlaufplan nach einem Ausfall.
Worin unterscheidet sie sich von der Entwicklungsdokumentation?
Im Adressaten. Die Entwicklungsdokumentation richtet sich an die Person, die den Code ändert, und erklärt Aufbau und Entscheidungen. Die Betriebsdokumentation richtet sich an die Person, die das System am Laufen hält, und erklärt Betrieb, Störungsbehebung und Wiederanlauf.
Wo sollte die Dokumentation liegen?
Außerhalb der Umgebung, die sie beschreibt, und mit einem Zugriff, der von dieser Umgebung unabhängig ist. Eine Dokumentation, die beim Ausfall des Servers ebenfalls nicht erreichbar ist, hilft im Ernstfall nicht.
Gehören Zugangsdaten in die Dokumentation?
Die Kennwörter selbst nicht. In die Dokumentation gehört, welche Zugänge es gibt, wem sie gehören und in welchem Kennwort-Verwalter sie liegen. So bleibt die Unterlage auch dann weitergebbar, wenn nicht jeder Leser Zugriff auf die Zugänge haben soll.