Technische Dokumentation – Fragen und Antworten zur Technischen Dokumentation

Das Prinzip der Verständlichkeit in der IEC/IEEE 82079-1 befasst sich auch mit Methoden zur Navigation und des Mediengebrauches. Hierbei geht es um digitale Anleitungen und wie darin der Benutzer navigieren kann. Um diesen Punkt zu erfüllen, muss der Technische Redakteur anders vorgehen als bei der Papieranleitung. Dabei muss er sich Fragen stellen wie beispielsweise wie sucht meine Zielgruppe nach Informationen? Wie kann ich ihr diese schnell zur Verfügung stellen? Und wie werden diese überhaupt abgerufen? Hat z.B. der Zimmermann ein Smartphone in der Tasche, mit dem er über einen QR-Code auf die digitale Anleitung kommt?

Die IEC/IEEE 82079-1 beschäftigt sich ebenfalls mit der Planung von Dokumentationsprojekten. Der komplette Prozess ist in der neuen Fassung beschrieben. Von der Identifizierung von benötigten Informationen über die Definition der Darstellung von Inhalten und die Entwicklung von Konzepten zur Veröffentlichung der Dokumente.

Mit der Version 2 der IEC/IEEE 82079-1 kam ein eigenes Kapitel dazu, welche sich mit dem Managementprozess von Informationen beschäftigt. Auch sind die in der Vorgängernorm geschaffenen Prinzipien für die Dokumentationserstellung überarbeitet. Was die Anforderungen an Struktur und Inhalte von Dokumenten angeht sind diese zur Vorgängerversion auch stark gewachsen. Auch befasst sich die neue Version nun mit einer Definition von benötigten Qualifikationen zum Verfassen von Nutzungsinformationen.

Der Anwendungsbereich der IEC/IEEE 82079-1 hat sich im Gegensatz zur Vorgängernorm nicht wirklich groß geändert. Der Anwendungsbereich ist nur genauer definiert.

Nun sind nämlich namentlich in der Norm die folgenden Produkte aufgeführt:

• Maschinen und Anlagen
• Medizinprodukte
• Verbraucherprodukte
• Software
• Technische Dienstleistungen

Außerdem soll die Norm auf ein Breite von Medien anwendbar sein wie beispielsweise:

• Serviceinformationen die als PDF verteilt werden
• Online Hilfen einer Software
• Gedruckte Montageanleitungen in der Verpackung eines Verbraucherproduktes
• Funktionsbeschreibungen auf der Medizinprodukteseite eines Herstellers
• Aufkleber auf dem Produkt
• Unterlangen für ein Produkttraining
• Störungsinformationen angezeigt auf Maschinendisplays
• Zum Download bereitgestellte Informationen für einen Sensor
• Tutorials für ein web-based Training

Die Horizontalnorm IEC/IEEE 82079-1 gilt für alle Arten von Produkten, wo Nutzungsinformationen zur sicheren Anwendung des Produktes notwendig sind. Die einzigen Ausnahmen bestehen bei Chemikalien und Arzneimittel. Diese Art von Produkten haben keine übliche Produktlebensphasen wie Transport, Installation, Betrieb, Wartung und Entsorgung.

Die Vorgängernorm der IEC/IEEE 82079-1 war eine IEC-Norm und war daher nur im europäischen Raum gültig. Die 2. Edition der 82079-1 ist eine ISO/IEC/IEEE Norm und daher weltweit gültig.

Die Norm IEC/IEEE 82079-1 macht nur wenige Angaben in Bezug auf die IT-Sicherheit. Die Norm betont die Wichtigkeit bei der Erstellung, Austausch oder Speicherung von Informationen die gängigsten Methoden zum Informationsschutz oder der -sicherheit zu berücksichtigen. Damit ist Verschlüsselung, Datensicherung, Maskierung von Daten und Datenvernichtung gemeint. Zudem verweist die Norm auf die Anwendung der ISO/IEC 27002, welche Empfehlungen für das Informationssicherheitsmanagement gibt.

Falls laut Risikobeurteilung außergewöhnlichen Situationen und Notsituationen auftreten können, fordert die IEC/IEEE 82079-1 folgende Angaben in den Nutzungsinformationen eines Produktes:

