Normen nicht nur für die Softwarewelt: ISO/IEC/IEEE 2651x Reihe
Prof. Sissi Closs, Hochschule Karlsruhe – Technik und Wirtschaft, C-Topic Consulting GmbH
Im Hinblick auf Standardisierung hat die Softwarewelt eine eigene Geschichte. Anders als beispielsweise im Maschinenbau oder in der Medizintechnik gab es lange Zeit keine speziellen Vorgaben oder Normen für die Dokumentation von Software. Das hat sich geändert, als 2008 mit der ISO/IEC 26514 die erste Norm der ISO/IEC/IEEE 2651x Normenreihe für Softwaredokumentation erschien. Im Laufe der Jahre wurde die Reihe weitergeführt. Sie besteht heute aus fünf Normen, die allerdings nach wie vor wenig oder gar nicht bekannt sind, auch wenn sie schon mehrfach beschrieben und präsentiert wurden.
Vortragsfolien und Artikel:
- Closs, Sissi (2018): Immer der Reihe nach; technische kommunikation 03/18
- Closs, Sissi (2017): Neuigkeiten von den Normen für die Software-Doku; tekom- Jahrestagung 2017; zu den Folien
- Closs, Sissi (2016): Normen nicht nur für die Software-Doku: ISO/IEC/IEEE 2651x Reihe; Vortrag tekom-Jahrestagung 2016; zu den Folien
- Grünwied, Gertrud (2013): Ein vielfältiges Spektrum; technische kommunikation, 03/13, S. 22-25
- Reilly, Annette (2013): Standards 101; Intercom; Ausgabe November/December 2013, S. 28-29
- Reilly, Annette (2016): Standards for software documentation
- Schmeling, Roland; Gocke, Andrea (2013): Software-Dokumentation – Anforderungen, Normen, Wirklichkeit; Vortrag tekom Jahrestagung 2013
Die Normen im Überblick
Die Normenreihe für die Dokumentation von Software ist mit ihrem 2651x-Nummernkreis in die „Systems and software engineering“-Normen eingegliedert. Das Ziel der Normenreihe ist, die Erstellung einheitlicher, vollständiger, sachlich richtiger, aktueller und gebrauchstaugliche User Assistance zu unterstützen. Die Normenreihe betont bewusst eine prozessorientierte Sicht. User Assistance ist nicht nur ein Endprodukt zum Abschluss eines Software Release, sondern begleitet den gesamten Lebenszyklus eines Produkts.
Jede Norm dieser Reihe adressiert einen speziellen Aspekt im Informationsentwicklungsprozess mit den jeweils zugehörigen Rollen, Aufgaben und Anforderungen. Generell beziehen sich alle 2651x-Normen schwerpunktmäßig auf Informationsprodukte für Anwender von Software. Die Besonderheiten von Informationsprodukten für andere Zielgruppen und Zwecke wie beispielsweise Entwicklung, Projektverwaltung und Schulung sind nicht berücksichtigt. Eine Übersicht der Normenreihe zeigt folgende Tabelle.
Tabelle 1 zeigt die Normen der ISO/IEC/IEEE 2651x-Reihe im Überblick:
| ISO/IEC/IEEE Norm | Untertitel | Primäre Zielgruppe | Kurzbeschreibung Inhalt |
| 26511 | Requirements for managers of information for users of systems, software, and services | Personen in Leitungsfunktionen, Manager | Gibt einen Überblick über die einzelnen Phasen des Informationsentwicklungsprozesses aus der Sicht des Managements im Hinblick auf Pflichten, Aufgaben und erwartete Ergebnisse. |
| 26512 | Requirements for acquirers and suppliers of information for users | Personen, die Dokumentationsleistungen einkaufen, und Lieferanten | Enthält Vorgaben und Regelungen für die Zusammenarbeit zwischen Auftraggebern und Lieferanten. |
| 26513 | Requirements for testers and reviewers of information for users | Prüferinnen/Prüfer und Gutachterinnen/Gutachter | Beschreibt die Anforderungen für das Prüfen und für Usability-Tests von Informationsprodukten im Rahmen der Qualitätssicherung. |
| 26514 | Requirements for designers and developers of user documentation | Informationsentwicklerinnen/Informationsentwickler, Technische Redakteure | Enthält sowohl einen Standardisierungsansatz für den Informationsentwicklungsprozess, als auch Vorgaben für die Informationsprodukte, die im Rahmen des Softwarelebenszyklus erstellt werden. |
| 26515 | Developing information for users in an agile environment | Personen, die in agilen Umgebungen arbeiten | Beschreibt Anforderungen an die Erstellung und Verwaltung von Informationen in einer agilen Entwicklungsumgebung. |
Verwandte Standards
Die Normenreihe fasst vorhandene Standards für die Softwaredokumentation zusammen und bringt sie mit Standards für die Softwareentwicklung in Zusammenhang.
Tabelle 2 zeigt verwandte Standards, auf denen die Normenreihe aufbaut:
| IEEE 1063-2001 | Standard for the design and preparation of user documentation |
| ISO/IEC 18019:2004 | Software and system engineering – Guidelines for the design and preparation of user documentation for application software |
| ISO/IEC 12207:2008 | System and software engineering – Software life cycle processes |
| ISO/IEC 15288:2008 | System and software engineering – System life cycle processes |
Für wen sind die Normen interessant?
Auch wenn die Normen deklarieren, dass sie sich auf die Softwarewelt beziehen, behandeln sie Themen, die durchaus auch die Informationsentwicklung in anderen Bereichen betreffen. Die Normen können daher auch nützlich sein, wenn es nicht oder nicht nur um Software und nicht nur um User Assistance für Anwender geht.
Kenntnis und Berücksichtigung der Normen sind daher allen zu empfehlen, die mit Informationsentwicklung in irgendeiner Weise zu tun haben bzw. damit in Berührung kommen. Den Stellen, die mit der Informationsentwicklung betraut sind, geben die Normen Orientierung und Argumentationshilfen und verhelfen ihnen zu einem besseren Stand im Unternehmen. Für das Unternehmen unterstützen die Normen die Zusammenarbeit mit anderen Unternehmen, helfen, Verbesserungspotenzial zu identifizieren und bilden die Grundlage für die Qualitätssicherung und das Vertragswesen.
Wo können Sie die Normen beziehen?
Die Normen sind derzeit alle nur in englischer Sprache erhältlich und kostenpflichtig. Sie können direkt bei den Standardisierungsorganisationen ISO und IEEE sowie über den Beuth-Verlag gekauft werden. Vorwort und Einleitung der Normen sind auf der Webseite www.iso.org einsehbar.
Aktueller Stand der Normungsarbeit
Alle Normen werden im 5-Jahres-Rythmus regelmäßig überprüft und gegebenenfalls überarbeitet. Die Hauptnorm 26514 wird zurzeit überarbeitet. Alle anderen Normen der Reihe wurden bereits überarbeitet.
Überarbeitete Versionen
Die neuen Versionen der Normen 26511, 26512, 26513 und 26515 sind veröffentlicht.
Vom Buch zur „Information for Users“
Um den ursprünglich auf Bücher und Print-Ausgabe ausgerichteten Ansatz schrittweise zu reformieren, wird als erstes die Terminologie für die komplette Normenreihe kritisch geprüft und angepasst. Bei dem aktuellen Überarbeitungszyklus stand die Bezeichnung „documentation“ im Fokus. Da sie historisch bedingt weitgehend mit buchartigen und gedruckten Werken assoziiert wird, wurde für die neuen Versionen der Normen die offenere Bezeichnung „information for users“ gewählt. Damit ist der erste Schritt getan, andere Arten von Nutzerinformationen als Bücher zu berücksichtigen.
Beteiligte Standardisierungsorganisationen
| Abkürzung | Beschreibung |
| IEC | International Electrotechnical Commission |
| IEEE | Institute of Electrical and Electronics Engineers |
| ISO | International Organization for Standardization Entwickelt internationale Normen für alle Bereiche außer Elektrotechnik und Elektronik (IEC) und Telekommunikation (ITU). |
Weiterentwicklung
Erfreulicherweise unterstützt die tekom die Normenarbeit mit dem Beirat für Recht und Normen. Besonders vielversprechend ist die Koordinierung durch die promovierte Volljuristin und Betriebswirtin, Dr. Claudia Klumpp. Sie vertritt die Interessen der tekom in zahlreichen Normungsgremien auf nationaler und internationaler Ebene und arbeitet an der Überarbeitung der ISO/IEC 82079-1 (Preparation of instructions for use -- Structuring, content and presentation -- Part 1: General principles and detailed requirements) und der ISO/IEC/IEEE 2651x-Normenreihe mit. So könnten die Softwarenormen und die ISO/IEC 82079-1 nach und nach angepasst und widerspruchsfrei gemacht werden. Wünschenswert sind Verbesserungen in mehreren Bereichen, in denen sich Schwachstellen zeigen:
- Generell orientieren sich die Normen immer noch zu stark an dem Buch- und Print-Modell für Informationsprodukte. Topic-basierte Strukturen, in die Software bzw. ins Produkt integrierte Informationen und digitale Medien sind noch zu wenig berücksichtigt.
- Es gibt erhebliche Redundanzen und Inkonsistenzen zwischen den einzelnen Normen sowie zwischen diesen und anderen Normen. Insbesondere müssten die Softwarenormen und die zentrale Norm ISO/IEC 82079-1 aufeinander abgestimmt werden.
- Die Terminologie ist teilweise veraltet und inkonsistent.
Wo spielen die Standards eine Rolle?
Im Zuge wachsender Digitalisierung und Vernetzung gewinnt die Normenreihe ISO/IEC/IEEE 2651x für Softwaredokumentation einen immer größeren Stellenwert. Steuerung und Kontrolle von Geräten, Prozessen und Menschen werden immer mehr von Software beeinflusst und teilweise sogar komplett übernommen. Damit spielen die Sicherheit für Menschen und Dinge, Gebrauchstauglichkeit, Rationalisierung und Kompatibilität auch bei der Information über Software eine immer größere Rolle, was wiederum verlässlich überprüfbare Qualitätskriterien erfordert. Einheitliche Regelungen und Standards sind dafür eine wesentliche Voraussetzung.
Des Weiteren sind die Normen der Reihe ISO/IEC/IEEE 2651x nicht nur für die Softwarebranche tauglich. Sie sind wertvolle Regelwerke für jede Art von Informationsentwicklung, da ihre prozessorientierte Ausrichtung und die Berücksichtigung von agilen Verfahren den heutigen Vorgehensweisen bei der Produkt- und Informationsentwicklung entsprechen. Darüber hinaus liefern sie durch die spezifische Ansprache der unterschiedlichen Akteure im Entwicklungsprozess wie Autoren, Projektleitung, Qualitätssicherung etc. Regeln, die fokussiert auf die jeweilige Rolle zu deren Aufgaben passen.
Die Norm 26511 adressiert Personen in Leitungsfunktionen, die für die Informationsentwicklung zuständig sind. Sie behandelt die Managementaufgaben in allen Phasen des Entwicklungsprozesses. Dazu gehören:
- Bedarfsanalyse
- Konzeption einer umfassenden Content-Strategie
- Zusammenstellung passender Teams
- Festlegung von Bearbeitungszyklen und -plänen
- Leitung und Koordinierung der Qualitätssicherung
- Leitung und Koordinierung der Übersetzung in unterschiedliche Sprachen
- Leitung und Koordinierung der Publikation und Produktion der gewünschten Informationsprodukte
- Marktbeobachtung
- Betriebswirtschaftliche Auswertungen
In der überarbeiteten Fassung aus dem Jahr 2018 wird die Bedeutung der Content-Strategie noch mehr betont. Sie spielt eine zentrale Rolle, da sie Auswirkung auf die ganze Organisation, die Produkte und die Kunden hat.
Weiterhin wird das Thema Compliance noch mehr hervorgehoben, das auch für Leitungspersonen im Informationsentwicklungsprozess ein wichtiges Thema ist, bei dem sie intensiv mit der Produktentwicklung zusammenarbeiten müssen. Dieser Aspekt ist besonders interessant für Bereiche mit hohen regulatorischen Anforderungen wie beispielsweise die Medizintechnik.
Sehr hilfreich sind die Anhänge, insbesondere Anhang B mit einem exemplarischen Projektplan für die Informationsentwicklung und Anhang C mit einem Plan für das Übersetzungsmanagement.
Die 2011 erstmalig erschienene Norm 26512 enthält Vorgaben und Regelungen für die Zusammenarbeit zwischen Auftraggebern und Lieferanten von Softwaredokumentation. Sie richtet sich an Personen, die Dokumentationsdienstleistungen einkaufen, und an Dienstleister, die solche Services anbieten. Die überarbeitete Version wurde 2018 veröffentlicht. Neben der angesprochenen Terminologieänderung wurden nur die Struktur der Norm 26512 geringfügig überarbeitet und die Literaturliste aktualisiert.
Die Norm betrachtet Dokumentationsdienstleistungen als wichtige Elemente im Produktlebenszyklus und legt Regeln sowohl für die Einbeziehung als auch für die Erbringung fest. Diese Regeln dienen dazu, die Zusammenarbeit zwischen auftraggebender Seite und auftragnehmender Seite zu strukturieren. Beide Seiten werden parallel betrachtet und gleichwertig berücksichtigt.
Die Norm gibt darüber hinaus Hilfestellung, was auf beiden Seiten für erfolgreiche gemeinsame Projekte von Anfang an berücksichtigt werden muss. Sehr hilfreich sind die Anhänge der Norm, ein Anhang mit Checklisten für die auftraggebende Seite und einer für die Lieferantenseite. Beide Anhänge enthalten nützliche Anforderungen, deren konsequente Berücksichtigung eine gute Basis für einen transparenten, problemfreien Ablauf von Informationsentwicklungsprojekten darstellt. Es ist festgelegt, welche Dinge von auftraggebender Seite geklärt und geliefert werden müssen und wie sich die auftragnehmende Seite zu verhalten hat.
Für Auftraggeber ist diese Norm eine große Stütze, insbesondere, wenn es noch keine Erfahrung mit dem Einkauf von Dokumentationsdienstleistungen gibt. So deklariert die Norm die Notwendigkeit, die Anforderungen an die zu erstellenden Nutzerinformationen nach vorgegebenen Richtlinien transparent zu spezifizieren.
Auch für die auftragnehmende Seite ist die Norm ein gutes Regelwerk. Sie kann sich einerseits darauf berufen, was sie von der auftraggebenden Seite zu bekommen hat und anderseits erhält sie klare Vorgaben, was sie zu leisten und zu liefern hat.
Die Anforderungen für die auftragnehmende Seite besagen beispielsweise, dass sie jederzeit ihre Arbeit nachvollziehbar dem Auftraggeber darstellen können muss. Und für beide Seiten gilt die wichtige Anforderung, dass Änderungen an den ursprünglich vereinbarten Konditionen frühzeitig und offen kommuniziert werden müssen.
Hervorzuheben ist, dass die Norm nicht nur anwendbar ist, wenn Auftraggeber und Auftragnehmer unterschiedliche Firmen sind, sondern durchaus auch innerhalb einer Firma, wenn es sich bei auftraggebender und auftragnehmender Seite um unterschiedliche Abteilungen im selben Unternehmen handelt.
Was generell für die Normenreihe ISO/IEC/IEEE 2651x gilt, gilt im Besonderen für die Norm 26512. Wenn es darum geht, die Zusammenarbeit zwischen auftraggebender und auftragnehmender Seite für Informationsentwicklungsprojekte zu regeln, ist sie in allen Bereichen brauchbar, nicht nur im Bereich Software.
Die 2011 erschienene Norm 26513 beschreibt die Anforderungen für die Qualitätssicherung von Informationsprodukten und richtet sich an Reviewer und Usability-Tester.
Diese Norm unterstützt diejenigen, die an Tests und Reviews von Nutzerinformationen im Kontext von Software und Systementwicklung beteiligt sind. Die Norm fokussiert den Bedarf der Nutzer, brauchbare, vollständige, konsistente und korrekte Informationen über Software und Systeme zu erhalten. Ein wichtiges Augenmerk liegt auf der Notwendigkeit, Informationsprodukte mit echten Nutzern während des Entwicklungszyklus zu testen.
Die überarbeitete Version ist bereits 2017 erschienen. Neben der Änderung von „documentation“ auf „information for users“ und den erweiterten Literaturhinweisen lag der Schwerpunkt bei der Überarbeitung auf Evaluierungsstrategien und Methoden. Dazu gibt es erweiterte Abschnitte über Systemtests, Usability-Tests, Überprüfung der Barrierefreiheit von Benutzerinformationen sowie Tests und Reviews von Übersetzung und Lokalisierung. Die beste Neuerung ist der neue Anhang mit Richtlinien für benutzerzentrierte Tests und Reviews. Die Richtlinien empfehlen entsprechend den minimalistischen Prinzipien Handlungsorientierung, Berücksichtigung realer Aufgaben, Eingehen auf Fehlererkennung und -behebung und effizienten Zugang als Testkriterien für Informationsprodukte. Die entsprechend diesen Prinzipien aufgeteilten ca. 70 Qualitätskriterien sind wertvolle Hilfestellung für eine qualitativ hochwertige und umfassende Qualitätssicherung von Informationsprodukten.
► Bartell, Sandy und Klumpp, Claudia: Softwarenorm gibt Nutzertest vor; technische kommunikation 02/17
26514, die ursprüngliche Hauptnorm der Reihe, besteht aus einer Reihe inhaltlicher Kapitel und Anhängen:
- User documentation process within the system/software life cycle
- Project requirements, objectives, and constraints
- Analysis and design
- Development and review
- Production
- Structure of documentation
- Information content of user documentation
- Presentation format of documentation
- Annex A: User documentation style guide content
- Annex B: Writing style and techniques for user documentation
- Annex C: User documentation style for translation and localization
- Annex D: Design, development, and production of printed documentation
- Annex E: Checklists for user documentation
- Annex F: Requirements clauses and checklist for the documentation process
- Annex G: Requirements clauses and checklist for the documentation products
Die Norm befasst sich auf ca. 150 Seiten im Wesentlichen mit Themen des verständlichen Schreibens und der Gestaltung von Print-Produkten. Die Fülle der Themen deutet bereits darauf hin, dass jedes einzelne Thema sehr kurz abgehandelt wird. Nur für die Gestaltungsrichtlinien werden 30 Seiten spendiert. Alle anderen Kapitel füllen jeweils maximal 10 Seiten. Softwarespezifische Aspekte wie Installation, Konfiguration, Personalisierung, Änderungsinformationen, Programmschnittstellen werden hingegen nicht angesprochen. Auch auf die Vielfalt der möglichen Zielgruppen geht die Norm in keiner Weise ein. Daher ist die Norm 26514 in der aktuellen Fassung noch kein willkommenes Regelwerk. Die Überarbeitung wurde Ende 2018 aufgenommen und wird bis ca. 2021 dauern.
► Closs, Sissi (2009): Der neue ISO-Standard für Software-Dokumentation (ISO/IEC 26514); Vortrag tekom-Jahrestagung 2009
Diese Norm fokussiert Aspekte der Informationsentwicklung in einer agilen Projektumgebung. Die Norm geht nicht auf eine spezielle agile Methode ein, sondern thematisiert Aspekte, die generell in einem agilen Umfeld von Bedeutung sind. Dazu gehören:
- User Stories zu Ermittlung der relevanten Informationen
- Verwaltungsinstrumente wie Backlogs für die Aufgaben
- Planung und Durchführung der Aufgaben in kleinen Einheiten wie Sprints
- Enge Zusammenarbeit mit der Entwicklung
- Organisation der Informationsentwicklung mit dem Entwicklungsprozess
Die Norm betont auch, dass die Informationsentwicklung vielfältige Aufgaben in einem agilen Team übernehmen kann. Dazu gehören neben der Entwicklung der „Information for Users“ die Durchführung von Tests, das Erarbeiten von Feedback, die Mitarbeit beim Design der User Experience und die Schulung der Team-Mitglieder.
► Stazi, Alessandro; Gocke, Andrea; Closs, Sissi (2019): A common misunderstanding “agile does not need documentation”
Prof. Sissi Closs
Sissi Closs, Expertin für Topic-orientierte Strukturierung und DITA, ist seit 1997 Professorin für Informations- und Medientechnik an der Hochschule Karlsruhe – Technik und Wirtschaft.
Außerdem ist sie seit dem Verkauf Ihrer Comet-Firmengruppe mit C-Topic Consulting als Beraterin für Informationsarchitektur tätig.
Bei der tekom engagiert sie sich in vielen Bereichen, zum Beispiel im Beirat für Normen, im Redaktionsbeirat der ‚technischen kommunikation‘, im European Academic Colloquium Review Board, sowie als Referentin, Autorin und Prüferin.