IT-Dokumentation - Der Blog

Was beinhaltet eine (gute) IT-Dokumentation?

Mi, 21. Mai 2014

Eine Frage in diversen Foren befasst sich immer wieder mit dem Thema, welche Inhalte zu einer (guten) IT-Dokumentation gehören. Welche Informationen soll die Dokumentation beinhalten, welchen Umfang soll der Inhalt haben? Spannend ist dann die Frage, ob dafür jemand eine (wiederum gute) Word-Vorlage zur Hand hätte. Kosten soll es natürlich keine verursachen und man will auch nicht viel Zeit aufwenden. Eine ganze IT-Dokumentation in einem einzigen Word-Dokument? Spannend. Aber was ist da die Vorstellung vom Ergebnis?

Aber wie baut sich nun eine (gute) IT-Dokumentation auf?

Gehen Sie anders an das Thema heran und fragen Sie sich, was Sie mit der IT-Dokumentation erreichen wollen. Mal abgesehen von der Erfüllung rechtlicher Vorgaben.

Der Duden beschreibt den Begriff Dokumentation als „Zusammenstellung und Nutzbarmachung von Dokumenten“. Da wir hier eine IT-Dokumentation erstellen wollen, formulieren wir die Aussage anders: „Zusammenstellung und Nutzbarmachung von Informationen“. Das ist unser Ziel: die Nutzbarmachung von Informationen. Daten werden durch Auswertung und der Bildung von Zusammenhängen zu einer Information. Diese Daten gilt es also zunächst zusammen zu tragen.

In drei Schritten zur IT-Dokumentation

Im ersten Schritt geht es deshalb darum, entsprechende Daten in Ihrem Netzwerk zu sammeln. Wir brauchen qualifizierten Input, um eine fundierte Datengrundlage zu schaffen. Da halten wir es mal wie Internet-Provider, Regierungen und Geheimdienste. Wir wollen sehr viele Daten sammeln, löschen können wir ja immer noch. Aber es ist nun einmal so: was man nicht erfasst, kann man später nicht auswerten. Aber hier erfassen wir ja keine personenbezogenen Daten, sondern Inventardaten unseres Netzwerks und die Datenerfassung hat gute Gründe.

‘‘ Wir müssen kennen und verstehen was wir dokumentieren.“

Ist diese Datengrundlage dann einmal geschaffen, werden die Daten im zweiten Schritt durch Bildung von fachlichen Zusammenhängen und Bewertungen zu einer Information gewandelt. Um aktuelle Informationen zur Verfügung zu haben, brauchen wir also auch aktuelle Daten aus unserem Netzwerk. Dies erreichen wir mit der Dokumentationssuite Docusnap durch zeitgesteuerte Inventarisierungsaufträge. Im dritten Schritt werden die konkreten IT-Konzepte dann in Form der IT-Dokumente erzeugt. Diese werden dann an zentraler Stelle allen berechtigten Personen zur Verfügung gestellt.

Was beinhaltet eine (gute) IT-Dokumentation

1. Sammeln von Inventardaten für den Input

Der Aufbau einer IT-Dokumentation kann also in mehrere Stufen eingeteilt werden. Wir befüllen zunächst einen großen Topf mit Input in Form von Inventardaten, manuell erfassten kaufmännischen Dokumenten und organisatorischen Daten. Diesen Topf beschriften wir, in Anlehnung an ITIL, mit dem Begriff Configuration Management Database (CMDB). Passt nicht alles in eine Datenbank, ist dies nicht weiter schlimm. Dann nehmen Sie einfach mehrere Datenbanken. ITIL nennt dieses System dann Configuration Management System (CMS). Gerne können auch Logfiles der IT-Systeme mit erfasst werden, hier kann Syslog helfen Daten einzusammeln. Aber Logfiles werden wir im Folgenden nicht weiter betrachten. Viele Daten müssen überwiegend händisch hinzugefügt werden. Es handelt sich beispielsweise um Softwarelizenzen, Passwörter, Informationen des Beschaffungswesens, konkrete Einsatzzwecke und Verfügbarkeitsanforderungen an Hard- und Software. Man kann eigentlich niemals zu viel erfassen.