• Abfolge von Handlungen, die bei außergewöhnlichen Situationen und Notsituationen auftreten können. Das kann die Unterbrechung der Stromversorgung, Kühlung oder andere Steuerfunktionen sein.
• Angaben zu einem Neustart des Produktes nach einem Eingriff
• Störungsmeldungen und die Lokalisierung von Störungen
• Im Brandfall einzusetzende Brandbekämpfungsgeräte
• Vorhersehbare Emissionen, Lecks und Austritte von Schadstoffen mit Warnhinweisen vor möglichen Gefährdungen und Maßnahmen zur Vermeidung von Schäden
• Erste-Hilfe-Maßnahmen für Erkrankungen, die im Zusammenhang mit der Anwendung des Produktes auftreten können. Das kann ein epileptischer Anfall, Verbrennungen, oder elektrischer Schlag sein. Ebenso gehört ein Hinweis dazu, dass nach den Erste-Hilfe-Maßnahmen eine professionelle medizinische Behandlung aufzusuchen ist.

Die Norm IEC/IEEE 82079-1 verlangt bezüglich einer erlaubtenModifikation am Produkt, dass diese Modifikationen in den Nutzungsinformationen beschrieben sind. Das Produkt muss auch nach Modifikation weiterhin sicher verwendbar bleiben. Verweise auf externe Quellen (Fremddokumentation) sind auch möglich und bieten sich vor allem für umfangreiche Modifikationen an.

Die Norm IEC/IEEE 82079-1 fordert von den Nutzungsinformationen deutliche Hinweise, falls Modifikationen am Produkt nicht zulässig sind. Können durch nachträgliche Modifikationen Gefährdungsstellen entstehen, ist darauf ebenfalls hinzuweisen. Je nach Konsequenz einer Modifikation ist mit einem extra Warnhinweis auf diese Gefährdung hinzuweisen.

IEC/IEEE 82079-1 verlangt, dass falls ein Produkt erneut zu verpacken ist, aufgrund Weiterversand oder Einlagerung, die Anleitung entsprechende Informationen enthält. Dazu gehören unter anderem Angaben zu besonderen Vorkehrungen, die beim erneuten Verpacken zu treffen sind.

Eine Informationsüberladung (Overload) in Abbildungen ist laut IEC/IEEE 82079-1 zu vermeiden. Die Norm schlägt vor, dass Abbildungen nur Informationen enthalten, die zur zugehörigen Beschreibung relevant sind. Bei Bedarf können dann die gleichen Abbildungen in den einzelnen Teilen der Nutzungsinformationen wiederholt vorkommen. Die Redewendung „Weniger ist mehr“ hilft auch beim Gestalten von Abbildungen für die Technische Dokumentation.

Bei Hinweisen zur Beachtung der Anleitung verlangt die IEC/IEEE 82079-1 -, dass das international genormte Gebotszeichen zum Einsatz kommen soll. Gemeint ist das Piktogramm „Anleitung beachten“ nach der ISO 7010. Der Einsatz von Eigenkreationen ist zu vermeiden.

Falls einem Produkt zur Selbstmontage eine Montageanleitung beiliegt, müssen diese Nutzungsinformationen laut der Norm IEC/IEEE 82079-1  erläuternde Informationen beiliegen. Die zu montierenden Komponenten und sonstige benötigte Objekte wie Werkzeuge müssen beschrieben sein. Auch muss die Ausrichtung und Positionierung der zu montierenden Komponenten erläutert sein. Die Handlungsanweisungen sollen als Schritt-für-Schritt-Anleitung aufgeführt sein. Mögliche Sicherheitsvorkehrungen und ggf. Warnhinweise sind aufzuführen, um die Sicherheit der Benutzer zu gewährleisten. Mögliche vorhersehbare und vermeidbare Fehler sind in den Nutzungsinformationen zu beschreiben. Erfordert die Montage besondere Fähigkeiten, müssen die Nutzungsinformationen entsprechend darauf hinweisen. Beispielsweise durch Warnungen wie „Montage nur durch einen qualifizierten Elektriker“ in den Nutzungsinformationen. Auch schlägt die Norm vor, die gegebenen Hinweise in der Anleitung mittels einem Usability-Test zu bewerten, ob diese ausreichend sind.

