USE CASES

IT-Systemdokumentation und Betriebshandbücher

Eine aktuelle IT-Systemdokumentation schafft Transparenz über Systeme, Komponenten, Konfigurationen und Abhängigkeiten. Plattformdokumentationen ergänzen diese technische Sicht um übergreifend genutzte technische Infrastrukturen und Plattformen. Betriebshandbücher beschreiben die Aufgaben, Verantwortlichkeiten und Verfahren für den laufenden Betrieb.

Mit Cloud-Services, Automatisierung und verteilten IT-Landschaften verändern sich auch die Anforderungen an die Dokumentation. Statt Informationen mehrfach in statischen Dokumenten zu pflegen, sollten System- und Plattformdokumentationen, Betriebshandbücher und aktuelle Informationen aus führenden IT-Systemen sinnvoll miteinander verknüpft werden.

System- und Plattformdokumentation als technische Gesamtsicht

Die Systemdokumentation beschreibt den technischen Ist-Zustand eines einzelnen IT-Systems oder technischen Services. Die Plattformdokumentation beschreibt übergreifend genutzte technische Grundlagen, auf denen mehrere Systeme oder Services betrieben werden. Dazu können beispielsweise Netzwerk-, Virtualisierungs-, Cloud-, Container- oder Datenbankplattformen gehören.

Sie beantworten primär folgende Fragen:

Welche Systeme, Plattformen und Komponenten sind vorhanden?
Wie sind sie aufgebaut und konfiguriert?
Über welche Schnittstellen sind sie miteinander verbunden?
Welche technischen Abhängigkeiten bestehen?

Damit unterstützt die technische Dokumentation Planung, Betrieb, Änderungen, Informationssicherheit und Notfallvorsorge.

Sie muss nicht in einer einzelnen Datei vorliegen. Vielmehr kann sie Dokumente und Pläne mit strukturierten Daten und Verweisen auf führende Informationsquellen verbinden.

Typische Inhalte der System- und Plattformdokumentation

Je nach dokumentiertem Gegenstand gehören dazu beispielsweise:

Funktion, Zweck, Geltungsbereich und Kritikalität des Systems oder der Plattform,
Architektur und technische Komponenten,
bereitgestellte Plattformdienste und zugeordnete Systeme,
Schnittstellen und Abhängigkeiten,
Netzwerke und Sicherheitszonen,
Konfigurationen und Versionsstände,
technische Rollen- und Berechtigungskonzepte,
technische Ausgestaltung von Backup, Monitoring und Protokollierung,
Verweise auf Systemverantwortliche und weitere führende Informationsquellen.

Dabei können Bestands- und Konfigurationsdaten beispielsweise in einer CMDB oder einem Repository geführt werden. Monitoringinformationen liegen im Monitoring-System, Störungen und Änderungen im ITSM-System. Die Systemdokumentation sollte diese Informationen nicht unnötig duplizieren, sondern strukturiert erschließen und auf die jeweils führende Quelle verweisen.

Warum reicht die Systemdokumentation allein nicht aus?

Die technische Beschreibung allein genügt nicht, um ein System verlässlich zu betreiben. Betriebsteams benötigen konkrete Anleitungen und Regelungen: Wer führt welche Aufgabe wann, wie und wie oft aus? Welche Kontrollen sind erforderlich? Was ist bei Abweichungen oder Störungen zu tun?

Für die handlungsorientierte Dokumentation der betrieblichen Aufgaben werden in der Praxis vor allem die Begriffe Betriebshandbuch und Betriebskonzept verwendet. Beide Bezeichnungen stehen hier für dieselbe Art von Dokumentation. Entscheidend ist nicht das Label, sondern ob die für einen verlässlichen Betrieb benötigten Inhalte vollständig, verständlich und aktuell verfügbar sind.

Typische Inhalte eines Betriebshandbuchs oder Betriebskonzepts

Ein Betriebshandbuch beziehungsweise Betriebskonzept umfasst beispielsweise:

Betriebsaufgaben, Zuständigkeiten und Vertretungsregelungen,
Starten, Herunterfahren und Wiederanlaufen von Systemen,
regelmäßige Kontrollen und Überwachungsaufgaben,
Durchführung und Kontrolle von Datensicherungen,
Wiederherstellungsverfahren und Funktionstests,
Patch-, Wartungs- und Änderungsverfahren,
Behandlung typischer Störungen und Alarme,
Melde- und Eskalationswege,
Nachweise über ausgeführte Aufgaben und Kontrollen,
besondere Verfahren für Notbetrieb und Wiederanlauf.

