Dipl.-Ing. (FH) Karla Flemming
Ingenieurbüro für Technische Dokumentation
+49(0)5602 919 4544
Grundlagen und Regeln in der Technischen Dokumentation
NORMEN
Normen, die bei der Erstellung von Gebrauchsanleitungen zu beachten und anzuwenden sind:
Die Norm DIN EN IEC/IEEE 82079-1:2021-09 ist nicht harmonisiert, sie steht nicht im Amtsblatt, hat aber nach dem deutsch Geräte- und Produktsicherheitsgesetz Vermutungswirkung und muss somit zur Erstellung von Anleitungen herangezogen werden.
-
DIN EN IEC/IEEE 82079-1:2021-09 - Erstellung von Nutzungsinformationen (Gebrauchsanleitungen) für Produkte - Teil 1: Grundsätze und allgemeine Anforderungen (IEC/IEEE 82079-1:2019); Deutsche Fassung EN IEC/IEEE 82079-1:2020. Unterscheide zur Vorgängerversion: hier
-
ANSI Z535.6-2006 - US-amerikanische Norm für Sicherheitshinweise in Produktbeschreibungen, Anleitungen und anderen Begleitunterlagen. Die ANSI gilt nicht für den deutschen Markt, trotzdem wird das Layout der Warnhinweise gern in europäischen Anleitungen verwendet.
Zusätzlich hat der VDI seine eigene Norm herausgebracht. Blatt 1 und 4 sind hier nützlich für die Erstellung einer Betriebsanleitung.
-
VDI 4500 Blatt 1 - Technische Dokumentation (Begriffsdefinitionen und rechtliche Grundlagen)
-
VDI 4500 Blatt 2 - Technische Dokumentation (Organisieren und Verwalten)
-
VDI 4500 Blatt 3 - Technische Dokumentation (Erstellen und Verteilen von elektrischen Ersatzteilinformationen)
-
VDI 4500 Blatt 4 - Technische Dokumentation (Dokumentationsprozess-Planen, Gestalten, Erstellen)
Wenn es um die Risikobeurteilung geht, sind folgende Normen maßgeblich:
-
DIN EN ISO 12100 - Sicherheit von Maschinen (allg. Gestaltungsleitsätze, Risikobeurteilung und Risikominderung)
-
DIN EN 60204 - Sicherheit von Maschinen (Elektrische Ausrüstungen)
Sicherheitsfarben und Sicherheitszeichen sind dieser Norm zu entnehmen:
-
DIN ISO 3864-3 - Graphische Symbole
Der Leitfaden für die Umsetzung der Produktvorschriften der EU 2022 ist der „Blue Guide“. Dieser löste 2022 das "New Approach" ab.
HARMONISIERTE NORM
Ist eine Norm harmonisiert, greift die Konformitätsvermutung.
Die Anwendung einer Norm ist grundsätzlich freiwillig.
Harmonisiert bedeutet, dass die Norm offiziell auf Geheiß der EU erstellt wurde. Eine harmonisierte Norm ist im Amtsblatt der EU veröffentlicht.
Bei Anwendung einer harmonisierten Norm gilt die Konformitätsvermutung. Das heißt, dass bei Einhaltung bzw. Anwendung der Norm zu vermuten ist, dass das Produkt mit den entsprechenden wesentlichen Anforderungen übereinstimmt.
Der Hersteller kann aber auch Normen anwenden, die den Regelungen einer harmonisierten Norm widersprechen, solange der Hersteller die wesentlichen Anforderungen erfüllt. Der Hersteller muss dann, in einem sogenannten Konformitätsbewertungsverfahren dokumentieren, dass sein Produkt den wesentlichen Anforderungen genügt. Der Hersteller stellt dann eine Konformitätserklärung aus.
Die Marktaufsicht (Behörde) führt stichprobenartige Prüfungen bei den Herstellern durch. Jedoch immer, wenn ein Unfall geschehen ist oder durch Hinweise anderer Behörden.
Diese kann z. B. das Inverkehrbringen der Maschine oder des Produktes untersagen, Busgelder verhängen, die Information der Nutzer anordnen u.a. Prüfmaßnahmen durchführen.
Für den Hersteller ist es also sinnvoll, sich gleich an harmonisierte Normen zu halten. Das bezieht sich vor allem auf die Technische Dokumentation.
SAFE-PRINZIP
Dies sind die Basics zum SAFE-Prinzip. Wichtig ist zudem, dass die Warnhinweise den entsprechenden Handlungen zugewiesen werden. Die allgemeingültige Erklärung der Sicherheitshinweise, welche in der Dokumentation verwendet werden und deren Bedeutung, gehören in das Kapitel Sicherheit.
S -Symbol mit Signalwort
A - Art und Quelle der Gefahr
F - Folgen der Gefahr
E- Entkommen (Gefahrvermeidung)
Signalwörter (nach ANSI Z535.6) oder Symbole (ISO 7010:2019-07 bzw. DIN ENISO 7010/A6:2022-12)
GEFAHR | Folgen sind schwere Verletzung oder Tod, wenn die Gefahr nicht gemieden wird.
WARNUNG | Folgen sind mögliche schwere Verletzungen oder Tod, wenn die Gefahr nicht gemieden wird.
ACHTUNG | Folgen sind mögliche schwere Verletzungen, wenn die Gefahr nicht gemieden wird.
HINWEIS | Folge ist Sachschaden, wenn die Gefahr nicht gemieden wird.
TERMINOLOGIE
Das Anwenden der Terminologie in einer Anleitung ist in der Technischen Dokumentation üblich und notwendig.
Es ist wichtig, bei Betriebsanleitungen auf die Terminologie zu achten, weil klare und präzise Sprache für die Benutzer von Maschinen und Geräten von entscheidender Bedeutung ist. Eine präzise und konsistente Terminologie erleichtert das Verständnis der Anweisungen und minimiert das Risiko von Fehlern und Unfällen.
Wenn die Terminologie in einer Betriebsanleitung unklar, mehrdeutig oder inkonsistent ist, kann dies zu Verwirrung bei den Benutzern führen. Sie können Schwierigkeiten haben, die Anweisungen zu verstehen, was zu Fehlern führen kann. In einigen Fällen kann dies zu ernsthaften Sicherheitsrisiken führen, insbesondere wenn es um komplexe Maschinen oder gefährliche Arbeitsumgebungen geht.
Darüber hinaus gibt es oft rechtliche und regulatorische Anforderungen an Betriebsanleitungen, einschließlich der Notwendigkeit, bestimmte Begriffe und Konzepte korrekt zu verwenden. Wenn eine Betriebsanleitung diese Anforderungen nicht erfüllt, kann dies zu rechtlichen Konsequenzen führen, einschließlich möglicher Haftung für Schäden, die durch fehlerhafte Anweisungen oder unklare Sprache verursacht wurden.
Daher ist es wichtig, bei Betriebsanleitungen auf die Terminologie zu achten und sicherzustellen, dass sie klar, präzise und konsistent ist. Eine sorgfältige Überprüfung durch Fachleute und erfahrene Technische Redakteure kann dazu beitragen, dass die Anleitung klar verständlich ist und das Risiko von Fehlern minimiert.
Verwenden Sie für ein Bauteil immer genau ein und dasselbe Wort. Auch wenn es den Text langweilig erscheinen lässt, unterlassen Sie es unter allen Umständen, die Terminologie aus stilistischen Gründen zu wechseln. Beim Nutzer führen solche Begriffsänderungen in hohem Maße zu Verwirrungen, denn er weiß nicht, ob es sich beim neuen Begriff um ein anderes Bauteil handelt als zuvor.
Die Verwendung einer Tabelle ist zwar mit einigem Aufwand verbunden, zahlt sich aber am Ende zu Gunsten für eine verständliche Anleitung aus.
Redaktionssysteme haben ein solches Verwaltungssystem bereits inkludiert, was die Verwaltung erleichtert. Allerdings ist auch hier der Pflegeaufwand der Daten nicht zu unterschätzen.
Ich berate Sie diesbezüglich gerne. Nehmen Sie Kontakt zu mir auf!