Die Norm IEC/IEEE 82079-1 fordert, dass die Zielgruppe jederzeit die aktuell gültige Fassung der Nutzungsinformation zur Verfügung gestellt werden können. Daher ist eine Verwaltung und Rückverfolgbarkeit von einzelnen Versionsständen von den Nutzungsinformationen wichtig. Um nachvollziehen zu können, wann welche Version der Nutzungsinformationen an die Endbenutzer gingen.

Die Norm IEC/IEEE 82079-1 schlägt für Warnungen vor Sachschäden die Signalwörter „NOTICE“, „ATTENTION“ oder „TAKE CARE“ vor. In der ANSI Z535.6 ist ebenfalls „NOTICE“ für Warnungen vor Sachschaden aufgeführt. Im deutschen Sprachgebrauch hat sich zudem das übersetzte Signalwort „HINWEIS“ durchgesetzt.

Nutzungsinformationen sollen laut der IEC/IEEE 82079-1 in Abschnitt 8.2 die folgenden Informationsarten enthalten:

• Beschreibende Informationen:
  • Informationen über die Nutzungsinformationen selbst (Über diese Anleitung, Darstellungskonventionen)
  • Identifizierung und Beschreibung des Produktes (Aufbau, Komponenten und Funktionen)
  • Beschreibung von Steuerungen und Anzeigen (Displays, Schalter, Hebel, usw.)
  • Prozessbeschreibung (Anwendungsfälle oder Betriebsarten)
  • Sicherheitshinweise (dabei sind nicht die Warnhinweise gemeint)
• Anweisende Informationen
  • Handlungsanweisungen in Schritt-für-Schritt-Folge (wie Montage-, Installations- oder Wartungsarbeiten)
  • Warnhinweise als Teil der Handlungsanweisungen (zu befolgende Regeln zur Vermeidung von Risiken)
• Referentielle Informationen
  • Titelseite
  • Inhaltsverzeichnis
  • Abbildungs- und Tabellenverzeichnis
  • Glossar
  • Terminologie
  • Fehlerbehebung
  • Ersatzteile

Handlungsanweisungen in Nutzungsinformationen sollen laut der IEC/IEEE 82079-1 in Schritt-für-Schritt-Anleitungen aufgeführt sein. Diese sollen Vorabinformationen enthalten, die einen Überblick über die Handlung geben und evtl. Voraussetzungen nennen. Danach sind Anweisungen in Anleitungsschritten mit arabischen Ziffern zu nummerieren. Warnhinweise sind vor dem jeweiligen Anleitungsschritt anzugeben. Mögliche Zwischenergebnisse sind anzugeben. Das Ende der Handlungsanweisung ist ebenfalls mit zu beschreiben, damit der Nutzer feststellen kann, dass die Handlung abgeschlossen ist.

Die Norm IEC/IEEE 82079-1 verlangt bei Produkten, die Daten oder geistiges Eigentum enthalten, bestimmte Angaben in den Nutzungsinformationen.

• Eigentumsbestimmung zu den gespeicherten Daten, aber auch zu Hard- und Software-Assets
• Beschreibung des Verfahrens zur Aufbewahrung oder Zerstörung der Daten sowie Bestätigungen
• Verantwortlichkeiten in Bezug auf die Löschung/Entsorgung von Daten

Die IEC/IEEE 82079-1 verlangt, dass Nutzungsinformationen auch die Demontage und Entsorgung eines Produktes behandeln. Dabei müssen die Demontagearbeiten beschrieben sein, die unter Berücksichtigung des Umweltschutzes von der Zielgruppe gefahrlos durchführbar sind. Falls Teile des Produkts dem Recycling zuzuführen sind, müssen die Nutzungsinformationen Hinweise im Einklang mit den einschlägigen rechtlichen Anforderungen beinhalten. Auch Informationen zur Entsorgung müssen unter Berücksichtigung der Sicherheit von Personen und des Umweltschutzes zur Verfügung stehen.

Bei der Reparatur eines Produktes fordert die IEC/IEEE 82079-1 genaue Informationen zur Vorgehensweise. Dazu gehören unter anderem:

