Dokumentation – warum dieses Negativimage ?
Diese Woche auf der Arbeit ist es mal wieder zur Sprache gekommen, das Thema Dokumentation. In der wöchentlichen Sitzung der Softwareentwickler sind wir irgendwie draufgekommen und wie immer gab es die unterschiedlichsten Kommentare mit oft negativem Tenor:
Entwickler 1:
Ich habe derzeit keine Zeit zum Schreiben, bin im Stress!
Entwickler 2:
Liest die Dokumentation eigentlich jemand bei uns?
Chef:
Dokumentation kostet Geld, macht das nebenbei.
Warum hat die Dokumentation von Software, oder allgemein von Arbeitsvorgängen so ein absolut negatives Image? Warum schreibt niemand gerne die Dokumentation zu dem, was er getan hat?
Selbsterkenntnis
Jahrelang habe ich mit der Ansicht gelebt, dass ich das meiste im Kopf habe. Für Notfälle packt man sich einen Zettel mit den wichtigsten Befehlen des neuen Programms irgendwohin und gut ist. So nach und nach kamen mir aber Zweifel, vor allem dann, wenn man zum x-ten Mal die gleiche Aufgabe durchführen muss, aber einem ums Verrecken die Verfahrensweise nicht mehr einfällt, die man das letzte Mal angewendet hat. Mich hat das irgendwann so tierisch genervt, weil ich immer wieder Zeit investieren musste, die gleichen Dinge zu lernen, dass ich angefangen habe, Dinge systematischer zu notieren.
Einfachheit
Zuerst habe ich mir die Frage gestellt, warum ich so wenig aufgeschrieben habe. Ich glaube, das größte Hindernis war ein passendes, möglichst einfaches System. Zu Beginn habe ich immer wieder Dokumentationssysteme durchgetestet, nie ein passendes gefunden. Nach langer Suche habe ich mich für mein persönliches System entschieden: Microsoft OneNote (und privat Evernote). Eine ausführlichere Vorstellung hatte ich hier mal geschrieben. Alle aufwändigeren Texte schreibe ich ganz simpel in Word, Excel und Visio. Wenn das System kompliziert ist und ein Hindernis darstellt, nutzt man es nicht.
Zeitersparnis
Nach und nach habe ich dann auch angefangen, dies auf alle Projekte auszudehnen, mit denen ich beruflich zu tun habe. Ich schreibe viel mehr Kommentartext in meine Quellcodes, baue Übersichten in Excel oder erstelle komplette Dokumentationen in Word. Kein Prosagesülze, sondern die Essenz der Dokumentation für Leute, die auf dem gleichen Wissensstand sind, wie ich auch. Klar, das ganze braucht auch seine Zeit, aber nach und nach merkt man, dass man dadurch auch Zeit sparen kann. Wenn mich jemand fragt, ob ich ihm ein Programm von mir erklären kann, habe ich nun oft die Möglichkeit, erst einmal auf die Doku zu verweisen. Bei gut kommentierten Quellcodes braucht der andere Entwickler ebenfalls nicht ständig nachfragen und es gibt generell weniger Missverständnisse. Das spart mir Zeit und ihm ebenfalls.
Klarheit
Dokumentation ist dafür da, Klarheit zu schaffen. Vorgänge sollen beschrieben werden, damit andere Menschen (oder man selbst nach einem längeren Zeitraum) die durchgeführte Aktion ebenfalls hinbekommt. Nichts ist schlimmer, als Dokumentation, die durch Seitenanzahl und Grafiken beeindrucken will. Versteht mich nicht falsch, Doku kann auch mal länger sein und ab und an sagt ein Bild mehr als 1000 Worte, aber das wichtigste ist die Klarheit des Textes.
Professionalität
Gleiches versuche ich auch für die Kunden und Endanwender zu realisieren. Wenn ich Verfahrensweisen habe, um beispielsweise bei der Problembehebung zu helfen, dann lege ich diese immer auch in Textform irgendwo ab, damit ich beim nächsten Fall der gleichen Art darauf zurückgreifen kann. Auch auf diese Art spart man Zeit und man zeigt nach außen hin, dass man professionell arbeiten kann. Oder mögt ihr eine Hotline, bei der das Gegenüber erst einmal herumstochert und ständig “gleich hab ich’s” von sich gibt? Gute Dokumentation ist ein Zeichen von Professionalität.
Kostenfaktor
Ich bin noch weit entfernt davon, immer ein passendes Dokument greifbar zu haben, aber der Erfolg ist jetzt schon deutlich zu merken. Wichtig ist, bei den Kollegen und auch bei sich selbst das Bewusstsein dafür zu schaffen, dass Doku keine lästige Pflicht ist, sondern einen unmittelbaren Nutzen hat, wenn man es richtig macht. Auch dem Chef muss klar werden, dass hierfür Zeit aufgewendet werden muss, die genauso so einem Projekt gehört, wie die eigentliche Entwicklung. Dokumentation hat einen direkten Nutzen und ist nicht nur ein Kostenfaktor.
In diesem Sinne: Nein zu seitenlanger Schwafeldoku, Ja zu effektiven Texten!
Ähnliche Artikel:
Leave a Reply