Software-Dokumentation, Teil 7 Eine verständliche Benutzerdokumentation erstellen

Bei der Erstellung einer Benutzerdokumentation ist es wichtig, die richtigen Inhalte für die richtige Zielgruppe zu vermitteln. Das ist immer auch eine Abwägung von Kosten und Nutzen. Wichtig ist in allen Fällen, dass die Anleitung wirkt und funktioniert.

Anbieter zum Thema

PresseBox - unn | UNITED NEWS NETWORK GmbH

Confluent Germany GmbH

Windhoff Group

Eine gute Benutzerdokumentation ist das A und O eines jeden Software-Produkts. Ist die Anleitung inhaltlich und didaktisch gut verfasst, hilft sie Usern, sich mit der Software zu befassen und erste Schritte und Basisfunktionen selbst zu erschließen und sogar verschiedene Schritte der Selbsthilfe angeleitet durchzuführen, falls es Probleme gibt.

Das spart Geld für Schulungen und Support, kann aber punktuell oder dauerhaft Kosten für die Erstellung, Pflege und Aktualisierung des Handbuchs oder der Online-Hilfe verursachen. Von daher ist es wichtig, vorab zu prüfen, welche Art der Benutzerdokumentation überhaupt sinnvoll ist, welche Zielgruppe angesprochen werden soll – und ob sie beim Kunden überhaupt ankommt.

Auto-Handbücher sind ein gutes Vorbild

Autofahrer kennen wahrscheinlich die Handbücher, die jedem Neuwagen beiliegen. In gedruckter Form wird dem Autobesitzer zunächst schematisch erklärt, welche Bedienelemente es gibt. Auf den folgenden 200 bis 300 Seiten werden dann die einzelnen Funktionen knapp erläutert und Bedienszenarien durchgespielt.

Anschließend folgt ein Teil, der bei einfachen Problemen Hilfe zur Selbsthilfe gibt: Ölstand prüfen, Scheibenwischer wechseln, Leuchtmittel auswechseln und so weiter. Wer mehr will, soll in die Werkstatt gehen. Zu guter Letzt folgt ein Teil mit einigen technischen Spezifikationen, gefolgt von einem Index des Handbuchs.

Kurzum: Die Autohersteller liefern „perfekte“ (und in der Erstellung sehr teure) Handbücher zu ihren Autos, die jedem Autofahrer ermöglichen, das komplexe technische Gerät „Auto“ zu bedienen und zumindest bei kleinen Problemen selbst Hand anzulegen. Bei einer so großen Zielgruppe gilt: Die Handbücher müssen so technisch wie nötig und so einfach wie möglich gehalten werden.

Das ideale Software-Handbuch

Software-Entwickler haben bei der Erstellung des Handbuchs allerdings einen Vorteil gegenüber Autoherstellern: Sie bedienen in aller Regel keine so breite Zielgruppe. Wer nicht Betriebssysteme oder komplette Office-Suiten entwickelt, muss auch nicht auf eine breite Zielgruppe hinarbeiten, was die Erstellung einer Benutzerdokumentation deutlich erleichtert.

Jeder Benutzerdoku-Erstellung sollte dennoch zunächst eine Zielgruppen-Analyse vorangehen: Smartphone-Spiele besitzen eine völlig andere Zielgruppe als zum Beispiel spezialisierte Videoschnitt-Lösungen. Große Programme benötigen natürlich eine umfangreichere Dokumentation als kleine Apps.

Read the fucking manual!

Nun ist es gerade bei Softwareprodukten im Consumer-Bereich oft Konsens, das Handbuch links liegen zu lassen und bei Problemen Google und Foren zu bemühen oder im Kollegen- und Bekanntenkreis jemanden zu fragen, der sich auskennt. Gibt es hier keine Hilfe, wendet sich der User an den Software-Support.

Auf Seiten des Entwicklers bedeutet dies natürlich Zeitaufwand und verursacht je nach Größe des Projekts auch Kosten für eine Support-Abteilung oder ein Callcenter. Um diese Kosten abzufangen, sind Software-Entwickler im schnelllebigen Consumer-Markt in den vergangenen Jahren dazu übergegangen, die Benutzerdokumentation immer stiefkindlicher zu behandeln und stattdessen Online-FAQs oder gleiche E-Mail-Support anzubieten.

Eine gut gemachte Benutzerdoku kann – selbst, wenn sie nur online oder als PDF geliefert wird – viel Last im Support-Bereich abfangen. Von daher bietet es sich an, Usern im Programm selbst Hilfestellung zu geben und per Link in einen Online-Supportbereich mit Anleitung und Hilfe-Dokument weiterzuleiten und so das Handbuch sozusagen auf dem Silbertablett zu servieren. Allerdings gibt es inhaltlich einige Regeln zu beachten:

1. Informationen ansprechend aufbereiten

