50.000 Wörter Softwaredokumentation verfasst
50.000 Wörter umfassender Softwaredokumentation in Markdown auf GitHub, Craft und Confluence verfasst und damit Wissenserhalt und transparente Abläufe sichergestellt.
2022 – 2024
Situation. Das meiste wichtige Wissen über das Produkt und die Arbeitsweise des Teams lag in einzelnen Köpfen. Das funktioniert, bis jemand hinzukommt oder geht. Dann stockt die Einarbeitung, und ein Teil des Unternehmenswissens kann mit einer einzigen Kündigung dauerhaft verschwinden.
Aufgabe. Das Wissen sollte in eine Dokumentation überführt werden, die Menschen tatsächlich aufbewahren und nutzen: verständlich genug zum Lesen und ausreichend strukturiert, um sie zu pflegen statt nach einem Monat aufzugeben.
Massnahmen. Ein großer Teil wurde von Hand geschrieben: am Ende rund 50.000 Wörter in Markdown auf GitHub, Craft und Confluence, jeweils dort, wo die Inhalte hingehörten. Dokumentiert wurden Architektur, Abläufe und praktische Anleitungen zu den Fragen, die immer wieder aufkamen. Die Inhalte blieben versionsverwaltet und ebenso wichtig auffindbar, denn eine nicht auffindbare Dokumentation ist kaum besser als gar keine.
Ergebnis. Das Wissen war nicht länger so verletzlich. Neue Mitarbeitende fanden schneller hinein, und Abläufe ließen sich nachschlagen, statt aus der Erinnerung rekonstruiert zu werden. Die Arbeit wurde überprüfbar: Vorgehen und Gründe waren sichtbar, statt geglaubt werden zu müssen.