- 1 Section
- 10 Lessons
- unbegrenzt
- IT-Dokumentation10
- 1.1Warum Dokumentation? Arten, Zwecke, Zielgruppen
- 1.2Leistungen dokumentieren: Nachweise und Berichte
- 1.3Betriebshandbuch erstellen
- 1.4Netzwerkdokumentation
- 1.5Server- und Systemdokumentation
- 1.6Prozessdokumentation und SOPs
- 1.7Übergabeprotokolle und Abnahmedokumentation
- 1.8Leistungserbringung abstimmen und kontrollieren
- 1.9Veränderungsprozesse begleiten und dokumentieren
- 1.10Dokumentation mit Wiki-Systemen
Warum Dokumentation? Arten, Zwecke, Zielgruppen
„Dokumentation? Kommt schon noch." – einer der teuersten Sätze in der IT. Eine unerwartete Krankschreibung oder ein Mitarbeiter-Abgang reicht, und plötzlich weiß niemand mehr, wie die seltsame Konfiguration auf dem Mail-Server entstanden ist, wo das Backup-Passwort liegt oder welche Firewall-Regel den ERP-Traffic durchlässt. IT-Dokumentation ist keine lästige Nebenpflicht – sie ist die Geschäftsgrundlage: Auditoren prüfen sie, Versicherungen verlangen sie, Wissensträger gehen irgendwann, und im Incident wird sie zur Lebensversicherung. Diese Lektion zeigt dir die wichtigsten Doku-Arten (oft als Pyramide dargestellt: Strategisch / Konzeptionell / Operativ / Operations), die jeweiligen Zielgruppen (Geschäftsführung, Architekten, Admins, Endanwender), die Zwecke (Compliance, Betrieb, Übergabe, Schulung) und die typischen Antipatterns. Sie ist die Einleitung in den gesamten Doku-Kurs (K65) – die folgenden Lektionen behandeln dann konkrete Doku-Typen im Detail.
1) Die Doku-Pyramide – vier Ebenen
IT-Dokumentation lässt sich gut nach Abstraktions-Ebene sortieren. Klick die Ebenen an:
2) Warum überhaupt dokumentieren?
Die wichtigsten Zwecke – jeder Punkt rechtfertigt für sich genommen Doku-Aufwand:
📋 Compliance
DSGVO, ISO 27001, BSI IT-Grundschutz, BAIT/KAIT, TISAX – alle fordern Doku als Nachweis. Ohne sie keine Zertifizierung.
🚨 Incident-Response
Im Notfall entscheiden Minuten. Wenn der Admin krank ist und niemand das System kennt: Doku rettet.
👥 Wissenstransfer
Onboarding neuer Mitarbeiter, Vertretung, Übergaben. Ohne Doku braucht jeder Neue Monate, bis er produktiv ist.
🔄 Wiederholbarkeit
SOPs (Standard Operating Procedures) sichern, dass eine Aufgabe immer gleich abläuft – unabhängig von der ausführenden Person.
💼 Auditierbarkeit
Interne und externe Audits (Revision, Wirtschaftsprüfer) müssen Spuren finden – wer hat wann was gemacht?
📈 Optimierung
Ohne Ist-Stand keine Verbesserung. Doku ist die Basis für Continual Improvement.
⚖ Rechtssicherheit
Im Streitfall (Vertragsverletzung, Schadensersatz) ist Doku Beweismittel. Was nicht dokumentiert ist, hat oft nicht stattgefunden.
🎓 Schulung
Anwender-Doku (FAQ, Schulungsmaterial) entlastet den Support direkt – jede dokumentierte Frage ist eine, die nicht gestellt wird.
3) Zielgruppen-Matrix – welche Doku für wen
Nicht jede Doku ist für jeden. Die Matrix zeigt, welche Doku-Typen welche Zielgruppen brauchen:
4) Vier Zwecks-Kategorien
Eine andere Sortierung – nach wozu die Doku dient:
| Kategorie | Beispiele | Lebensdauer |
|---|---|---|
| Architektur-Doku | Netzwerk-Diagramm, System-Übersicht, Datenflussdiagramme | mittel-lang (1-5 Jahre) |
| Betriebs-Doku | Betriebshandbuch, Server-Steckbrief, Monitoring-Konfig, Backup-Plan | mittel (1-2 Jahre, ständig aktualisiert) |
| Prozess-Doku | SOPs, Runbooks, RACI-Matrix, Workflows | mittel-lang |
| Anwender-Doku | FAQ, Schulungsmaterial, How-Tos, Tutorials | kurz-mittel (oft aktualisiert) |
| Compliance-Doku | DSGVO-Verzeichnisse, Sicherheitskonzepte, Audit-Berichte | lang (mit Aufbewahrungsfristen) |
| Projekt-Doku | Pflichtenheft, Test-Doku, Übergabe-Protokolle, Schulungspläne | kurz (projektbezogen) + Archiv |
5) Doku-Strategien
Wo soll Doku liegen, wie wird sie gepflegt? Drei verbreitete Ansätze:
- Wiki-zentral – Confluence, Wiki.js, Bookstack, MediaWiki. Alle Doku an einem Ort, gut suchbar, kollaborativ. Mehr in Wiki-Systeme.
- Docs-as-Code – Markdown in Git, Pull Requests, Build-Pipelines. Versioniert, reviewbar, automatisch deploybar. Trendwende seit DevOps. Tools: MkDocs, Sphinx, Docusaurus, Hugo.
- Spezial-Tools pro Thema – CMDB für Assets, draw.io/Lucidchart für Diagramme, Itop/i-doit für Konfig-Items. Best-of-Breed, aber Verteilung der Information.
In der Praxis: Mischformen. Z. B. Wiki als „Brain" mit Verlinkungen in CMDB, Diagramm-Tool und Git-Repo.
6) Welche Eigenschaften gute Doku hat
Nicht jede Doku ist gute Doku. Acht Qualitätsmerkmale:
- Auffindbar – Volltextsuche, sinnvolle Titel, klare Strukturen. Doku, die niemand findet, ist wertlos.
- Aktuell – Datum sichtbar, regelmäßige Reviews. Veraltete Doku ist gefährlicher als keine.
- Korrekt – Stimmt mit dem realen Zustand überein. Diskrepanzen werden aktiv adressiert.
- Vollständig – nicht jeder Furz, aber alles, was für die Zielgruppe relevant ist.
- Verständlich – Vokabular der Zielgruppe, Beispiele, Diagramme. Endanwender-Doku in einfacher Sprache.
- Konsistent – einheitliche Struktur, Vorlagen, Begriffe. Erleichtert Lesen und Pflege.
- Zugriffsgeschützt – sensible Informationen mit Berechtigungs-Schichten. Passwörter nicht ins Wiki.
- Versioniert – Änderungen nachvollziehbar, Rollback möglich.
7) Antipatterns
- „Wird gemacht, wenn Zeit ist." Zeit ist nie. Doku braucht festen Slot, sonst entsteht sie nicht.
- Tribal Knowledge. Wissen lebt nur im Kopf einzelner Personen. Bei deren Abgang massive Lücke. Lösung: aktive Doku-Pflicht in Aufgabenpaketen.
- Doku als Strafe. „Du machst die Doku" – als ungeliebter Job. Lösung: Doku als Teil der eigentlichen Aufgabe etablieren („Definition of Done").
- Veraltete Doku, die niemand pflegt. Schlimmer als keine Doku – Anwender folgt falscher Anleitung, baut Mist. Lösung: Review-Zyklus, Verfalldatum auf Doku-Artikeln.
- Tool-Wirrwarr. Doku in 5 verschiedenen Systemen – niemand weiß, wo was steht. Lösung: einheitliche Doku-Strategie, klare Hauptablage.
- Zu detailliert / zu oberflächlich. Architektur-Doku mit 200 Konfig-Werten, oder Betriebshandbuch ohne konkrete Befehle. Lösung: pro Doku-Typ die richtige Granularität.
- Geheime Doku im Kopf des Chefs. Wichtige Informationen werden mündlich weitergegeben, nicht festgehalten. Bei dessen Urlaub Chaos.
- Doku ohne Zielgruppe. Wer ist der Adressat? Architekt? Operator? Endanwender? Pro Doku klar definieren.
- Endlose Word-Dokumente. 100 Seiten Betriebshandbuch in einem .docx – unleserlich. Aufteilen, verlinken, suchbar machen.
Zusammenfassung
IT-Doku ist gleichzeitig Pflicht (Compliance, Audit) und Werkzeug (Incident, Wissenstransfer). Als Pyramide gedacht reicht sie von strategisch (5-10 J Lebensdauer) über konzeptionell und operativ bis hinunter zu Operations-Tasks wie Runbooks (Tage bis Monate) – jede Ebene mit eigener Zielgruppe und Granularität. Gute Doku ist vor allem auffindbar, aktuell und korrekt; alles andere folgt daraus. Wer Ablage-Ort und Pflegeprozess nicht vorab festlegt, endet in Tool-Wirrwarr und Tribal Knowledge.
Verwandte Lektionen: Betriebshandbuch · Wiki-Systeme · Prozess-Doku · und mehrWeitere relevante LektionenLeistungen dokumentierenNetzwerk-DokuServer-DokuÜbergabeprotokollCMDBTOMsIncident Management
