1. Einleitung

Die Notwendigkeit einer speziellen Dokumentation für den Anwender/Benutzer eines Computerprogrammes ist unbestritten. Die Dokumentation wird unter vielfältigen Begriffen wie z.B. Bedienungsanleitung, Handbuch/Manual, Anwenderdokumentation, Online-Hilfe etc. angeboten.

In diesem Beitrag werden die Anforderungskriterien dargestellt, die ein Handbuch - mit Betonung auf Buch - zu einem sinnvoll zu verwendenden Dokumentationsmittel für das einzusetzende Anwendungsprogrammsystem machen. Das Handbuch ist somit ein wichtiges Arbeits- und Hilfsmittel, das dem Benutzer den Umgang mit dem Programm ermöglicht.

Dokumentationen, die außerhalb des Einfluß- und Einsatzbereiches des Anwenders liegen wie z.B. die gesamte technische Dokumentation des Softwaresystems werden hier nicht betrachtet.

2. Sinn und Zweck des Anwenderhandbuches

Das Handbuch soll den Benutzer in die Lage versetzen:

• das erworbene Programm auf seinem Computer einzusetzen
• den Leistungsumfang des Programmes zu erkennen und zu verstehen
• die Funktionalitäten des Programmes richtig und sinnvoll anzuwenden
• Ausnahmesituationen möglichst selbständig zu lösen.

• richtig sein, d.h. es muß das eingesetzte Programm richtig dokumentieren
• vollständig sein, d.h. alle Funktionalitäten, die für den Anwender wesentlich sind,  müssen beschrieben sein
• übersichtlich sein, d.h.  brauchbar, handlich und  handhabbar sein
• verständlich sein, d.h. verständlich für einen Anwender, der sich meistens auf kein spezielles EDV-Fachwissen stützen kann.

3. Anforderungskriterien

3.1 Richtigkeit

Die Aussage ‘Das Handbuch muß richtig sein’ ist die elementare Voraussetzung für einen sinnvollen Einsatz eines Handbuches. Die übrigen Kriterien machen nur Sinn, wenn diese Grundvoraussetzung erfüllt ist.

Richtig ist ein Handbuch, wenn es genau das Programm dokumentiert, das der Anwender in seinem Computersystem einsetzt. D.h. das Handbuch muß eindeutig dem eingesetzten Programm zuzuordnen sein und es muß die Funktionalitäten des eingesetzten Programms richtig dokumentieren.

Haupt-Kriterien für die Richtigkeit eines Handbuches sind also:

• die eindeutige Zuordnung des Handbuches zum Programm bzw. zur Programmversion
• die programmkonforme Darstellung der Benutzeroberfläche (Masken, Maskenfolgen, Funktions- und Feldbezeichnungen, Feldinhalte etc.)
• die fachlich/sachliche Richtigkeit bei der Beschreibung der Funktionen, eingesetzten Grundlagen, Methoden, Formeln etc.
• die sprachliche Richtigkeit (Orthographie, Grammatik, Ausdruck)

3.2 Vollständigkeit

Das Handbuch ist dann vollständig, wenn es beschreibt, wie der Anwender das Programm auf seinem Computer installieren und die angebotenen Funktionen sinnvoll benutzen kann und wie er auf dabei auftretende Fehler und Ausnahmesituationen reagieren muß bzw. wie er sie beheben oder vermeiden kann.

Hauptkriterien für die Beurteilung der Vollständigkeit eines Handbuches sind also:

• eine ausreichende Installationsanweisung, d.h. System-Voraussetzungen, technische Beschreibungsmerkmale zum Programm, Vorgehensweise, benutzerspezifische Anpassung des Programms (Customizing),
• die komplette Beschreibung des Programm-Aufbaus, aller Programm-Funktionalitäten und deren Benutzung
• ausführliche Beschreibung und Erklärung der Fehlermöglichkeiten, der entsprechenden Fehlermeldungen sowie deren Vermeidung bzw. Behebung
• Datensicherung, Daten-Reorganisation
• Verhalten in Ausnahmesituationen
• Hinweise auf Unterstützung seitens des Programmherstellers/-lieferanten

