Warum Technical Writer uns retten können

Das Problem

Ich wette, dass jede*r Entwickler*in schon mal an diesem Punkt in seiner oder ihrer Karriere war: Wenn man so lange programmiert hat, dass die Augen schon ein bisschen anfangen zu tränen, man gefühlt eine Millionen Syntaxfehler produziert und zähneknirschend wieder behoben hat und eine andere Fehlermeldung zu generieren schon als Tageserfolg durchgeht. Bis schließlich doch irgendwann der Moment kommt, in dem auf einmal alles funktioniert. Und warum? Naja, only God knows!

Was ein wirklich lustiges Meme von Reddit so humorvoll darstellt, wird spätestens dann zu einem Problem, wenn 3 Wochen später deine Kollegin wissen will, wie sie deinen Code denn jetzt zum Laufen bekommt. Auf deinen Vorschlag, einfach mal am nächsten Sonntag in der Kirche vorbeizuschauen, reagiert sie leider leicht gereizt. 

Dass dies kein Einzelfall ist, wird deutlich, wenn man bedenkt, dass obiges Bild mehr als 17.000 Upvotes erhalten hat. An diesem Punkt müsste etwas auffallen: Wenn wir wollen, dass bei unserer Software keine 254 Stunden verschwendet werden, um sie zu verstehen, müssen wir etwas an unserer Arbeitsweise ändern.

Eine Lösung

Ein Allheilmittel gibt es sicher nicht, aber einen vielversprechenden Ansatz: Technical Writing. 

Noch nie gehört? Nicht schlimm! Technical Writer oder zu Deutsch "technische Redakteur*innen", helfen uns bei OTTO, die Developer Experience auf ein neues Level zu heben. Bei OTTO wird diese neue Rolle aktuell mit zwei unterschiedlichen Technical Writer Profilen ausgestaltet:

Der Team-Technical Writer

Als Teil eines Softwareentwicklungs-Teams unterstützt diese Rolle bei der Dokumentation von Software, um Entwickler*innen ihre Arbeit zu erleichtern. Technical Writer sparren zum Beispiel Benennungen von Variablen (damit du dich nachher nicht wieder 20 Minuten wundern musst, was du mit „values 2_tmp“ nochmal gemeint hast). Außerdem schaffen sie Standards, die nachvollziehbar und für Entwickler*innen hilfreich sind. Sie schreiben READMEs, die ihrem Namen auch tatsächlich gerecht werden: sie sind nämlich nicht leer oder enthalten nur einen Satz. Sie standardisieren Dokumentation und zentralisieren Informationen, damit kein Wissen über Code-Funktionalitäten verloren geht, sobald ein*e Mitarbeiter*in nicht mehr daran arbeitet.

Um das Team effektiv zu unterstützen und den Kontext für die Dokumentationsaufgaben präsent zu haben, ist diese Rolle fest in das Team eingebunden. Sie ist bei allen relevanten Terminen wie Daily, Planning, Estimation oder Discovery dabei.

Der übergreifende Technical Writer

Wie der Name schon vermuten lässt, arbeitet dieser Technical Writer losgelöst vom Team- und Domänenkontext. Auf Organisationsebene unterstützt diese Rolle z.B. mit Dokumentation für übergreifend-relevante Kontexte wie zum Beispiel API - oder Design-Guidelines oder begleitet Maßnahmen zur Wissenszentralisierung. 

Sie zeigt Teams, die noch keinen Technical Writing Support haben, mit Sparrings den Mehrwert der Rolle auf oder diskutiert und vermittelt dem Management die Relevanz von Technical Writing in einem großen Unternehmen wie OTTO.

Die Mission

Bei OTTO arbeiten fast 2000 Menschen jeden Tag an Software. Wenn wir als Ziel haben, das bestmögliche Endprodukt auf die Beine zu stellen, schaffen wir das nur, wenn wir gemeinsam daran arbeiten. Wenn wir verständlich machen, woran wir arbeiten und wie wir daran arbeiten. Wenn wir nicht versuchen das Rad neu zu erfinden, auf dem am anderen Ende des OTTO Campus‘ schon ein ganzes Auto fährt. 

Entwickler*innen sind genug damit beschäftigt, ihren Code zum Laufen zu bekommen. Sie haben sich nicht ohne Grund dazu entschieden, ihren Lebensunterhalt mit Sprachen wie Java oder C++ zu verdienen, anstatt mit Dokumentation auf Deutsch oder Englisch. Was ich sagen will: der Fokus von Entwickler*innen liegt klar auf der Programmierung und wenige haben Freude an der Dokumentation ihres Codes.

Aber Technical Writer haben umso mehr Freude daran! Und technische Dokumentation zu erstellen und komplexe Zusammenhänge einfach zu vermitteln ist ihr Job.