IT-Dokumentation - Der Blog

Was ist eine gute IT-Dokumentation?

Mi, 10. März 2021

Wenn es sich um das Thema IT-Dokumentation dreht, gehen viele IT-Verantwortliche schon mal vorsorglich in Deckung. Es ist nicht immer leicht, eine komplette IT-Dokumentation zu realisieren. Schon gar nicht, wenn man ohne Hilfsmittel an die Sache herangeht.

Bevor man sich aber an die Sache heranmacht, sollte geklärt werden, was es, außer genügend Zeit und Man-Power, zu einer guten IT-Dokumentation braucht.

Die Taube in der Hand ist besser als der Spatz auf dem Dach

Die IT-Dokumentation ist seit je her immer schon ein bedeutendes Schreckgespenst der IT-Abteilungen gewesen. Sehr aufwändig in der Konzeption und Erstellung und die regelmäßige Wartung der Dokumentation ist im normalen Tagesgeschäft eher die Ausnahme. Die Folge davon ist, dass ein großer Teil der anfänglich gut gemeinten IT-Dokumentation schon nach kurzer Zeit nicht mehr aktuell ist und damit auch zum Teil nutzlos wird.

Der Aufwand, jedes Mal manuell alle Daten aufzunehmen und diese in die Dokumentation einzupflegen, ist enorm.

Die IT-Dokumentation und die Landwirtschaft

Könnten Sie sich vorstellen, dass unsere Landwirte ihre Äcker und Felder noch von Hand bearbeiten? Oder mit arbeitsstarken Ackergäulen, die einen Pflug hinter sich herziehen und ihre Arbeit verrichtet? Natürlich wäre das möglich. Wäre es sinnvoll? Wohl eher kaum. Kaum ein Landwirt würde sich heute dafür ein Pferd kaufen, wenn es bessere, einfachere und schnellere Methoden gibt. Dafür gibt es gigantische Maschinen, die einem möglichst viel von der damals sehr schweißtreibenden Arbeit abnehmen. Manuell werden die Maschinen nur mehr über das Feld geführt, den Rest erledigt die Technik. Manuelle Arbeiten werden so weit wie möglich vermieden.

Ähnlich verhält es sich mit unserer IT-Dokumentation. Wer möchte, kann alles manuell auf ein Blatt Papier übertragen. Wir können aber auch die Möglichkeiten der modernen IT nutzen und eine IT-Dokumentation führen, die mit automatisierten Vorgängen und geringem Aufwand stets aktuell gehalten wird. Die manuellen Erfassungen werden so weit wie möglich reduziert.

Aus was besteht denn eine gute IT-Dokumentation?

Prinzipiell haben können wir eine gute IT-Dokumentation in verschiedene Abschnitte unterteilen.

Die Datenbasis

Um eine Dokumentation zu erstellen, brauchen wir Daten. Um Daten zu erhalten, müssen wir diese erheben (lassen). Mit „erheben lassen“ ist jetzt keinesfalls gemeint, den Lehrling auf eine chaotische Reise durch die IT-Landschaft zu schicken, bewaffnet mit Block und Stift, um die IT zu erfassen. Wir lassen uns diese Informationen mit einer Inventarisierungssoftware zusammenstellen, die mit verschiedensten Scan-Verfahren die gesamte IT durchforstet und anschließend in einer Datenbank speichert.

Ergänzt werden diese Daten durch manuelles Hinzufügen von Informationen über z. B. Softwarelizenzen, Passwörter oder auch Hinweise zu Beschaffungsvorgängen, Verfügbarkeitsanforderungen und noch vieles mehr. Für eine gute IT-Dokumentation sind mehr zusätzliche Informationen besser als nur wenige. Und ausgewertet werden können nun eben nur Daten, die auch erfasst sind.

Die Verarbeitung der Informationen

Herzlichen Glückwunsch.
Ist die Datenbank vollgefüllt mit den wertvollen Informationen, haben wir den ersten Schritt für eine gute und vernünftige IT-Dokumentation getan. Da wir jetzt mit frischen Daten arbeiten können, müssen wir uns um die regelmäßige Aktualisierung erst später kümmern.

Um die Daten auswerten und auch verstehen zu können, müssen diese zuerst einmal in thematische und fachliche Beziehungen zueinander gesetzt werden. Hier werden primär die Techniker gefragt sein. Das Wissen über Zusammenhänge und Abhängigkeiten von Hardwaresystemen und installierter Software können nur die Fachleute dokumentieren, welche diese eingeführt haben oder aktuell betreuen. Wir bereiten also die Inventardaten in der Form auf, dass deren Abhängigkeiten untereinander dokumentiert werden.

Heureka – das ständig aktuelle IT-Handbuch

Egal, ob Sie nun ein umfassendes IT-Handbuch, das IT-Notfallhandbuch oder einen Wiederanlaufplan mit den vorhandenen Daten erstellen wollen. Docusnap bietet hier mehr als nur die Basisfunktionen einer Inventarisierung.
Mit unzähligen vorgefertigten Berichten, die eine exakte Selektion der Daten ermöglicht, sind ihren Wünschen kaum Grenzen gesetzt. Alle erforderlichen Daten sind nun in der Datenbank verfügbar und mit den bereits fertigen Vorlagen bauen wir uns schnell eine komplette IT-Dokumentation, ein Notfallhandbuch oder einen Wiederanlaufplan auf. Da wir damit auf ständig aktualisierte Inventarisierungsdaten zugreifen, sind auch alle unsere Handbücher immer auf dem neuesten Stand. Inklusive den Netzwerkplänen, die automatisch an jede Veränderung angepasst werden.

Was bringt eine umfangreiche Dokumentation ohne aktuelle Daten?

Einer der entscheidendsten Faktoren für die Qualität einer Dokumentation ist neben dem Umfang die Aktualität der Datenbasis. Welche Inventardaten gesammelt und in die CMDB eingetragen werden sollen und welche kaufmännischen Daten benötigt werden, hängt von Ihrem Unternehmen ab.
Je hochwertiger der Input, desto besser kann der Output in Form Ihrer Handbücher gestaltet werden. Auch hier finden wir im Dokumentationstool Docusnap die optimale Unterstützung für jeden einzelnen Schritt.
Grafische Übersichtspläne sollten ebenfalls fester Bestandteil Ihrer IT-Dokumentation sein. Hierfür bietet Docusnap ebenfalls bereits Vorlagen für die Erstellung von Netzwerk- oder Topologie-Plänen.
Ein professionelles Tool wie Docusnap erleichtert die Erstellung und Wartung der IT-Dokumentation enorm. Vor allem die automatische Aktualisierung spielt dabei eine wichtige Rolle, denn was bringt uns ein Notfallplan für eine alte, nicht mehr im Einsatz befindliche Serverlandschaft?