Ein paar Tipps für künftige Dokumentationsliebhaber

Kaum ein Projekt vergeht ohne dass man sich irgendwann später fragt: „Wie war das damals nochmal genau?“

Wie gehts euch mit der Dokumentation? Tut ihr euch schwer damit?

Ich habe mich über viele Jahre häufig über fehlende oder schlechte Dokumentation geärgert und bin dadurch zu einer leidenschaftlichen Dokumentiererin geworden.

Falls euch der Gedanke an die Dokumentation, die ihr eigentlich längst schreiben müsstet gerade spontan zum Stöhnen bringt, helfen euch vielleicht ein paar Tips, wie ich an die Dokumentation herangehe:

  1. Zeitpunkt: Am besten während man am Projekt arbeitet. Schlüsselmomente, wenn man die Dokumentation starten sollte, sind z.B. , wenn man was schwieriges fachliches verstanden hat, oder etwas kniffliges technisch umgesetzt hat.
  2. Ablageort: Ich liebe die Freiheit und Durchsuchbarkeit von Wikis. Alternativ einigt euch zumindest mit euren Kollegen, wohin ihr dokumentiert, so dass ihr gegenseitig eure Dokus finden könnt.
  3. Mentale Zeitreise: Beim Dokumentieren frage ich mich immer: Wenn ich das Projekt in 2 Jahren übernehmen müsste, was würde ich wissen wollen? Worüber würde ich mich ärgern, dass ich es jetzt nicht aufgeschrieben habe?
  4. Rollentausch: Ich stelle mir vor, dass ich Teile der Doku auch anderen Lieferanten oder dem Kunden zukommen lassen würde und versuche mir vorzustellen, was diese anderen Interessensgruppen wissen müssten.
  5. Besser schlecht dokumentiert als nicht dokumentiert: Ein Screenshot; ein Foto; ein Scan von einem Notizblock… alles ist besser als nichts in der Hand zu haben
  6. Freiheit für die Dokumentierer: Zu enge Vorgaben verleiten dazu einfach vom letzten Projekt zu kopieren oder sich durch die enge Struktur gequält zu fühlen etwas aufzuschreiben, das man für das eigene Projekt nicht wichtig findet → Davon profitiert am Ende niemand.
  7. Konkretes: Hier ein paar Ideen, was immer hilfreich ist: Welche Komponenten sind betroffen? Wo finde ich den Code? Was ist mit Kunden und Dienstleistern abgesprochen? Wichtige Entscheide aus Meetings; falls relevant: Schnittstellenbeschreibungen und Beispielaufrufe

Habt Ihr noch andere Tips, die euch bei der Dokumentation helfen?

1 Like