Ohne Normen geht in vielen Branchen und Berufen gar nichts. Oft sind sie so allgemein gehalten, dass es schwierig ist, für konkrete Aufgaben einen Nutzen aus ihnen zu ziehen. Die Aussagen der Norm müssen interpretiert und im Detail mit Leben gefüllt werden. Umso erfreulicher, wenn es einmal ganz anders ist und eine Norm sehr konkret wird.

Die Anfang 2022 erschienene ISO/IEC/IEEE 26514 „Systems and software engineering – Design and development of information for users“ ist eine wahre Fundgrube für alle, die sich mit der Anwenderdokumentation für Software beschäftigen. Von dieser Norm profitieren insbesondere Redakteure, die erstmalig mit Software-Dokumentation betraut sind, und Software-Entwickler, die eher sporadisch mit Anwenderinformationen in Berührung kommen. Erfahrene technische Redakteure werden an vielen Stellen – hoffentlich – vor allem bestätigt bekommen, dass ihr Vorgehen sinnvoll ist. Für sie ist es nützlich, dass zu verschiedenen Themen die wesentlichen Aspekte übersichtlich zusammengetragen wurden. Das hilft, den Fokus immer wieder nachzuführen oder auch einmal ganz neu einzustellen.

Prozess- und ergebnisorientiert

Die Norm geht auf die besondere Situation beim Arbeiten an der Mensch-Maschinen-Schnittstelle ein. Die Anwenderinformationen werden auf dem gleichen Display angezeigt, auf dem auch Meldungen erscheinen und Informationen eingegeben werden. Hier wird die Frage beantwortet, wann und wie Anwenderinformationen sinnvoll vermittelt werden. Auch Besonderheiten der Anzeigen durch die Software (statisch, dynamisch) werden betrachtet. An vielen Stellen verweist die Norm auf die IEC/IEEE 82079 und holt so die „Hausnorm“ der technischen Dokumentation ins Boot.

In Kapitel 4 führt die Norm aus, wie Konformität zur Norm erreicht wird. Dabei geht es einerseits um die Prozessqualität (conformance to processes), andererseits um die Ergebnisqualität (conformance of information products). Das erschließt beispielsweise Möglichkeiten, die Anforderungen der Norm zum Vertragsgegenstand zu machen.

Im Weiteren widmet sich die Norm dem Prozess der Informationserstellung, nennt wesentliche Prozessschritte und zeigt auf, wie man die Entwicklung der Anwenderinformationen mit der Entwicklung der Software verzahnt.

Allroundhilfe für Softwaredokumentation

Ein anderer Bereich der Norm widmet sich dem Thema „Information architecture and development“. Hier wird dargelegt, welche Aspekte für die Anwenderdokumentation eine Rolle spielen, wie man an die Informationen kommt und wie man sie in den Prozess integriert. Nicht nur in hochagilen Projekten kommt es darauf an, die Entwicklung der Anwenderdokumentation transparent zu gestalten, sodass sichergestellt ist, dass Änderungen an der Software – soweit zutreffend – auch in der Anwenderdokumentation nachgeführt werden. Auch Übersetzung, Verteilung und Wartung der Dokumentation sind Themen, die in diesem Abschnitt aufgegriffen werden.

Qualität, Struktur und Formate der Anwenderinformationen sind weitere Punkte, denen sich die Norm widmet. „Qualität“ behandelt dabei vor allem die allgemeingültigen Anforderungen an Anwenderinformationen: Korrektheit, Konsistenz, Verständlichkeit, Prägnanz, Minimalismus, Verfügbarkeit. Auch „User-generated Content“ wird besprochen, also Inhalte, die von den Nutzern selbst verfasst und wiederum anderen Nutzern zugänglich gemacht werden. Hier ist dann beispielsweise die Frage zu beantworten, wer den Inhalt sehen darf/soll.

Fazit

Die Norm beantwortet viele Fragen, die auf den ersten Blick naheliegend erscheinen, genauso wie auch die Antworten sehr plausibel sind. Wer mit Software und deren Dokumentation nicht vertraut ist, wird auf viele dieser Fragen allerdings gar nicht kommen bzw. erst im Nachhinein sagen: „Klar, da muss man sich mit beschäftigen.“

Leseempfehlung für alle, die Anwenderinformationen für Software erstellen und pflegen oder die für den Prozess verantwortlich sind, nach dem diese Informationen erstellt werden.