How to Write This ?!?! User Guide?

Dokumentation als Brücke zwischen Entwickler und Anwender

Handbücher werden im Allgemeinen eher ungern gelesen. Man muss sich nur mal im privaten Umfeld umgucken – ein neues technisches Gerät ist schnell gekauft, aber lieber probiert man stundenlang herum als einen Blick in das Benutzerhandbuch zu werfen.
Aber woher kommt diese negative Einstellung? Warum liest keiner gerne Handbücher? Wieso ist eine hilfreiche Dokumentation bei Softwareprodukten aber doch notwendig? Und worauf kommt es beim Schreiben guter Benutzerdokumentationen an?

Digitaler Vortrag per Teams

All diese Fragen wollte ich bei den Magdeburger Developer Days 2020 in Magdeburg in meinem Vortrag mit dem Titel „How to Write This F***** User Guide?“ thematisieren. Aufgrund der Einschränkungen rund um Covid-19 konnte dieser Vortrag leider nicht stattfinden. Umso mehr habe ich mich über das Angebot gefreut, meinen Vortrag intern und digital bei valantic zu halten. So haben per Teams-Besprechung ca. 25 Kolleg*innen meinem Vortrag gelauscht. 😊

Kurz zu mir: Als Nicht-Entwickler in einer Softwarefirma finde ich mich täglich in einer hauptsächlich von Männern dominierten Domäne wieder, in der mein Fachgebiet auch mal ein bisschen untergeht. Seit 2015 arbeite ich bei der valantic Trading Solutions AG in Magdeburg als Technische Redakteurin und Fachübersetzerin und habe im Laufe der Zeit viele Erfahrungen in diesem Bereich gesammelt, verschiedene Herausforderungen gemeistert und das Schreiben der Benutzerdokumentation sowie damit einhergehende Workflows stetig mitverbessert. An meinen Erfahrungen möchte ich Kolleg*innen sowie Interessierte gerne teilhaben lassen und habe in meinem Vortrag daher folgende Fragen adressiert:

Woher kommt die negative Einstellung gegenüber Handbüchern?

Vor allem bei komplexen Softwareprodukten sind die Handbücher, die entstehen, oft sehr unhandlich („Das Handbuch ist zu lang, man wird von Informationen erschlagen.“) oder sogar unbrauchbar („Das Handbuch beschreibt nicht die Probleme, die ich habe bzw. antwortet nicht auf die Fragen, die ich habe.“). Auch andere Aspekte verstärken diesen negativen Grundtenor, denn oftmals ist noch nicht mal allen Mitarbeitenden bekannt, wo das aktuelle Handbuch zu finden ist. Oder aber der Aufwand der Handbucherstellung steht einfach nicht im Verhältnis zum Nutzen. Meist führt dies zu zwei extremen Fällen: entweder viel zu viel Doku oder aber es wird gar kein Wert auf Doku gelegt.

Warum ist Dokumentation eigentlich notwendig?

Zum einen gibt es den rechtlichen Hintergrund: Die technische Dokumentation, d. h. Benutzerinstruktionen, Bedienungsanleitungen und Gebrauchsanweisungen, ist laut Produkthaftungsgesetz ein zum Lieferumfang gehörender Produktbestandteil.  Somit sind Fehler im Benutzerhandbuch auch Produktfehler. Was viele nicht wissen: Die Pflicht, die Dokumentation in der jeweiligen Landessprache bereitzustellen, kann nicht einfach durch vertragliche Vereinbarungen umgangen werden. Des Weiteren muss die Kundenerwartung erfüllt werden. Auch wenn scheinbar niemand Handbücher so richtig gerne liest, kommt man als User evtl. irgendwann an den Punkt, an dem man mit Ausprobieren nicht mehr weiterkommt und doch mal etwas nachlesen möchte.

Langfristig kann gute Benutzerdokumentation sogar Kosten sparen: eine gute Struktur und konsistente Aufbereitung des Funktionsumfangs kann im Idealfall nicht nur Kundenfragen reduzieren, sondern auch die Übersetzung und Pflege der Dokumentation vereinfachen. Entstandene Inhalte können außerdem für verschiedene Zwecke und auch von anderen Abteilungen (Sales, Marketing o. ä.) wiederverwendet werden. Zudem kann nachhaltige Wissensspeicherung die Einarbeitung neuer Mitarbeiter und die Vorbereitung von Schulungen aktiv unterstützen.

Worauf kommt es bei guter Dokumentation an?

Das Wichtigste vorweg: das Hineinversetzen in den Anwender ist beim Schreiben guter Benutzerdokumentation das A und O. Der Nutzer muss im Zentrum stehen und dafür müssen die Zielgruppen klar definiert und die Informationen zielgruppengerecht gegliedert und aufbereitet werden. Außerdem sollte der Nutzer durch direkte Anrede aktiv einbezogen werden und durch kurze und prägnante Sätze klare Anweisungen erhalten. Dabei ist die richtige Reihenfolge der Informationen unbedingt notwendig und ggf. eine visuelle Darstellung hilfreich. Für die Strukturierung von Informationen gibt es in der Theorie viele verschiedene Ansätze, auf die ich an dieser Stelle nicht zu detailliert eingehen möchte. Als Beispiel sei nur die IMAP® (Information Mapping)-Methode genannt, die sieben Prinzipien, sieben Informationsarten und zwei Informationseinheiten definiert.

Beim Schreiben der Benutzerdokumentation sollten auch gewisse Standards etabliert werden. Dazu gehören standardisierte Festlegungen, z. B. in Bezug auf Getrennt- und Zusammenschreibung oder das korrekte Zahlenformat, richtige Rechtschreibung und Grammatik, konsistenter und angemessener Stil sowie eine einheitliche Terminologie. Schau dir hierzu doch meinen anderen Blogbeitrag zum Thema an.

Essentiell ist es, die Dokumentation in den Entwicklungsprozess einzubeziehen – nur dann können alle Vorteile voll ausgeschöpft werden.

Agile Dokumentation

Abschließend bin ich auf agile Projekte in der Softwareentwicklung und die Rolle der Dokumentation in solchen Projekten eingegangen. Ist die Benutzerdokumentation wie man sie kennt noch notwendig? Wenn ja, in welchem Maße? Und welche Alternativen gibt es zu endlos langen PDFs oder Online-Hilfen? Da gibt es nämlich tatsächlich einige…

  • User Stories um einen Doku-Teil erweitern
  • Microdoks (kleine Informationseinheiten) verwenden
  • Kleine und in sich abgeschlossene Featurebeschreibungen schreiben
  • Benutzerdokumentation in Form von Wikis bereitstellen
  • Docs as Code (Dokumentation zusammen mit dem Quellcode) erstellen

Eigene praktische Erfahrungen mit agiler Dokumentation habe ich bisher noch nicht gemacht. Aufgrund des positiven Feedbacks nach meinem Vortrag und allgemein sehr interessierten Stimmen bei valantic bin ich jedoch zuversichtlich, dass wir schon bald gemeinsam Projekte dieser Art angehen werden. Ich habe mich sehr gefreut, so viele Fragen und reges Interesse von meinen Kollegen erhalten zu haben. Viele haben live teilgenommen, einige haben sich die Aufzeichnung im Nachgang angesehen und viele interessante Gespräche sind daraus entstanden.

Schreib als Erster einen Kommentar

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.