IT-Dokumentation Vorlagen
Trotz steigender Dokumentationsanforderungen gibt es für die IT-Dokumentation nach wie vor weder Standards, Frameworks noch andere verbindliche Vorgaben. Es ist daher nicht verwunderlich, dass die Anzahl der Anfragen nach Vorlagen, nach wie vor sehr hoch ist.
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. Die Inhalte sind weder rechtsverbindlich, noch erheben sie einen Anspruch auf Vollständigkeit.
Hinweise zur Nutzung unserer Vorlagen finden Sie außerdem im Beitrag Vorlagen richtig einsetzen.
Systemakten Vorlage
Der Systembetrieb respektive Architekturbetrieb bildet die Basis jeder IT-Organisation. Für einen ordnungsgemäßen Betrieb aber ist eine aktuelle Dokumentation unerlässlich.
Gemäß der von uns verwendeten Definitionen benutzen wir für diesen Teil der Dokumentation den Begriff der Systemakten. Eine Systemakte ist eine modulare Zusammenstellung aller für ein System erforderlichen Informationen, wobei diese beispielsweise auch in einer Datenbank wie z. B. einer CMDB gespeichert sein können. Beachten Sie hierzu auch die Use Case-Beschreibung Systemdokumentation und Betriebshandbücher.
Das hier herunterladbare Beispieldokument zeigt den möglichen Aufbau von Systemakten für verschiedene Systemgruppen (entsprechend der Strukturierung der Systembausteine im IT-Grundschutzkompendium).
Wichtig: Auch wenn der Systembetrieb oder Teile davon von Dienstleistern betrieben werden, ist eine Dokumentation erforderlich. Mehr dazu erfahren Sie im Use Case Dokumentation bei IT-Outsourcing.
Betriebshandbuch Vorlage
Der Betrieb der Systeme ist kein Selbstzweck, sondern dient letztlich immer dem Zweck, Anwendungen bereitzustellen, die ihrerseits für die Erbringung der technischen Services und der Business-Services benötigt werden. Und genauso wie für den Systembetrieb werden für den Betrieb von Anwendungen dokumentierte Informationen benötigt.
In Abgrenzung zu den Systemakten für den Systembetrieb benutzen wir für die Dokumentation von Anwendungen den Begriff Betriebshandbücher. Ein Betriebshandbuch muss demnach alle erforderlichen Informationen für den Betrieb einer Anwendung (fachliche Anforderungen, Architektur, betriebliche Aufgaben, Umsetzung von Sicherheitsanforderungen, Störungsmanagement u.a.) beinhalten.
Beachten Sie hierzu auch die Use Case-Beschreibung Anwendungs- und Softwaredokumentation sowie unseren Beitrag Anwendungsbetrieb – Schnittstelle zwischen Systembetrieb, Entwicklung und Fachbereich.
Die nachstehend 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, wobei die spezifischen Inhalte natürlich individuell festgelegt werden müssen. Außerdem ist es meist nicht sinnvoll, eine Vorlage für alle Anwendungen zu verwenden. Betriebshandbücher für die von der IT genutzten Werkzeuge haben zwangsläufig andere Schwerpunkte, als etwa ein Betriebshandbuch für den SAP-Betrieb.
Und auch wenn Teile des Anwendungsbetriebs outgesourct sind, muss dies bei den Betriebshandbüchern berücksichtigt werden, da in diesem Fall auch der Dienstleister Dokumentationspflichten hat.
Unsere Vorlage kann zur Erstellung einer eigenen Word-Dokumentenvorlage verwendet werden, aber auch als Blaupause für eine WIKI-Vorlage benutzt werden.
In der Praxis hat sich der Aufbau eines Dokumentationsportals zum Beispiel in SharePoint oder Confluence bewährt. Portale für die Dokumentation können die Verwaltung und den Zugriff auf Informationen wesentlich vereinfachen und damit den Nutzen und die Akzeptanz von Dokumentation deutlich erhöhen. Betriebshandbücher etwa können hier als WIKI-Seiten verwaltet werden und aus einer Kombination von Text und Verweisen bestehen. Sie stellen damit den „Single Point of Information“ für den Betrieb einer 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.
Nähere Informationen hierzu finden Sie in unserer Use Case Beschreibung Aufbau der Dokumentationsplattform.
Das nachstehende Bild zeigt exemplarisch einen Ausschnitt aus einer WIKI-Seitenvorlage für ein Betriebshandbuch. Als Dokumentationsplattform wird im dargestellten Beispiel Microsoft SharePoint eingesetzt.
Weitere Hilfsmittel
Zu einigen Bereichen der IT-Dokumentation stellen auch Drittanbieter Vorlagen, Beispiele und andere Hilfsmittel zur Verfügung. Diese stellen wir Ihnen in gesonderten Beiträgen im Bereich Wissen Kompakt vor.
Mit den hier bereitgestellten Vorlagen möchten wir Ihnen die Erstellung eigener Vorlagen erleichtern. Noch effektiver können wir Sie im Rahmen einer individuellen Beratung unterstützen. Wir zeigen Ihnen, wie Sie Vorlagen als wichtigen Baustein Ihrer IT-Dokumentation optimal nutzen können.
Mehr zu unseren Angeboten finden Sie unter Umsetzung & Optimierung im Bereich Services.