Dokumentation ist wichtig und Dokumentation ist (eigentlich) Pflicht – darüber herrscht zumindest theoretisch Einigkeit. Die Realität sieht jedoch oft anders aus. Dokumentation ist lästig und überhaupt nur was für Feiglinge, oder?

Sobald eine Dokumentation benötigt wird, sei es für eine IT-Systemarchitektur, eine  Applikation oder eine Betriebshandbuch, stellt sich oft heraus, dass es gar kein passendes Dokument gibt, dass das vorhandene Dokument völlig veraltet ist oder die gesuchten Informationen gar nicht enthält. Wird die Dokumentation zur Behebung einer Störung benötigt, können die beschriebenen Szenarien den Blutdruck der handelnden Personen in ungeahnte Höhen schnellen lassen. Wie war doch gleich das Root-Passwort? In welcher Reihenfolge mussten die Prozesse gestartet werden und welche Prozesse werden für den reibungslosen Betrieb überhaupt benötigt?

Es stellt sich also die Frage, welche Arten von Dokumentationen erforderlich sind, um den IT-Betrieb sicherzustellen.

Dokumentationen für Service Support

In diesem Dokument sollen alle notwendigen Schritte beschrieben sein, um einen IT-Service wiederherzustellen. Hierfür bieten sich Wikis an oder dedizierte Known Error-Datenbanken, die mit der CMDB verknüpft sind. Wikis bieten den Vorteil, dass Aktualisierungen schnell und einfach vorgenommen werden können.

Dokumentationen zur Applikationsarchitektur

Dokumente über die Applikationsarchitektur helfen ebenfalls, Störungen und Fehler zu beheben. Wenn es sich um komplexe Zusammenhänge handelt, beantwortet diese Dokumentation Fragen nach den Anwendern, dem Datenfluss und den Schnittstellen zu den umgebenden Systemen. Ansprechpartner und Zulieferer können so schneller identifiziert werden, die Störungsbehebung wird beschleunigt.

Dokumentation der Systemlandschaft

Dieses Dokument zeigt die Umgebung, in die die Applikation eingebettet ist. Schnittstellen, liefernde Systeme und abnehmende Systemen werden schematisch und übersichtlich dargestellt.  Es wird außerdem klar, welche Applikationen in welchem Verantwortungsbereich liegen.

Audit-Dokumentation

Das jährliche Sicherheits-Audits steht an? Mit einer gepflegten Dokumentation und einer logischen Ablage lässt sich dieser lästigen Pflichtaufgabe mit Gelassenheit entgegensehen. Ein Großteil der Fragen der Auditoren lässt sich mit der vorhandenen Dokumentation spontan beantworten. Allerdings sollte eine Versionskontrolle und -pflege der Dokumente erkennbar sein.

Übergaben und Einarbeitung

Bei Urlaubsvertretungen müssen oftmals viele Details zu offenen Themen, Projekten, Ansprechpartner an eine Kollegin oder Kollegen übergeben werden. Eine aktuelle Dokumentation, die am besten für alle Mitarbeiter zugänglich ist, vereinfacht die Urlaubsübergabe. Kommen neue Mitarbeiter ins Team kann die Einarbeitung mit der Lektüre der Dokumentation beginnen. Die wichtigsten Fragen sind damit meistens schon beantwortet. Auch für eine Mitarbeiterschulung läßt sich die Dokumentation sehr gut einsetzen.

Ist Dokumentation also wirklich nur etwas für Feiglinge? Es  läßt sich zusammenfassend feststellen, dass in einer zunehmend vernetzten Welt, Dokumentation neuen Stellenwert gewinnt.