Glossar

Dokumentationsrichtlinie

Eine Dokumentationsrichtlinie ist ein verbindliches, übergeordnetes Regelwerk (Policy), das die strategischen Ziele, Grundsätze, Verantwortlichkeiten und Mindestanforderungen für die Dokumentation in einer Organisation festlegt. Sie schafft den Ordnungsrahmen für alle Bereiche (Systembetrieb, Anwendungsmanagement, ITSM, ISMS, Notfall) und ist auch für externe Dienstleister bindend.

Die Dokumentationsrichtlinie als Steuerungsrahmen

Die IT-Dokumentationsrichtlinie ist das zentrale Regelwerk für den Umgang mit Dokumentation in der IT-Organisation. Sie beantwortet das „Warum“ und „Was“ der Dokumentation (Governance), verhindert Wildwuchs und stellt sicher, dass Dokumentation rechtssicher und auditfähig ist. Dazu muss sie u. a. folgende Fragen beantworten:

  • Was ist in welchen Bereichen zu dokumentieren (z. B. IT-Betrieb, Anwendungen, Services, Sicherheits- und Notfallthemen)?
  • Welche Dokumententypen (z. B. Richtlinien, Konzepte, Prozesse, Handbücher, Arbeitsanweisungen, Aufzeichnungen) werden verwendet und wie sind sie in der Dokumentationsarchitektur verankert?
  • Welche Qualitätsanforderungen gelten (Vollständigkeit, Aktualität, Verständlichkeit, Konsistenz)?
  • Wer trägt Verantwortung (Owner, Autoren, Reviewende, Freigebende, Plattformverantwortliche)?
  • Wie laufen Erstellung, Review, Freigabe, Veröffentlichung, Änderung, Archivierung und Löschung ab (Dokumentenlenkung)?
  • Wo werden Dokumente abgelegt, wie sind sie auffindbar und geschützt (DMS, SharePoint, Wiki, ISMS-/ITSM-Tool)?

Damit stellt die Dokumentationsrichtlinie sicher, dass Dokumentation bereichsübergreifend einheitlich, steuerbar und auditfähig ist – und nicht in Insellösungen endet.

Sinnvolle Regelungsbereiche für die verschiedenen Aufgabenbereiche des IT-Betriebs:

  • Verpflichtung zur Dokumentation von Infrastrukturänderungen. Festlegung, dass kein System ohne Betriebshandbuch in Produktion gehen darf.
  • Vorgabe von Quality Gates: Welche Dokumente (Architektur, Testprotokolle) müssen bei Meilensteinen (z. B. Go-Live) vorliegen?
  • Integration der Dokumentation in Prozesse, z. B. Regelung, dass ein Incident-Ticket erst geschlossen werden darf, wenn die Lösungsdokumentation aktualisiert wurde.
  • Festlegung, dass externe Partner die internen Dokumentationsstandards einhalten müssen (oder äquivalente Standards nachweisen). Grundlage für vertragliche Vereinbarungen.
  • Forderung nach Schutz der Dokumentation (Vertraulichkeit klassifizieren). Regelung zur Aufbewahrung von Nachweisen (Logs, Reports) gemäß Compliance-Vorgaben.
  • Vorgabe, dass kritische Dokumente (Notfallhandbuch) redundant und unabhängig verfügbar gehalten werden müssen (z. B. Papier, Offline-Speicher).

Beispiele

  • Regelung zur Freigabe: „Betriebskonzepte müssen vom Systemverantwortlichen und dem ISB freigegeben werden.“
  • Regelung zur Aktualität: „Alle Richtliniendokumente müssen mindestens jährlich überprüft werden (Review).“
  • Regelung für Projekte: „IT-Projekte müssen 5 % des Budgets für die Erstellung der Betriebsdokumentation reservieren.“

Abgrenzung und Synonyme

Abgrenzung zum Dokumentationskonzept

  • Dokumentationsrichtlinie: Strategisch/Normativ („Was muss getan werden?“). Eher statisch.
  • Dokumentationskonzept: Operativ/Umsetzend („Wie machen wir das genau?“). Beschreibt Tools, Ablagestrukturen, konkrete Vorlagen.

Synonyme

  • Documentation Policy
  • Leitlinie zur Dokumentation

Verwandte Begriffe

FAQ Dokumentationsrichtlinie

Die Dokumentationsrichtlinie regelt grundsätzlich und bereichsübergreifend, welche Dokumente es geben soll, wie sie aufgebaut, freigegeben, gepflegt und archiviert werden und wie die Dokumentation über IT-Betrieb, Anwendungen, Services, ISMS und Notfall hinweg zusammenhängt. Ohne eine gemeinsame Richtlinie entstehen leicht uneinheitliche, schwer steuerbare Dokumentationslandschaften.

Sie gehört zu den strategischen Managementdokumenten und ist im Rahmen des Dokumentationsmanagements zu erstellen. Sie sollte zentral veröffentlicht sein und für alle relevanten Rollen verbindlich gelten.

Indem sie als mitgeltendes Dokument in den Vertrag oder SLA aufgenommen wird. Der Provider muss bestätigen, dass er nach diesen (oder gleichwertigen) Regeln arbeitet.

Nach oben scrollen