Interview mit einem anonymen Programmierer

Über die Bedeutung einer guten Dokumentation

Die Situation ist wirklich nicht zu verharmlosen. Die Zurückhaltung vieler Kunden, Entwicklern für die Dokumentation ihrer Arbeit angemessen Zeit einzuräumen, ist zweifelsohne kritisch zu sehen. Dieses Phänomen führt zu einer Vielzahl von Problemen, die sich auf die Effizienz, das Wohlbefinden und letztendlich auf den Erfolg von Projekten auswirken können.
Doku-Interview.jpg

Interviewer: Guten Tag Herr Oku. Vielen Dank, dass Sie sich die Zeit für dieses Interview nehmen. Wir wissen, dass es als verantwortungsbewusster Software-Entwickler nicht leicht ist, über das Thema Dokumentation zu sprechen. Wir bewundern Ihren Mut. Um das Gespräch zu beginnen, könnten Sie uns etwas über sich und Ihre Erfahrungen als Programmierer erzählen? Wieso wollen sie nicht erkannt werden?

Software Developer: Guten Tag! Natürlich, gerne. Ich bin ein Softwareentwickler mit mehreren Jahren Erfahrung in der Branche. Ich habe in verschiedenen Unternehmen und an unterschiedlichen Projekten gearbeitet, für kleine Start-ups, den Mittelstand aber auch Großkonzerne. 

Manche meiner Kunden haben Vorurteile gegenüber Softwareentwicklern, die ihre Projekte dokumentieren. Einige sind der Meinung, dass das Schreiben von Dokumentation Zeitverschwendung ist und einen guten Programmierer nur davon abhält, sich auf das eigentliche Entwickeln zu konzentrieren. Andere sind der Ansicht, dass gut geschriebener Code selbsterklärend sein sollte und keine zusätzliche Dokumentation erfordert. Und so werden im Allgemeinen Entwickler, die viel Zeit mit der Dokumentation verbringen, als nicht gut und produktiv genug wahrgenommen. Man unterstellt Ihnen nicht in der Lage zu sein, schnell genug eine komplexe Codebasis zu durchdringen. Sie werden als "Bürokraten" beschimpft, die sich mehr um Formalitäten kümmern als um das eigentliche Programmieren. Dokumentation wird als ein Zeichen von Unsicherheit oder Inkompetenz angesehen. Es heißt, dass ein Entwickler, der sein Projekt ausführlich dokumentieren muss, nicht wirklich weiß, was er tut. Diese Haltung führt dazu, dass dokumentierende Entwickler als weniger fähig oder weniger erfahren erachtet werden. Das ist der Grund wieso ich nicht erkannt werden will.

Interviewer: Ist die Situation in der Entwicklerszene wirklich so schlimm?

Software Developer: Die Situation ist wirklich nicht zu verharmlosen. Die Zurückhaltung vieler Kunden, Entwicklern für die Dokumentation ihrer Arbeit angemessen Zeit einzuräumen, ist zweifelsohne kritisch zu sehen. Dieses Phänomen führt zu einer Vielzahl von Problemen, die sich auf die Effizienz, das Wohlbefinden und letztendlich auf den Erfolg von Projekten auswirken können. Zeitdruck und Stress sind unvermeidliche Begleiter, wenn Entwickler gezwungen sind, sich ohne Dokumentation in ein Software-Projekt einzuarbeiten oder selbst auf die Dokumentation zu verzichten. Dies kann zu übermäßigem Druck führen, da Entwickler versuchen, in einem engen Zeitrahmen sowohl qualitativ hochwertigen Code zu schreiben als auch notwendige Informationen einzuholen oder weiterzureichen. Der resultierende Stress und Zeitdruck erhöhen das Risiko von Burnout bei Entwicklern, was nicht nur ihre individuelle Gesundheit und Zufriedenheit beeinträchtigt, sondern auch die Produktivität und Qualität ihrer Arbeit negativ beeinflusst. Und Burnout wiederum kann zu verminderter Kreativität, Konzentrationsproblemen und letztendlich zu einem Rückgang der Arbeitsleistung führen. Dies ist auch in verschiedenen Studien [Anm. d. Red.: 1, 2] nachgewiesen worden.

