Mindestanforderungen an eine Benutzerdokumentation sind eine Installationsanleitung, eine Übersicht über den Aufbau des Programms sowie die Darstellung des Programmeinstiegs und der Behandlung von Fehlern. Diese Angaben sind entweder in gedruckter Form oder als gesonderte Datei für jedermann ausdruckbar bereitzustellen.

Die Dokumentation ist jeweils dann anzupassen, wenn Änderungen bei der Anwendung der Software erforderlich sind, die für einen durchschnittlich befähigten Nutzer der Zielgruppe nicht unmittelbar aus der Software heraus verständlich sind. Bei Programmen, die ständig weiterentwickelt werden, genügt eine etwa jährliche Aktualisierung.

Der nachfolgend abgedruckte Vorschlag eines Kriterienkatalogs fasst das Ergebnis der bisherigen Arbeit zusammen.

1. Richtigkeit

a) Identifizierende Angaben
  • Programmbezeichnung
  • Programmversions-Nr.
  • ggf. Lizenz-Nr., Vertrags-Nr.
  • Handbuch-Versions-Nr.
    • b) Programmkonforme Darstellung

  • des Programmaufbaus
  • der Programmfunktionen
  • der Feldbezeichnungen
  • der möglichen Feldinhalte

    • 2. Vollständigkeit

    a) Installationsbeschreibung

  • Auflistung der gelieferten Unterlagen
  • Systemvoraussetzungen (Hardware/Software)
  • Qualifikation des Anwenders
  • Sicherheitshinweise
  • technische Beschreibungsmerkmale des Programms
  • Installationshinweise
  • Standard und Sonderformen
  • Erklärung der Installationsparameter
  • typische Systemverhaltenskennzahlen
  • Optimierungsvorschläge
  • benutzerspezifische Anpassungen
  • Registrations- und Garantieunterlagen
    • b) Beschreibung der Programm-Funktionalitäten

  • Aufgabenstellung und Einsatzgebiet des Programms
  • Menüstruktur (Funktionsablauf)
  • Programmablauf der jeweiligen (Einzel-)Aufgaben
  • zugrundeliegende Normen und Konventionen
  • Grundlagen und Berechnungsmethoden
  • Befehls-Kurz-Übersicht (Reference Card)
  • Musterbeispiele für Standardaufgaben
  • Tips und Tricks (Experten-Modus)
    • c) Benutzer-Daten

  • Struktur
  • Speicherung
    • d) Verhalten in Ausnahmesituationen

  • Erläuterung jeder einzelnen Fehlermeldung
  • Hinweise auf zu ergreifende Maßnahmen
  • Maßnahmen bei Abweichungen zwischen erwartetem und tatsächlichen Ergebnis
    • e) Unterstützung durch den Programmlieferanten/-hersteller

  • Kontaktadresse für den Benutzer
  • Hotline, soweit vorhanden

    • 3. Übersichtlichkeit/ Verständlichkeit

    a) Zielgruppenbezug

  • Fachkenntnisse
  • Allgemeinbildung
  • Erwartungsschemata und Wahrnehmungsfilter
    • b) Aufbau

  • produktorientiert (Reihenfolge der Funktionen) / benutzerorientiert (nach typischem Arbeitsablauf)
  • übersichtliche hierarchische Gliederung
  • Informationsmenge jeweils nach mentaler Verarbeitungskapazität
    • c) Orientierungshilfen

  • strukturiertes Inhaltsverzeichnis
  • alphabetisches Stichwortverzeichnis
  • ggf. Glossar (Verzeichnis der Abkürzungen und Fachausdrücke)
    • d) Textverständlichkeit

  • jeweilige Landessprache
  • sprachliche Richtigkeit
    • e) Wortwahl

  • einheitlich durchgängige Begrifflichkeit
  • Vermeidung oder sofortige Erklärung von Fremdwörtern
  • Vermeidung nichtgängiger Worte und Abkürzungen
  • genormte Signalwörter bei Warnungen
  • Satzkonstruktion
  • kurze vollständige Sätze
  • Voranstellung der wesentlichen Aussage
  • unterschiedlicher Sprachstil für beschreibende und handlungsorientierte Teile
    • g) Motivationssteuerung

  • optische Trennung von Haupt- und Zusatzinformation (Leseführung)
  • Textabschnitt mit jeweils vollständigen Informationen im Hinblick auf Quereinsteiger
    • h) Bildgestaltung

  • Verwendung von Standardfarben
  • Lokalisierung und Identifizierung durch Bildaussagen
  • realistische Maskendarstellung mit konkreter Blicklenkung
  • Vormach-/Nachmachtechnik für Handlungsanweisungen
    • i) Typographie und Layout

  • Text/Bild-Zuordnung
  • gebräuchliche Schrifttypen und -größen
  • erkennbare Schriftgradunterschiede
  • optimale Zeilenlänge und -abstände
  • Buchformat mit Bindung zweckmäßig