Glossar
Dokumentationsplattform
Eine Dokumentationsplattform ist die zentrale technische Infrastruktur (Software/Tool), auf der alle dokumentierten Informationen einer Organisation erstellt, verwaltet, versioniert und bereitgestellt werden. Sie unterstützt den gesamten Dokumentenlebenszyklus und dient als „Single Source of Truth“ für IT-Betrieb, Anwendungsmanagement, Service-Management, ISMS und Notfallmanagement. Typische Beispiele sind Wikis (Confluence), SharePoint oder spezialisierte Dokumentenmanagementsysteme (DMS).
Die Dokumentationsplattform im IT-Betrieb
Die Dokumentationsplattform ist mehr als nur ein Ablageort („Fileserver“). Sie muss aktiv Prozesse unterstützen und unterschiedliche Sichten auf Informationen ermöglichen und dabei Anforderungen aller IT-Bereiche integrieren:
- Anwendungsmanagement (ALM): Die Plattform muss die Dokumentation entlang des Lebenszyklus (Requirements, Design, Build, Operate) abbilden und verknüpfen. Entwickler und Betrieb müssen auf demselben Stand arbeiten (DevOps-Ansatz).
- IT-Servicemanagement (ITSM): Die Plattform stellt die Wissensbasis (Knowledge Base) für den Service Desk bereit. Sie verknüpft Service-Informationen (SLA) mit technischen Details, um schnelle Lösungen bei Incidents zu ermöglichen.
- Outsourcing/Provider: Die Plattform muss Mechanismen bieten, um externe Partner einzubinden (z. B. geschützte Bereiche für Provider-Dokus) oder Schnittstellen, um Dokumente aus Provider-Portalen zu integrieren/verlinken.
- Sicherer IT-Betrieb & ISMS: Die Plattform benötigt ein Berechtigungskonzept (wer darf lesen/schreiben?), Audit-Trails (wer hat was geändert?) und muss gegen Datenverlust gesichert sein (Backup). Sie dient als Ablageort für Nachweise (Audit-Proof).
Notfallmanagement: Eine entscheidende Anforderung ist die Verfügbarkeit im Notfall. Wenn die Plattform selbst ausfällt (z. B. RZ-Brand), müssen Notfallhandbücher dennoch zugreifbar sein (z. B. durch Synchronisation auf Offline-Medien oder redundante Cloud-Instanzen).
Beispiele
Enterprise Wiki (z. B. Confluence)
Wird oft für die dynamische Betriebsdokumentation genutzt. Inhalte sind verlinkt, durchsuchbar und kollaborativ pflegbar. Nachteil: Oft schwächer bei strengen Lenkungs-Workflows (Freigabe).
DMS / ECM (z. B. SharePoint mit Lenkungs-Workflow)
Geeignet für formelle Dokumente (Richtlinien, Verträge), die revisionssicher archiviert und gelenkt werden müssen.
Integrierte IT-Service Management-Suite
Die Dokumentation ist direkt am Asset (CMDB) oder Prozess (Incident) hinterlegt. Ideal für den operativen Betrieb.
Abgrenzung und Synonyme
Abgrenzung zur CMDB
- CMDB: Verwaltet strukturierte Daten und Beziehungen von CIs (Configuration Items), z. B. „Server X hat IP Y“.
- Dokumentationsplattform: Verwaltet unstrukturierte oder semi-strukturierte Informationen, Konzepte, Handbücher und Anleitungen. Beide Systeme sollten verknüpft sein.
Abgrenzung zum Dateisystem (Fileserver)
Ein Fileserver bietet reine Dateiablage ohne Metadaten, Versionierungshistorie, Verlinkung oder Workflow-Unterstützung. Er gilt heute als ungeeignet für komplexe IT-Dokumentation.
Synonyme
- Wissensdatenbank / Knowledge Base
- Informationsplattform
- DMS (im weiteren Sinne)
Verwandte Begriffe
- Dokumentationsmanagement
- Dokumentationsarchitektur
- Dokumentierte Informationen
- Anwendungsdokumentation
FAQ Dokumentationsplattform
Wie stelle ich die Verfügbarkeit im Notfall sicher?
Die Plattform darf kein „Single Point of Failure“ sein. Kritische Dokumente (Notfallhandbuch) müssen regelmäßig exportiert (PDF) und an einem unabhängigen Ort (z. B. sicherer Cloud-Speicher, verschlüsselte Tablets) bereitgestellt werden.
Wie binde ich Provider ein?
Entweder durch Zugänge (Provider pflegt direkt auf der Plattform) oder durch definierte Schnittstellen/Ablagebereiche, wo gelieferte PDFs revisionssicher abgelegt werden. Wichtig: Die Hoheit über die Struktur sollte beim Auftraggeber bleiben.
Ein Tool für alles oder Best-of-Breed?
Oft ist eine Trennung sinnvoll: Ein Wiki für die dynamische Technik-Doku und ein DMS für vertragliche/formelle Dokumente – verbunden durch Links. Wichtig ist eine klare Dokumentationsarchitektur: welches Dokument liegt wo.
Eignet sich ein Wiki für Architektur-Dokumentation?
Ja, sehr gut. Wikis erlauben die Verlinkung von Komponenten und die Einbettung von dynamischen Diagrammen (z. B. Draw.io, Gliffy), was die Aktualität im Architekturbetrieb fördert.