Der erforderliche Umfang richtet sich nach Systemtyp, Kritikalität, Schutzbedarf, Komplexität und Betriebsmodell. Ein Betriebshandbuch sollte so konkret sein, dass qualifizierte Mitarbeitende Standardaufgaben sicher durchführen und bei Störungen angemessen reagieren können.

Welche Inhalte im Einzelfall sinnvoll sind, zeigen auch die Beispiele für Richtlinien und Betriebshandbücher.

Technische Dokumentation und Betriebshandbücher klar abgrenzen

System- und Plattformdokumentationen auf der einen und Betriebshandbücher beziehungsweise Betriebskonzepte auf der anderen Seite erfüllen unterschiedliche Aufgaben:

System- und Plattformdokumentation	Betriebshandbuch
Beschreibt den technischen Ist-Zustand	Beschreibt Aufgaben und betriebliche Verfahren
Zeigt Aufbau, Komponenten und Konfigurationen	Legt Durchführung, Zuständigkeiten und Intervalle fest
Dokumentiert Schnittstellen und Abhängigkeiten	Regelt Kontrollen, Reaktionen und Eskalationen
Beantwortet vor allem: Was ist vorhanden und wie ist es aufgebaut?	Beantwortet vor allem: Wer muss was, wann und wie tun?

Die Abgrenzung lässt sich auch an einzelnen Themen erkennen:

Die System- oder Plattformdokumentation beschreibt, welche Backup-Lösung technisch eingesetzt wird. Das Betriebshandbuch legt fest, wann Sicherungen kontrolliert und Wiederherstellungen getestet werden.
Die System- oder Plattformdokumentation zeigt, welche Komponenten überwacht werden. Das Betriebshandbuch beschreibt, wer Alarme prüft und welche Maßnahmen oder Eskalationen daraus folgen.
Die System- oder Plattformdokumentation hält Konfigurationen und Abhängigkeiten fest. Das Betriebshandbuch regelt, wie Änderungen vorbereitet, durchgeführt, geprüft und dokumentiert werden.

Die inhaltliche Trennung bedeutet nicht, dass voneinander isolierte Dokumente entstehen müssen. Beide Informationsbereiche können in einem gemeinsamen Dokumentationsportal oder Werkzeug verwaltet werden. Wichtig sind eine eindeutige Zuordnung, klare Verantwortlichkeiten und gegenseitige Verweise. Ändert sich ein System oder eine Plattform, muss deshalb auch geprüft werden, ob die zugehörigen Betriebsverfahren angepasst werden müssen.

Unterstützung durch KI

KI kann den Zugriff auf vernetzte System- und Plattformdokumentationen sowie Betriebshandbücher erleichtern. Abhängig von Datenqualität, Schnittstellen und Berechtigungen kann sie Informationen aus Dokumenten, CMDB, ITSM-Tools oder anderen operativen Systemen zusammenführen und aufbereiten.

Mögliche Einsatzbereiche sind:

natürlichsprachliche Suche über verschiedene Informationsquellen,
Zusammenfassungen technischer und betrieblicher Informationen,
Entwürfe für System- und Plattformbeschreibungen, Betriebshandbücher oder Runbooks,
Erkennung widersprüchlicher Angaben und möglicher Dokumentationslücken,
Unterstützung bei Reviews und der Vorbereitung von Änderungen.

KI ersetzt aber weder eine geeignete Informationsarchitektur noch die fachliche Prüfung. Verantwortliche müssen weiterhin festlegen, welche Quelle führend ist, ob Informationen korrekt sind und welche betrieblichen oder sicherheitsrelevanten Entscheidungen daraus abgeleitet werden.

So unterstützt dokuit bei Systemdokumentation und Betriebshandbüchern

Viele IT-Organisationen verfügen zwar über Inventarlisten, technische Dokumente und einzelne Betriebshandbücher, aber nicht über eine konsistente Struktur für deren Zusammenspiel. dokuit analysiert die bestehende Dokumentationslandschaft, die Anforderungen des Betriebs sowie die eingesetzten Information.

Darauf aufbauend unterstützt dokuit bei:

Entwicklung einer Dokumentationsstrategie für den System- und Infrastrukturbetrieb,
klarer Abgrenzung und sinnvoller Verknüpfung von technischer Dokumentation und Betriebshandbüchern,
Strukturierung von System- und Plattformdokumentationen und Betriebshandbüchern,
Definition von Dokumentenklassen, Informationsarten und Verantwortlichkeiten,
Erstellung bedarfsgerechter Vorlagen für System- und Plattformdokumentationen sowie Betriebshandbücher beziehungsweise Betriebskonzepte,
Einbindung von CMDB, ITSM, Repositories und weiteren Informationsquellen,
Verknüpfung mit ISMS-, Notfall- und Anwendungsdokumentation,
Qualitätssicherung und Organisation der laufenden Pflege.