• Eine Liste mit Anzeigen zur Fehleridentifizierung und –lokalisierung
• Beschreibung von Diagnosesysteme zur Fehlererkennung
• Alarm-Liste mit Hinweise zu Normal- und Grenzwerte
• Vorgehensweise für die Fehlerbehebung und Reparatur
• Kontaktdaten des Inverkehrbringers oder einer anderen Stelle für fachliche Hilfe

Die IEC/IEEE 82079-1 beschreibt folgende Aspekte, was die Beschreibung von Aufgaben hinsichtlich einer bestimmten Zielgruppe angeht:

• Motivation zur Ausführung der Aufgabe (Die Motivation des Nutzers ist zu berücksichtigen, bspw. ob der Nutzer das Produkt nur kurzfristig nutzen will)
• Häufigkeit der Ausführung (Je seltener, desto informativer müssen die Nutzungsinformationen sein)
• Dauer der Aufgabe (Je kürzer die Aufgabe, desto höher die Wahrscheinlichkeit, dass der Benutzer nochmals Informationen zur Aufgabe benötigt)
• Einzel- oder Team-Aufgabe (Klare Informationen darüber, wer was und wann macht)
• Umweltbedingungen (Lichtarme Umgebung, im Freien, ergonomisch ungünstige Haltungen, usw.)
• Fehlertoleranz (Aufgaben, wo die richtige Ausführung sehr bedeutend ist, benötigten genaue Schritt-für-Schritt-Anleitungen)
• Entscheidungsfreiheit (Bevorzugte Herangehensweise beschreiben, wenn mehrere Arten zur Durchführung der Aufgabe möglich sind)
• Voraussetzungen (Benötigte Voraussetzungen für die Durchführung der Aufgabe sind zu beschreiben)
• Üblichkeit der Aufgabe (Spezielle Aufgaben, besonders wenn diese nicht den Gewohnheiten der Nutzer entsprechen, benötigen eine genau Informationsbeschreibung)

Die Norm IEC/IEEE 82079-1 fordert, dass Terminologie auf dem Produkt, seiner Verpackung und den Nutzungsinformationen konsistent und eindeutig sind. Begriffe, welche die Zielgruppe voraussichtlich nicht kennt, gilt es zu vermeiden oder separat zu erläutern.

Komplexe Systeme wie Maschinen und Anlagen weißen häufig Zulieferteile mit eigener Dokumentation auf. Die Zulieferer können eine abweichende Terminologie verwenden.

Dann müssen die eigenen Nutzungsinformationen die Zusammenhänge erläutern. Über eine Liste kann vor der Dokumentation des Zulieferers ein Terminologie-Vergleich der verschiedenen Benennungen erfolgen. Diese Liste nennt dann die Hauptbezeichnung im Dokument und listet auch die Bezeichnung des Zulieferers auf.

Nutzungsinformationen müssen gemäß der IEC/IEEE 82079-1 eindeutig identifizierbar sein. Zur Identifikation eines Dokumentes eignen sich laut der Norm:

• Titel des Dokumentes
• Identifikationsnummer zur Unterscheidung
• Ausstellungsdatum
• Überarbeitungsnummer (Versionsstand) und Ausgabedatum der Überarbeitung
• Eine Kennzeichnung für die Sprachausgabe (bspw. Sprachcode nach ISO 639-2)

Anforderungen an Nutzungsinformationen stellt die IEC/IEEE 82079-1 im Kapitel 5. Für Verbraucherprodukte (B2C) müssen die Anforderungen in den Abschnitten 5.2 und 5.3 erfüllt sein. Diese legen die Anforderungen an Nutzungsinformationen fest. Bei Produkte, die für den gewerblichen Gebrauch (B2B) bestimmt sind, kann der Hersteller wählen. Er entscheidet, ob er die Anforderungen an Nutzungsinformationen erfüllt und/oder ebenfalls die Anforderungen an den Informationsmanagementprozess erfüllt. Der Abschnitt 5.4, Kapitel 6 und Kapitel 10 behandeln die Anforderungen an den Informationsmanagementprozess.

