Glossar
IT-Dokumentation
IT-Dokumentation umfasst die Gesamtheit aller Dokumente und Nachweise, die Aufbau, Betrieb, Weiterentwicklung, Sicherheit und Notfallvorsorge der IT beschreiben oder nachweisen. Sie bildet die gemeinsame Grundlage für IT-Betrieb (System- und Plattformbetrieb), Anwendungsmanagement, IT-Servicemanagement, IT-Sicherheit, Notfallmanagement sowie für die Steuerung von Kunden- und Lieferantenbeziehungen im IT-Umfeld.
Die IT-Dokumentation als Grundlage der IT-Organisation
IT-Dokumentation ist kein einzelnes Dokument, sondern eine modulare Informations- und Dokumentationslandschaft, die alle relevanten Aspekte der IT abdeckt:
- Was tut die IT? – Services, Anwendungen, Funktionen.
- Wie ist die IT aufgebaut? – Systeme, Plattformen, Infrastrukturen, Schnittstellen.
- Wie wird die IT betrieben? – Aufgaben, Prozesse, Rollen, Werkzeuge.
- Wie wird Sicherheit gewährleistet? – Sicherheitsziele, Risiken, Maßnahmen.
- Wie wird mit Notfällen umgegangen? – Notfallstrategien, Wiederanlaufpläne, Übungen.
- Wie ist die Zusammenarbeit mit Kunden und Dienstleistern geregelt? – Servicekatalog, SLAs, Verträge, Nachweise.
Eine nachhaltige IT-Dokumentation ist bereichsübergreifend (IT-Betrieb, Anwendungen, Services, IT-Sicherheit, Notfall, Outsourcing), strukturiert (Dokumentationsarchitektur mit Ebenen und Dokumententypen), gesteuert (Dokumentationsmanagement mit Prozessen, Rollen, Werkzeugen) und auditfähig (erfüllt Anforderungen aus geltenden Regularien).
IT-Dokumentation ist kein Selbstzweck, sondern ein Produktionsfaktor der IT. Sie vernetzt Informationen aus den verschiedenen Aufgabenbereichen:
System- und Architekturbetrieb
Dokumentation der Infrastruktur (Server, Netz, RZ), Architekturpläne, Konfigurationen und Betriebshandbücher für Basisdienste.
Anwendungsmanagement
Dokumentation über den gesamten Lebenszyklus – von der Anforderung (Lastenheft) über die Architektur (Systementwurf) bis zum Betrieb (Admin-Handbuch) und Release-Management.
IT-Servicemanagement (ITSM)
Dokumentation der Services (Servicekatalog, SLAs) und Prozesse (Incident/Change Management). Sie macht Leistungen für den Kunden transparent.
Outsourcing/Provider
Dokumentation der Schnittstellen zu Dienstleistern (Verträge, Leistungsbeschreibungen, Verantwortungsabgrenzung). Integration von Provider-Dokumenten in die eigene Landschaft.
ISMS & Sicherer IT-Betrieb
Dokumentation von Sicherheitsvorgaben (Richtlinien), Risiken und Kontrollen. Sie ist der Nachweis für die Einhaltung von Sicherheitsstandards.
Notfallmanagement
Bereitstellung von Notfallhandbüchern und Wiederanlaufplänen, die im Ernstfall die Handlungsfähigkeit sichern.
Beispiele
- Strategische Ebene: IT-Strategie, Dokumentationsrichtlinie, Sicherheitsleitlinie.
- Taktische Ebene: Betriebskonzepte, Sicherheitskonzepte, Notfallkonzepte, Service Level Agreements (SLA).
- Operative Ebene: Betriebshandbücher, Installationsanleitungen, Wiederanlaufpläne, Netzwerkpläne.
- Nachweis-Ebene (Records): Wartungsprotokolle, Incident-Tickets, Audit-Berichte, Change-Requests.
Abgrenzung und Synonyme
Abgrenzung zur Technischen Redaktion
- Technische Redaktion: Erstellt oft Produktdokumentation für externe Kunden (Bedienungsanleitungen).
- IT-Dokumentation: Fokussiert auf den internen IT-Betrieb und die Bereitstellung von Services.
Abgrenzung zum Wissensmanagement
IT-Dokumentation ist strukturierter und stärker formalisiert (Nachweispflicht), während Wissensmanagement auch implizites Erfahrungswissen umfasst.
Synonyme
- Betriebsdokumentation (als Teilmenge)
- Systemdokumentation (als Teilmenge)
Verwandte Begriffe
- IT-Betriebsdokumentation
- Anwendungsdokumentation
- ISMS-Dokumentation
- Notfalldokumentation
- Dokumentationsmanagement
FAQ IT-Dokumentation
Wie gehe ich vor, wenn meine IT-Dokumentation aus vielen „Dokumenteninseln“ besteht?
Zunächst sollte eine strukturierte Bestandsaufnahme erfolgen (Was gibt es wo? Was ist relevant, veraltet oder doppelt?), gefolgt von einem Zielbild mit klarer Dokumentationsarchitektur und Zielplattform. Auf dieser Basis können Migrationsregeln definiert und die Restrukturierung mit einem Pilotbereich begonnen werden, bevor sie schrittweise auf weitere Systeme und Services ausgeweitet wird.
Was ist das wichtigste Ziel der IT-Dokumentation?
Die Sicherung von Know-how und die Unabhängigkeit von Kopfmonopolen. Der IT-Betrieb muss auch funktionieren, wenn Schlüsselpersonen ausfallen (Vertretbarkeit).
Wie kann ich „Altlasten“ in der bestehenden IT-Dokumentation pragmatisch behandeln?
Bewährt hat sich, einen Stichtag für die neue Struktur und Regeln zu setzen und Altbestände in einem separaten Bereich nur noch zur Recherche vorzuhalten. Benötigte Dokumente werden dann bei Nutzung schrittweise geprüft, überarbeitet und in die neue Struktur übergeführt, ergänzt um eine klare Statuskennzeichnung (z. B. aktiv, in Überarbeitung, archiviert).
Wie können Tools helfen, bestehende Dokumenteninseln schrittweise zu verknüpfen?
Wichtig ist, vorhandene Dokumentationen und Dokumente über Verlinkungen, Metadaten und „Landing Pages“ zu verbinden, anstatt Inhalte zu duplizieren. Standardisierte Vorlagen erleichtern die Überführung und sorgen dafür, dass die Dokumentation schrittweise in eine konsistente Gesamtstruktur hineinwächst.