Blog
dranbleiben!
Dr. Uwe Alkemper

Dokumentation - Quo vadis

Dokumentation ist eine lästige Pflicht und bindet viele Ressourcen. Kann Automatisierung in der Informationsaufbereitung hier Entlastung schaffen? Wo geht die Reise hin?

Eine lästige Pflicht

“Ist eine aktuelle, korrekte und vollständige Dokumentation vorhanden, die Rollen und Verantwortlichkeiten beschreibt?”.

In diesem Satz kann man “Rollen und Verantwortlichkeiten” durch viele andere Worte ersetzen wie: Notfallpläne, Datensicherung, Entwicklung-/Betriebs-/Support-Prozesse, Service Level, Software, Software-Architektur, Systemlandschaft, Testing, Qualitätssicherung, Sicherheitskonzept …

Diese Frage wird gestellt, wenn neue Mitarbeiter in ein Unternehmen kommen. Wir stellen sie selbst oft, wenn wir am Anfang eines Audits oder einer IT-Revision stehen. Die Antwort ist meist nicht wirklich befriedigend da Dokumentation als lästige Pflicht angesehen wird und in der Priorität den Aufgaben in der Umsetzung nachgelagert ist. Durch die zunehmende Bedeutung von Compliance, Risk Management und Datenschutz/DSGVO sind Anforderungen und Umfang von Dokumentation dabei eher noch deutlich gestiegen (siehe dazu auch Blog-Beitrag “Datenschutz in Entwicklungsprojekten”).

Ich würde an dieser Stelle gerne zwei Arten von Dokumentation unterscheiden, da es zum einen Dokumentation gibt, die automatisch erstellt werden kann, wenn dies z. B. im Entwicklungs- oder Betriebsprozess entsprechend vorgesehen ist (technische Konfigurationsparameter, Systemvariablen, Code-Kommentierungen, Tests und Testergebnisse, Reports etc.). Auf der anderen Seite gibt es Dokumentation, die händisch erstellt und gepflegt werden muss (wie Projektbeschreibung, Fortschrittsberichte, Produkt- und Prozessbeschreibungen, Vertriebsunterlagen, Entscheidungsvorlagen, Businessplan, Unternehmensstruktur, Vision/Strategie etc.).

Dokumentation ist Teil der Unternehmenskultur

Wenn ich ein großes Projekt neu starte, lege ich großen Wert darauf, dass jede/jeder Beteiligte/r weiß an welcher Stelle und in welcher Form Informationen von ihr/ihm abgelegt werden. Dazu gebe ich von Anfang an die Dokumentationsstruktur vor und lege in Confluence, auf Google-Drive, Sharepoint etc. die entsprechenden Haupt- und Unterordner an. Besonderen Wert lege ich auf die Erstbefüllung mit bereits vorhandenen Informationen und Dokumenten, da hier die Weichen gestellt werden. Und während den ersten Monaten der Nutzung achte ich wie ein Wachhund darauf, dass sich die Dokumentation nicht verselbständigt. Dabei passe ich die Dokumentationsstruktur laufend auf die Bedürfnisse des Projektes an und deaktiviere auch wieder veralteten Content.

Eine wesentliche und ebenso schwierige Aufgabe ist es, alle Beteiligten zu motivieren, wichtigen Content, der mehrere Bereiche betrifft auch immer abzulegen und zu aktualisieren ohne die ganze Organisation zu lähmen. Als Projektleiter oder Führungsperson im Unternehmen hat man das Mandat dafür. Als Überzeugungstäter in einer unteren Ebene der Hierarchie ist das ein hoffnungsloses Unterfangen. Daher ist der Umgang mit Informationen für mich eine Frage der Unternehmenskultur.

Was tun?

Wenn es um Informationen und Dokumentation geht, die vollständig oder zum großen Teil manuell erstellt werden müssen, bin ich fest davon überzeugt, dass es immer einen Sheriff geben muss, der oder die alle Beteiligten motiviert, unterstützt aber auch konsequent einfordert, dass die Informationen in aktueller Form, zeitnah und möglichst vollständig abgelegt werden. Um den Aufwand für Dokumentation in diesem Bereich zu minimieren hat sich bewährt, möglichst nur ein führendes Tool (z. B. Confluence) zu verwenden und sich dann auch wöchentliche Projektreports, Entscheidungsvorlagen usw. im Projekt direkt mit den Möglichkeiten des Tools zu erstellen. D.h. Vermeidung von zusätzlichen PPT-Folien für internes Reporting.

Als conventic sind wir aber auch immer auf der Suche nach 100%-Automatisierung. Das ist unsere DNA. Und alle Informationen, die in strukturierter Form vorliegen, können wir auch immer automatisch in eine ständig aktuelle Dokumentation gießen, wenn wir dies vorher planen und die Templates dafür einrichten. Dies ist besonders interessant für alle Bereiche der Betriebsdokumentation bei der sich Parameter wie URLs, IP-Adressen, Gruppenbezeichnungen etc. häufig ändern können, die Struktur aber stabil ist. Ein anderer wichtiger Bereich ist die Erzeugung von lesbarem Code, um zu ermöglichen, dass sich ein Nachfolger in angemessener Zeit in den Code einarbeiten kann.

Quo vadis?

Wo geht die Reise nun hin? Offensichtlich kann es nicht die Zukunft sein, dass wir immer einen Großteil der Dokumentation manuell erstellen, 20 % davon jedes Jahr veraltet und wir nach 5 Jahren genauso viel Arbeit mit der händischen Aktualisierung haben wie im ersten Jahr mit der Erstellung.

Ein Verzicht auf aktuelle und korrekte Dokumentation ist auch nicht möglich, da fehlende Dokumentation zu einem Chaos im Unternehmen und bei allen Beteiligten führt und selbst einfachste Entscheidungen nicht mehr nachvollziehbar sind. Die zuvor genannten zwingenden Compliance-Vorgaben lassen hier auch gar keine Diskussion zu.

Damit liegt alle Hoffnung für die Zukunft in der Automatisierung. Zahlreiche Ansätze dazu gibt es ja bereits bei Entwicklung, Betrieb und Service. Heute geht aber noch jedes Unternehmen seinen eigenen Weg mit den unterschiedlichsten Tools. Ich fürchte, dass wir noch weitere 10 Jahre brauchen, bis dann auch Business-Pläne und Entscheidungsvorlagen automatisiert erstellt werden.

Das Ziel ist aber klar: 100%-Automatisierung bei Betriebs-, System-, Support-, Benutzer-Dokumentation. Und idealerweise auch noch darüber hinaus. Wir freuen uns auf Euer Feedback!

none
Conventic Icon
Standort Bonn
Burgstraße 69
53177 Bonn
Deutschland
+49 228 76 37 69 70
Standort Braunschweig
Westbahnhof 11
38118 Braunschweig
Deutschland
+49 228 76 37 69 70
Wir sind Mitglied bei
Grouplink Icon
Hubwerk Icon
Newsletter abonnieren
Impressum, Haftungsausschluss und Datenschutzerklärung
© 2022 conventic GmbH · Alle Rechte vorbehalten.