Der Abschnitt 5.2 der IEC/IEEE 82079-1 erläutert allgemeine Prinzipien, die es bezüglich den Anforderungen an Nutzungsinformationen einzuhalten gilt.

• Nutzungsinformationen müssen alle für die Zielgruppe erforderlichen Informationen enthalten für einen sicheren, effizienten und effektiven Gebrauch des Produktes.
• Auch müssen die Nutzungsinformationen leicht und deutlich dem unterstützten Produkt zuordnungsbar sein.
• Die Nutzungsinformationen sind ein Produktbestandteil und müssen die gleiche Aufmerksamkeit und Bedeutung erhalten wie jedes andere Teil des Produktes.
• Für die Zielgruppe des Produktes müssen die Nutzungsinformationen relevant und nutzbar sein für die zu erwartenden Aufgaben und Ziele im Umgang mit dem Produkt.
• Auch müssen die Nutzungsinformationen den sicheren Betrieb und die sichere Instandhaltung des Produktes fördern.

Neben diesen allgemeinen Prinzipien beinhaltet die Norm noch weitere Prinzipien, um die Liste der Anforderungen an Nutzungsinformationen zu vervollständigen. Dabei geht es um einzuhaltende Prinzipien zur Sicherstellung der Informationsqualität der Nutzungsinformationen.

Abschnitt 5.3 der IEC/IEEE 82079-1 behandelt sieben Prinzipien, die zur Sicherstellung der Informationsqualität für hochwertige Nutzungsinformationen stehen. Diese sind:

• Vollständigkeit
• Minimalismus
• Korrektheit
• Prägnanz
• Konsistenz
• Verständlichkeit
• Verfügbarkeit

Als Vollständigkeit sieht die IEC/IEEE 82079-1, dass die Nutzungsinformationen einige Aspekte abdecken müssen, damit diese als vollständig zu sehen ist.

• Bestehende Risiken beim Gebrauch des Produktes
• Alle durchzuführenden und erlaubten Aufgaben von allen Zielgruppen während des Produktlebenszyklus
• Informationsbedarf der Zielgruppe
• Alle rechtlichen Verpflichtungen (auch die vertraglichen Anforderungen) 

Es empfiehlt sich die Abteilungen Forschung, Entwicklung, Konstruktion, Marketing und Vertrieb in die Recherche zur Vollständigkeit einzubeziehen. Auch gilt es hinsichtlich der obigen Punkte zu prüfen, was mit dem Kunden hinsichtlich der Einhaltung der Norm 82079-1 vertraglich vereinbart ist und welche Version einzuhalten ist.

Die IEC/IEEE 82079-1 fordert Nutzungsinformationen minimalistisch zu halten. Keine weitschweifende Erklärungen und Füllwörter, welche die Nutzungsinformationen aufblähen. Auf Redundanzen nach Möglichkeit verzichten. Einzige Ausnahme betrifft die Wiederholung von sicherheitsbezogene Informationen. Diese dürfen laut Norm vorkommen.

Unter dem Prinzip der Korrektheit versteht die IEC/IEEE 82079-1 die Erfordernis, dass die Nutzungsinformationen die neuesten Informationen zum Produkt beinhalten. Das bedeutet, dass immer die aktuellen Nutzungsinformationen dem Kunden zugänglich sein müssen. Durch Produktbeobachtungen und einer Versionierung der Nutzungsinformation kann diese Forderung sichergestellt werden.

Jede Nutzungsinformation muss laut der IEC/IEEE 82079-1 prägnant sein. Die Norm verlangt, dass die Informationen im Hinblick auf Inhalt, Format und Medien prägnant sind. Die Norm erwähnt dabei folgende Aspekte:

• Formulierungen kurz und präzise
• Keine unnötigen Einzelheiten oder Details in Texte und Illustrationen
• Videos beschränken sich auf relevante Inhalte

Im Hinblick auf Inhalt, Darstellung und Medien müssen Nutzungsinformationen laut der IEC/IEEE 82079-1 konsistent sein. Dies bedeutet, dass die Informationen eindeutig und korrekt sind. Zur Erreichung der Konsistenz fordert die Norm dazu auf, dass Inhalte und die Formatierung dieser Inhalte zu trennen sind. Formatierung betrifft Strukturen, Überschriften, Aufzählungen sowie der Einsatz von einheitlicher Farbe in Nutzungsinformationen. Inhaltlich sind Dinge wie Symbole, Warnhinweise, Maßeinheiten oder eine einheitliche Terminologie gemeint.

