Dokumentation war schon immer Teil meiner Arbeit um Nach­vollziehbarkeit zu gewährleis­ten. Beginnend mit 2014, eher aus einem Hobby heraus, habe ich als Freiwilliger regelmäßig und immer öfters Beiträge zur Dokumentation bei ownCloud eingebracht. Anfang 2021 wurde dies vertraglich auf die nächste Stufe gehoben. Seitdem trage ich dort wesentlich sowohl zum Content als auch zur Organisation und der Framework Pflege der Dokumentation bei. Die Dokumen­tation umfasst hier 7 Produkte, zum Teil mehrfach versioniert, verteilt über 11 ineinander verzahnte Git Repositories und greift auf weitere Git Repositories zu, von welchen vollautomatisiert produktspezifische Daten eingebunden werden. Als Dokumentations­framework wird Antora verwendet. Parallel dazu gibt es auch andere Projekte und Auftragsarbeiten mit weiteren Kunden.

Bei der Dokumentation arbeitet man im Regelfall mit zwei völlig unterschiedlichen Ansätzen. Hervor­zuheben ist, dass sie aus Sicht der Dokumentation kostentechnisch in der Erstellung nahezu ident sind, nicht aber was die allgemeinen Kosten, speziell die Folgekosten betrifft.

• Reaktive Dokumentation
  Entwicklungstechnisch ist alles schon passiert, man beschreibt den Ist-Zustand nachträglich, so gut es geht.
• Proaktive Dokumentation
  Direkte Einbindung in den Entwicklungs­prozess. Interaktives, frühzeitiges und eigenständiges Arbeiten.

Bei der reaktiven Dokumentation, sie betrachtet immer nur einen begrenzten Abschnitt, muss jemand sagen was genau zu dokumentieren ist. Dies bindet naturgemäß Ressourcen zur Definition und für Nachfragen und ist im Regelfall, obwohl bewährt, eine kosten­intensive und wenig effiziente Vorgehensweise. Lücken, Auffällig­keiten, Inkonsis­tenzen oder ähnliches die während der Arbeit ans Tageslicht kommen, können zwar rückgemeldet werden, sind aber eher schwierig im Nachhinein zu beheben. Diese Dinge bemerkt im Regelfall auch der Leser.

Bei der proaktiven Dokumentation, sie betrachtet immer den gesamten Kontext, wird direkt mit den Entwicklern gearbeitet und gege­benenfalls auch in den Entwick­lungsprozess eingegriffen. Seien es suboptimale Texte im User­interface bis zu Unstimmigkeiten in Abläufen, der Administration bzw. der Benutzung die spätestens bei der Beschreibung erkennbar werden würden. Proaktive Dokumentation ist eine hervorragende Feedbackschleife um eine Außensicht  sofort in alle möglichen Unternehmensbereiche einzuführen, welche nicht nur die Entwicklung, sondern z.B. auch Marketing, Vertrieb und den Support umfasst. Informationsfluss und Timelines können für alle Beteiligten bestens umgesetzt werden und Mitarbeiter können sich auf ihre jeweiligen Kernaufgaben konzen­trieren. Diese Form ist auch jene, die ich bei ownCloud sehr effizient betreibe.

Weitere, oben noch nicht genannte Punkte können gerne auf Anfrage und entsprechend den Bedürfnissen des Untern­ehmens erarbeitet und umgesetzt werden.