Langer Titel und viel dahinter: Die DIN EN IEC/IEEE 82079-1:2021-09 (VDE 0039-1:2021-09) „Erstellung von Nutzungsinformationen (Gebrauchsanleitungen) für Produkte – Teil 1: Grundsätze und allgemeine Anforderungen“ könnte man fast schon als Bibel der Technischen Redaktion betiteln.

Schwester (oder Bruder?) dieser Norm stellt die Norm ISO/IEC/IEEE 26514:2022-01 „System- und Software-Engineering – Design und Entwicklung von Informationen für Anwender“ dar, welche ähnliche Inhalte, jedoch gemünzt auf die Softwarebranche bietet.

Möchtest du eine Softwaredokumentation erstellen, schaust du ziemlich wahrscheinlich vorab erst einmal in diese beiden Normen. Was finden sich dort für überschneidende Inhalte? Diese:

Inhalt

Umfang

Beide Normen geben einen umfassenden Überblick über die verschiedenen Parameter eines Informationsprodukts. Der Normumfang der 26514 umfasst:

  • Struktur
  • Inhalt
  • Format
  • Gestaltungsempfehlungen
  • Single-Source Ansatz (softwarespezifisch)

Die 26514 unterstreicht die Argumente der Horizontalnorm 82079-1 und hebt die drei wesentlichen Aspekte guter Nutzerinformationen hervor:

  • Zielgruppen- und Tätigkeitsanalyse
  • Zielgruppenzentrierte Informationskonzepte,
  • Prüfung und Gewährleistung herausragender Informationsqualität

Aspekte, die wir besonders gerne in der 26514 lesen und hervorheben:

„Die Entwicklung von Informationskonzepten gehört nach vorne in den Softwareentwicklungsprozess. D.h. sie läuft parallel zur Entstehung des Produktes“

Softwaredokumentation, so sehen auch wir das, ist definitiv nicht das „notwendige Übel“ sondern Marktvorteil für dein digitales Produkt.

Je später du mit der Entwicklung von Nutzerinformationen beginnst, desto schwieriger wird es, diese nutzerfreundlich zu integrieren. Ein Großteil der kleinen, grundlegenden Informationshäppchen gehört als Microcopy (UX-Writing) bereits ins Produkt, so nah an die anwendende Person, wie eben möglich. Als Tooltipps, Label-Text oder schlicht Button-Text.

Steht erstmal das Design und sind „Standardtexte“ gesetzt. Werden Gespräche über Anpassungen oftmals zäh.

Prozesse

Zudem werden die Schritte einer Informationsentwicklung definiert, die sich auch von der technikorientierten Technischen Dokumentation (Technik, Maschinenbau etc.) nachvollziehen und eben auch nachempfinden lassen:

  1. Identifizierung Projektziele
  2. Analyse Projektumfang
  3. Zielgruppe berücksichtigen
  4. Beschreiben der Topics
  5. Reuse-Strategie spezifizieren
  6. Barrierefreiheit inkludieren
  7. Nutzbarkeit erörtern
  8. Übersetzung und Lokalisierung berücksichtigen
  9. Projektleistungen spezifizieren
  10.  Anforderungen an Tools identifizieren
  11.  Qualitäts- und Testkriterien aufstellen
  12.  Informationsentwicklung terminieren
  13.  Kosten- und Zeitaufwand ermitteln
  14.  Risikoanalyse und Risikominderung
  15.  Team erstellen

Der Projektumfang wird Schritt für Schritt definiert. Diese Planungsaufgabe überschneidet sich in der Technischen als auch der Software-Dokumentation. Fortgeschrittenen Technischen Redaktionen und großen Redaktionsteams in komplexen Softwaresystemwelten mag das vorkommen, wie ein alter Schuh. Den vielen einzelkämpfenden in der Welt digitaler Produkte hingegen, können speziell diese Inhalte wunderbar anschieben und damit den Arbeitsalltag bereichern.

