Du sollst deine Arbeit dokumentieren

Von Karim Geiger — unter Development am 16.12.2016

Ich bin noch nicht sehr alt. Trotzdem habe ich eine wichtige Erfahrung in meinem Leben gemacht, welche meiner Meinung nach elementar für die berufliche Karriere als Informatiker ist.

Egal, ob du ein Entwickler, Sysadmin oder Supporter bist, dieser simple Tipp wird dein Leben verändern. Hier erfährst du ihn!

Entschuldigung. Das klang vielleicht etwas Clickbaitiger als gedacht. Aber nunja, es ist ein einfacher Trick, wie man sich das Leben und die berufliche Laufbahn einfacher gestalten kann: Dokumentiert, was ihr getan habt.

That’s it. Danke fürs Lesen.


 

Ich denke ich muss nicht viel über Dokumentation sagen. Jeder ITler hat seine eigene Meinung dazu entwickelt. Manche lieben Dokumentation, die meisten aber hassen sie. Es macht keinen Spaß sie zu erstellen, durchlesen wird sie sowieso keiner und in drei Monaten ist sie sowieso wieder veraltet. Warum also überhaupt damit anfangen? Absolut verschwendete Zeit.

Eben nicht.

Dokumentation ist wichtig. Ich sage das nicht aus Manager- oder Sales-Sicht, sondern aus der Engineering-Perspektive. Warum du dokumentieren solltest? Weil du dir nicht alles merken kannst. Du dokumentierst nicht für andere. Du dokumentierst nicht, um dich später einmal ersetzbar zu machen, sondern du dokumentierst, damit du später weißt, was du da genau getan hast. Und das wirst du früher oder später wissen müssen:

  • Wenn du im Support arbeitest und dokumentierst, wie du den Drucker eingerichtet hast, und welche Probleme es dabei gab, wirst du es dir in zwei Monaten, wenn du ihn nochmal einrichten musst, danken.
  • Wenn du Sysadmin bist und in einem halben Jahr einen zweiten Cluster-Server aufsetzen sollst, wirst du es dir danken, wenn du alles dokumentiert hast. Auch, wenn du das Deployment automatisiert hast.
  • Wenn du Entwickler bist und in einem Jahr ein komplexes System erweitern musst, welches du selbst entwickelt hast, wirst du es dir danken.

Auch, wenn du im Moment ganz genau weißt, wie das, was du dokumentieren würdest, funktioniert, dann dokumentiere es trotzdem. Alleine aus zwei Gründen: Offensichtlich vergisst man Details. Und Details sind im Job des Informatikers ungeheuer wichtig. Aber auch das eigene Verständnis der Materie wird besser, während du dokumentierst. Es ist ein Unterschied, ob du nur Gedanken in deinem Kopf hast, oder ob du sie sortiert, strukturiert und organisiert niederschreibst. Kennst du das, wenn du versucht etwas zu schreiben, du es aber nicht so wiedergeben kannst, wie du es im Kopf hast? Das liegt daran, dass Kopf und Papier zwei unterschiedliche Dinge sind. Der Kopf kann Zusammenhänge ohne dass wir es merken auflösen. Schreiben wir sie nieder, wird erst ersichtlich, dass an dieser Stelle ein Zusammenhang – und damit eventuell Klärungsbedarf – besteht.

Hab außerdem keine Angst, dass Dokumentation dich ersetzbar macht. Ich habe noch niemanden gesehen, der entlassen wurde, weil er dafür gesorgt hat, dass jemand anderes seinen Job machen kann. Und selbst wenn du deswegen entlassen wirst, wärst du in dieser Firma nicht glücklich geworden. Außerdem ist es in der IT-Branche wirklich keine Kunst einen Job zu bekommen. Zudem werden Menschen, die dokumentieren in der Regel nicht entlassen, sondern vielmehr befördert, da sie dafür sorgen, dass die gesamte Firma davon profitiert.

Kommen wir zum vorletzten Punkt: Wie schaffe ich es, dass meine Dokumentation nicht veraltet? Nun, du musst sie natürlich pflegen. Dokumentation wächst. Mit jedem Problem kommen neue Lösungen hinzu, und genauso muss nach jeder Änderung die Dokumentation angepasst werden. Das mag zu Anfang aufwendig sein, aber schon bald hast du das Schreiben der Dokumentation in deinen Workflow mit aufgenommen. Und das kann sogar Spaß machen.

Mir persönlich macht das Schreiben von Dokumentation in der Tat Spaß. Ich würde es nicht den ganzen Tag tun wollen, aber es ist zum einen eine nette Abwechslung zum IT-Alltag, hilft die Gedanken zu sortieren und zeigt am Ende, was man geschafft hat. Nach dem Schreiben oder Pflegen einer Dokumentation sieht man nämlich sofort das Resultat. Man sieht das fertige Dokument, aber auch die dokumentierte Arbeit. Man sieht, dass man etwas geleistet hat, und hat es für die Ewigkeit festgehalten.

Und hier folgt der letzte Punkt: Warum ist mir Dokumentation so wichtig?

Ganz einfach, weil es die Arbeitsweise wiederspiegelt. Es macht keinen Spaß mit jemandem zu arbeiten, dem seine Arbeit nicht wichtig ist. Ein für mich absolut abstoßendes Zitat ist:

I throw together things until it works then I move on.

Genau das ist der Grund, warum es so viele Probleme in der IT gibt. Kein Architekt geht hin, entwirft ein Haus, das bei Optimalbedingungen stehen bleibt, und geht wieder. In der IT ist das gang und gäbe. “Hauptsache es läuft”, könnten sich einige aufs T-Shirt drucken. Und damit machen sie nur Probleme. Es mag auf kurze Sicht funktionieren und den größten Profit für einen selbst bringen, ist aber einfach nur asozial. Außerdem versalzt man sich auf lange Sicht selbst die Suppe.

Deswegen: Dokumentiere deine Arbeit. Wenn du daran Freude hast, kannst du stolz auf dich sein. Wenn die Dokumentation so komplex ist, dass du selbst beim Schreiben Probleme hast, setz dich hin und mach das, was du gerade versucht zu dokumentieren, erneut. Nichts muss auf Anhieb richtig sein. Aber mit der Zeit wird es immer besser. Und das sollte unser aller Ziel sein.