Modernste Methoden in der Software-Entwicklung, aber immer noch Dokumentieren als wäre es 1993? Warum kontinuierliches Erweitern der Nutzer-Dokumentation Sie weiterbringt, erklärt unser Online Enablement Manager Matthias Gidda.

Wenn bei Ihnen im Unternehmen ebenfalls Produkte entwickelt werden, ob Software oder Kaffeemaschinen, kennen Sie das vielleicht nur zu gut: Das Dev-Team hat den Sprint geschafft, stolz werden die mit Spannung erwarteten neuen Features im Sprint Review ausprobiert. Das Management möchte das Release am liebsten schon gestern, also sagt der Produktmanager noch schnell dem Team Bescheid, das sich um die Online-Hilfe kümmert: „Schaut euch schnell an was heute im Review gezeigt wurde und schreibt Release Notes dafür, heute Nacht gehen wir live“.

„Nach dem Review kurz Runterdokumentieren“ ist keine Strategie

Was dann passiert, ist so vorhersehbar wie schlecht: Irgendjemand zieht sich noch schnell was aus den Fingern, das die Neuerungen mehr oder wenig langweilig-trocken umschreibt, und übersieht dabei eine kleinere Änderung komplett. Die Dokumentation wird nicht rechtzeitig fertig und das Release muss um einen Tag verschoben werden. Eine Woche danach fragt die Person im Dev-Team nach, wie die vor mehreren Tagen releasten Features genau funktionieren, weil sie noch nicht alle Details in der Online-Hilfe aktualisiert hat. Die Entwickler schauen etwas widerwillig vom Rechner auf, und wissen auch nicht mehr genau wer letzte Woche welchen Subtask gemacht hat.

Gefährlich wird diese Vorgehensweise besonders bei großen Neuerungen, die wochenlang schrittweise entwickelt und erst dann ausgeliefert werden: Der nötige Änderungsaufwand in der Online-Dokumentation wird lange unterschätzt, weil außerhalb des Entwicklungsteams gar niemand all die kleinen Stellen kennt, an denen etwas geändert wurde. Nach dem Release sehen die Nutzer dann wochenlang veraltete Screenshots und Beschreibungen.

  • Mehrwert für die Nutzer: mäßig

  • Beitrag zu einem guten Produkt: null

  • Nerv-Faktor für das Team: beträchtlich

Online Enablement Manager Matthias Gidda

Ich würde jetzt wirklich gerne behaupten können, dass wir bei Meisterplan schon immer völlig anders vorgegangen sind. Aber auch wir haben schonmal erst am Tag vor dem Release mit der Dokumentation angefangen und waren dann enttäuscht.

Freut das Team und die Nutzer: „Continuous User Documentation“

Auch wir mussten nämlich die Online-Hilfe erst einmal als ein Produkt begreifen, das nach agilen Methoden inkrementell erweitert wird. Seitdem machen wir Online-Dokumentation auf eine Art, die ich als das kontinuierliche Verbessern der Benutzerdokumentation (also etwa „Continuous User Documentation“) bezeichnen würde:

  • Es gibt (mindestens) einen Technischen Redakteur, der fester Teil des Dev-Teams ist – kein Zuschauer mehr, der nach dem Spiel aufs Spielfeld läuft und Fotos schießt.

  • Wie die Entwickler erfahren die technischen Redakteure spätestens zum Sprintbeginn, was umgesetzt werden soll und was der Nutzer davon hat (anstatt sich später selber zusammenzureimen, was mit einem neuen Feature eigentlich erreicht werden sollte).

  • Im Daily bekommen sie laufend Updates zum Entwicklungsfortschritt, so dass sie immer wissen welche Implementierungsentscheidungen getroffen wurden und für welche Features bereits Screenshots angefertigt werden können.

  • Aufkommende Rückfragen können schnell geklärt werden, da Entwickler und Produktmanagement im selben Aufgabenkontext sind wie die technischen Redakteure.

  • Wo im Produkt neue Texte gebraucht werden, werden von Anfang an auch Technische Redakteure eingebunden. So sind Schreibweisen und Begriffe in Produkt und Dokumentation immer einheitlich und es gibt einen klaren Verantwortlichen für die Verbesserung der Texte.

  • Während der Backlog Refinements hinterfragen Technische Redakteure zusammen mit den UX-Designern, ob vorgestellte Lösungsansätze aus Nutzersicht intuitiv genug sind – da sie die sind, die nachher in Worten erklären müssen wie etwas funktioniert, ergänzen sie die Diskussion sinnvoll.

Wenn Sie nicht Software machen, sieht der Weg zu einer besseren Dokumentation Ihres Produkts vielleicht etwas anders aus. Aber in jedem Fall sorgen Sie durch eine Verknüpfung von Produktentwicklung und Dokumentation dafür, dass Benutzern in der Online-Hilfe besser erklärt wird, wie Sie Ihre Probleme lösen, anstatt ihnen nur zu sagen, wo sie welchen Button finden. Und die Änderungen an der Online-Hilfe sind dadurch immer schon bereit, wenn die Entwickler mit dem Feature fertig sind, so dass die Release- und Feedbackzyklen möglichst kurz sind.

Mehr lesen?