Neuer ISO-Standard für Software-Dokumentationen

Anschließend muss der Autor der Dokumentation erheben, was genau die Nutzer mit der Software anfangen. Falls sie noch im Entwicklungsstadium ist, muss er überlegen, welche Aufgaben welche Gruppe von Nutzern wahrscheinlich damit erledigen wird. Auf Grundlage all dieser Erhebungen richtet sich dann das Design der Dokumentation.

Umfangreiche Qualitätskontrollen

Im Anschluss beginnt dann die eigentliche Arbeit, die Texte und Grafiken für die Dokumentation zu erstellen. Qualitätskontrolle spielt dabei eine große Rolle. So soll ein Vorgehen zur Evaluierung der Dokumentation ausgearbeitet werden. Dabei müssen die unterschiedlichen Sichtweisen der Beteiligten berücksichtigt werden: Die Entwickler sehen die Software durch eine andere Brille als Anwender oder das Management.

Vorgesehen sind des weiteren Verfahren zur inhaltlichen Überprüfung der Dokumentation. Sie sollte nach verschiedenen Kriterien überprüft werden: Ist sie technisch korrekt, werden Sicherheitsbelange genügend berücksichtigt, ist sie leicht zu verstehen, ist sie in sich schlüssig, fehlt nichts, entspricht sie den gültigen Rechtsvorschriften? Wer an einer Durchsicht anhand dieser Kriterien beteiligt werden soll und wie sie abzulaufen hat, sollten der Autor und der Projektmanager gemeinsam festlegen.

Tests parallel zur Anwendungsentwicklung

Als nächster Schritt folgt dann ein Test der Dokumentation in Verbindung mit der Software. Er ist Aufgabe des Teams, das die Dokumentation erstellt. Laut ISO sollte die Dokumentation in jeder Phase der Anwendungsentwicklung getestet werden, sofern die Software zum jeweiligen Zeitpunkt verfügbar ist. Dabei stehen Fragen im Mittelpunkt wie: Stimmen die Querverweise? Wird in bestimmten Situationen die richtige Information angezeigt? Haben die Anweisungen in der Dokumentation den gewünschten Erfolg?

Als letztes Testverfahren ist schließlich ein Benutzerfreundlichkeitstest mit den späteren Anwendern der Dokumentation vorgesehen. Er ist laut ISO die am meisten anerkannte Methode um festzustellen, ob die in der Dokumentation enthaltene Information wirklich das ist, was die Nutzer brauchen.