Dokumentation hat verschiedene Dimensionen. Man muss nicht nur wissen, was man wie dokumentiert und in welchem Umfang, sondern sollte auch mit verschiedenen Ausprägungen umgehen können. Eine App, die mit einer ähnlichen Fachlichkeit auf z.B. Android und iOS läuft, kann dabei schon zur unlösbaren Herausfoderung werden.
Ich arbeite in einem Scrum-Team, das eine native App für iOS und Android kontinuierlich weiterentwickelt und mehrere Releases pro Jahr an den Endkunden ausliefert. In Hinblick auf Dokumentation birgt das folgenden Herausforderungen:
- iOS und Android haben dieselbe Fachlichkeit, aber mitunter eine unterschiedliche Umsetzung der Anforderung, da man auf betriebssystemspezifische Faktoren Rücksicht genommen hat oder nehmen musste.
- Native Apps müssen vom Kunden aktualisiert, also aus dem Playstore oder Appstore heruntergeladen werden. Klemmt man ältere Versionen nicht direkt ab, muss man mit verschiedenen Software-Ständen beim Kunden umgehen.
Die Produktdokumentation wird durch diese Umstände komplexer. Mit der Unterscheidung zwischen zwei Betriebssystemen kann man vielleicht noch umgehen. Wenn es unterschiedliche Umsetzungen gibt, kann man z.B. eine Tabelle mit zwei Spalten nutzen. Arbeitet man zusätzlich mit unterschiedlichen Versionsständen, wird es schon schwieriger, die Übersichtlichkeit zu bewahren.
Für die Confluence-Nutzer unter uns gibt es an dieser Stelle eine Lösung. Atlassian hat mit Scroll Versions eine Erweiterung für das Wiki im Store, mit der man diesem Problem begegnen kann. Man kann den Wiki-Eintrag nicht nur versionieren, sondern auch verschiedene Varianten anlegen. Das ist nicht nur interessant für die Unterscheidung zwischen mehreren Betriebssystemen, sondern kann auch relevant sein für die Dokumentation von Bereichen, die für unterschiedliche Kundengruppen andere Ausprägungen haben. Mittels Attributen können die Varianten beschrieben und beliebig kombiniert werden.
Trotz aller Freiheiten, darf man aber nicht vergessen, dass die Dokumentation zielgruppengerecht geschrieben werden muss. Die Leser der Dokumentation müssen sich auch mit dem Tool „Scroll Versions“ auskennen und die Versionierungsgedanken des Redakteurs nachvollziehen können. Hier gilt das Prinzip der Einfachheit. Überlegt euch ganz genau, wann eine Variante Sinn macht und ob man es zwingend benötigt.
Ich persönlich werde mich von nun an in den Versionierungsdschungel begeben und berichten, auf welche Hürden ich noch treffen werde. Ach ja, ich bekomme kein Geld von Atlassian 😉 .
Agile Dokumentation 