Sie arbeiten in einem verteilten Team und betreiben Kundensysteme und kennen sicher die nachfolgend beschriebenen Situationen.
- Es ist Rufbereitschaft zu leisten und/oder die gleichen Aufgaben sind in unregelmäßigen Abständen sofort – auch nachts – zu erledigen.
- Systeme sind auf- oder abzubauen, aber je nach Dienstplan von unterschiedlichen Mitgliedern des Teams.
- Verschiedene Kunden rufen bei verschiedenen Mitgliedern Ihres Teams an und fragen immer wieder die gleichen Fragen.
In solchen Konstellationen ist eine gute Dokumentation unersetzlich. Was zeichnet nun eine "gute" Dokumentation aus?
Eine solche muss
- leicht und schnell zu finden sein
- einfach, verständlich und präzise gehalten sein (am besten mit Beispielen)
- leicht zu pflegen sein (von jedem Teammitglied)
- konsistent und nicht redundant sein (ein und dieselbe Information nur an einer Stelle!)
- von den Mitgliedern Ihres Teams akzeptiert sein.
Nach meiner Erfahrung ist eine solche technische Dokumentation sinnvoll unterteilt in folgende Kategorien:
In einem internen Teil (zugänglich nur für Ihr Team) sollten u.a. zu finden sein:
- Checklisten für häufig wiederkehrende Handlungsabläufe
- kurze HowTo's oder Tipps & Tricks mit Beispielen für komplizierte Sachverhalte (zum Beispiel erprobte Abfragen spezieller Details einer Datenbank)
- Schwerpunktthemen Ihrer speziellen Technologie mit Beispielen
- Handlungsanweisungen für den täglichen Betrieb oder die Rufbereitschaft
- Systemkonfigurationen
- maßgeschneiderte Installationsanleitungen für Ihre Umgebung
Optional und je nach den lokalen Gegebenheiten kann ein öffentlicher Teil (zugänglich für den Kunden) Hilfe zur Selbsthilfe geben. Hier können Antworten auf häufige Fragen der Kunden dazu beitragen, die Arbeitslast Ihrer Teammitglieder zu reduzieren.
Wenn die Dokumentation und das verwendete Werkzeug von den Mitarbeitern Ihres Teams akzeptiert wird, dann gehört im täglichen Leben nur noch eine Portion Disziplin eines jeden einzelnen dazu, die Dokumentation auf dem aktuellen Stand zu halten. Dieser Aufwand wird oft unterschätzt ("das kann man mal später machen – wenn Zeit ist"). Die Erfahrung zeigt aber, dass dies ist eine tägliche Aufgabe ist, denn jede Systemlandschaft verändert sich ständig. Und nichts ist kontraproduktiver als eine unvollständige oder veraltete Dokumentation. Dies führt sofort dazu, dass die Dokumentation nicht mehr verwendet wird.
Wenn die wenigen beschriebenen Prinzipien aber eingehalten werden, wird sich sehr schnell zeigen, dass
- die Fehlerrate im Team sinkt
- jedes Teammitglied in der Lage ist, die gleiche Tätigkeit in der gleichen Art und Weise auszuführen
- die Systeme gleich aufgebaut und gepflegt werden.
Das verwendete Dokumentationswerkzeug muss natürlich die oben beschriebenen Anforderungen erfüllen. Wir in unserem Team haben sehr gute Erfahrungen mit einem Wiki (www.mediawiki.org/wiki/MediaWiki) gemacht.
Viel Freude beim Dokumentieren.
Dr. Matthias Mann
stv. Themenverantwortlicher Datenbankadministration
Bild von Tobias Albers-Heinemann auf Pixabay
