Bei der Dokumentation von Software muss schnell und flexibel reagiert werden. Kurzfristige Release-Zyklen, agiles Arbeiten und sich ständig weiterentwickelnde Softwareversionen sind spezifische Anforderungen, mit denen Technische Redakteur:innen bei der Softwaredokumentation konfrontiert sind. Hinzu kommt: Um eine Software richtig beschreiben zu können, müssen die Redakteur:innen diese auch selbst nutzen und verstehen. Dabei kann es schon einmal passieren, dass sie über den ein oder anderen Softwarefehler stolpern. Das muss jedoch kein Hindernis sein, sondern kann zu positiven Synergieeffekten führen.
Wie das gelingt? Wir haben die zentralen Punkte für Sie zusammengefasst.
Agil arbeiten
Die im Softwareumfeld übliche agile Arbeitsweise erfordert, dass ein Produkt in der Regel entwicklungsbegleitend dokumentiert werden muss. Dazu werden in Softwareprojekten die zu erledigenden Aufgabenpakete in kurzen Etappen (Sprints) geplant. Das schafft Flexibilität, gibt die Möglichkeit zur Priorisierung und sorgt dafür, dass an verschiedenen Stellen gleichzeitig gearbeitet werden kann. Diese Arbeitsweise führt allerdings auch dazu, dass Aufgabenpakete und damit auch Softwarefeatures sich schnell verändern und weiterentwickeln. Die Technische Redaktion steht dadurch vor besonderen Herausforderungen: Schnell passiert es, dass die Dokumentation zu kurz kommt und nicht Schritt halten kann mit der schnelllebigen Softwareentwicklung.
Wie lässt sich das verhindern?
Aufgrund des ständigen Wandels und der erforderlichen Flexibilität beim agilen Arbeiten ist es unserer Erfahrung nach sinnvoll, externe Redakteur:innen direkt in Sprints und die Planung von Aufgabenpaketen einzubinden. So haben diese einen guten Überblick darüber, woran gerade gearbeitet wird. Sie können die Auswirkungen der aktuellen Arbeitspakete auf die Dokumentation direkt mitverfolgen, einschätzen und berücksichtigen. Das ist besonders hilfreich, wenn die Dokumentation zeitgleich zur Entwicklung erfolgen soll und bereits kurze Zeit nach Abschluss der Entwicklung zur Verfügung stehen muss. In solch einem Fall muss meist unter Zeitdruck gearbeitet und dokumentiert werden. Gelingt das nicht, müssen die neuen Informationen mühselig nachverfolgt und nachträglich eingearbeitet werden. Durch das geschickte Einbinden von Redakteur:innen in eine agile Arbeitsweise lässt sich dies verhindern.
Weitere Vorteile sind: Agile Redakteur:innen finden sich schnell in das Arbeitsumfeld ein und erlangen so einen ganzheitlichen Überblick über den Stand der Entwicklung. Sie erkennen, welche Features zu welchem Zeitpunkt dokumentiert werden sollten. Sie wissen, an welchen Stellen es mögliche Schwierigkeiten gibt, auf die bei der Dokumentation besonderes Augenmerk gelegt werden muss. Zudem sind sie in der Lage, nachträgliche Anpassungen an den richtigen Stellen in der Dokumentation vorzunehmen, wenn Änderungen, Weiterentwicklungen oder Abhängigkeiten in der Software dies erfordern. So bleibt die Dokumentation stets aktuell und fachlich korrekt.
→ Das Einbinden von Technischen Redakteur:innen in eine agile Arbeitsweise ist kein Hindernis, sondern bietet Potenzial, die Dokumentation pünktlich bereitzustellen sowie aktuell und korrekt zu halten.
Verstehen, testen und verbessern
Der erste Schritt zu einer korrekten Dokumentation ist das Verstehen der Software. Wie die Endnutzer:innen auch müssen sich die Technischen Redakteur:innen Schritt für Schritt mit der Software vertraut machen. Das hilft ihnen dabei, die Anwenderperspektive einzunehmen und den konkreten Informationsbedarf auf Userseite zu identifizieren. Der Blick für die relevanten Informationen wird durch den Lernprozess während der Testphase zusätzlich geschärft. Dieser Blick ist im Vergleich dazu bei den Entwickler:innen aufgrund der Vertrautheit mit dem Produkt nur eingeschränkt vorhanden.
Es muss aber nicht dabei bleiben, dass die Redakteur:innen die Software im Rahmen der Dokumentationserstellung „nur“ verstehen. Um die Qualität der Nutzerinformationen weiter zu steigern, hat es sich als hilfreich erwiesen, wenn Redakteur:innen die Software aufmerksam nutzen und dadurch Dokumentation und Software zusammen auf Usability testen. Diese Schnittstelle zwischen Softwaredokumentation und Softwaretest kann für positive Synergieeffekte sorgen: Durch das Nutzen und Testen verbessert sich die praktische Kenntnis der Software und durch die Dokumentationserstellung das theoretische Wissen über die Software.
Unsere Erfahrung mit diesem Vorgehen zeigt, dass Redakteur:innen mit der Zeit Testfälle übernehmen und zum Beispiel Bugs identifizieren können. Ein wesentlicher Vorteil: Durch die verstärkte Einbindung in das Software Engineering können die Redakteur:innen den Einfluss von Bugs und anderen Fehlern auf die Dokumentation direkt einschätzen und so ihre eigene Arbeit besser planen. So lässt sich im Zuge der Dokumentationserstellung auch die Softwarequalität stetig verbessern. Diese Synergieeffekte werden auch davon angetrieben, dass sich die Skillsets von Redakteur:innen und Softwaretester:innen in gewissem Maße überschneiden: Man muss in der Lage sein, präzise zu arbeiten, jede Eventualität durchzudenken und – der wichtigste Punkt – Resultate präzise und verständlich zu kommunizieren.
→ Eine Kombination aus Softwaredokumentation und Softwarenutzung führt dazu, dass sowohl die Qualität der Software als auch die Qualität der Nutzerinformationen verbessert werden.
Spezifikationen optimieren
Nicht nur für die Endnutzer:innen einer Software müssen Informationen verständlich und fehlerfrei aufbereitet werden. Gut gepflegte interne Spezifikationsdokumente sind genauso wichtig, damit Entwicklerteams sich an diesen orientieren können. Das sorgt für Konsistenz bei der Entwicklung und verhindert unnötige Fragestellungen und potenzielle Fehler. Die zentrale Voraussetzung: Die internen Spezifikationsdokumente müssen gut strukturiert, konsistent und für alle Beteiligten klar verständlich sein. Dazu gehört auch ein durchdachtes Versionierungskonzept, das in der Lage ist, verschiedene Softwarestände korrekt abzubilden. In der Entwicklungsphase können dadurch viele Rückfragen, unnötige Abstimmungen und Abweichungen reduziert werden. Technische Redakteur:innen, die schon früh am Softwareengineering beteiligt werden, können einen wertvollen Beitrag zur Verbesserung interner Spezifikationsdokumente leisten.
→ Die Prüfung und Verbesserung der Konsistenz und Qualität von internen Spezifikationsdokumenten kann die Softwarequalität positiv beeinflussen.
Richtig publizieren
Bei der Publikation von Nutzerinformationen kommt es auf das richtige Medium und das richtige Format an. Gerade im Softwarebereich weist der Trend klar in Richtung digitaler Nutzerinformationen, während die klassische Anleitung in Papierform immer mehr an Bedeutung verliert.
Aufgrund der leichten Aktualisierbarkeit digitaler Informationen stehen die Dokumentationsverantwortlichen unter besonderem Druck, die Softwareanleitungen stets korrekt und aktuell zu halten. Ein enges Zusammenspiel zwischen Entwicklung und Technischer Redaktion bietet auch hier den entscheidenden Vorteil: Redakteur:innen, die eng in den Entwicklungsprozess involviert sind, können unmittelbar auf Änderungen, Weiterentwicklungen und Abhängigkeiten in der Software reagieren. So lassen sich neue Informationen deutlich effizienter erfassen und umsetzen, als es bei einer nachgelagerten Dokumentationserstellung der Fall wäre.
Um diese Vorteile auch bei der Publikation auszuschöpfen, müssen die Inhalte dann genau so schnell an richtiger Stelle bereitgestellt werden. Online-Hilfen und Informationsportale können hier eine sinnvolle Lösung sein.
→ Durch das Einbinden von Redakteur:innen in den gesamten Prozess der Softwareentwicklung können Nutzerinformationen besser und schneller im richtigen Format bereitgestellt werden.
Unser Fazit: Informationsexpert:innen möglichst früh ins Boot holen.
Die Technische Redaktion als ungeliebtes letztes Glied einer langen Informationskette? Moderne, agile Vorgehensmodelle zeigen gerade im Softwarebereich, wie es besser geht. Der Grundgedanke dahinter ist klar: den Projektfokus konsequent auf den Anwendernutzen legen. Damit das gelingt, ist es wichtig, die Technischen Redakteur:innen gleich von Beginn an in den Entwicklungsprozess zu integrieren. Das macht die Dokumentationserstellung zum einen deutlich flexibler. Zum anderen: Als Expert:innen für Usability und Verständlichkeit können die Redakteur:innen wertvollen Input an das Entwicklerteam zurückspielen. Ob es dabei um schwer nachvollziehbare Bedienabläufe, missverständliche Terminologie oder nichtssagende Fehlermeldungen geht: Die stärkere Einbindung von professionellen Informationsvermittlern kann entscheidend dazu beitragen, Korrekturaufwände zu vermeiden und eine höhere Ergebnisqualität zu erreichen.