Das Ziel einer Benutzerdokumentation ist es, den Leser dazu zu bringen, sich essentielle Funktionen selbst beizubringen und sich im Fall eines Problems möglichst selbst helfen zu können. Informationen sollten von daher möglichst übersichtlich angeboten werden. Dabei helfen zum Beispiel ein Index oder eine intelligente Suche. Die online in Knowledge-Bases oftmals angebotene semantische Suche muss allerdings ausgeklügelt genug sein, um auch Varianten eines Suchbegriffs sowie der Fragestellung zu berücksichtigen, damit der User die Antwort auf seine Frage auch findet.

2. Relevanz vs. Informationsgehalt

Wichtig ist, dass der User mit der Benutzerdokumentation auf seinem Niveau abgeholt wird. Die Zielgruppenanalyse kann wichtige Hinweise auf die Ansprache und den Inhalt geben. So mögen zahlreiche technische Hintergrundinfos für Software-Ingenieure interessant sein; ist die Zielgruppe aber nicht technisch versiert, was bei Consumer-Software eher die Regel als die Ausnahme ist, sollte diese Art überflüssiger Information vermieden werden. Die Information in der Benutzerdoku sollte für die gegebene Zielgruppe relevant sein.

3. Didaktisch vorgehen

Bei der Erstellung einer Benutzerdokumentation sollten die Informationen vom Großen zum Kleinen gegliedert werden. Das bedeutet, dass wichtige, alle User betreffende Informationen möglichst weit vorne stehen sollten. Mit Hilfe von Querverlinkungen in Form von Hyperlinks oder Seitenverweisen kann dann in tiefergehende Bereiche verwiesen werden. Grundsätzlich sollte die Logik einer Benutzerdokumentation der Vorstellung eines Baumes folgen.

Der Stamm ist das, was alle User sehen, etwa die Benutzeroberfläche. Einzelne Äste zeigen die einzelnen Funktionen, die Zweige bilden Detailinfos ab. Der Vorteil dieser Vorgehensweise: Wie bei einem Baum kann eine ausufernde und teure „Verästelung“ leicht gekappt werden, ohne dass an der Essenz des Handbuchs etwas verändert werden muss. Kurzum: Eine gute Anleitung sollte sprichwörtlich vom Hölzchen aufs Stöckchen kommen, ohne jedes Blatt einzeln zu beschreiben.

4. Auf das Wording achten

Bei der Erstellung einer Benutzerdokumentation ist die Wortwahl natürlich wichtig. Wer beim User zu viele technische Begriffe voraussetzt, ohne diese zu erklären oder gar eigene Bezeichnungen für gängige Elemente und Funktionen einführt, wird mit seiner Benutzerdoku unnötig Verwirrung stiften. Hinzu kommt, dass die Zielgruppe möglicherweise andere Begriffe verwendet als der Software-Entwickler, da hier ein anderer Jargon üblich ist. Dementsprechend sollten solche Begrifflichkeiten vorab geklärt werden.

5. Für Aktualität sorgen

Eine Benutzerdokumentation ist natürlich nur so gut, wie ihre Aktualität: Mit jedem größeren Update sollte auch die Benutzerdokumentation überarbeitet werden: Entfernte Funktionen müssen gestrichen, neue Funktionen eingepflegt werden. Das schließt neben Text auch grafische Elemente ein. Als gutes Beispiel für diese Vorgehensweise dient hier Apple: Mit jeder größeren Software-Version werden auch die Handbücher aktualisiert und können vom User heruntergeladen werden. (https://support.apple.com/de_DE/manuals)

6. Kurz fassen

Wie bei allen sachlichen Text-Dokumenten gilt: So viel wie nötig, so wenig wie möglich. Schließlich schreiben Sie keinen Roman. Jedes zusätzliche Wort kann Verwirrung stiften und kostet den User Lebenszeit. Gleichzeitig sollten Inhalte aber so abgefasst sein, dass sie nicht, siehe Punkt 4, Begrifflichkeiten voraussetzen, die der Anwender nicht kennt. Je größer die Zielgruppe, desto kleiner ist dieser Pool an Begriffen. Deshalb kann es sinnvoll sein, technische Begrifflichkeiten durch einen zusätzlichen Appendix zu erklären, um sie nicht in jedem Punkt des Handbuchs erneut aufgreifen zu müssen.

7. Dummy-Test durchführen

Nach Abschluss der Erstellung einer Benutzerdokumentation sollte ein sogenannter „Dummy-Test“ durchgeführt werden. Dazu wird die Software samt Handbuch an einen Nutzer aus der gegebenen Zielgruppe weitergegeben, der mit der Software keine Vorkenntnisse hat. Dieser sollte sich mit Hilfe der Benutzerdoku selbstständig und ohne Rückfragen in die Software einarbeiten können. Treten unterwegs Fragen auf, sollten diese in „spezifisch“ und „relevant“ klassifiziert werden: Relevante Fragen sollten in der Dokumentation geklärt werden, bei spezifischen Fragen kann hingegen der Support weiterhelfen.

(ID:45900427)