Das Benutzerhandbuch für eine Software

Ein effektives Benutzerhandbuch ist mehr als nur eine Ergänzung zur Software. Es ist ein entscheidendes Werkzeug, das den AnwenderInnen den Einstieg in die Software erleichtert. Ähnlich wie die Entwickler-Dokumentation für EntwicklerInnen die zentrale Referenz darstellt, bildet das Benutzerhandbuch für die AnwenderInnen einer Software den Single-Point-of-Truth. Es navigiert die AnwenderInnnen der durch die vielfältigen Aspekte der Software – von grundlegenden Funktionen bis hin zu komplexen Prozessen.

• Das Benutzerhandbuch für eine Software
  • Braucht eine Software überhaupt ein Benutzerhandbuch?
  • Für wen das Benutzerhandbuch geschrieben wird
  • In welchen Formaten ein Benutzerhandbuch verfügbar sein sollte
  • Wie Gliederung und Navigation aussehen sollten
  • Wie die Inhalte eines Benutzerhandbuchs gestaltet sein sollten
    • Präzise Sprache
    • Zielgruppenspezifische Darstellung
    • Verwendung von User Stories
    • Schritt-für-Schritt-Anleitungen
    • Verwendung von Medien
  • Womit man ein Benutzerhandbuch erstellen kann

Braucht eine Software überhaupt ein Benutzerhandbuch?

Die Frage ist berechtigt, denn ähnlich wie bei der Code-Dokumentation kann man bei dem Benutzerhandbuch argumentieren, dass die Nutzeroberfläche der Software möglichst intuitiv und selbsterklärend sein sollte. Im Idealfall wäre ein Benutzerhandbuch dann überflüssig. Zudem kann man viele Hilfestellungen direkt in die Software einbauen, beispielsweise kurze Erklärtexte unter Formular-Feldern, kleine Hilfetexte als Overlays oder auch Onboarding-Features, mit denen neue Nutzer durch die wichtigsten Funktionen der Software geführt werden.

Die Realität sieht allerdings meist anders aus: Onboarding-Features sind zeitlich fixiert und werden häufig übersprungen. Kurze Erklärtexte sind meist auf einzelne Eingabe-Felder oder Micro-Funktionen beschränkt. Zu viele Erklärungen direkt im Nutzerinterface sind außerdem Dauerpräsent und lenken ab. Und gerade die komplexen und erklärungsbedürftigen Zusammenhänge lassen sich über kleine Hilfestellungen nicht ausreichend erläutern. Solche komplexen Zusammenhänge kann es selbst bei vergleichsweise einfacher Software geben, ein Benutzerhandbuch ist daher noch längst kein Hinweis auf mangelnde Intuitivität.

Für wen das Benutzerhandbuch geschrieben wird

Benutzerhandbücher werden für die End-Nutzer einer Software geschrieben, die mit der Nutzeroberfläche arbeiten. Anders als bei Code-Dokumentationen, Entwickler-Dokumentationen, API-Dokumentationen oder Administrations-Handbüchern können bei normalen Nutzern in der Regel keine technischen Kenntnisse vorausgesetzt werden.

Dennoch können sich Vorkenntnisse und Ansprache je nach Ausrichtung und Zielgruppe der Software deutlich unterscheiden. Bei Content-Management-Systemen sind die Nutzer im besten Fall ausgebildete Online-Redakteure. Selbst dann können jedoch keine Vorkenntnisse beispielsweise über SEO-relevante Funktionen wie Umleitungen oder bestimmte Meta-Angaben vorausgesetzt werden. Bei einer Verwaltungssoftware können dagegen umfangreiche fachliche Vorkenntnisse vorausgesetzt werden.

Vor dem Verfassen eines Benutzerhandbuchs ist es daher wie bei allen Texten wichtig, eine gute Zielgruppen-Analyse durchzuführen.

In welchen Formaten ein Benutzerhandbuch verfügbar sein sollte

Benutzer benötigen in ganz unterschiedlichen Situationen Hilfe und Informationen zu einer Software. Daher ist es wichtig, dass das Benutzerhandbuch flexibel ist und möglichst viele Nutzungsvarianten ermöglicht. Bei der Verfügbarkeit und Auslieferung der Informationen sollte es mehrere Optionen geben:

• Online-Version: Ein Benutzerhandbuch für eine Software sollte in erster Linie als Webseite zur Verfügung stehen, damit Nutzer direkten Zugriff auf die Informationen haben und die Informationen beispielsweise verlinkt werden können.
• PDF-Version: Das Benutzerhandbuch sollte zusätzlich im PDF-Format vorliegen, um Nutzern alle Möglichkeiten zu bieten: Herunterladen, speichern, ausdrucken, ablegen, weiterleiten und teilen. Im Idealfall steht das Handbuch auch im ePub-Format zur Verfügung, auch wenn das Format eine eher untergeordnete Rolle spielt.
• API-Version: Im Idealfall sollten die Inhalte des Benutzerhandbuchs über eine API abrufbar sein. Dadurch können die Inhalte des Benutzerhandbuchs zum Beispiel als Online-Hilfe in die Software selbst integriert werden. Eine einfache Verlinkung auf passende Kapitel der Web-Version ist im Zweifelsfall natürlich auch möglich. Die Verlinkung ist jedoch weniger weniger nutzerfreundlich, da der Nutzer die Software zum Lesen der Informationen verlassen muss.

Absehbar ist außerdem, dass die Bereitstellung von Informationen über Chatbots künftig eine große Rolle spielen wird.

Wie Gliederung und Navigation aussehen sollten

Ein gutes Benutzerhandbuch für eine Software sollte der bewährten Praxis von Entwickler-Dokumentationen folgen: Die Gliederung sollte hierarchisch und möglichst flach sein. Eine stetig präsente Seiten-Navigation ermöglicht die Orientierung und macht die Struktur des Handbuchs fassbar. Innerhalb eines Kapitels bzw. einer Seite können zusätzliche Binnen-Navigationen zu einzelnen Überschriften hilfreich sein. Auch Navigations-Elemente zur Seite davor, zur Seite danach und zum übergeordnenten Kapitel sowie klassische Breadcrumbs können die Orientierung erleichtern.

Wenn es mehrere Versionen einer Software gibt, sollte der Nutzer außerdem zwischen den Versionen springen können, möglichst auf jeder Seite zur jeweiligen Version.

Ein Such-Funktion gehört bei Web-Versionen zum Standard. Auch dialogorientierte Chatbots werden in Zukunft natürlich an Bedeutung gewinnen.

Wie die Inhalte eines Benutzerhandbuchs gestaltet sein sollten

Präzise Sprache

Ein Benutzerhandbuch für eine Software sollte mit einer präzisen Sprache verständliche Informationen liefern, die den Anwender bei der Nutzung einer Software unterstützen. Dabei sollte ein technisches Jargon vermieden werden. Spezialisierte Begriffe sollten erklärt werden, um die Zugänglichkeit zu gewährleisten.

Auch in dem Nutzerhandbuch kann man die Vorzüge und Stärken einer Software betonen, allerdings sollte man auf ein klassisches Marketing-Jargon und auf ausschweifende Formulierungen verzichten.

Zielgruppenspezifische Darstellung

In den meisten Fällen hat eine Software unterschiedliche Nutzergruppen. Ein Content-Management-System kann beispielsweise unterschiedliche Rollen und Berechtigungen für Autoren und Redakteure anbieten, wobei der Autor lediglich Schreibrechte für eigene Artikel hat, während der Redakteur alle Artikel ohne Einschränkungen bearbeiten, publizieren und löschen kann.

In so einem Fall ist es wichtig, die Informations-Bedürfnisse jeder Zielgruppe zu analysieren und das Benutzerhandbuch entsprechend zu strukturieren. Im besten Fall baut man die Dokumentation modular auf, sodass allgemeine Informationen, die für alle Nutzergruppen relevant sind, von spezifischen Anleitungen für jede Nutzerrolle getrennt sind. Es kann sinnvoll sein, separate Abschnitte oder Kapitel für jede Nutzergruppe zu erstellen, um es den Nutzern zu erleichtern, die für sie relevanten Informationen zu finden.

Verwendung von User Stories

Grundsätzlich sollte man in einem Benutzerhandbuch viele praktische Beispiele und Szenarien verwenden, die spezifisch auf die Aufgaben und Workflows jeder Nutzergruppe zugeschnitten sind. Für die Identifizierung der Bedürfnisse einer spezifischen Nutzergruppe können User-Stories nützlich sein. Häufig wurden solche User-Stories bereits während der Feature-Entwicklung im Ticket-System geschrieben. Eine User-Story besteht aus einem kurzen Satz und mehreren Akzeptanz-Kriterien. Der Satz beginnt immer mit der Nutzerrolle und einem spezifischen Bedürfnis, das der Nutzer erreichen will. Als Beispiel:

Als Autor möchte ich ein Bild in einen Artikel integrieren, um die visuelle Anziehungskraft zu erhöhen und die Leser länger auf der Seite zu halten.

Eine Sammlung solcher User-Stories gruppiert nach Nutzergruppen und Themen sowie priorisiert nach Wichtigkeit kann die Grundlage einer Dokumentation bilden und der Dokumentation eine erste Struktur geben.

Schritt-für-Schritt-Anleitungen

Schritt-für-Schritt-Anleitungen sind ein zentrales Element von Software-Dokumentationen. Sie ermöglichen Benutzern, komplexe Vorgänge zu verstehen und auszuführen, indem sie die Prozesse in handhabbare, leicht zu folgende Aktionen unterteilen.

Jede Anleitung sollte mit einer eindeutigen Beschreibung des erwarteten Ergebnisses beginnen und, wo nötig, auf mögliche Fehlerquellen oder Variationen im Prozess hinweisen. Die Strukturierung in logische, nachvollziehbare Abschnitte sowie die Einbeziehung von Tipps oder Hinweisen zur Fehlerbehebung können die Effektivität weiter steigern. Schritt-für-Schritt-Anleitungen werden sehr häufig durch relevante Screenshots, Diagramme oder Videos unterstützt.

Verwendung von Medien

Bei der Erstellung von Benutzerhandbüchern für Software sollten verschiedene Medien eingesetzt werden, um den unterschiedlichen Lernstilen und Informationsbedürfnissen der Nutzer gerecht zu werden. Zu den effektivsten Medien gehören:

• Screenshots: Bilder des Bildschirms helfen Nutzern, visuell nachzuvollziehen, was im Text beschrieben wird. Annotierungen und Hervorhebungen können dabei unterstützen, wichtige Bereiche zu betonen.
• Diagramme und Infografiken: Komplexe Informationen oder Abläufe lassen sich oft einfacher durch Diagramme oder Infografiken darstellen. Diese sollten klar beschriftet sein und zum Textinhalt passen.
• Videos: Kurze, zielgerichtete Videos können besonders effektiv sein, um dynamische Prozesse oder komplizierte Schritte zu vermitteln. Videos sollten mit Untertiteln versehen sein, um die Zugänglichkeit zu erhöhen.
• Animierte Gifs: Animierte GIFs bieten eine hervorragende Möglichkeit, kurze Abläufe oder Funktionen schrittweise zu demonstrieren, ohne dass der Nutzer ein Video starten muss. Sie sind besonders nützlich, um auf einfache Weise durch Prozesse zu führen oder die Interaktion mit der Software zu visualisieren. Animierte GIFs sollten klar fokussiert und nicht zu schnell ablaufen, um die Verständlichkeit zu gewährleisten. Zudem sollten sie sparsam eingesetzt werden, da sie, vor allem in großen Mengen, die Ladezeiten der Dokumentation erhöhen und ablenkend wirken können.

Generell gilt, dass alle Medien barrierefrei sein sollten, um Nutzern mit unterschiedlichen Fähigkeiten gerecht zu werden. Dies umfasst lesbare Schriftgrößen, alternative Texte für Bilder und barrierefreie Videoinhalte.

Womit man ein Benutzerhandbuch erstellen kann

Während Entwickler-Dokumentationen sehr häufig mit Static Site-Generatoren oder anderen Entwickler-Tools erstellt werden, haben Content Management Systeme für Benutzerhandbücher zahlreiche Vorteile:

• Redaktionsoberfläche: Im Gegensatz zu Static Site Generatoren verfügen Content Management Systeme über eine Redaktionsoberfläche, sodass auch nicht-technische Redakteure an dem Handbuch arbeiten können.
• Single Source Publishing: Geeignete CMS bieten ein Single Source Publishing an, sodass die Inhalte als HTML, PDF oder in anderen Formaten ausgespielt werden können.
• API-Auslieferung: Geeignete CMS können die Inhalte per API ausspielen, sodass sie zum Beispiel auch in die Software integriert werden können.

Technische Redakteure benutzen häufig spezialisierte Dokumentations-Systeme wie MadcapFlare oder andere Tools, die jedoch schnell komplex und kostspielig werden können. Gerade für kleine Unternehmen kommen daher auch schlanke Open Source CMS wie Typemill in Frage. Typemill wurde für Anwendungen wie Dokumentationen entwickelt und bietet mit dem eBook-Plugin eine zusätzliche Lösung für PDF-Dokumentationen an.