Darüber hinaus können die Kosten für Unternehmen steigen, wenn Projekte aufgrund unzureichender Dokumentation verzögert werden oder Entwickler aufgrund von Burnout oder Unzufriedenheit das Unternehmen verlassen. Der Verlust von erfahrenen Entwicklern, die das Unternehmen verlassen, ohne ihr Wissen und ihre Erfahrung angemessen zu dokumentieren, birgt die Gefahr eines "Braindrains". Wenn Schlüsselpersonen gehen, können Projekte zum Stillstand kommen oder erheblich verlangsamt werden, während das verbleibende Team versucht, den Wissensverlust auszugleichen und sich in die unvollständig dokumentierte Codebasis einzuarbeiten. Ein Teufelskreis!

Interviewer: Können Sie uns etwas über Ihre Einstellung zur Dokumentation in der Softwareentwicklung erzählen?

Software Developer: Sicher. Also, ich muss zugeben, dass ich zu Beginn meiner Karriere nicht viel Wert auf Dokumentation gelegt habe. Ich war mehr darauf konzentriert, den Code zu schreiben und die Anforderungen zu erfüllen, ohne wirklich darüber nachzudenken, wie wichtig es ist, den Prozess zu dokumentieren. Aber im Laufe der Zeit habe ich erkannt, dass gute Dokumentation entscheidend ist, um den Überblick über komplexe Projekte zu behalten und um die Zusammenarbeit im Team zu erleichtern.

Interviewer: Was hat Sie dazu gebracht, Ihre Einstellung zur Dokumentation zu ändern?

Software Developer: Nun, es gab mehrere Gründe. Zum einen begann ich, die Auswirkungen eines Mangels an Dokumentation zu spüren. Wenn ich einen Teil des Codes überarbeitet habe oder an einem Projekt arbeitete, das ich eine Weile nicht mehr angefasst hatte, musste ich oft viel Zeit damit verbringen, den Code zu verstehen und mich in die Logik einzuarbeiten. Das war ineffizient und frustrierend, sowohl für mich als auch für mein Team.

Interviewer: Wie haben Sie angefangen, Ihre Projekte besser zu dokumentieren?

Software Developer: Ich habe damit angefangen, kleine Kommentare im Code einzufügen, um die verschiedenen Teile und ihre Funktionalität zu erklären. Dann begann ich, das Ganze auszubauen, indem ich eine separate Dokumentation erstellte, die die Architektur des Projekts, die wichtigsten Komponenten, ihre Beziehungen zueinander und andere relevante Informationen beschrieb.

Interviewer: Welche Vorteile haben Sie durch diese verstärkte Dokumentation festgestellt?

Software Developer: Oh, da gibt es viele. Zunächst einmal hat es meine eigene Arbeit erleichtert. Wenn ich zurückkomme, um an einem Projekt weiterzuarbeiten oder wenn ich Code für jemand anderen überprüfe, kann ich viel schneller einsteigen, weil ich alle Informationen, die ich brauche, in der Dokumentation finde. Außerdem hat es die Zusammenarbeit im Team verbessert. Meine Kollegen können jetzt leichter verstehen, was ich gemacht habe, und sie können schneller herausfinden, wie sie ihre Arbeit damit verbinden können. Und nicht zuletzt werde ich jetzt viel seltener mit Fragen belästigt, die bereits in der Dokumentation beantwortet werden können.

Interviewer: Haben Sie irgendwelche Ratschläge für andere Entwickler, die möglicherweise auch mit der Dokumentation kämpfen?

Software Developer: Ja, auf jeden Fall. Ich würde ihnen raten, von Anfang an in die Dokumentation zu investieren. Es mag vielleicht wie zusätzliche Arbeit erscheinen, aber es spart wirklich Zeit und Frustration auf lange Sicht. Fangen Sie klein an, mit Kommentaren im Code, und bauen Sie von dort aus auf. Und denken Sie daran, dass gute Dokumentation nicht nur für Sie selbst wichtig ist, sondern auch für Ihre Kollegen und für die Gesamteffizienz Ihres Teams.

Interviewer: Vielen Dank für dieses aufschlussreiche Gespräch! Es war wirklich interessant, Ihre Perspektive zu hören.

Software Developer: Danke, dass Sie mich eingeladen haben. Es war mir eine Anliegen, darüber zu sprechen und ich hoffe, dass in Zukunft Kunden einer guten Dokumentation mehr Anerkennung schenken. Es ist wichtig, dass diese erkennen, dass Dokumentationsarbeit ein integraler Bestandteil des Softwareentwicklungsprozesses ist, der allen Beteiligten langfristig nur Vorteile bietet.