Verständlichkeit in der IEC/IEEE 82079-1 bedeutet, dass Nutzungsinformationen für die Zielgruppe verständlich sein sollen. Dazu gehören die verwendeten Texte, Terminologie, Illustrationen, Sicherheitszeichen und grafische Symbole sowie Methoden zur Navigation und des Mediengebrauches. Diese Punkte müssen den Nutzungsgewohnheiten, Bildungsniveau sowie den (kulturbedingten) Vorstellungen der Zielgruppe entsprechen.

Bezüglich Verfügbarkeit verlangt die IEC/IEEE 82079-1, dass Nutzungsinformationen während der zu erwartenden Lebensdauer des Produktes für die Zielgruppe verfügbar sind. Dies bedeutet, dass Nutzungsinformationen technische zugänglich bleiben und auch lesbar sind. Um diese Anforderung zu erfüllen, gilt es nachzuprüfen, wie die Zielgruppe mit den Nutzungsinformationen zu dem Produkt umgeht. Im Rahmen der Produktbeobachtung entwickeln sich dann Strategien, wie Nutzungsinformationen verfügbar bleiben.

Ein Informationsmanagementprozess, wie in der IEC/IEEE 82079-1 gefordert, führt zu einem schlüssigen Informationskonzept für die Erstellung der Nutzungsinformationen. Der Informationsmanagementprozess beinhaltet die Beschaffung von Informationen für die Nutzungsinformationen und Festlegungen hinsichtlich Informationserzeugung, -speicherung, -verbreitung und –abruf. Das Konzept legt unter anderem die Art der benötigten Informationen für den Ersteller der Nutzungsinformationen fest. Dazu gehören beispielsweise:

• Risikobeurteilungen
• Zielgruppenanalysen
• Marketingdokumente
• Dokumente zu ähnlichen Produkten (vom Hersteller selbst oder von Mitbewerber)
• Service-Dokumente (zu Reklamationen oder Kundenfragen)
• Informationen aus der Marktbeobachtung ähnlicher Produkte

Der Grund, dass die IEC/IEEE 82079-1 anders heißt als die Vorgängernorm hat mit der Übernahme in nationale Normen zu tun. Die neue Fassung ist bisher nur auf internationaler Ebene ausgearbeitet. Für Deutschland ist das Deutsche Institut für Normung (DIN) zuständig für die nationale Durchführung und Organisation der Normungsarbeit. Auf europäischer Ebene ist das Europäische Komitee für Normung (CEN) und das Europäische Komitee für elektrotechnische Normung (CENELEC) zuständig, um Normen zu etablieren. Erst nach Übernahme auf nationaler und europäischer Ebene trägt die Norm auch die Bezeichnungen DIN und EN.

Auf der internationalen Ebene fand die Überarbeitung in Zusammenarbeit mit den internationalen Normungsinstitutionen ISO (International Organization for Standardization), IEC (International Electrotechnical Commission) und IEEE (Institute of Electrical and Electronics Engineers) statt. Auch wenn die ISO an der Ausarbeitung mitgewirkt hat, haben nur die IEC und IEEE eine Vereinbarung zur gemeinsamen Normungsarbeit. Deswegen trägt die neue Edition der 82079-1 auch nur die Bezeichnungen IEC/IEEE im Namen.

Die IEC/IEEE 82079-1 aus dem Jahr 2019 ist die Nachfolgenorm der DIN EN 82079-1 aus dem Jahre 2013. Im Zuge des für Normen üblichen Prüfungs- und Überarbeitungsintervalls war eine Revision der alten Norm fällig. Im April 2019 erschien dann die neue Fassung mit dem englischen Titel „Preparation of information for use (instructions for use) of products – Part 1: Principles and general requirements“. Als horizontale Norm ist diese Norm für die Erstellung von allen Arten von Anleitungen anwendbar. Die deutsche Fassung der Norm ist für den Herbst 2020 geplant.