Glossar

Systemdokumentation

Systemdokumentation beschreibt Aufbau, Struktur, Komponenten und Schnittstellen eines IT-Systems oder einer Anwendung. Sie liefert das technische Verständnis für Planung, Betrieb, Änderungen, Sicherheit und Notfallvorsorge.

Die Systemdokumentation als technische Gesamtsicht

Während die Systemakte (bzw. das Betriebskonzept) den Blick auf ein einzelnes System richtet, beschreibt die Systemdokumentation die IT-Landschaft als Ganzes. Sie ist keine einzelne Datei, sondern eine Struktur oder Bibliothek, die alle technischen Informationen bündelt. Sie setzt sich aus zwei Hauptbereichen zusammen:

Die Summe aller Einzel-Systembeschreibungen

Alle Systemakten (z. B. Konfigurationen der 50 Server, 10 Switches, 5 Firewalls) sind Teilmengen der Systemdokumentation.

Übergreifende Infrastruktur-Informationen

Dokumente, die Beziehungen und Zusammenhänge darstellen (z. B. Netzwerk-Topologiepläne, Zonenkonzepte, VMware-Cluster-Design, RZ-Raumpläne).

Zielsetzung: Die Systemdokumentation dient dazu, den technischen Ist-Zustand der gesamten IT transparent zu machen, Abhängigkeiten aufzuzeigen und Administratoren eine navigierbare Wissensbasis für den Betrieb und das Troubleshooting zu bieten.

Beispiel

CMDB (Configuration Management Database)

Als Datenbank ist sie das zentrale Werkzeug der Systemdokumentation. Sie enthält die Datensätze (Systembeschreibungen) aller CIs (Configuration Items) und deren Beziehungen.

Abgrenzung und Synonyme

Abgrenzung zur Systemakte

  • Systemdokumentation: Die Bibliothek (der Gesamtbestand aller technischen Infos).
  • Systemakte: Das einzelne Buch in dieser Bibliothek (die Beschreibung eines konkreten Systems).

Abgrenzung zur Anwenderdokumentation

  • Systemdokumentation: Zielgruppe IT-Abteilung/Admins (technischer Blick „unter die Haube“).
  • Anwenderdokumentation: Zielgruppe Endanwender (fachlicher Blick auf die Nutzung der Software).

Synonyme

  • Technische Gesamtdokumentation
  • Infrastrukturdokumentation
  • IT-Bestandsdokumentation

Verwandte Begriffe

FAQ Systemdokumentation

Das ist die größte Herausforderung. Die Lösung liegt nicht im Tool, sondern im Prozess: Die Pflege der Systemdokumentation muss zwingend an den Change-Management-Prozess gekoppelt sein. Ein technischer Change (z. B. Firewall-Regel ändern) darf erst dann als „abgeschlossen“ gelten, wenn auch die Dokumentation nachgezogen wurde.

Indirekt ja. Für steuerrelevante Systeme fordert die GoBD eine Verfahrensdokumentation (deren technischer Teil die Systemdokumentation ist). Auch Normen wie die ISO/IEC 27001 oder Vorgaben für KRITIS-Betreiber setzen eine aktuelle Netzplanerhebung und Systemdokumentation zwingend voraus.

Nach oben scrollen