Normen der Softwaredokumentation

DIN EN IEC/IEEE 82079-1:2021-09 (VDE 0039-1:2021-09): Was steckt hinter diesem langen Titel?

Die DIN EN IEC/IEEE 82079-1:2021-09 (VDE 0039-1:2021-09) klingt vielleicht kompliziert, aber sie ist im Grunde das Standardwerk für Technische Redakteur:innen. Diese Norm dreht sich darum, wie man Gebrauchsanleitungen für Produkte richtig erstellt.

Gibt es eine Standardnorm für Softwaredokumentation?

Ja, die gibt es! Die ISO/IEC/IEEE 26514:2022-01 ist quasi der Bruder oder die Schwester dieser Norm 82079. Allerdings richtet sie sich speziell an die Softwarebranche.

Warum sind diese Normen wichtig?

Wenn du eine Softwaredokumentation erstellen möchtest, wirst du ziemlich sicher in diese beiden Normen schauen. Aber was haben sie gemeinsam? Lass uns das mal genauer anschauen.

Was umfassen die Normen?

Beide Normen geben dir eine umfassende Anleitung, wie ein Informationsprodukt aussehen sollte. Die Norm 26514 deckt dabei folgende Bereiche ab:

• Struktur
• Inhalt
• Format
• Gestaltung
• Single-Source-Ansatz (speziell für Software)

Was betonen die Normen besonders?

Die 26514 verstärkt die Punkte der 82079-1 und hebt drei wesentliche Aspekte guter Nutzerinformationen hervor:

1. Zielgruppen- und Tätigkeitsanalyse
2. Zielgruppenzentrierte Informationskonzepte
3. Prüfung und Gewährleistung von Informationsqualität

Welche Prozesse werden genannt?

Die Normen definieren auch die Schritte, die bei der Erstellung von Informationsprodukten nötig sind. Diese Schritte ähneln denen, die auch in der Technischen Dokumentation für Maschinen und Technik angewendet werden:

• Projektziele definieren
• Projektumfang analysieren
• Zielgruppe berücksichtigen
• Inhalte (Topics) beschreiben
• Reuse-Strategie spezifizieren
• Barrierefreiheit einbeziehen
• Nutzbarkeit prüfen
• Übersetzung und Lokalisierung einplanen
• Qualitäts- und Testkriterien festlegen
• Kosten und Zeitaufwand ermitteln
• Risikoanalyse durchführen

Warum ist das Timing wichtig?

Eine Aussage, die wir in der 26514 besonders mögen: „Die Entwicklung von Informationskonzepten gehört nach vorne in den Softwareentwicklungsprozess.“ Das bedeutet, dass die Softwaredokumentation nicht als lästiges Anhängsel betrachtet werden sollte, sondern als echter Marktvorteil. Je früher du beginnst, desto besser!

Was passiert, wenn man zu spät anfängt?

Je später du mit der Entwicklung von Nutzerinformationen beginnst, desto schwieriger wird es, sie nutzerfreundlich zu integrieren. Kleine Informationshäppchen sollten bereits im Produkt enthalten sein, wie zum Beispiel Tooltips oder Button-Texte.

Was ist mit den Beschränkungen und Auflagen?

Die Normen definieren auch Beschränkungen und Auflagen, die für digitale Informationsprodukte zu beachten sind, darunter:

• Copyright
• Nationale Gesetzgebung
• Trademarks
• Lizenzierung
• Datenschutz
• Zertifizierung des Softwareprodukts

Wie beschafft man die notwendigen Informationen?

Auch bei der Informationsbeschaffung gibt es Parallelen zwischen den Normen:

• Vorbereitete, strukturierte Interviews
• Gruppeninterviews
• Analyse bestehender Informationsprodukte

Fazit:

Beide Normen haben viel gemeinsam und möchten vor allem eines: Nutzerinformationen besser machen. Sie sind eine große Hilfe, wenn du digitale Informationsprodukte erstellen willst. Ein Pauschalrezept findest du dort allerdings nicht – du musst die Normen auf die spezifischen Herausforderungen in deinem Unternehmen anwenden.