Software-Dokumentation und Messung der Dokumentationsqualitaet

10.02.1995

Franz Lehner, Hanser Verlag, Muenchen 1994, 208 Seiten, 58 Mark

Die Qualitaet einer Software-Dokumentation ist massgeblich fuer die Qualitaet der Software selbst. Diese Erkenntnis ist weniger selbstverstaendlich, als sie klingt.

Zur vollstaendigen und in der Praxis verwertbaren Dokumentation von Programmen gibt es eine Reihe von Methoden. Franz Lehners Handbuch vermittelt erstmals einen Ueberblick ueber die einzelnen Verfahren, Werkzeuge und Techniken. Die Schwerpunkte des Buches liegen entsprechend in der Systematisierung des Dokumentationsbegriffs, dem Vorgehen bei der Dokumentation selbst sowie dem organisatorischen und rechtlichen Umfeld.

Im Anschluss an ein Plaedoyer fuer die Dokumentation als integralen Bestandteil der Softwarequalitaet beschreibt Lehner die einzelnen Schritte eines Dokumentationsprozesses. Als Hilfsmittel und Werkzeuge stellt er PC-gestuetzte Dokumentations- und Projekt- Management-Programme vor und erlaeutert die Schwierigkeiten, verschiedene Programmversionen zu verwalten. Ein eigenes Kapitel widmet der Verfasser den Elementen einer Benutzerdokumentation. Dabei geht es ebenso um die Ermittlung der richtigen Zielgruppe, das Layout und die Gestaltung wie um die Struktur und Gliederung eines Handbuchs.

Um den Leser bei der Beurteilung der Qualitaet von Dokumentationen zu unterstuetzen, fuehrt er vor, wie Verstaendlichkeit und Lesbarkeit bewertet werden koennen, und beschreibt von der "Cloze Procedure" bis zum "Hamburger Verstaendlichkeitskonzept" verschiedene Methoden der Qualitaetspruefung.

Der Titel steht fast konkurrenzlos in den Regalen der Buchhaendler. Zielgruppe sind Programmierer, die sich ueber die Moeglichkeiten der Softwaredokumentation informieren wollen, und Auftraggeber, die bei der Festlegung des Leistungsumfangs eines Software-Auftrags keine Fehler machen moechten.