So entsteht eine Dokumentationsstruktur, die den Betrieb unterstützt, Redundanzen begrenzt und Informationen dort pflegt, wo sie fachlich und technisch führend sind.

Schaffen Sie mit klar abgegrenzten und verknüpften System- und Plattformdokumentationen sowie Betriebshandbüchern die Grundlage für einen verlässlichen IT-Betrieb.

Eine vernetzte Informationsbasis für den IT-Betrieb

Eine moderne IT-Dokumentation ist mehr als eine Sammlung statischer Dokumente. Sie verbindet System- und Plattformdokumentationen, Betriebshandbücher beziehungsweise Betriebskonzepte sowie aktuelle Daten aus unterschiedlichen Systemen zu einer nachvollziehbaren Informationsbasis. Weitere Dokumentationsbereiche, beispielsweise die Anwendungsdokumentation, können bedarfsgerecht eingebunden werden. Der IT-Betrieb greift auf die jeweils benötigten Informationen zu. Durch die klare inhaltliche Zuordnung bleibt erkennbar, welche Quelle führend ist und wer für ihre Pflege verantwortlich ist.

FAQ zur IT-Systemdokumentation und zu Betriebshandbüchern

Was ist eine IT-Systemdokumentation?

Eine IT-Systemdokumentation (häufig auch als technische IT-Dokumentation bezeichnet) beschreibt die technische Struktur einer IT-Landschaft oder eines konkreten Systems. Sie umfasst unter anderem Komponenten, Architektur, Schnittstellen, Abhängigkeiten, Konfigurationen und technische Betriebsinformationen.

Was ist eine Plattformdokumentation?

Eine Plattformdokumentation beschreibt die technische Sicht auf eine übergreifend genutzte Plattform, auf der mehrere Systeme oder Services betrieben werden. Dazu gehören beispielsweise Aufbau, Komponenten, bereitgestellte Dienste, zentrale Konfigurationen, Schnittstellen, Abhängigkeiten sowie technische Sicherheits- und Verfügbarkeitsmechanismen.

Was ist der Unterschied zwischen Systemdokumentation und Betriebshandbuch?

Die Systemdokumentation beschreibt vor allem den technischen Ist-Zustand eines Systems: Aufbau, Komponenten, Schnittstellen, Abhängigkeiten und Konfigurationen. Für gemeinsam genutzte technische Plattformen erfüllt die Plattformdokumentation dieselbe Aufgabe. Das Betriebshandbuch beschreibt dagegen, wie ein System oder eine Plattform betrieben wird: Aufgaben, Zuständigkeiten, Intervalle, Kontrollen, Reaktionen und Eskalationswege.

Wie detailliert muss ein Betriebshandbuch sein?

Das Betriebshandbuch sollte so detailliert sein, dass qualifizierte Mitarbeitende den Betrieb nachvollziehen, Standardaufgaben durchführen und typische Störungen bearbeiten können. Der konkrete Umfang richtet sich nach Kritikalität, Komplexität, Schutzbedarf, Betriebsmodell und sollte bedarfsgerecht zugeschnitten sein.

Reicht eine automatisierte Inventarisierung für den IT-Betrieb aus?

Nein. Eine Inventarisierung liefert wichtige Bestands- und Konfigurationsinformationen, beschreibt aber normalerweise nicht die erforderlichen Betriebsabläufe, Kontrollhandlungen, Verantwortlichkeiten und Eskalationswege.

Muss ein Betriebshandbuch ein einzelnes Dokument sein?

Nein. Ein Betriebshandbuch kann als strukturierte Sammlung von Informationen, Anleitungen und Verweisen umgesetzt werden. Die Informationen können beispielsweise in SharePoint, Confluence, einem Wiki, einer CMDB oder anderen geeigneten Systemen liegen.

Kann KI Betriebshandbücher erstellen?

KI kann vorhandene Informationen zusammenfassen, strukturieren und für Dokumentationsentwürfe verwenden. Besonders interessant wird dies, wenn neben Dokumenten auch strukturierte Informationen aus CMDB, Repositories, ITSM oder anderen Systemen einbezogen werden können.

Die Qualität hängt jedoch von der verfügbaren Informationsbasis und ihrer Aktualität ab. KI-generierte Betriebshandbücher müssen deshalb fachlich geprüft, in der Regel ergänzt und freigegeben werden.