Grundlagen und Regeln in der Technischen Dokumentation
NORMEN in der Technischen Dokumentation
Normen, die in der Technischen Dokumentation 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.
Unterschiede zur Vorgängerversion:
Die DIN EN IEC/IEEE 82079-1 enthält Anforderungen und Empfehlungen für die Erstellung von Benutzerinformationen zu Produkten und Dienstleistungen. In Bezug auf die Quellsprache fordert die Norm, dass die Benutzerinformationen in einer Sprache erstellt werden müssen, die von der Zielgruppe verstanden wird. Dies bedeutet, dass die Quellsprache nicht vorgeschrieben ist, sondern von der Zielgruppe abhängt. Wenn die Zielgruppe beispielsweise hauptsächlich deutschsprachig ist, sollten die Benutzerinformationen auf Deutsch verfasst werden.
Ein weiterer Unterschied besteht darin, dass die DIN EN IEC/IEEE 82079-1 auf der IEC/IEEE-Norm basiert und internationalen Charakter hat, während die DIN EN 82079-1 auf europäischen Normen basiert und somit eher auf die spezifischen Anforderungen im europäischen Raum abgestimmt ist.
Die DIN EN IEC/IEEE 82079-1 enthält im Vergleich zur DIN EN 82079-1 detailliertere Anforderungen und Empfehlungen zur Erstellung von Benutzerinformationen. Einige Beispiele sind:
-
Zielgruppenanalyse: Die Norm fordert eine detaillierte Analyse der Zielgruppe, einschließlich ihrer Sprache, Bildungsniveau, Erfahrung und Kenntnisse. Dies hilft bei der Erstellung von Benutzerinformationen, die auf die Bedürfnisse der Zielgruppe zugeschnitten sind.
-
Informationsstruktur: Die Norm empfiehlt eine klare Strukturierung der Informationen in Benutzerinformationen, um eine schnelle und effektive Nutzung zu ermöglichen. Hierzu werden beispielsweise Empfehlungen zur Gliederung, zur Verwendung von Überschriften, Listen und Tabellen gegeben.
-
Sprache: Die Norm fordert, dass die Sprache in den Benutzerinformationen klar, einfach und verständlich sein muss. Es werden Empfehlungen zur Vermeidung von Fachbegriffen, Abkürzungen, unverständlichen Sätzen und komplexen Formulierungen gegeben.
-
Medienwahl: Die Norm empfiehlt die Verwendung verschiedener Medienformate zur Unterstützung der Benutzerinformationen, wie z.B. Bilder, Videos und Animationen. Hierbei werden auch Empfehlungen zur Gestaltung und Verwendung der Medien gegeben.
-
Barrierefreiheit: Die Norm enthält detaillierte Anforderungen zur Barrierefreiheit von Benutzerinformationen, um eine optimale Nutzung durch Menschen mit Behinderungen zu gewährleisten. Hierzu werden Empfehlungen zur Verwendung von alternativen Texten, Audiobeschreibungen und Gebärdensprache gegeben.
Zusammenfassend kann gesagt werden, dass die DIN EN IEC/IEEE 82079-1 eine umfassendere und detailliertere Norm ist, die auf eine optimale Erstellung von Benutzerinformationen abzielt.
-
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 Maschinenrichtlinie
Ist eine Norm harmonisiert, greift die Konformitätsvermutung.
Die Maschinenrichtlinie ist eine Richtlinie, die im Amtsblatt der EU gelistet ist und dem deutschen ProdSG und dort der 9. ProdSV unterliegt und demzufolge anzuwenden ist. Sie ist keine Kann-Bestimmung. Geltungszeitraum und durch welche Verordnung sie abgelöst wird, finden Sie hier.
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.
Marktüberwachung und die Konformität von Produkten - Pflichten und Befugnisse der Marktüberwachungsbehörden lt. VERORDNUNG (EU) 2019/1020
Liste Harmonisierte Normen
Eine Liste Harmonisierter Normen, finden Sie im Amtsblatt der EU (EUR-Lex).
Es ist ratsam, die offizielle Website der Europäischen Kommission oder der nationalen Normungsorganisationen zu konsultieren, um die neuesten und genauesten Informationen zu erhalten. Dort finden Sie eine aktuelle Liste von Harmonisierten Normen, die sich mit technischer Dokumentation, Konformitätsbewertung und Sicherheit von Maschinen und Produkten befassen. Dort finden Sie die neuesten verfügbaren Ressourcen und Informationen zu diesem Thema.
Im Amtsblatt finden Sie nicht nur Normen sondern auch Richtlinien und Verordnungen.
Übrigens auch wenn einen Norm nicht im Amtsblatt steht, diese aber in harmonisierten Normen erwähnt wird, gilt die Konformitätsvermutung.
Wollen Sie mehr wissen? Nehmen Sie Kontakt auf!
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
Terminologie Definition
In der Technischen Dokumentation bezieht sich der Begriff "Terminologie" auf die spezifische Sprache und die Auswahl der Begriffe, die in Technischen Dokumenten verwendet werden. Diese Begriffe sind entscheidend, um klare und präzise Informationen zu vermitteln, insbesondere in Bereichen wie Ingenieurwissenschaften, Informatik, Medizin oder anderen technischen Disziplinen.
Die Terminologie in der Technischen Dokumentation dient dazu, einheitliche und verständliche Begriffe für komplexe technische Konzepte, Produkte oder Prozesse festzulegen. Dies erleichtert nicht nur das Verständnis für technische Fachleute, sondern auch für Endbenutzer, die die Produkte verwenden oder sich mit den technischen Informationen vertraut machen müssen.
Terminologie umfasst verschiedene Aspekte, darunter:
-
Fachbegriffe: Spezifische Wörter oder Phrasen, die in einem bestimmten technischen Kontext verwendet werden. Diese Begriffe sind oft international standardisiert, um Missverständnisse zu vermeiden.
-
Abkürzungen und Akronyme: Kurzformen von Begriffen, die häufig in technischen Dokumenten verwendet werden, um Platz zu sparen. Es ist wichtig, diese klar zu definieren, um Verwirrung zu vermeiden. Hier sollten jedoch nur Abkürzungen verwendet werden die öffentlich gebräuchlich und bekannt sind, ansonsten sollte generell auf Abkürzungen verzichtet werden, um eindeutig zu bleiben.
-
Jargon: Spezielle Begriffe oder Ausdrücke, die in einer bestimmten technischen Branche oder Community gebräuchlich sind. Diese können für Außenstehende schwer verständlich sein und müssen entsprechend erklärt werden. Grundsätzlich sollte jedoch auf Jargon in technischen Dokumentationen verzichtet werden.
-
Synonyme und Homonyme: In der Technischen Dokumentation ist es wichtig, klare Unterscheidungen zwischen Begriffen zu treffen, die ähnlich klingen oder geschrieben werden, um Verwirrung zu vermeiden.
-
Mehrsprachige Terminologie: In globalen Märkten müssen technische Dokumente oft in verschiedenen Sprachen verfügbar sein. Die korrekte Übersetzung und Verwendung von Fachbegriffen in verschiedenen Sprachen ist entscheidend.
Die Festlegung und einheitliche Verwendung von Terminologie in der technischen Dokumentation gewährleistet, dass Informationen klar, konsistent und präzise übermittelt werden. Dies ist besonders wichtig, um Missverständnisse zu vermeiden und die Sicherheit sowie Effizienz bei der Verwendung technischer Produkte oder Dienstleistungen zu gewährleisten.
Terminologie in der Technischen Dokumentation anwenden
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!