Agile Dokumentation in der Software-Entwicklung

Veröffentlicht: 21.10.2022 Aktualisiert: 14.11.2022
Thema: Content-Erstellung Smart Information Wiederverwendung

Agile Entwicklungsprozesse sind im Software-Bereich seit einigen Jahren State of the Art. Aber wie sieht es eigentlich mit der Dokumentation aus, die zu der „agilen“ Software gehört? Aus vielen Technischen Redaktionen hört man hier immer wieder Bedenken. Sven Schmitt, Technischer Redakteur bei dem Quanos-Kunden Adcubum, arbeitet in agilen Entwicklungsprozessen. In einem Webinar hat er uns erklärt, wie das funktioniert und wo die Herausforderungen stecken.

Redaktion bei Adcubum

Adcubum ist die Nummer 1 in der Schweiz, wenn es um Kranken- und Unfallversicherungen geht. 1997 von fünf Studenten der Universität St. Gallen gegründet, hat sich Adcubum mit 8 Standorten und über 400 Mitarbeitern zu einer festen Größe als Softwarehersteller für Versicherungen entwickelt. Adcubum ist Gewinner des europäischen Xcelent-Awards für Kundenzufriedenheit. Agile Entwicklungsprozesse, mit den sich Kundenbedürfnisse schnell und präzise umsetzen lassen, sind ein wesentlicher Grundpfeiler für diesen Erfolg.

Es ist deshalb leicht nachzuvollziehen, dass aus Sicht des Technischen Redakteurs die enge Einbettung in diese Entwicklungsprozesse und damit in das Entwicklungsteam entscheidend ist. Technische Redakteure nehmen in einem agilen Team eine eigene Rolle ein und verantworten die Dokumentation des Entwicklungsfortschritts und die Einhaltung der Terminologie. Dies grenzt Technische Redakteure deutlich von den Entwicklern ab, ebenso wie von der Rolle des Scrum Masters als Moderator und Unterstützer des Teams und von der Qualitätssicherung.

Der Product Owner steht zwar außerhalb des Entwicklungsteams, spielt aber eine wichtige Rolle, weil er Anforderungen definiert und priorisiert. Dies gilt auch für die Qualität der Dokumentation, so dass der Product Owner immer auch die Technische Redaktion im Blick haben muss.

Ebenfalls außerhalb des Entwicklungsteams organisieren sich die Querschnittsaufgaben der Technischen Redaktion. Denn neben den konkreten Projektaufgaben müssen sich Technische Redakteure und Redakteurinnen auch auf teamübergreifende Standards verständigen. Dazu treffen sich die Technischen Redakteurinnen und Redakteure in sogenannten Gilden, denen ein Documentation Lead vorsteht. In den zweiwöchentlichen Gilden-Veranstaltungen übergreifende Dokumentationsthemen, die für alle technischen Redakteure, unabhängig von ihrer fachlichen Zugehörigkeit zu einem Team, wichtig sind.

Die Doku-Lounge von Quanos ist DER Podcast rund um die Technische Redaktion. Kerstin Berke lädt regelmäßig Gäste ein zur gemütlichen Diskussion. Klicken Sie hier, um zum Podcast zu gelangen.

Arbeiten in Sprints

Die Arbeit des Entwicklungsteams organisiert sich in Sprints, kurzen Arbeitseinheiten von ein bis vier Wochen; in denen Anforderungen erfasst, bewertet und der dazu gehörige Aufwand geschätzt wird, diese Anforderungen umgesetzt werden und dann ein Kundenfeedback eingeholt wird. Aus den Erkenntnissen dieses Feedbacks und den Erfahrungen, die im Sprint gewonnen wurden, fließen dann wieder Erkenntnisse in den nächsten Sprint ein. Denn Sprints organisieren immer nur Teile des Entwicklungsprozesses, sie folgen so lange aufeinander, bis das Produkt übergabereif ist.

In jeder Phase der Sprints muss ein Technischer Redakteur (oder eine Technische Redakteurin) dokumentationsrelevante Aufgaben erkennen, bearbeiten und prüfen. Mit seinem Wissen zu Terminologie und zur Vermittlung von Inhalten übernimmt er eine wichtige Beratungsfunktion im Entwicklungsteam. Da die Dokumentation auch Bestandteil des Produkts ist, stehen seine Arbeitsergebnisse ebenso im Kundenreview wie die programmierten Bestandteile der Software.

Agile Redaktion – ein Gewinn?

Wie sieht nun die Bilanz für die Technische Redaktion in einem solchen Umfeld aus? Als positiv betrachtet Sven Schmitt die enge Anbindung an den Entwicklungsprozess. Dadurch fließen Informationen leichter und Feedback aus Entwicklung und vom Kunden kommt schneller beim Technischen Redakteur an. Als Technischer Redakteur lässt sich leichter Einfluss auf den Entwicklungsprozess nehmen; dadurch lassen sich Fehlentwicklungen leichter vermeiden. Extrem hilfreich ist auch die Arbeitsweise in einem Scrum-Prozess: Dokumentation kann auf diese Weise nach und nach fertig gestellt werden, statt als ein großes Ganzes zu Ende des Entwicklungsprozesses. Andererseits werden die Bedürfnisse der Dokumentation immer gesehen, da sie ein integraler Bestandteil (und damit eine integrale Anforderung) im Entwicklungsprozess sind.

Doch die enge Einbindung ins Entwicklungsteam hat auch ihre Nachteile. Die Einhaltung von Text- und Terminologiestandards über die verschiedenen Teams hinweg erschwert sich. Nicht immer lässt sich die Dokumentation parallel zur Entwicklung vollziehen oder es kommt zu unnötigen nachträglichen Textanpassungen. Die Beschleunigung der Releases und die Vervielfachung der Softwareversionen machen die Arbeit des Technischen Redakteurs ebenfalls schwerer.

Aber alles in allem lässt sich festhalten: Technische Redakteure können in agilen Prozessen gut arbeiten, wenn sie eine feste Rolle im Entwicklungsteam haben und ihre Bedürfnisse in den Sprints Gehör finden.

 

Sie möchten noch mehr erfahren?

Dann sehen Sie sich unser Video zum Thema an!

Andere Artikel von Quanos

Das könnte Sie auch interessieren

5 Vorteile von modularem Content

5 Vorteile von modularem Content

Wer mit einem CMS arbeitet und vielleicht sogar mit SCHEMA ST4, dem ist modularer Content bekannt. Inhalte bestehen i…

Wer braucht schon Metadaten? - Quanos Content

Wer braucht schon Metadaten? - Quanos Content

Das Thema Metadaten erfreut sich in der technischen Dokumentation großer Beliebtheit und wird regelmäßig in Vorträgen…

Der Projektkonfigurator im Einsatz bei SKOV: Von Michelangelos David zum 3D-Drucker

Über Variantenmanagement schreiben wir in diesem Blog zwar regelmäßig - aber Varianten im Projektbaum haben wir bishe…