Warum Technical Writer uns retten können

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 verhindern wollen, dass bei der Nutzung unserer Software unzählige Stunden für das Verständnis verschwendet werden, brauchen wir eine Veränderung in unserer Arbeitsweise – und hier kommt der technische Redakteur ins Spiel.

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

Vielleicht hast du noch nie von einem Technical Writer gehört – keine Sorge, das ist kein Problem! Technische Redakteur*innen helfen uns bei OTTO, die Entwickler-Erfahrung zu verbessern und für eine zukunftssichere Software-Dokumentation zu sorgen. Diese Berufsgruppe hat in den letzten Jahren immer mehr an Bedeutung gewonnen und ist ein unverzichtbarer Bestandteil in vielen Softwareunternehmen.

Bei OTTO ist die Rolle des Technical Writers noch neu, aber sie hat bereits ihre Relevanz unter Beweis gestellt. Es gibt zwei unterschiedliche Profile für Technische Redakteure:

Dieser technische Redakteur ist direkt in das Entwicklerteam eingebunden und unterstützt die 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 des Team-Technical Writers fest in das Team eingebunden. Sie ist bei allen relevanten Terminen wie Daily, Planning, Estimation oder Discovery dabei.

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.

Bei OTTO arbeiten fast 2000 Menschen täglich an Software. Damit wir das bestmögliche Produkt entwickeln, müssen wir unser Wissen und unsere Arbeitsweise verständlich machen. Technical Writer helfen dabei, dass Entwickler*innen sich auf ihre eigentliche Aufgabe konzentrieren können: das Programmieren. Sie schaffen eine verständliche und gut strukturierte Dokumentation, die sicherstellt, dass Code auch in Zukunft nachvollziehbar bleibt.

Entwickler*innen haben oft wenig Freude daran, ihre Arbeit zu dokumentieren – sie sind darauf fokussiert, ihren Code fehlerfrei zum Laufen zu bringen. Doch für den Erfolg eines Projektes ist es wichtig, dass der Beruf des technischen Redakteurs nicht unterschätzt wird. Ein Technical Writer übernimmt die Aufgabe, komplexe technische Details verständlich und gut strukturiert zu dokumentieren.

Wenn wir als Entwickler*innen weiterhin effizient und ohne Zeitverlust arbeiten möchten, müssen wir lernen, unsere Dokumentationen genauso ernst zu nehmen wie den Code selbst. Technische Redakteure bieten uns die Möglichkeit, unsere Projekte nachhaltig und gut dokumentiert zu gestalten, sodass zukünftige Entwickler*innen nicht im Dunkeln tappen müssen. Sie verhindern, dass Projekte zu „Altlasten“ werden, deren Funktionsweise niemand mehr nachvollziehen kann.

Trotz ihrer Bedeutung ist der Beruf des technischen Redakteurs in vielen Unternehmen noch nicht weit verbreitet. Zu viele Entwickler*innen haben noch nie von Technical Writing gehört und das Profil hat sich in der Softwareentwicklung noch nicht stark durchgesetzt. 

Doch die Rolle des Technical Writers hat großes Potenzial, die Softwareentwicklung zu transformieren. Immer mehr Unternehmen erkennen den Wert dieser Berufsgruppe, die dazu beiträgt, Software nicht nur funktional, sondern auch nachhaltig und gut dokumentiert zu gestalten. Bei OTTO setzen wir deshalb verstärkt auf Technical Writing und haben auch aktuell eine offene Stelle für einen Technischen Redakteur.