Beschränkungen/Auflagen der Benutzerinformation

Zusätzlich werden Beschränkungen und Auflagen definiert, welche für die digitalen Informationsprodukte zu beachten sind. Diese sind größtenteils ebenso für technikbezogene Informationsprodukte gültig.

  • Copyright
  • Nationale Gesetzgebung
  • Danksagungen
  • Trademarks
  • Lizenzierung
  • Vertragliche Bestimmungen
  • Recht an geistigem Eigentum
  • Garantie und Gewährleistung
  • Berücksichtigung von Vorgängerversionen
  • Eigenständig oder Teil einer Suite
  • Pläne für zukünftige Versionen
  • Standard oder kundenspezifisch
  • Sind Übersetzung, Lokalisation oder kundenspezifische Versionen benötigt
  • Datenschutz
  • Soll das Softwareprodukt zertifiziert/akkreditiert werden?

 Aufgabenprofile

Die Norm thematisiert Aufgabenprofile, bei welchen die anstehenden Tasks analysiert werden durch Fragen:

  • Warum wird eine Tätigkeit ausgeführt?
  • Wie regelmäßig wird diese Tätigkeit durch eine Zielgruppe ausgeführt?
  • Wie geht der Nutzer oder die Nutzerin dabei vor?
  • Ist mit Ablenkungen während der Durchführung zu rechnen?
  • In welcher Reihenfolge wird die Tätigkeit ausgeführt?
  • Gibt es Voraussetzungen, die erfüllt sein müssen?
  • Wie fehleranfällig/fehlertolerant ist der Task? Und folglich: Muss die Reihenfolge zu 100% eingehalten werden?
  • Wie wirkt sich die Erledigung oder Unterlassung der Tätigkeit auf das System aus?
  • Gibt es Folgereaktionen, die nutzende Personen beachten müssen?

Hier geht es besonders um den Nutzungskontext, welcher sich von der Umgebung her sicher stark zwischen Softwareprodukten und beispielsweise der Bedienung einer Maschine unterscheidet. Auch die 82079 betrachtet den Nutzungskontext. Unter anderem auch die Reihenfolge von Tätigkeiten oder Ablenkungen während der Nutzung.

 Informationsbeschaffung

Auch die Informationsbeschaffung hat deckungsgleiche Punkte:

  • Vorbereitete, strukturierte Interviews
  • Gruppeninterviews bieten oft mehr Infos durch den direkten Austausch
    zwischen den teilnehmenden Personen.
  • Analysieren bestehender Informationsprodukte im Softwarelebenszyklus.

Hier wird bewusst auf „weitere Informationen“ in der EN 82079 verwiesen, welche als Leitnorm für die Softwarenorm diente.

Das lässt sich im Übrigen generell festhalten: Auch an anderen Stellen wird ganz wörtlich der Bezug zur EN 82079 ausgesprochen. Ein Informationsentwickler soll die Usability-Anforderungen aus 82079 entnehmen. Dort wird thematisiert, Benutzerfreundlichkeit umfasst Nützlichkeit, Verständnis, Effizienz, Merkfähigkeit, Erkennung und Meldung von Fehlern sowie Kundenzufriedenheit.

Die beiden Normen haben viele Gemeinsamkeiten. Die Hauptgemeinsamkeit ist, dass sie Nutzerinformationen schlichtweg besser machen wollen. Beide Normen gehen auch auf prozessuale und aufgabenspezifische Aspekte ein und werden dabei meist sogar sehr konkret. Sie sind beide eine gute Hilfestellung, wenn man digitale Informationsprodukte erstellen möchte. Es lohnt sich also, in beide Normen reinzuschauen. Auch wenn du nicht umhinkommst, eine konkrete Handlung für die Herausforderungen in deinem Unternehmen daraus abzuleiten. Ein Pauschalrezept für „moderne Softwaredokumentation“ sucht man in beiden Normen vergebens.