IT-Handbuch erstellen

Zuletzt aktualisiert: Mi, 1. Dezember 2021

Nun haben Sie es endlich geschafft! Nach all den Vorbereitungen, Festlegungen und den ganzen Inventarisierungen sind wir nun endlich an dem Punkt angekommen, an dem wir uns mit der Erstellung des IT-Handbuchs beschäftigen.

Verwenden Sie eine Vorlage zur ersten Gliederung

Nutzen Sie auch hier wieder die IT-Konzepte des Dokumentationstools Docusnap. Hier können Sie unter Verwendung der Vorlage für ein IT-Handbuch ein Betriebshandbuch erstellen. Damit bekommen Sie schon mal eine erste Gliederung des Dokuments. Dieses wird dann nach und nach mit Inhalt gefüllt. Im Lieferumfang bringt Docusnap einen Texteditor mit. Damit kann das IT-Handbuch direkt in der Anwendung geschrieben werden. Möchten Sie das Dokument lieber mit einem anderen Texteditor wie Microsoft Word erstellen, dann können Sie dies natürlich tun. In diesem Fall müssen Sie jedoch auf die direkte Einbindung von Grafiken aus den IT-Beziehungen verzichten. Auch die Einbindung von Inventardaten und Berichten aus Docusnap bleibt in dem Fall verwehrt. Sie verlieren damit die Möglichkeit, dass das Handbuch automatisch aktualisiert werden kann.

Das IT-Handbuch kann ein übergeordnetes Dokument sein

Welche Inhalte ein IT-Handbuch haben muss, ist leider nicht verbindlich zu beantworten. Bleiben wir also bei der beliebten Aussage: es kommt darauf an. In das IT-Handbuch selber gehören meines Erachtens auch alle Informationen rund um die Organisation der IT-Abteilung. Das IT-Handbuch sollte ein übergeordnetes Dokument sein. Werden einzelne Themen zu umfangreich, dann werden deren Inhalte einfach in andere Dokumente ausgegliedert. Im IT-Handbuch verbleiben dann nur noch eine kurze Beschreibung des Themas und ein Verweis auf das separate Dokument. Somit sprengt es nicht den Umfang des IT-Handbuchs, trotzdem haben Sie einen zentralen Zugang zu Ihrer kompletten Dokumentation.

Im IT-Handbuch selbst muss nicht alles beschrieben werden, aber es muss alles erwähnt werden. Beschreiben Sie kurz, was es alles in der IT-Abteilung gibt. Das vereinfacht die Orientierung über Ihre IT-Dokumentation. Das IT-Handbuch wird damit zu dem Dokument, mit dem Sie Ihr IT-Managementsystem beschreiben. Führen Sie alle Themen auf und verweisen Sie bei Bedarf auf andere Dokumente. Beispiel IT-Notfallhandbuch oder Datenschutzhandbuch. Diese Themen sind eigenständig und gehören nicht im IT-Handbuch dokumentiert. Aber sie gehören zur IT-Abteilung, also beschreiben Sie im IT-Handbuch, dass sich der Themen angenommen wurde und verweisen Sie auf die weiterführenden Handbücher.

Mit dieser Flexibilität können Sie Ihre IT-Dokumentation beliebig erweitern. Fangen Sie mit einem Dokument an und erweitern Sie es bei Bedarf.

– Auflistung aller IT-Dokumente und weiterer Handbücher, Verweise dorthin

– Liste der IT-Services gemäß Service Catalogue, Verweis dorthin

– Leitbild und Leitlinien der IT-Abteilung

– Prozessbeschreibungen, Verweis auf Prozesslandschaft

– Dokumentationsrichtlinien

– Namenskonventionen für Dokumente und IT-Systeme

– …

Strukturierung der IT-Landschaft vereinfacht die Dokumentation

Die Dokumentation aller IT-Systeme gehört natürlich auch zum IT-Handbuch. Je nach Umfang der IT-Landschaft wird diese sehr umfangreich. Alleine die einzelnen Datenblätter der IT-Systeme umfassen schnell tausende von Seiten. Auch hier rate ich dazu, im Handbuch zu erwähnen, dass es Datenblätter gibt, wie diese erstellt werden und dann auf die aus Docusnap heraus erstellten Dateien zu verlinken.

Wenn Sie Ihre IT-Systeme bereits in Systemgruppen entsprechend einem Service Catalogue aufgeteilt haben, dann greifen Sie jetzt darauf zurück. Erstellen Sie am besten je Infrastructure-Service ein einzelnes Dokument. Benutzen Sie dazu eine Vorlage mit definierter Gliederung. Beschreiben Sie jeden Service in der Form, dass detaillierte Informationen zum fachlichen Ablauf dokumentiert werden. Erweitern Sie die fachliche Beschreibung um eine grafische Übersicht, die sie vorab in den IT-Beziehungen erstellt haben. Nutzen Sie dazu wieder die Möglichkeiten von Docusnap, um die Aktualisierung zu vereinfachen.

Manche Informationen könnten vielleicht eleganter in anderen Dokumenten geführt werden. Ich empfehle Ihnen aber alle Dokumente, in denen IT-Systeme dokumentiert werden, über Docusnap zu erstellen. Die Ablage der in Docusnap erstellten Dokumente kann auch für andere Mitarbeiter direkt im Zugriff sein, ohne erst über Docusnap gehen zu müssen. Dazu kann die Ablagestruktur auch über einen Webbrowser aufgerufen werden. Haben Sie im Intranet ein Portal für die IT-Abteilung, dann binden Sie es doch einfach dort mit ein. Standardmäßig finden Sie im konfigurierten Dokumentationspfad eine „index.htm“. Darüber können Sie auf die Dokumente zugreifen.

Wenn Sie die Speicherpfade für die IT-Dokumentation von Docusnap in der Datensicherung aufgenommen haben, werden Sie auch im Notfall alle benötigten Informationen zusammen haben. Ab einem gewissen Umfang besteht Ihre IT-Dokumentation aus vielen einzelnen Dokumenten, die aber nur zusammen auch im Notfall die benötigten Informationen liefern können.