Neuer ISO-Standard für Software-Dokumentationen

Um seine Dokumentation richtig zu konzipieren, muss ihr Ersteller ferner die Rahmenbedingungen für die Dokumentation im speziellen Fall kennen. Dabei muss er zum Beispiel die Frage klären, ob es in einer Organisation Richtlinien für die Dokumentation gibt. Auch rechtliche Bestimmungen sind zu beachten: Datenschutzregelungen ebenso wie sonstige Regelungen des nationalen Rechts im jeweiligen Land.

Anwender muss in 20 Sekunden das Gewünschte finden

Die angestrebte Zahl an verkauften Software-Lizenzen sollte der Entwickler einer Dokumentation ebenfalls kennen. Auch über sonstige Eckdaten muss er im Bilde sein: Wann genau wird eine Software veröffentlicht? Kommt sie weltweit zum gleichen Zeitpunkt auf den Markt? Wie lange vor dem Auslieferungsdatum muss die Dokumentation fertig sein?

Der ISO-Standard mahnt auch Benutzerfreundlichkeit an. Hier werden zum Teil ganz konkrete Kriterien genannt. So gelten Struktur und Navigation einer Dokumentation dann als annehmbar, wenn ein Anwender darin innerhalb von 20 Sekunden die Informationen findet, die er sucht.

Verbindliche Zeitpläne vereinbaren

Um an die entscheidenden Angaben über eine Software-Neuentwicklung zu kommen, rät die Standardisierungs-Organisation den Entwicklern dazu, mit den beteiligten Fachleuten strukturierte Interviews zu führen. Gemeinsam mit Software-Entwicklern und Projektmanagern sollte der Autor der Dokumentation sich auf allgemein verbindliche Zeitpläne verständigen.

Alles bisher Beschriebene sind zunächst nur die Vorarbeiten. Als nächsten Schritt schreibt ISO/IEC 26514:2008 eine Analyse vor. Darin geht es zum Beispiel darum, sich eingehend mit den späteren Lesern auseinanderzusetzen. Der Verfasser der Dokumentation muss wissen, mit welchem Vorwissen er bei den Anwendern rechnen kann, wie gut etwa deren Englischkenntnisse sind, aber auch, wie häufig sie mit der fraglichen Anwendung arbeiten.