roemisch 3

mehr

WISSENSWERTES & NÜTZLICHES

Vorlagen sind nur ein Baustein einer ganzheitlichen IT-Dokumentation und müssen außerdem individuell zugeschnitten werden. Wir zeigen Ihnen, wie Sie diese im Rahmen Ihrer IT-Dokumentation optimal nutzen können. 

Möchten Sie mehr über unsere Angebote erfahren?

Rufen Sie uns an unter (+49) 06047 950265 oder senden Sie uns eine Mail an info@dokuit.de.

IT-Dokumentation Vorlagen

Es gibt kaum ein Projekt zur IT-Dokumentation in dem wir nicht um die Erstellung von Dokumentenvorlagen gebeten werden. Auch die Anzahl der Suchanfragen im Internet nach Vorlagen für die IT-Dokumentation ist groß. Und das ist auch verständlich, gibt es doch weder Standards, Frameworks oder andere verbindliche Vorgaben für die IT-Dokumentation.

Auf dieser Seite stellen wir Ihnen einige der von uns entwickelten Vorlagen zur Verfügung. Die Vorlagen können zu internen Zwecken ohne Einschränkungen verwendet werden. Bei einer Weitergabe oder Veröffentlichung ist ein Verweis auf den Urheber (Manuela Reiss – dokuit) erforderlich.

Betriebshandbuch Vorlage

Zu den wesentlichen Aufgaben von IT-Organisationen gehört die Bereitstellung der Anwendungen für die Fachbereiche. Unerlässlich ist eine Dokumentation für die Anwendung im operativen IT-Betrieb. Adressat dieser Dokumente ist nicht nur der IT-Betrieb, sondern auch Auditoren und Revisoren zur externen Bewertung der Ordnungsmäßigkeit der IT. Entsprechend sollten die Dokumente klar strukturiert und nachvollziehbar sein.

Leider finden sich aber weder in der Praxis, noch in der Literatur verbindliche Definitionen für den Begriff „Betriebshandbuch“. Entsprechend gibt es auch keine klaren Regelungen, wie detailliert ein Betriebshandbuch sein muss bzw. welche Inhalte es haben muss oder kann.

Die hier herunterladbare Vorlage zeigt beispielhaft den inhaltlichen Aufbau eines Betriebshandbuchs. Die Struktur hat sich in unserer Beratungspraxis als Basis für die Ableitung eigener Vorlagen bewährt.

Grundsätzlich kann die Vorlage zur Erstellung der eigenen Word-Dokumentenvorlage verwendet werden. Allerdings sind in Office-Dokumenten Verlinkungen kaum mit angemessenem Aufwand zu pflegen. Die Verwaltung in einem WIKI hingegen bietet den Vorteil, dass sowohl Inhalte dokumentiert als auch Verlinkungen innerhalb des WIKIs und auf andere Quellen einfach möglich sind und diese auch bei Veränderungen erhalten bleiben. Außerdem wird die gemeinsame Bearbeitung erleichtert.

In der Praxis hat sich dabei die Bereitstellung von Dach- oder Klammerdokumenten für die Anwendungen bewährt. Hierzu besteht das Betriebshandbuch aus einer Kombination von eingetragenen Inhalten und Verweisen und stellt damit den „Single Point of Information“ für den Betrieb der Anwendung dar. Jeder Nutzer enthält alle wichtigen Informationen in einer Übersicht und kann bei Bedarf auf weitere Dokumente und Informationsquellen (die notwendigen Zugriffsrechte vorausgesetzt) zugreifen.

Das nachstehende Bild zeigt beispielhaft einen Ausschnitt für ein solches Betriebshandbuch. Als Dokumentationsplattform wird im dargestellten Beispiel Microsoft SharePoint eingesetzt, die Dokumentation der Betriebshandbücher erfolgt in Seiten vom Typ WIKI.

Systemakten Vorlage

Auch in Zeiten von Servicemanagement und Business Alignment bildet der Betrieb der Systeme die Basis jeder IT-Organisation. Hierfür benötigt der Betrieb eine entsprechende Dokumentation. Definitionsgemäß sind Betriebshandbücher ein Teil der Anwendungsdokumentation. In Abgrenzung dazu wird für die Dokumentation von Systemen von uns der Begriff „Systemakte“ verwendet. Systemakten sind eine Zusammenstellung aller für ein System erforderlichen Informationen, wobei diese beispielsweise auch in einer Datenbank wie z. B. einer CMDB gespeichert sein können.

Das hier herunterladbare Beispieldokument zeigt den möglichen Aufbau von Systemakten. Nähere Informationen zum Einsatz von Systemakten finden Sie in unserem Praxisbuch IT-Dokumentation.

Weitere Vorlagen

Zu einigen Bereichen der IT-Dokumentation stellen auch Drittanbieter Vorlagen, Beispiele bzw. andere Hilfsmittel zur Verfügung. Diese stellen wir Ihnen in gesonderten Beiträgen im Bereich Wissen Kompakt vor.