Dokumentationsrichtlinie
Mindeststandard für AFANDI-Dokumentation: Struktur, Verantwortlichkeiten, Review und Änderungsnachweis.
Kurz erklärt
Diese Seite beschreibt den Arbeitsstandard für Dokumentationsrichtlinie – mit Fokus auf konkrete Entscheidungen statt allgemeiner Leitlinien.
Zentral sind hier vor allem welche inhalte pflichtfelder sind und wann doku als „gültig“ gilt, damit Teams denselben Maßstab anwenden.
Nachvollziehbar wird der Standard erst durch verlinkte Nachweise wie versionshistorie und durch dokumentierte Grenzfälle/Ausnahmen.
Wann diese Seite hilft
Typische Situationen, in denen diese Seite als Arbeitsdokument Mehrwert bringt – und wo eine andere Doku passender ist.
Typische Einsätze
- wenn für Dokumentationsrichtlinie ein organisationsweiter Standard mit klaren Grenzen zu dokumententypen, owner und reviewrhythmus festgelegt werden soll
- wenn Entscheidungen zu welche inhalte pflichtfelder sind zwischen Teams aktuell unterschiedlich getroffen werden
- wenn Audit oder internes Review konkrete Nachweise wie versionshistorie einfordert
- wenn Ausnahmen im Bereich „Regeln & Verantwortung“ häufiger werden und sauber befristet/regelt werden müssen
Eher nicht passend bei
- wenn es bei Dokumentationsrichtlinie nur um einen einmaligen Einzelfall ohne Standardisierungsbedarf geht
- wenn ein detailliertes Projektticket oder eine technische Schritt-für-Schritt-Anleitung gepflegt werden soll
Empfohlener Ablauf
Pragmatische Reihenfolge, die in der Praxis funktioniert – vom Scope bis zum Review.
- Anwendungsbereich für Dokumentationsrichtlinie fachlich und organisatorisch festziehen; Scope-Lücken vermeiden (insb. dokumententypen, owner und reviewrhythmus).
- Standardentscheidungen definieren: welche Inhalte Pflichtfelder sind und wann Doku als „gültig“ gilt – inklusive zuständiger Rollen.
- Ausnahmen mit Kriterien, Fristen und Re-Review modellieren; häufige Grenzfälle zu versionierung und änderungsnachweise explizit abfangen.
- Nachweise im Regelprozess verankern (mindestens versionshistorie und review-kommentare).
- Prüfung anhand realer Abweichungen fahren und Stolperfallen wie „Dokus werden aktualisiert ohne Änderungsvermerk“ in die Regel zurückspiegeln.
Entscheidungsregeln
Dokumentationsrichtlinie ist gut dokumentiert, wenn Regeln, Grenzfälle und Nachweise so konkret sind, dass Teams damit ohne Zusatzabsprachen arbeiten können.
Standardfall
Für Dokumentationsrichtlinie zuerst den Anwendungsbereich konkret machen: Dokumententypen, Owner und Reviewrhythmus.
Freigabe & Rollen
Entscheidungen zu welche inhalte pflichtfelder sind und wann doku als „gültig“ gilt nicht implizit lassen, sondern Rollen und Freigaben explizit benennen.
Grenzfälle
Ausnahmen nur zulassen, wenn sie den Standard nicht aufweichen; besonders relevant sind hier versionierung und änderungsnachweise.
Kontrollpunkt
Prüfbar ist die Regel erst, wenn versionshistorie und review-kommentare sauber verlinkt sind.
Was dokumentiert werden soll
Hier nur die spezifischen Inhalte zu Dokumentationsrichtlinie pflegen; allgemeine Doku-Regeln bleiben in der zentralen Leitlinie. Zentrale Leitlinie.
Die Seite ist dann gut, wenn eine Vertretung den Standard anwenden oder prüfen kann, ohne erst Personenwissen einsammeln zu müssen.
Definitionen
Begriffe, Scope und Grenzen zu Dokumentationsrichtlinie konkretisieren – inklusive dokumententypen, owner und reviewrhythmus.
Standardkonfiguration / Prozess
Den Standard so notieren, dass welche inhalte pflichtfelder sind und wann eine seite archiviert wird eindeutig entschieden sind.
Belege
Artefakte direkt nennen und verlinken: Versionshistorie, Review-Kommentare, Links zu Quellartefakten.
Review-Stand
Aktive Ausnahmen, letzte Änderung und nächster Review gehören auf die Seite – besonders bei Themen mit versionierung und änderungsnachweise.
Typische Stolperfallen
Pflege hier echte Fallstricke aus der Praxis von Dokumentationsrichtlinie; allgemeine Hinweise gehören in die zentrale Leitlinie. Zentrale Leitlinie.
- Umfang driftet: Dokus werden aktualisiert ohne Änderungsvermerk.
- Regel bleibt abstrakt: Owner ist genannt, aber nicht erreichbar.
- Nachweis fehlt: Seiten bleiben sichtbar obwohl sie ersetzt wurden.
- Ausnahme entgleist: Standard bleibt abstrakt ohne Anwendungsbezug.
Prüfung & Pflege
Prüfe diese Seite gegen reale Vorgänge zu Dokumentationsrichtlinie – nicht nur gegen den Wortlaut. Entscheidend ist, ob Standard, Ausnahmen und Nachweise im Alltag tragen.
- Sind Pflichtfelder auf den Vorlagen konsistent?
- Sind veraltete Seiten archiviert/verlinkt?
- Ist die Versionslogik nachvollziehbar?
- Ist der Scope noch korrekt?
Prüf-Fokus für „Dokumentationsrichtlinie“: Regeln & Verantwortung; prüfe dabei insbesondere dokumententypen, owner und reviewrhythmus.
Sinnvolle Kennzahlen
Wenige Kennzahlen genügen – wichtig ist, dass sie Entscheidungen oder Verbesserungen auslösen.
Für „Dokumentationsrichtlinie“ Kennzahlen direkt an welche inhalte pflichtfelder sind und die häufigsten Praxisrisiken koppeln.
Review-Quote
Anteil fristgerecht geprüfter Seiten
Intervall: monatlich
Verwaiste Seiten
Anzahl Seiten ohne aktiven Owner
Intervall: monatlich
Aktualisierungszeit
Zeit von Prozessänderung bis Doku-Update
Intervall: quartalsweise
Nächste Schritte
Ergänze jetzt die konkrete Entscheidung zu welche inhalte pflichtfelder sind inkl. Verantwortlichen, Datum und Verweis auf versionshistorie.
Auf „Dokumentationsrichtlinie“ als Nächstes besonders klar machen: welche dokumententypen, owner und reviewrhythmus im Standardfall gelten und welche Ausnahmen befristet sind.