2. Die gesammelten Daten werden zu Informationen verarbeitet

Nun setzen wir die inventarisierten Daten in thematische und fachliche Beziehungen zueinander. 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. Das Ergebnis dieser Verarbeitung bezeichnen wir als IT-Beziehung, in Anlehnung an ITIL auch als IT-Service. Für eine (gute) IT-Dokumentation sollten so viele Abhängigkeiten wie möglich dokumentiert werden.

3. Zusammenstellung Ihrer Handbücher als Output

Die Sammlung von IT-Beziehungen wiederum ergeben als Output das IT-Konzept. Dies kann man mit IT-Handbuch, Wiederanlaufplan oder IT-Notfallhandbuch betiteln. Abhängig vom jeweiligen IT-Konzept variieren natürlich dessen Inhalte. Mit Blick auf ITIL können wir auch von einem Service Catalog sprechen. Dies ist die IT-interne, technische Dokumentation aller Services. Zur Erstellung eines Service Catalog benötigen Sie jedoch eine entsprechende Gruppierung Ihrer IT-Landschaft.

Egal ob Sie bereits über solche Gruppierungen verfügen oder nicht, Sie können nun durch Gruppierung von Daten aus dem großen Topf „CMDB“ das gewünschte Ergebnis in Form von IT-Konzepten zusammenstellen. Der Verweis auf eine Rechnungs- oder Lieferscheinnummer spielt im Konzept „IT-Notfallhandbuch“ keine Rolle. Aber auf einem Geräte-Datenblatt sollte diese Information auf jeden Fall angegeben werden. Wenn man aber einen Wiederanlaufplan dokumentieren möchte, benötigt man in diesem Konzept Daten zu den durchgeführten Datensicherungen der IT-Systeme. Die Datengrundlage muss aus Qualitätsgründen einheitlich sein. Sie dokumentieren ja immer die gleiche EDV-Anlage, also fügen Sie alle Daten einheitlichen Inventardatenbanken zu.

Die Qualität der Inventardaten ist entscheidend für eine (gute) IT-Dokumentation

Nun können Sie für sich hoffentlich die Eingangsfrage beantworten. Eine gute IT-Dokumentation muss zunächst auf einer umfassenden und aktuellen Datenbasis beruhen. Dann verknüpfen Sie die benötigten Informationen zu IT-Beziehungen und erstellen damit Ihr IT-Konzept. Somit erhalten Sie Ihre gewünschte Dokumentation. Welche Inventardaten gesammelt und in die CMDB eingetragen werden sollen und welche kaufmännischen Daten benötigt werden, hängt von Ihrem Unternehmen ab. Tragen Sie nach und nach so viele Informationen zusammen, wie Sie mit vertretbarem Aufwand leisten können. Damit kann sich der Aufbau insgesamt zwar über mehrere Jahre hinziehen, wenn aber nur begrenzt Zeit für dieses Projekt zur Verfügung steht, dann lässt es sich nur begrenzt beschleunigen.

Für eine gute IT-Dokumentation ist es entscheidend, auf welche Datenbasis zurückgegriffen werden kann und wie es um die Qualität dieser Daten bestellt ist. Die Handbücher sind letztendlich der Output, in dem die jeweiligen Inhalte zusammengetragen werden.

Je hochwertiger der Input, desto besser kann der Output in Form Ihrer Handbücher gestaltet werden. Hier finden Sie im Dokumentationstool Docusnap die optimale Unterstützung für jeden einzelnen Schritt. Grafische Übersichtspläne sollten ebenfalls fester Bestandteil Ihrer IT-Dokumentation sein. Greifen Sie dazu auf diverse Vorlagen für die Erstellung von Netzwerkplänen zurück, die bereits im Lieferumfang von Docusnap enthalten sind. Nutzen Sie die Möglichkeiten einer modernen Software in vollem Umfang aus und erleichtern Sie sich die strukturierte Erstellung Ihrer IT-Dokumentation.

Schreibe einen Kommentar