3.3 Übersichtlichkeit

Die Übersichtlichkeit trägt wesentlich zur Akzeptanz des Handbuchs und damit letztlich auch zur Akzeptanz des Programms bei. Ein richtiges und vollständiges Handbuch nützt dem Anwender nicht viel, wenn er die benötigten Informationen nur mühsam und umständlich mit erheblichem Zeitaufwand finden kann.

Die Übersichtlichkeit des Handbuches wird im Wesentlichen festgelegt durch:

• den Aufbau und die Gliederung, die beide der Struktur des Programmes und der durch den Anwender zu bewältigenden Aufgabe gerecht werden sollen
• Orientierungshilfen zum schnellen Auffinden von Programm-Elementen auf allen Ebenen (Struktur, Funktion, Teilfunktion, Einzelaufgabe, Feld, Feldinhalt) sowie zur Beantwortung von Fragen und Problemen mit Hinweisen auf Musterfälle usw.
• Format, Form und äußere Gestaltung, wobei hier vorrangig die optische Gestaltung, die Handhabbarkeit und damit auch die Handlichkeit gemeint sind.

3.4 Verständlichkeit

Verständlichkeit ist dann gegeben, wenn der Benutzer die richtig und vollständig und auch in übersichtlicher Form dargestellten Informationen des Handbuches auch verstehen kann.

Da der individuelle subjektive Vorgang des Verstehens von vielen Faktoren abhängt, werden hier nur solche Kriterien aufgeführt, die zu einem leichteren Verständnis beitragen können. Das sind im Wesentlichen:

• die fachliche Aufgabenstellung des Programms und der entsprechende Sachverstand des Handbuchverfassers
• Sprache und Sprachstil des Handbuchverfassers
• sinnvolle Verwendung von grafischen Darstellungen in Verbindung mit den textlichen Darstellungen (eine Grafik sagt mehr als tausend Worte!) z.B. für Folgen von Arbeitschritten und Masken, Funktionen und Teilfunktionen, Pull-Down-Menues etc.
• Bezug zu den verfügbaren Bildschirmmasken (Imago-Darstellung)
• aufgabenbezogene Darstellung
• Anwendungsbeispiele
• Form und Gestaltung (siehe auch Kap. Übersichtlichkeit)

Detaillierter Kriterienkatalog 

1. Richtigkeit 

1.1 Zuordnung zum Programm (= Handbuch-Identifizierung):

• Programmbezeichnung
• Programm-Identififaktions-Nr.
• Programm-Versions-Nr.
• Programm-Freigabe-Datum
• ggfs. Lizenz-Nr., Vertrags-Nr. etc.
• Handbuch-Versions-Nr.
• Handbuch-Erstell-Datum
• Handbuch-Letztes-Änderungsdatum
• Handbuch-Versions-Protokoll (Change Log)

• des Programmaufbaus
• der Programmfunktionen
• der Maskenfolge
• der Einzelmasken
• der Maskenfunktionen, -teilfunktionen
• der Feldbezeichnungen
• der möglichen Feldinhalte
• der benutzbaren Parameter
• der Listen, Reports, Statistiken etc.

• der Funktionen
• der verwendeten Grundlagen
• der eingesetzten Methoden
• von Formeln etc.

• Rechtschreibung
• Grammatik
• Ausdruck

2. Vollständigkeit 

2.1 Installationsbeschreibung

• Auflistung der gelieferten Unterlagen
• Systemvoraussetzungen (Hardware/Software)
• technische Beschreibungsmerkmale des Programms
• Installationsprozedur
• Standard und Sonderformen
• Erklärung der Installations-Parameter, deren Zusammenhänge
• typische Systemverhaltenskennzahlen
• Optimierungsvorschläge
• benutzerspezifische Anpassungen
• Registrations- und Garantieunterlagen

