Benutzerdokumentation: Definition und Erklärung
Die Benutzerdokumentation ist – ähnlich wie die Anleitung für ein Spiel oder die Aufbauanleitung für ein IKEA-Möbelstück – eine Beschreibung des erstellten Programms, der erstellten Software für den Endbenutzer. Sie erleichtert und erklärt dem Benutzer den Umgang mit der Anwendung. Die Benutzerdokumentation dient dazu, dem Benutzer jede nützliche, aber auch weniger nützliche Anwendung eines Programms zu erklären.
Was gehört zur Benutzerdokumentation?
Zur Benutzerdokumentation (Benutzerhandbücher, Anleitungen, Video-Tutorials) gehören heute:
- Kontextsensitive Hilfe an jeder Stelle des Programmablaufs.
- Online-Version eines gedruckten Benutzerhandbuchs auf der lokalen Festplatte, mit Hyperlinks und direktem Zugriff auf einzelne Referenzen aus der Hilfefunktion.
- Aktuelle Informationen auf der Website des Entwicklers.
- Geführte Tour durch die Benutzeroberfläche als erster Einstieg.
- Agenten und Assistenten, die als regelbasiertes System den Benutzer durch gezielte Fragen bei der Lösung komplexer Probleme unterstützen.
Art, Ansprache, Gestaltung und Umfang der Benutzerdokumentation hängen letztlich von den Präferenzen des Entwicklers und den Bedürfnissen des Anwenders ab. Dennoch gibt es Elemente, die in jeder Benutzerdokumentation enthalten sein sollten:
- Hardware- und Softwarevoraussetzungen, um mögliche Performance- oder Kompatibilitätsprobleme beim Anwender direkt abzufangen.
- Installationsanweisungen, falls erforderlich.
- Erste Schritte: z.B. das Spiel starten oder ein Dokument erstellen.
- Liste der Funktionen der Software.
- Gegebenenfalls Erklärung der Steuerung und der Bedienelemente.
- Typische Fehlermeldungen und deren Behebung.
- Kontaktinformationen für den Fall, dass sich der Nutzer nicht selbst helfen kann.
Die Benutzerdokumentation dient dazu, die Anwendung einfacher und schneller nutzbar zu machen. Eine gute Benutzerdokumentation wird aus der Sicht des Benutzers erstellt. Nur so kann sichergestellt werden, dass die Bedürfnisse des Endbenutzers erfüllt werden. Besonderes Augenmerk ist auf eine für die erwarteten Nutzer verständliche Sprache zu legen.
Software-Benutzerdokumentation
Traditionell wurde einfach ein Handbuch mit der Software geliefert. Das hat sich mit den grafischen Benutzeroberflächen geändert. Sie sollten selbsterklärend sein und intuitiv zur richtigen Bedienung führen. Ein gutes Benutzerhandbuch enthält
- Informationen über die Funktionalität der Software, ihre Eingabedaten und die erzeugten Ergebnisse – aus der Sicht des Anwenders/Benutzers.
- Eine grundlegende Bedienungsanleitung.
- Hinweise zur Fehlerbehebung, Fehleranalyse mit Gegenmaßnahmen.
- Ein Tutorial, in dem einige Übungsaufgaben exemplarisch gelöst werden können und im Idealfall eigenständige Lösungsversuche begleitet und bei Misserfolg aufgelöst werden.
- Frequently Asked Questions (FAQ) in übersichtlicher Form.
- Glossar mit Erläuterungen zu Fachbegriffen.
Die einfachste Art der Benutzerdokumentation ist wahrscheinlich die Erstellung eines einfachen Benutzerhandbuchs in Form einer Online-Dokumentation, einer Wissensdatenbank oder einer FAQ. Der Vorteil dieser Lösung ist, dass die Online-Dokumentation jederzeit aktualisiert werden kann. Wenn z.B. nach einem Update die gleichen Supportanfragen auftauchen, kann der Text entsprechend angepasst werden.
Der Hauptzweck von Benutzerhandbüchern und Dokumentationen besteht darin, die Zeit zu verkürzen, die ein Kunde benötigt, um ein Softwareprodukt zu verstehen. Eine klare, gut gepflegte und organisierte Benutzerdokumentation hilft den Benutzern, das Produkt optimal zu nutzen. Sie ist auch eine Zeitersparnis für das Support-Team, das diese Zeit für die Lösung kritischer Probleme verwenden kann.
