Technische Dokumentation – Fragen und Antworten zur Technischen Dokumentation

Die Norm DIN EN ISO 20607 fordert, dass falls die Maschine nicht vom Hersteller oder unter seiner Verantwortung in Betrieb geht, dass die Betriebsanleitung entsprechende Informationen für die Inbetriebnahme enthält. Dazu gehören Informationen zu besondere Risiken und Gefährdungen sowie die dazu zu treffenden Vorsichtsmaßnahmen. Ebenfalls falls nötig, die Informationen zu besonderen Verfahren für die Inbetriebnahme und welche Werkzeuge und Geräte verlangt sind. Auch Beschreibungen zur Sicherung und Verpackung von Materialien (Bänder, Schutzfolien, usw.), die es zu entfernen gilt, gehören dazu. Verfahren zu Einstellungen, Messungen und Prüfungen sowie Inspektionen vor der Inbetriebnahme der Maschine sind ebenfalls zu erläutern.

Die DIN EN ISO 20607 verlangt, dass die Betriebsanleitung zur Fehlersuche und –behebung von Störungen eine Fehlerliste enthält. Die Liste soll auf einer gewissen Logik basieren und beispielsweise die häufigsten Fehler zuerst nennen. Die Liste ist in Fehlermeldungen, mögliche Ursachen und entsprechende Lösungen aufzuteilen. Falls erforderlich, sollen auch zu Fehlern Anmerkungen oder Vorsichtsmaßnahmen angegeben sein.

Bezüglich Reinigung und/oder Desinfizierung einer Maschine verlangt die DIN EN ISO 20607, dass dem Benutzer Informationen in geeignetem Umfang zur Verfügung stehen. Dazu gehören eine Auflistung von benötigten Werkzeugen und Geräten sowie die Eigenschaften von Reinigungsmitteln. Ebenfalls die Angabe von benötigter persönlicher Schutzausrüstung. Ist eine besondere Betriebsart für die Reinigung und/oder Desinfizierung der Maschine nötig, ist dies ebenfalls in der Betriebsanleitung anzugeben. Weiterhin eine Beschreibung zur Energietrennung, dem Reinigungs- und Desinfektionsverfahren sowie das Verfahren zur Wiederherstellung des Betriebs.

Die DIN EN ISO 20607 fordert in Kapitel 5.2.9 „Inspektion, Prüfung und Instandhaltung“, dass Informationen zu empfohlen Ersatzteilen in der Betriebsanleitung angegeben sind. Dazu gehören die Spezifikationen der Ersatzteile, insbesondere deren Teile, die die Sicherheit der Maschine beeinflussen. Weiterhin müssen laut dem Kapitel alle sicherheitsrelevanten Inspektionen, Prüfungen sowie die Instandhaltung für die gesamte Maschine und deren Zubehör beschrieben sein.

Wichtige Informationen aus Anleitungen von Lieferanten und Zulieferern müssen in die eigene Dokumentation integriert werden. Die DIN EN ISO 20607 sieht dafür zwei Möglichkeiten vor. Entweder werden die Informationen direkt in die eigene Dokumentation übernommen oder die Originalanleitungen werden dem Nutzer zur Verfügung gestellt. Dann genügt ein Verweis auf die entsprechenden Dokumente und Kapitel.

Die DIN EN ISO 20607 lässt dem Redakteur hier entsprechenden Freiraum. Einen einzelnen Lösungsweg gibt es nicht, da der Umfang und die Komplexität des beschriebenen Produktes entsprechend berücksichtigt werden müssen.

In der Anleitung sollten auf jeden Fall die Lebensphasen des Produktes berücksichtigt werden. In der Regel lassen sich hiervon auch bereits die verschiedenen Zielgruppen davon ableiten und berücksichtigen. Je nach Maschine kann dann überlegt werden, ob es sinnvoll ist, die Anleitung in mehrere Dokumente aufzuteilen. Maschinen die zum Beispiel zu Bauwerken werden (z. B. Kraftwerke), werden vermutlich nur einmal transportiert. Entsprechend ist das Kapitel für die weitere Produktlebenszeit irrelevant und als separates Dokument behandelt werden.

