Dokumentationen werden nach wie vor als kosten- und zeitintensives, wenn auch notwendiges Übel angesehen. Sie sind erforderlich, damit sich Funktionen eines Programms nach gesetzlichen Vorschriften prüfen lassen oder ein Testat erstellt werden kann. Darüber hinaus soll gewährleistet sein, daß Veränderungen der Software etwa durch Erweiterungen und Korrekturen nicht an Personen gebunden sind.

Eine Programmbeschreibung sollte deshalb nicht als Kostenverursacher, sondern als gewinnbringende Investition betrachtet werden. Immerhin: Je besser das Handbuch, desto leichter lassen sich Bedienungsfehler vermeiden. Andere positive Aspekte, die sich aus einer anwendergerechten Programmbeschreibung ergeben, sind ein geringerer Schulungsaufwand, die Entlastung des Hotline-Service sowie eine leichtere Wartbarkeit des Produkts.

Bevor man mit der Dokumentation beginnt, muß deshalb genau analysiert werden, wen das Handbuch ansprechen will. Demgemäß sind Sprache und Aufmachung adressaten- und nicht produktbezogen zu wählen. Am besten ist es, die Anleitungen von potentiellen Nutzern oder externen Fachleuten erstellen zu lassen, die den Erklärungsbedarf besser erkennen als das Programmierteam, für das alles selbstverständlich erscheinen muß. Auf diese Weise vermeidet man Betriebsblindheit. Als sinnvoll hat sich auch der Einsatz programmtechnischer Hilfen erwiesen, wenn zum Beispiel Funktionen detailliert und nachvollziehbar beschrieben werden müssen.

Ein Kriterium für gute Dokumentationen ist auch, daß sie sich nach nutzerbezogenen Gesichtspunkten richten und nicht unbedingt nach der Logik, die dem Programm als Funktionalität zugrunde liegt. Sollte sich die Beschreibung einer Funktion allzu schwierig gestalten, kann es unter Umständen sinnvoll sein, eine programmtechnische Verbesserung vorzunehmen.

Grundsätzlich empfiehlt sich, nicht an der falschen Stelle zu sparen: An der Qualität einer Darstellung erkennt der Anwender, welche Wertschätzung der Hersteller selbst seinem Programm entgegenbringt.

Die häufigsten Mängel

Die Einstellung, Dokumentationen nur deshalb zu verfassen, weil Sachzwänge dies erfordern, ist völlig fehl am Platz und schlägt sich zwangsläufig in der Qualität nieder. Hier die häufigsten Mängel:

- Texte sind zu kurz und daher außer für Eingeweihte unverständlich.

- Die Beschreibung eines Bildes ist erst durch Umblättern auf der nächsten Seite zu finden.

- Es gibt zu viele Verweise auf andere Kapitel und Seiten.

- Funktionen werden wie in einem Nachschlagewerk ohne Angabe der funktionalen Zusammenhänge sequentiell beschrieben, so daß der Leser kein umfassendes Programmverständnis entwickeln kann.

- Unübliche Eingaben, die programmtechnisch notwendig sind, werden nicht besonders herausgestellt.

- Ungenauigkeiten wie ein fehlender Hinweis auf notwendige Leerzeichen werden nicht erkannt.

- Kürzel des Programms werden in der Beschreibung übernommen.

- Man verwendet einen nur dem Programmierer verständlichen Fachjargon.

- Suchfunktionen werden erschwert, zum Beispiel, weil es einmal "Anforderung zum Druck" und dann "Druckanforderung" heißt.

Klaus Müller ist freier Journalist in Wiesbaden (E-Mail: klaus-mueller-wiesbaden@t-online.de).