Abstrahiert dokumentieren

Wenn man über agile Dokumentation schreibt, kommt man zwangsläufig zu der Fragestellung wie man den zeitlichen Aufwand des Dokumentierens so gering wie möglich halten kann. Ein Sprint dauert oft nur zwei oder drei Wochen und da kommt das unliebsame Dokumentieren allein schon aus Zeitnöten oft zu kurz.

Abstrahierte Dokumentation kann hier helfen. Wir müssen nicht immer alles zu jedem Feature erneut aufschreiben. Beispielweise muss ein Fehlerhandling zu Fehlern wie „kein Internet verfügbar“ oder „Schnittstelle nicht erreichbar“ nicht immer wieder neu beschrieben werden, sondern kann ein zentraler Bereich in der Produktdokumentation sein, auf den referenziert wird. Ähnlich verhält es sich mit den Themen Styleguide oder Umgang mit Barrierearmut. Je mehr ich nach bestimmten Ablaufmustern beschreiben kann, desto weniger muss ich zukünftig pro Feature beschreiben.

Dasselbe spielt sich vorab in der Projektdokumentation ab, wenn konzipiert wird. Initial muss sicherlich viel neues designed und besprochen werden. Ein Ergebnistyp dieser Diskussionen sollte aber immer ein Pattern sein, das zentral gepflegt wird. Sei es ein User Interface-Pattern, das beschreibt wie ein Button oder eine Kachel aussieht oder sei es ein User Flow-Pattern, das aufzeigt wie gewohnte Abläufe in der Anwendung zu funktionieren haben. Wie werden prinzipiell wichtige Mitteilungen dargestellt? Wie verhält sich der Zurück-Button in Android? Mit der Zeit wird sich so der Designaufwand und der Diskussionsbedarf minimieren.

Allerdings benötigt es dafür an Abstraktionsvermögen, das nicht jedem so leicht von der Hand geht. Die vielleicht zunächst hohe Investition lohnt sich aber mit jeder weiteren Feature-Umsetzung und hat somit einen dauerhaften Return-on-Invest.