Die DIN EN ISO 20607 zeigt anhand einer umfangreichen Liste die Möglichkeiten für die Erstellung einer kurzen und einfachen Betriebsanleitung. Zu den Möglichkeiten und Anforderungen gehören:

• Sprachfreie Anweisungen, die den Text unterstützen (z. B. Bilder mit Pfeilen)
• Kurze und einfache Sätze
• Durchgehende Benennungen und die Vermeidung von Synonymen
• Einsatz von Tabellen oder Aufzählungen
• Einsatz von Diagramme und Grafiken
• Konsistente Verwendung von Begriffen und Einheiten
• Verwendung von aktiver Sprache
• Verwendung von Wiederholungen (falls erforderlich)
• Muss leicht zu übersetzen sein

Maschinen verfügen häufig über Signale und Warneinrichtungen, um den Bediener vor Restrisiken und Gefahrensituationen zu warnen. Häufig informieren diese Einrichtungen (wie Signallampen) außerdem über den Status der Maschine. Die DIN EN ISO 20607 fordert daher, dass all diese Einrichtungen in der Dokumentation aufgeführt und erläutert werden. Damit der Leser deren Bedeutung erkennen kann.

Die DIN EN ISO 20607 fordert, dass Warnhinweise, Gefährdungs- und Sicherheitssymbole von anderen Inhalten der Betriebsanleitung unterscheidbar sein müssen. Auch muss die Bedeutung von Zeichen und Piktogrammen eindeutig erklärt werden. Die Norm fordert dabei die Verwendung der Signalwörter „GEFAHR“, „WARNUNG“ und „VORSICHT“ für Warnhinweise und die Kodierungsfarben aus ISO 3864-2. Für Piktogramme und Sicherheitszeichen verweist die Norm auf die ISO 7000 und ISO 7010.

Die DIN EN ISO 20607 fordert, dass der Hersteller den Benutzer über alle relevanten Restrisiken informiert und davor warnt. Allgemeine Aussagen zu Restrisiken müssen dabei vermieden werden. Alle vorhandenen Restrisiken müssen in der Anleitung aufgeführt und erläutert werden. Am besten auf Basis der Lebensphasen und dem Auftreten des einzelnen Restrisikos. Als Grundlage für die Ermittlung der Restrisiken dient die vorher durchgeführte Risikobeurteilung.

Die DIN EN ISO 20607 ermöglicht auch die Erstellung von Betriebsanleitungen, die aus einem einzelnen Dokument bestehen. Sie fordert dabei jedoch, dass die Informationen für die verschiedenen Zielgruppen so aufbereitet werden, dass diese unterscheidbar sind. Es muss verhindert werden, dass ein Benutzer nicht versehentlich Informationen oder Handlungen durchführt, für die er nicht qualifiziert ist.

Die DIN EN ISO 20607 fordert, dass die Anleitung so gegliedert ist, dass die Informationen schnell gefunden werden können. Dazu gehören die Verwendung von Abschnitten, Kapiteln, Unterabschnitten, Überschriften, Nummerierungen, Hervorhebungen und unterschiedliche Farben. Außerdem fordert die Norm, dass der Leser erkennen können muss, ob das Dokument vollständig ist. Dazu verweist sie auf das Inhaltsverzeichnis und eine Seitennummerierung.

Bei der Lesbarkeit der Anleitung verweist die DIN EN ISO 20607 auf die Zielgruppen der Anleitung. Das einzige Kriterium hierbei ist, dass die Zielgruppen das Dokument lesen kann. Als Beispiel listet die Norm verschiedene Schriftgrößen und Symbole im Anhang.  Die dortigen Angaben stammen dabei aus IEC IEEE 82079-1:2019. Für den fortlaufenden Text einer Betriebsanleitung wird beispielsweise eine Schriftgröße von 8 pt bis 14 pt empfohlen. Wichtige Informationen sollten außerdem entsprechend hervorgehoben werden, beispielsweise mit Farben.