• Sinn, Zweck, Aufgabenstellung und Einsatzgebiet des Programms
• Programmaufbau
• Hauptfunktionen des Programms
• Menue-Struktur (Funktionsablauf)
• logischer Programmablauf zur jeweiligen (Einzel-)Aufgabe
• Beschreibung der Einzelfunktionen
• zugrundeliegende Vorschriften
• sonstige Grundlagen
• theoretische Grundlagen
• Berechnungsmethoden
• Formeln
• funktionale Parameter und deren Wirkungsweise
• verwendete Normen und Normierungen (z.B. Ergonomie, Tastenbelegung (Short Keys), GUI = Graphical User Interface = Standard-Masken-Layout)
• Befehls-Kurz-Übersicht (Reference Card)
• Musteranwendungen
• Tips und Tricks (Expert-Modus)

• Listen der Fehlermeldungen
• Erläuterung jeder einzelnen Fehlermeldung
• Hinweise auf zu ergreifende Maßnahmen
• Hinweise auf die Vermeidung von Fehlern

• Hinweise: wann, wie oft, in welchem Umfang, mit welcher Methode, mit welchen Funktionen bzw. (speziellen) Programmen etc.

• Systemabbruch
• Neustart (Kalt-, Warmstart)
• Abweichungen zwischen erwartetem und tatsächlichem Ergebnis

• Kontaktadresse für den Benutzer
• Hotline
• Helpdesk
• Schulung, Training, Benutzerforum, Internet etc.
• Garantie etc.

3.1 Aufbau und Gliederung
 (zum Gesamtumfang siehe auch Kapitel Vollständigkeit)

• Einführung
• Kurzbeschreibung des Programms

- Aufgabe
- Aufbau, Module, Funktionen
- Zusammenhang der Module
- Kurzbeschreibung der Module
• Beschreibung je Modul

- Funktionen und deren Zusammenhang
- Arbeitsweise je Funktion /Teilfunktion
• Bearbeitungshinweise

- je Funktion, Teilfunktion, Maske, Feld
•  Bearbeitungsleitfaden je Aufgabe (Screen-Navigation)
• Verweise auf Muster- und Beispielfälle
• Sonderfälle und Ausnahmen
• Auflistung von nicht-machbaren Aufgaben
• Anhang (technische Informationen, verwendete Konventionen, Normen etc.)

• Inhaltsverzeichnis (einheitlich und übergreifend)
• Stichwortverzeichnis:

 - alphabetisch
 - funktional geordnet
 - Hervorhebung von Basisfundstellen
 - Verweis auf Musterfälle/-beispiele
• Glossar (Verzeichnis der Abkürzungen  und Fachausdrücke)
• Querverweise im Text
• Hinweise im Text auf Nachbarthemen
• separate Schnell-Information = Befehls-Kurz-Übersicht (Reference Card)

• Normales Buchformat (ca. 23 x 16 cm)
• kein Folianten- oder Lexikonformat
• durchgehende Seitennumerierung
• Registereinteilung (Griff- und/oder Farbregister)
• handbuch-einheitliche Seitenaufteilung

- Kapitel-/Abschnittshinweis im Seitenkopf
- geregelte Schrift-Font-Verwendung
- Randbemerkungen
- Fußzeilen
- deutlich erkennbare Querverweise
• Einsatz von Farbe als Organisationshilfe

4.1 Fachlicher Inhalt des Programms

• Qualifikation des Handbuchautors

- Sachkenntnis
- Erfahrung
- Darstellungsfähigkeit

• Deutschsprachig (EG: jeweilig gültige Nationalsprache)
• Satzaufbau, Wortwahl etc.
• einheitlich durchgängige Begrifflichkeit
• Vermeidung von Fremdwörtern bzw. sofortige Erklärung oder Hinweis auf Glossar
• Vermeidung von nichtgängigen Abkürzungen

• Kombination von Text und Grafik
• grafische Darstellung für zeitliche und/oder sachliche Arbeitssequenzen
• Maskendarstellungen in der Form, wie der Benutzer sie tatsächlich auch sieht, auch farbig (Imago-Darstellung)
• Masken, Funktionen und Teilfunktion als grafische Einzelschrittdarstellung
• Aufgabenbezogene Darstellung
• Anwendungsbeispiele

- Beschreibung des Beispiel-Scenarios
- Ausdruck der Masken je Einzelschritt

4.4 Formale Gestaltungsmerkmale
 (siehe auch Kap. Übersichtlichkeit)