WISSEN KOMPAKT

Das richtige IT-Dokumentationstool finden

Eierlegende Wollmichsau

Welches IT-Dokumentationstool empfehlen Sie denn?“ ist eine der häufigsten Fragen in unserer Beratungspraxis. Diese Frage suggeriert, dass mit einer einzigen Anwendung alle Bereiche der IT-Dokumentation gleichermaßen bedient werden können. Dabei ist der Wunsch, die Erledigung aller Dokumentationsaufgaben möglichst in einer Anwendung abbilden zu können, sehr verständlich. Verstärkt wird dieser Wunsch nicht selten durch Werbeaussagen von Herstellern, die genau dies versprechen. Doch so einfach lässt sich die Frage leider nicht beantworten.

Um es vorweg zu nehmen: „Das Dokumentationstool für die IT“ d.h. die eine Anwendung, die zur Erledigung aller Dokumentationsaufgaben einer IT-Organisation geeignet ist, gibt es nicht und kann es nach unserem Verständnis auch nicht geben. Allenfalls gibt es Hersteller, die Tools für verschiedene Einsatzzwecke in einer Suite bündeln. Aber selbst komplexe IT-Governance, Risk und Compliance-Suiten oder Enterprise-Architecture-Management-Anwendungen decken nicht alle Dokumentationsanforderungen ab.

Die wichtigste Frage: Was soll dokumentiert werden?

In der Praxis wird die IT-Dokumentation häufig mit der Dokumentation der IT-Systeme und der Infrastruktur gleichgesetzt und auf diese beschränkt. Eine solche Systemdokumentation ist zwar ein wesentlicher Teil der IT-Dokumentation, die Beschränkung darauf lässt aber eine ganze Reihe von Aufgabenbereichen und damit Dokumentationsbereichen unberücksichtigt. Denn wo sollen dann die Dokumente für Aufgabenfelder wie Störungsmanagement, Changemanagement,  Informationssicherheitsmanagement, Softwareentwicklung, IT-Risikomanagement, IT-Notfallmanagement zugeordnet werden. Hinzu kommt, dass die Anforderungen an die aufgeführten Dokumentationsbereiche aufgrund der unterschiedlichen Nutzergruppen völlig unterschiedlich sind.

Inventarisierungs- bzw. Discovery-Tools beispielsweise unterstützen automatisiert die Ermittlung der eingesetzten IT-Systeme sowie deren Systeminformationen und sind damit ein wichtiger Baustein. Zur Erstellung von textuellen Vorgabedokumenten, wie Richtlinien, Konzepte und Arbeitsanleitungen sind sie jedoch wenig geeignet, auch wenn einige Anwendungen Funktionen dafür integriert haben. Eine Plattform für die Verwaltung und die gemeinsame Bearbeitung von Dokumenten können sie aber nicht ersetzen. Hierfür ist der Einsatz eines Dokumentenmanagementsystems (DMS) sinnvoll. Ein DMS ist wiederum nicht geeignet, die externen Schnittstellen der eingesetzten Business-Anwendungen abzubilden oder die Beziehungen zwischen den eingesetzten Infrastrukturkomponenten darzustellen. Dies ist das Einsatzgebiet der Configuration Management Database. In einer solchen CMDB können alle IT-Komponenten und deren Zusammenhänge beziehungsweise Abhängigkeiten vwewaltet werden, sodass sich daraus diejenigen Daten extrahieren lassen, die man zum Beispiel für die Erbringung eines Service oder für eine Serviceoptimierung benötigt.

Die eigenen Anforderungen definieren

Steht die Anschaffung eines IT-Dokumentationstools an, muss zwingend zuerst die wichtigste Frage beantwortet werden: Welchen Zweck bzw. welche Ziele verfolgen wir mit dem Einsatz einer solchen Anwendung? Denn auf diese Frage kann es viele Antworten geben:

  • Wir benötigen eine jederzeit aktuelle Sytemdokumentation für unseren operativen IT-Betrieb und wollen dafür die Systeme möglichst automatisch erfassen.
  • Wir wollen unsere Prozesse toolgestützt verwalten und konsistent dokumentieren.
  • Wir benötigen eine CMDB zur Unterstützung unserer IT-Servicemanagementprozesse.
  • Wir müssen ein Notfallmanagement implementieren und benötigen dafür eine Notfalldokumentation.
  • Wir wollen unsere Dokumente effizienter verwalten und im Team bearbeiten.
  • Wir wollen ein ISMS aufbauen und uns zertifizieren lassen und benötigen dafür eine ISO-27001-konforme Dokumentation.
  • Wir wollen unsere Projektdokumentation optimieren, um Schnittstellenprobleme in den Projekten zu reduzieren.
  • Wir müssen gemeinsam mit unseren Dienstleistern an der Entwicklungsdokumentation arbeiten und benötigen ein Tool, dass dies unterstützt.
  • Unsere Wirtschaftsprüfer fordern eine aktuelle Dokumentation der Managementvorgaben.

IT-Fachanwendungen sind keine Dokumentationstools

Betrachtet man die vorstehende Liste mit den Einsatzzwecken und Zielen genau, wird deutlich, dass sich die Bedarfe in zwei Gruppen unterteilen lassen:

  • Unterstützung bei der Dokumentation
  • Unterstützung bei der Erledigung der jeweiligen Fachaufgaben