Die DIN EN ISO 20607 setzt auch hier die Zielgruppe in den Fokus. So kann eine Anleitung aus mehreren, einzelnen Dokumenten bestehen, wenn diese für verschiedene Zielgruppen bestimmt sind. Auch soll der Redakteur überlegen, eine Anleitung in mehrere Dokumente aufzuteilen, wenn diese ansonsten zu umfangreich werden würde. Betreffen die Dokumente verschiedene Lebensphasen des Produktes, ist eine entsprechende Gliederung ebenfalls sinnvoll. Aber auch eine Betriebsanleitung in einem einzelnen Dokument ist möglich.

Die DIN EN ISO 20607 behandelt die Themen Terminologie und Formulierungen in mehreren Kapiteln und im Anhang. Die Kapitel stellen dabei grundlegende Anforderungen an die Terminologie und die Formulierungen. Dazu gehört, dass eine Betriebsanleitung verständlich sein muss, indem sie genormte Begriffe oder anerkannte, technische Begriffe verwendet. Werden jedoch besonders technische Begriffe oder Ausdrücke verwendet, fordert die Norm, dass diese erklärt werden. Außerdem soll eine Anleitung so einfach und kurz wie möglich sein. Im Anhang zeigt die DIN EN ISO 20607 anhand einer großen Anzahl an Beispielen welche Formulierungen gut sind und welche schlecht sind.

Die DIN EN ISO 20607 stellt konkret keine Anforderungen an die Qualität von Betriebsanleitungen. Der Fokus der Norm liegt auf den Inhalten von Betriebsanleitungen und deren Gestaltung. Für Grundsätze, allgemeine Informationen oder Qualitätskriterien gibt es nur wenige Informationen. Stattdessen verweist die DIN EN ISO 20607 auf die Horizontalnorm für Anleitungen, die IEC/IEEE 82079-1 von 2019.

Das Ziel jeder Anleitung ist es, dem Leser die benötigten Informationen zu vermitteln. Daher fordert die DIN EN ISO 20607 die Einhaltung des Kommunikationsablaufes „Lesen – Denken – Anwenden“, um den größten Nutzen zu erzielen. Außerdem fordert die Norm die Verwendung von Handlungssequenzen und die Fokussierung auf die Zielgruppe der Maschine und der Anleitung.

Die DIN EN ISO 20607 ist nur eingeschränkt zur Konformitätsvermutung geeignet. Im Anhang „ZA“ der Norm DIN EN ISO 20607 finden sich Einschränkungen hinsichtlich der Konformitätsvermutung. Darin sind die Kapitel 4 und 5 mit Ausnahme des Abschnittes 4.11 als Teile für die Konformitätsvermutung gelistet. Mit der Einhaltung dieser Kapitel kann der Hersteller nachweisen, dass er die Anforderungen der Maschinenrichtlinien im Kapitel 1.7.4.2 erfüllt.

Die Norm DIN EN ISO 20607 ist seit 1. April 2020 im Amtsblatt der Europäischen Union unter den harmonisierten Normen aufgeführt. Die Norm EN ISO 20607:2019 mit dem Titel: Sicherheit von Maschinen — Betriebsanleitung — Allgemeine Gestaltungsgrundsätze ist dort als eine B-Norm aufgeführt. Damit kann die Einhaltung dieser Dokumentationsnorm als Konformitätsvermutung zur Einhaltung der Bestimmungen der Maschinenrichtlinie 2006/42/EG herhalten.

Die DIN EN ISO 20607 konkretisiert die Anforderungen der Maschinenrichtlinie 2006/42/EG an eine Betriebsanleitung im Maschinenbau. Zwar gibt es mit der DIN EN 82079-1 bereits eine Norm zum Erstellen von Anleitungen aller Art. Die Norm DIN EN ISO 20607 befasst sich jedoch nur für den speziellen Anwendungsfall von Betriebsanleitungen für Maschinen. Die Norm ist eine gute Ergänzung zur bisherigen DIN EN 82079-1, da sie speziell die inhaltlichen Anforderungen für den Maschinenbau und darauf bezogen einzelne Hilfestellungen zu Formulierungen enthält.