Software-Tipps
Software > Software-Tipps > Softwaredokumentation > Handbuch > Umfang und Vollständigkeit

Umfang und Vollständigkeit


Überprüfen des Handbuchs auf Umfang und Vollständigkeit
Ist das Handbuch umfangreich und vollständig?

Der Umfang des Handbuch sollte dem Funktionsumfang der Software angepasst sein. Bei einem komplexen Warenwirtschaftssystem sind durchaus mehrere Bände eines Handbuchs denkbar. Ein Handbuch muss nicht als Werk konzipiert sein, das vor der Benutzung der Software in Gänze durchgelesen werden muss. Neben der Funktion als Gebrauchsanleitung ist ein Handbuch auch ein Nachschlagewerk, das auch von erfahrenen Benutzern der Software im Bedarfsfalls herangezogen wird. Gut strukturierte Handbücher sind auch noch trotz umfangreichen Inhalten übersichtlich. Wesentliche Bestandteile von Softwarehandbüchern sind z.B.:

  • Inhaltsverzeichnis
  • Installationshinweise und -anleitungen
  • Gebrauchsanleitung der Software
  • Grafiken, Screenshots, Muster
  • Beschreibung der Funktionen und Hintergründe
  • Erläuterungen der Fehlermeldungen und Warnungen
  • Beschreibung der Schnittstellen (technische Einzelheiten z.B. im Anhang)
  • umfangreiche Begriffserklärungen (z.B. Glossar im Anhang)
  • Berechnungsgrundlagen, Erklärung der Formeln, Beispiele
  • Beschreibungen der Datenstrukturen, Tabellen, Datenfelder und Datentypen

Der “ideale Umfang” einer Handbuchs hängt auch von der Art der Software und von den Bedürfnissen und Rollen der Benutzer ab. Bei Programmiersprachen sind z.B. umfangreiche Funktionsverzeichnisse mit syntaktischen Beschreibungen der Parameter, Beispielen und Erklärungen üblich. Für kleinere Anwendungen,1 die nur von einer Benutzergruppe benutzt werden reichen oft einfache Gebrauchsanweisungen.


1 z.B. Fahrtenbuch, Terminplaner, Tools und Utilities