Diese Unterscheidung ist für das Verständnis und damit auch für die Tool-Evaluation wichtig. Denn Fachanwendungen wie beispielsweise Service Management Werkzeuge sind keine Dokumentationslösungen. Der originäre Einsatzzweck dieser Anwendungen ist nicht die Dokumentation, sondern die Unterstützung der Aufgaben für den jeweiligen Einsatzzweck.

Ein gutes Beispiel hierfür ist das in den meisten Unternehmen eingesetzte Ticketsystem. Wohl die Wenigsten würden dieses als Dokumentationsanwendung bezeichnen, obwohl die Dokumentation der Tickets und der Known Errors bzw. die mögliche Pflege einer FAQ-Datenbank ein wesentlicher Bestandteil solcher Systeme ist und im Gesamtkontext der IT-Dokumentation berücksichtigt werden muss. Im Vordergrund aber steht die Unterstützung bei der Bearbeitung von Störungen und Serviceanfragen sowie die Bereitstellung von Informationen zur proaktiven Vermeidung von Problemen. Gleiches gilt für die CMDB. In erster Linie soll diese durch die Dokumentation der Systemzusammenhänge den IT-Betrieb bei der Aufgabenerledigung unterstützen.

Tools zur Erledigung allgemeiner Dokumentationsaufgaben

Neben den Fachanwendungen zur Unterstützung der IT-Aufgaben gibt es aber natürlich auch Anwendungen, deren originärer Einsatzzweck die Verwaltung von Dokumenten bzw. die Unterstützung von Dokumentationsaufgaben ist. Dokumentenmanagementsysteme und Redaktionssysteme stehen hier an erster Stelle. Und auch WIKI-Systeme gehören dazu.

Redaktionssysteme werden häufig im Bereich der Technischen Dokumentation eingesetzt. Ein wesentliches Merkmal dieser Systeme ist die Trennung von Inhalten (Content), Datenstruktur und Design (Layout) sowie die Möglichkeit der Zugriffssteuerung bzw. Workflow. Im Zusammenhang mit Websites werden Redaktionssysteme auch als Content-Management-Systeme bezeichnet.

Die Hauptaufgabe von Dokumentenmanagementsystemen hingegen liegt darin, die definierten Dokumentationsverfahren in einem elektronischen System abzubilden, zu steuern und zu überwachen. Das DMS organisiert dabei Entwurf und Erstellung, Freigabe, Weitergabe und Verteilung, Auffinden sowie die Ablage und Übergabe an ein Archiv oder Löschung der Dokumente.

Bei einem WIKI arbeiten die Benutzer gemeinschaftlich an Texten, die ggf. durch Fotos oder andere Medien ergänzt werden können. Ein einzelnes Dokument, eine Wiki-Seite, kann hierbei mit wenigen Klicks geändert werden. Außerdem sind die einzelnen Seiten eines Wikis durch Querverweise (Hyperlinks) miteinander verbunden.  Im Gegensatz zu anderen Content-Management-Systemen bieten WIKIs weniger Gestaltungsmöglichkeiten für Layout und Design der Webseiten. Primäre Funktion ist ein Bearbeitungsmodus für jede Wiki-Seite, der es auch einem Benutzer ohne spezielle Kenntnisse der Software und ohne große Einarbeitung erlaubt, Text und Inhalt der Seite zu ändern.

Und wie findet man nun das richtige Dokumentationstool?

Da für die verschiedenen Aufgabenbereiche der IT-Organisation in den vergangenen Jahren immer mehr Fachanwendungen zur Aufgabenunterstützung entwickelt wurden, beginnt heute kein Unternehmen mehr auf der grünen Wiese. Daher bestehen die Herausforderungen bei der Dokumentation heute zunehmend darin, die in den IT-Fachanwendungen verwalteten Informationen für Dokumentationsaufgaben richtig zu nutzen.

Auch deshalb muss bei der Suche nach einer Dokumentationslösung zwingend immer die bestehende Anwendungslandschaft betrachtet werden. Hierzu zählen Anwendungen für Prozessmodellierung, Inventarisierung Lizenzverwaltung, Softwareverteilung, Ticketbearbeitung u.a. Diese sollten analysiert und hinsichtlich ihres Dokumentationsbeitrags bewertet werden. Bei der Analyse wird dann häufig sehr schnell deutlich, ob die Anschaffung einer Lösung zur Dokumentationsverwaltung allgemein oder zur Unterstützung bestimmter Aufgaben (oder beides) benötigt wird. Anschließend kann mit der gezielten Evaluation begonnen werden.

Um zu verhindern, dass Insellösungen oder Redundanzen entstehen, sollten sich alle eingesetzten Anwendungen im Idealfall ergänzen und miteinander agieren. So könnte zum Beispiel eine ISMS-Software auf die vom Inventarisierungstool erfassten Informationen zugreifen und die Ergebnisberichte regelmäßig in einem SharePoint-Bereich für das Infrastrukturteam veröffentlichen. In jedem Fall sollte vermieden werden, dass Daten redundant in mehreren Systemen gepflegt werden müssen.

Veröffentlicht 06/2019