Alle im Softwareprojekt wollen Doku lesen können. Jeder weiß auch, warum Doku wichtig ist und um wie viel schneller das Team sein könnte, wenn die richtigen Stellen dokumentiert wären. Nur: Keiner will die Doku schreiben, am liebsten drückt man sich davor.
Hier eine Liste der 6 beliebtesten Ausreden, um nicht dokumentieren zu müssen. Manche habe ich schon selbst benutzt, daher verstehe ich sie gut:
Ausrede 1: Der Code ist doch die Doku
Klar, es steht alles im Code, oder? FALSCH. Es steht zwar drin, was in diesem System gemacht wird und wie es gemacht wird. Aber es steht nicht da, warum es gemacht wird. Es steht auch meist nicht da, was die Verantwortlichkeit der Komponente ist, deren Code ich gerade lese. Also kann jeder Beliebiges einbauen, der diese Komponente nicht kennt. Sehr gefährlich!
Ausrede 2: Die Tests sind doch die Doku
Natürlich: Schön geschriebene, automatisierte Tests sind etwas Wunderbares. Eine Quelle der Einsicht und der Inspiration, wenn es darum geht, die Komponente zu benutzen oder zu erweitern. Sehr gerne, immer her damit! NUR: Die Tests sind sehr feingranular. Jeder Test erklärt dem Leser einen Teil des Systems, doch es ist nichts da, was den Zusammenhang herstellt. Kein Erzählfaden. Keine Strategie erkennbar. Hmmm, da muss etwas anderes her!
Ausrede 3: Javadoc ist doch die Doku
Sicher, Kommentare im Quellcode sind prima. Und wenn sie schön zusammengetragen und als klickbares HTML veröffentlicht werden, ist das auch wunderbar. Dadurch entsteht wenigstens ein gewisser Überblick. JEDOCH: Das Abstraktionsniveau dieser Kommentare ist identisch mit dem des Codes. Es ist Doku auf Ebene des Codes, nicht auf Ebene der Architektur. Also nicht geeignet, um die weitreichenden, schwer zurücknehmbaren Entscheidungen im Entwurfsprozess des Systems nachzuvollziehen.
Ausrede 4: Wir arbeiten agil und schätzen lauffähigen Code höher als Doku
Ja, gut, im Agilen Manifesto steht natürlich drin: „Wir schätzen funktionierende Software mehr als umfassende Dokumentation“. Ist auch richtig, denn wenn es hart auf hart kommt, ist es wichtiger, funktionierende Software an den Kunden freizugeben als einen Papierstapel, der „im Prinzip funktionieren sollte“. DOCH: Das ist nur eine taktische Wertung, sie ist nicht dazu gedacht, um darauf eine Strategie aufzubauen. Wenn wir niemals dokumentieren, haben wir im Team auch niemals ein einheitliches Verständnis des Systems! Das macht uns langsam und un-agil, weil wir Zeit damit verbringen, Fehler auszubügeln, die auf mangelndes Verständnis der Architektur zurückzuführen sind. Zu wenig Doku macht genauso langsam wie zu viel Doku.
Ausrede 5: Wir haben keine Lust, so viel zu schreiben
Das ist wenigstens ehrlich! Das ist auch die einzige Ausrede, die ich gelten lasse. Wenn man so ehrlich ist, kann man auch Kraft darauf verwenden, den Doku-Erstellungsprozess motivierend zu gestalten, dass alle im Team halbwegs gern und eigenverantwortlich mitmachen. Und: Sich gegenseitig dazu ermuntern, die „Doku-Energie“ hochzuhalten.
Ausrede 6: Anderes ist dringender
„Unser Chef will Doku, doch priorisiert er sie runter, sobald es terminlich eng wird“. Wie oft ich das schon gehört habe, wenn ich bei einem Team als Coach zu Gast war. Klar, irgendwas drängt immer. Ich dürfte jetzt auch diesen Blog-Post nicht schreiben, weil … (hier dringenden Grund einsetzen) … doch schreibe ich ihn, weil Sie ihn sonst nicht lesen könnten und nichts davon hätten. Mit diesen Chefs, die Doku runterpriorisieren, möchte ich gern reden: über Themen wie Verzugskosten zum Beispiel. Oder darüber, woher der hohe Aufwand für’s Bugfixing kommt. Dann hätte sich diese Ausrede wahrscheinlich schnell erledigt.
Nubbel 2011-1“ von Superbass – Eigenes Werk. Lizenziert unter CC BY-SA 3.0 über Wikimedia Commons
Ausreden ad acta legen und handeln!
Sie sind kein Nutzer von Ausreden, oder? Jedenfalls nicht lange, sonst läsen Sie mein Blog nicht. Wenn Sie mehr darüber wissen wollen, wie Sie jetzt mit Ihrer Doku „aus dem Quark kommen“, dann schauen Sie sich doch einfach meine Videoserie „ArchitekturDoku, die rockt!“ an. Und laden sich mein Whitepaper „7 Schritte zu guter ArchitekturDoku“ herunter. Danach entscheiden Sie, wie Sie innerhalb einer Woche mit Ihrem Doku-Vorhaben starten wollen. Betrachten Sie nicht nur den Schlüssel in Ihrer Hand – drehen Sie ihn!
Viel Erfolg dabei. Und: Hinterlassen Sie Ihre Lieblingsausreden gegen Doku als Kommentar zu diesem Blogpost. Ich bin sehr neugierig auf weitere „gewichtige“ Ausreden. 🙂
P.S.: Falls Sie sich gewundert haben, was diese Strohpuppe hier nebenan soll: Es gibt in Köln eine Sitte, die Nubbelverbrennung. Dabei macht man eine Strohpuppe, eben „den Nubbel“, für alles verantwortlich, was bisher schiefgelaufen ist und verbrennt ihn dann gemeinsam. Danach kann man ohne Probleme frisch anfangen. Vielleicht können Sie ja so etwas Ähnliches (zumindest im Geiste) für Ihr Vorhaben tun? 🙂