Ein typischer Fall: Das Projekt zur Einführung einer neuen Anwendung ist abgeschlossen und die mehr oder weniger ausführliche Betriebsdokumentation wurde an den IT-Betrieb übergeben. Dieser legt die Dokumente auf einem Fileshare ab, das war es. Werden die Dokumente dann nach einem Jahr für eine Prüfung oder eine Anpassung der Anwendung im Betrieb benötigt, sind sie hoffnungslos veraltet und nicht mehr brauchbar.
Dieses Schicksal teilen leider sehr viele Dokumente und tragen damit zu der weit verbreiteten Auffassung bei, dass eine IT-Dokumentation lediglich Arbeit und Kosten verursacht, aber keinen Mehrwert bringt. Dies muss aber keineswegs so sein. Wie Sie es schaffen Ihre IT-Dokumentation aktuell zu halten, zeigt dieser Beitrag.

Ohne Dokumentationsmanagement geht es nicht

Sicherheitsmanagement, Risikomanagement, Qualitätsmanagement, Servicemanagement sind nur einige Bereiche mit denen sich Unternehmen jeder Größe und Branche zunehmend auseinandersetzen müssen. Bei all diesen Anforderungen steht der Prozessgedanke im Vordergrund. Es reicht nicht aus einmalig eine Risikoanalyse zu erstellen. Vielmehr sind regelmäßige Überprüfungen und Anpassungen und die Einrichtung eines kontinuierlichen Verbesserungsprozesses erforderlich.
Die Erstellung von Dokumenten aber wird in vielen Organisationen als isolierter statischer Vorgang behandelt. Dies führt dann häufig dazu, dass es nicht an Dokumenten mangelt, diese aber bei Bedarf nicht mehr auffindbar und/oder nicht aktuell sind. Die Ursache dafür ist, dass es meist weder Regelungen gibt, noch Abläufe definiert sind. Mit anderen Worten: Es fehlt ein Dokumentationsmanagement. Ein solches muss organisatorischen Maßnahmen und gesteuerte Verfahren für die Dokumentenverwaltung definieren und ist nicht zu verwechseln mit dem Dokumentenmanagement, denn das bezeichnet laut Duden »die elektronische Verwaltung von Dokumenten in Datenbanken«.

okumentationsmanagement

Umsetzung in der Praxis

Häufig beginnen Projekte zur Optimierung der IT-Dokumentation mit der Suche nach einem Tool. Je umfangreicher die Anzahl an Dokumenten und je größer die Komplexität der Abhängigkeiten ist, desto stärker ist in der Tat das Erfordernis nach einer zentralen IT-gestützten Datenhaltung und Tool-Unterstützung bei der Dokumentation.
Allerdings darf die Auswahl eines Tools nicht am Anfang stehen. Tools können die definierten Verfahren unterstützen, sie jedoch nicht ersetzen. Für den Aufbau einer nachhaltigen Dokumentation sind vielmehr die in Bild 1 dargestellten Bereiche wichtig:
Dokumentationsvorgaben: Wer bereits Erfahrung mit »wild gewachsenen« IT-Dokumentationen gemacht hat, weiß, welche Schwierigkeiten entstehen können, wenn die Einzeldokumente keinerlei Standards in Bezug auf Benennung, formalen Aufbau und inhaltliche Ausgestaltung aufweisen und Abhängigkeiten zwischen den Dokumenten nicht nachvollziehbar sind. Die Erstellung und Durchsetzung einer Dokumentationsrichtlinie ist daher der erste und wichtigste Schritt zur Konsolidierung der Dokumentation. Diese muss neben formalen Vorgaben vor allem auch Verantwortlichkeiten regeln.
Dokumentationsverfahren: Zusätzlich müssen Verfahren für die Dokumentenerstellung und die Dokumentenpflege definiert und eingeführt werden. Ohne feste Regeln für die regelmäßige Überprüfung und Überarbeitung der Dokumente, wird an diesem Zustand auch nichts ändern. Nicht umsonst fordern Standards wie die ISO 9001 die Einrichtung von Verfahren zur Lenkung von Dokumenten und Aufzeichnungen.

Arbeitshilfen und Anleitungen: Jeder kennt die Situation: Man erhält ein Dokument und stellt beim Lesen fest, dass man die Inhalte nur mit Mühe versteht. Es gibt keinen roten Faden, man weiß eigentlich gar nicht an wen sich das Dokument richtet und geeignete Abbildungen, die zum Verständnis beitragen könnten fehlen. Gerade im IT-Umfeld ist bei Erstellern von Dokumenten die Auffassung verbreitet: »Der Inhalt zählt und wie der Leser damit zurecht kommt ist seine Sache«. Es ist deshalb wichtig Hilfen in Form von Anleitungen und Vorlagen, die das Layout und die Strukturierung vorgeben, bereitzustellen.

Fazit

Dokumentation ist kein Selbstzweck, sondern muss die die IT- Services und Prozesse unterstützen. Dafür aber wird eine aktuelle und an den jeweiligen Zielgruppen ausgerichtete IT-Dokumentation benötigt. Hierfür müssen Verantwortlichkeiten, Richtlinien und definierte Abläufe definiert und eingeführt werden. Ohne gelebte Regelungen wird es nicht gelingen, aus einer unzusammenhängenden Sammlung von Dokumenten eine nachhaltige Dokumentation aufzubauen.
Einen ersten Einstieg in dieses Thema möchte Ihnen unser Beitrag bieten. Spätere Blogbeiträge werden diese Thematik schlaglichtartig vertiefen. Umfassende Hilfestellungen zum Aufbau eines ganzheitlichen Dokumentationsmanagements finden Sie in unserem Praxisbuch IT-Dokumentation.

Manuela und Georg Reiss

Reiss / Reiss, Praxisbuch IT-Dokumentation

Und nun zur Verlosung der fünf Rezensionsexemplare des Titels Praxisbuch IT-Dokumentation:  Sie interessieren sich für IT-Dokumentation oder wollen sich einfach mal an das Thema wagen? Dann beantworten Sie bis zum 28. Februar die die untenstehende Gewinnfrage und tragen Ihre Antwort als Beitragskommentar ein.

 

Was sind Aufzeichnungen im Sinne von Dokumentationsmanagement?

a) Ergänzende handschriftliche Notizen

b) Dokumentation der Ergebnisse einer Tätigkeit bzw. eines Prozesses zum Zwecke des Nachweises

c) Tonaufnahmen bzw. audiovisuelle Mitschnitte

Die Gewinner schicken bitte nach der Lektüre ihre Bewertung bzw. Rezension an den Verlag oder veröffentlichen diese in Ihrem Netzwerk!

Na dann, viel Glück!

 Auch hier gelten wie immer die Gewinnspiel Teilnahmebedingungen des Verlages.

 Das Gewinnspiel ist nun offiziell beendet. Wir danken Ihnen für Ihre Teilnahme! Die Gewinner werden per E-Mail benachrichtigt!