Das Benutzerhandbuch ist das “Handbuch”, in dem die Bedienung der Software für die Nutzer beschrieben ist. Es enthält alle Informationen, die einem Nutzer helfen, das Produkt sicher und bestimmungsgemäß zu verwenden.

Der Begriff “Handbuch” drückt außerdem aus, dass es ein qualitätsgesichertes Ergebnisdokument der Produktentwicklung ist. Alternative bzw. eng verwandte Begriffe sind Benutzerdokumentation, Bedienungsanleitung oder Manual.

Die wichtigsten Kriterien für den Inhalt eines Benutzerhandbuchs sind:

Die Aussage ‘Das Benutzerhandbuch muss richtig sein’ ist die elementare Voraussetzung für seinen sinnvollen Einsatz. Die übrigen Kriterien machen nur Sinn, wenn diese Grundvoraussetzung erfüllt ist. Richtig ist ein Benutzerhandbuch, wenn es alle für den Nutzer sichtbaren Masken, Maskenfolgen, Funktions- und Feldbezeichnungen, Feldinhalte, etc. korrekt darstellt und deren Verwendung beschreibt. Sprachliche Richtigkeit (Orthographie, Grammatik, Ausdruck) der Texte wird in allen verfügbaren Sprachen vorausgesetzt.

Vollständig ist ein Benutzerhandbuch, wenn es alle vorbereitenden Aufgaben (z.B. Installieren, Ausführen, Anmelden) erklärt und alle fachlichen Abläufe aus Sicht des Nutzers beschreibt. Dazu gehört auch eine angemessene Beschreibung und Erklärung der Fehlermöglichkeiten, der entsprechenden Fehlermeldungen sowie deren Vermeidung bzw. Behebung.

Eine klare, übersichtliche Darstellung der Inhalte trägt wesentlich zur Akzeptanz des Benutzerhandbuches und damit letztlich auch zur Akzeptanz des Produktes bei. Ein richtiges und vollständiges Benutzerhandbuch nützt einem Nutzer nicht viel, wenn er die benötigten Informationen nur mühsam und umständlich mit erheblichem Zeitaufwand finden kann. Die Wahl des richtigen Mediums und die Navigation hat großen Einfluß auf die Übersichtlichkeit. Kontext-sensitive Hilfe und ein online verfügbares Benutzerhandbuch machen es den Nutzer leicht, die notwendige Information schnell zu finden.

Ein Benutzerhandbuch ist dann verständlich, wenn der Nutzer die richtig und vollständig und auch in übersichtlicher Form dargestellten Inhalte gut versteht. Die Beschreibungen orientieren sich dabei an der Sachkenntnis der Nutzer in ihren unterschiedlichen Rollen. Schrittweise Erklärungen (englisch: guided tour) und Praxisbeispiele ergänzend zu den meist abstrakten Beschreibungen im Benutzerhandbuch tragen viel zur Verständlichkeit bei. Ein gutes Benutzerhandbuch hat ein Glossar mit Erklärung der Fachbegriffe.

Form und der Inhalt sind abhängig vom Produkt, vom Unternehmen und vom Land. Oft bestimmt der Gesetzgeber, wie und in welcher Art ein Benutzerhandbuch bereitgestellt werden muss. Die Inhalte eine Benutzerhandbuches orientieren sich an den für Nutzer sichtbaren Teilen des Systems. In den meisten Fällen ist das die Benutzeroberfläche.


Wikipedia: Benutzerdokumentation

Die Benutzerdokumentation dient dazu, dem Benutzer die Anwendung des Programms zu erklären. Zur Benutzerdokumentation gehören heute zusätzlich:

  • Kontext-sensitive Hilfe an jeder Stelle des Programmablaufs.
  • Online-Version eines gedruckten Benutzerhandbuchs auf der lokalen Festplatte, mit Hyperlinks und direktem Verweis auf einzelne Fundstellen aus der Hilfefunktion heraus.
  • Aktualisierte Informationen auf der Website der Entwickler.
  • Guided Tour durch die Benutzerführung als erster Einstieg.
  • Agenten und Assistenten, die als regelbasiertes System durch gezielte Fragen an den Benutzer bei der Lösung komplexer Probleme helfen.

Auf eine für die zu erwartenden Benutzer verständliche Sprache ist besonders zu achten.


Wikipedia: user guide

A user guide or user’s guide, also commonly known as a manual, is a technical communication document intended to give assistance to people using a particular system. It is usually written by a technical writer, although user guides are written by programmers, product or project managers, or other technical staff, particularly in smaller companies.

User guides are most commonly associated with electronic goods, computer hardware and software.

Most user guides contain both a written guide and the associated images. In the case of computer applications, it is usual to include screenshots of the human-machine interface(s), and hardware manuals often include clear, simplified diagrams. The language used is matched to the intended audience, with jargon kept to a minimum or explained thoroughly.