Suche
Suche Menü

Technische Dokumentation in einem agilen Umfeld

Vor etwas über einem Jahr kam ich zur Qudosoft.

Ich war plötzlich mit Begriffen wie Scrum, Kanban, agilen Prozessen konfrontiert. In meinem Freundeskreis gibt es einige Technische Redakteure und wenn ich denen was von „Agiler Softwareentwicklung“ erzähle, vernehme ich oftmals ein tiefsitzendes Raunen. Oh man, auf was hatte ich mich da also eingelassen?  Natürlich hakte ich damals nach. Das allgemeine Problem ist: Agile Ansätze gibt es in der Entwicklungsabteilung und genau da hören sie auch wieder auf.

Kunde-IT-Doku_Agil

Die Redaktion ist abgegrenzt und während sich Entwickler freuen wie flexibel sie sein können und man die Fahnenstange hin und her schwingen kann und dann nochmal von links nach rechts im Kreise drehen, versuchen die Redakteure sich verzweifelt an das Ende der Stange zu hängen und sich festzukrallen. Das allgemeine Problem meiner Redaktionsfreunde ist also die fehlende Integration. Sie wissen nicht, auf was sie sich verlassen können und das Ergebnis ist oft, dass sie entweder vieles für die Tonne schreiben, weil sich doch wieder alles ändert oder sie am Ende der Produktentwicklung noch schnell die Dokumentation hinterher schieben müssen und so nach einer langen Durststrecke plötzlich unter enormen Zeitdruck stehen.

Ich war damals also gespannt, auf was ich mich da eingelassen hatte. An meinem ersten Tag nahmen mich meine Betreuer in Empfang und zeigten mir meinen Arbeitsplatz. Mitten im Entwicklerzimmer. Und dann wurde ich zu fast jedem Entwicklermeeting eingeladen und mir wurde sehr deutlich gemacht, dass ich nun Teil des Entwicklerteams bin. Während andere Redakteure nichts mitbekommen und Unmengen an Informationen an ihnen vorbeilaufen, wurde ich nur so mit Information beladen, so dass ich die erste Zeit vermutlich nur mit einem riesigen Fragezeichen in den Augen rumlief, da mein Gehirn versuchte jegliche Information aufzusaugen. Mit der Zeit lernte ich allerdings Informationen zu filtern und ich war wieder ansprechbar. Langsam erkannte ich die Vorteile, die ein agiles Umfeld für die Dokumentation bringen kann. Vorausgesetzt die Rahmenbedingungen stimmen.

Agile Dokumentation heißt bedarfsgerechte Dokumentation. Einer der Werte des Agilen Manifests lautet „ Funktionierende Software ist wichtiger als umfassende Dokumentation“. Dies bedeutet jedoch nicht, dass Dokumentation an sich unwichtig ist. Der Fokus liegt hierbei auf „umfassend“. Muss eine Dokumentation umfassend sein? Oder ist es nicht viel wichtiger, dass zu dokumentieren, was der Leser wirklich braucht? Der Leser muss Antworten auf seine Fragen finden. Nicht mehr, und nicht weniger.

Die bisherige Dokumentation bei der Qudosoft war jedoch noch nicht wirklich nach diesem Prinzip aufgebaut. Es gab eine sehr umfassende Onlinehilfe für das Übersetzungsmanagement-System ONTRAM, allerdings oftmals nicht wirklich verständlich, teilweise überholt und weit vom Kunden entfernt. Zudem konnten nur wenige an dieser Dokumentation mitschreiben, da sie in einem Tool erstellt wurde, zu dem nur wenige Zugang hatten. Die Aufgabe einer agilen Dokumentation sollte es sein, möglichst unkompliziert erstellt zu werden und den Kundenbedürfnissen zu entsprechen. Es gab einiges zu verändern, was den bisherigen Dokumentationsprozess anging. Die Konsequenz daraus war, von nun an die Dokumentation direkt in einem Wiki zu schreiben. Die Dokumentation wurde verschlankt und teilweise umgeschrieben.

Oftmals sind technische Redakteure in einem agilen Umfeld aber nicht nur dabei Anwenderdokumentation zu schreiben. In meinem Fall bedeutet es auch, dass ich den Entwicklern Tipps gebe, wie sie ihre Entwicklerdoku so strukturieren, dass sie auch verständlich bleibt, ihnen aufzeige, Wichtiges von Unwichtigem zu unterscheiden und auch dabei helfe, dass GUI Texte konsistent und gut formuliert sind. Aktuell bedeutet es auch die Nutzerfreundlichkeit der entwickelten Software zu evaluieren, indem Anwendertests vorbereitet, durchgeführt und ausgewertet werden.

design_vs_userExperience

Fazit meines ersten Jahres: Technische Dokumentation in einem agilen Umfeld funktioniert, so lange die Technische Dokumentation fester Bestandteil innerhalb des Entwicklerteams ist. Das Ganze ist kein Selbstläufer. Gute Kommunikation, Transparenz und Abstimmung der Arbeiten sind für uns die Lösung. Gerade wenn es darum geht, als Redakteur in mehreren Projekten tätig zu sein.

Denn wir sind auch Dienstleiter, und somit kommen auch andere Projekte, welche dokumentiert werden oder bei denen Oberflächentexte optimiert werden müssen oder Schulungsmaterialien aufbereitet werden oder oder oder. Die Integration im agilen Entwicklerteam bietet dazu die besten Möglichkeiten und so weitet sich das Feld einer technischen Redakteurin….

 

1 Kommentar Schreibe einen Kommentar

  1. Pingback: Der Technische Redakteur im agilen Umfeld (Scrum) | ausgeklügelt

Schreibe einen Kommentar

Pflichtfelder sind mit * markiert.


Agile Softwareentwicklung