Technische Dokumentation – Fragen und Antworten zur Technischen Dokumentation

Ja, wenn das Produkt personenbezogene Daten verarbeitet (z. B. Smart Devices, Überwachungskameras und Software oder Cloud-Dienste), gehört ein Hinweis zur DSGVO-konformen Nutzung in die Dokumentation.

Ja, wenn das Produkt personenbezogene Daten verarbeitet (z. B. Smart Devices, Überwachungskameras und Software oder Cloud-Dienste), gehört ein Hinweis zur DSGVO-konformen Nutzung in die Dokumentation.

Eine Möglichkeit die Größe zu ermitteln, ist die ISO 3864.
In Teil 2 dieser Norm gibt es eine Formel mit welcher sich die Höhe eines Zeichens für eine bestimmte Erkennungsweite errechnen lässt.

Sie lautet

h = D / 40

Dabei ist

h die Höhe des Zeichens in mm

D die Entfernung auf die das Zeichen sicher erkannt sein muss

40 der für die Berechnung erforderliche Distanzfaktor.

Beispiel:

Ein Sicherheitszeichen an einer stationären Maschine zur Holzbearbeitung soll auf eine Distanz von 2 m sicher erkannt werden.
Damit ergibt sich für h = 200 cm / 40 = 5 cm.
Das Sicherheitszeichen muss also eine Mindesthöhe von 5 cm haben.

Diese Berechnung kann allerdings möglicherweise nicht ausreichend sein, da sie Faktoren wie den Winkel aus dem das Zeichen betrachtet werden kann, die Beleuchtung des Umfeldes und der Maschine oder die Sehstärke des Betrachters nicht berücksichtigt.
Eine komplexere Formel für eine entsprechende Berechnung findet sich in Anhang 1 der ISO 3864-1.

Eine weitere Möglichkeit bieten die Technischen Regeln für Arbeitsstätten (ASR = Arbeitsstättenregeln): In der Tabelle 3 der ASR A1.3 (Sicherheits- und Gesundheitsschutzkennzeichnung) sind beispielsweise, abhängig von der Erkennungsweite, die entsprechenden Werte für Schriftzeichen, Verbots- und Gebotszeichen, Warnzeichen sowie Rettungs-, Brandschutz- und Zusatzzeichen festgelegt.

Grundsätzlich lässt sich wohl sagen, dass je größer der Gefahrenbereich (beispielsweise bei einem Industrieroboter) ist, desto größer müssen die Warnzeichen sein, damit sie rechtzeitig aus einer ausreichend sicheren Entfernung erkannt werden.

Sicherheits- und Warnhinweise kommen dann zum Einsatz, wenn ein Risiko weder konstruktiv noch mit anderen Schutzmaßnahmen ausreichend zu mindern ist. Dann gilt es die Benutzer direkt am Produkt oder in der Dokumentation über die mögliche Gefährdung aufzuklären. Am Produkt kommen dabei häufig Warnzeichen nach DIN EN ISO 7010 vor. Die Warn- und Sicherheitshinweise in der Dokumentation sind nach dem üblichen SAFE-Prinzip gestaltet.

Durch die Verwendung von Füllwörter bläht sich ein Sicherheitshinweis in einer Betriebsanleitung nur unnötig auf. Da Füllwörter keine sicherheitsrelevanten Informationen vermitteln, muss man Sie aus den Sicherheitshinweisen weglassen.

Dahingegen ein Beispiel mit Füllwörtern: „Drehen Sie nun bitte den Hebel nach unten“

Beispiel ohne Füllwörter: „Drehen Sie den Hebel nach unten“

Warnschilder für Maschinen können aus selbstklebenden Folien, Kunststoff, Aluminium oder Stahl bestehen. Die Art des zu verwendenden Materials für Warnschilder an der Maschine hängt zudem von dem Einsatzort der Maschine ab. In der Halle bieten sich Folien oder Kunststoff an. Für die Außenanwendung hingegen sollte man lackiertes Aluminium oder eingebrannter Stahl für die Warnschilder verwenden.

Nach dem ISO Standard müssen Warnschilder auf der Maschine ein oder mehrere Piktogramme enthalten, das vor einer Gefahr warnt. Weitere Angaben auf den Warnschildern auf der Maschine wie Warnstufe oder Text sind optional. Außerhalb von Europa können die Regelungen für Warnschilder zudem anders ausgelegt sein.

Bei der Strukturierung von Warnhinweisen in der Technischen Dokumentation ist es das Ziel, eine maximale Erkennbarkeit zu Erzielen. Der Text und die visuelle Darstellung durch Symbole und Sicherheitszeichen sollten auf das Wesentliche beschränkt sein. Die Stelle in der Technischen Dokumentation, an der ein Warnhinweis vorkommt, muss auffällig vom restlichen Inhalt abgegrenzt sein. Der Aufbau der Warnhinweise erfolgt nach dem SAFE-Prinzip. Deswegen fängt man bei der Strukturierung mit dem Signalwort an. Dann erklärt man die Art der Gefährdung. Anschließend erläutert man die möglichen Folgen bei Nichtbeachtung des Warnhinweises. Der Warnhinweis muss zudem deutliche Angaben enthalten, wie die Gefährdungen zu vermeiden sind.

Warnhinweise müssen in der Technischen Dokumentation offensichtlich als solche zu erkennen sein. Die Warnhinweise müssen sich gestalterisch von anderen Inhalten klar abheben sowie abgrenzen, um auffällig zu sein. Dies kann zum einem durch die Anwendung von größeren und/oder anderen Schriftgrößen oder Schriftarten erfolgen. Ebenso die Anwendung von Farben oder grafischen Symbolen einschließlich Sicherheitszeichen heben die Warnhinweise vom restlichen Text ab.

Die ISO 7010 schreibt vor, welche Symbole und Sicherheitszeichen in den Warnhinweisen innerhalb der Technischen Dokumentation zur Anwendung kommen dürfen. Die Symbole und Sicherheitszeichen dienen dazu Gefährdungen visuell darzustellen und verdeutlichen das Gefahrenrisiko, welche in den Warnhinweisen beschrieben ist.

Wenn Angaben zu Abständen für die sichere Nutzung des Produktes bekannt sein müssen, sind diese Angaben auch in den Warnhinweisen in der Betriebsanleitung zu nennen. Ein Fall aus der Produkthaftung zeigt dies ebenfalls. Nach Einbau eines Bodylifts in ein Fahrzeug ist eine Lenksäule des Fahrzeuges gebrochen. Die Ursache für den Bruch war ein zu geringer Abstand zwischen der Lenksäule und dem Bodylift. Dem Hersteller warf man vor, dass er keine Warnhinweise in der Betriebsanleitung auf den erforderlichen Abstand gegeben hat. Hier lag ein Instruktionsfehler vor, da auch Fachleute in dieser spezifischen Gefahrenlagen die konkret erforderlichen Abstände wissen müssen.

Es ist sinnvoll, einen Warnhinweis in mehrere aufzuteilen, wenn sich durch das Risiko sowohl Personen- wie auch Sachschäden ergeben können. Ein gutes Beispiel für die Technische Dokumentation im Maschinenbau ist hier der Transport einer Maschine. Beim Transport besteht die Gefahr, dass eine schwebende Maschine durch Herunterfallen einen Menschen verletzt wie auch die Maschine beschädigt. Übernimmt man beide Gefahren in einen Warnhinweis, übersieht man möglicherweise die zweite Gefahr. Hier ist es sinnvoll, den Warnhinweis in der Technischen Dokumentation aufzuteilen und nach Personen- und Sachschäden aufzutrennen.

In der Technischen Dokumentation verwenden Autoren die Begriffe Sicherheitshinweis und Warnhinweis häufig synonym. Dabei haben die Begriffe doch unterschiedliche Bedeutungen.

Sicherheitshinweise sollen dem Benutzer den sicherheitsgerechten Umgang mit dem Produkt grundlegend erklären. Ein Sicherheitshinweis ist didaktisch aufbereitet und steht in der Regel ohne Signalwort in der Technischen Dokumentation. Sicherheitshinweise stehen zudem vorangestellt in einem eigenen Sicherheitskapitel in der Betriebsanleitung.

Ein Warnhinweis soll die Aufmerksamkeit des Benutzers hingegen auf ein konkretes Risiko lenken und zur Gefahrenvermeidung anleiten. Die Hervorhebung des Hinweises durch ein Signalwort ist erforderlich um die Information als Warnhinweis zu kennzeichnen. Die Warnhinweise stehen zu Beginn der Kapitel der Betriebsanleitung oder innerhalb von Handlungssequenzen. Dabei soll der Warnhinweis den Zusammenhang (Lesefluss) nicht unnötig beeinträchtigen.

Fehler: Kontaktformular wurde nicht gefunden.

Die Erkennbarkeit von Piktogrammen bzw. Sicherheitszeichen in den Sicherheits– und Warnhinweisen in einer Betriebsanleitung oder auf der Maschine ist in der 2019 veröffentlichten harmonisierten Norm DIN EN ISO 20607 geregelt. Die im Anhang B befindliche Tabelle bezieht sich auf die Angaben aus der Norm IEC/IEEE 82079-1:2019. Diese empfiehlt unterschiedliche Größen hinsichtlich minimaler Schriftgrößen und Höhen von Sicherheitszeichen abhängig von der Größe des Produktes und der Entfernung der Betrachtung.

So sollten beispielsweise grafische Symbole und Sicherheitszeichen für Produkte, die aus 1 m Entfernung betrachtet werden, nicht weniger als 15 mm Größe aufweisen, um noch als kritische Kennzeichnungen auf dem Produkt wahrgenommen zu werden.

Eine nicht oder nicht angemessene erfolgte Warnung hinsichtlich eines vorhandenen Risikos des Produkts fällt in der Technischen Dokumentation unter Warnungsfehler. Häufig vorkommende Warnungsfehler sind:

• Unzureichende Warnungen oder Betriebsanleitungen
• Durch das Fehlen solcher Warnungen oder Betriebsanleitungen ist nicht plausibel, dass das Produkt sicher ist
• Die vorhandene Gefahr des Produkts hätte beschränkt oder vermieden werden können, wenn der Hersteller plausible Warnungen oder Betriebsanleitungen herausgegeben hätte

Eine grafische Übersicht in der Technischen Dokumentation über die Anbringungsorte von Warnschildern an einer Maschine hilft dem Benutzer der Betriebsanleitung. Da die DIN EN 82079-1 eine solche Übersicht fordert, sollte man dies bei der Erstellung einer Betriebsanleitung beachten. Auch können bei längerer Standzeit einer Maschine die Warnschilder an der Maschine abfallen oder unleserlich werden. Dann hilft eine Übersicht in der Betriebsanleitung, die Standorte für das Wieder- oder Neuanbringen von Warnschildern zu erläutern.

Um Warnhinweise in der Technischen Dokumentation aufzubauen, muss man alle Gefährdungen und Gefährdungsereignisse aus der Risikobeurteilung extrahieren, sofern die mit Restgefahren verbunden sind. Für den Aufbau eines Warnhinweises benötigt man daher die Angaben über:

• Art der Gefahr
• Gefährdung/Gefährdungsereignis
• Beschreibung der Gefährdung/des Gefährdungsereignisses
• Risikoeinschätzung
• Beschreibung der Restgefahr
• Beschreibung der Schutzmaßnahmen, sofern es welche gibt

Ein guter Warnhinweis in der Technischen Dokumentation macht die Sinnhaftigkeit von Vermeidung und Verboten deutlich. Der Warnhinweis lässt Gefahren und Konsequenzen plausibel und nachvollziehbar erscheinen. Weiterhin spricht ein guter Warnhinweis den Leser direkt an. Ein guter Warnhinweis ist nicht länger als notwendig aber mindestens so lang wie notwendig.

Die Warnhinweise für Maschinen, welche in die USA gehen, unterliegen der amerikanischen ANSI Norm. Diese fordert die strikte Trennung zwischen Personen- und Sachschäden. Personenschäden werden dafür je nach Schwere mit den Signalwörtern DANGER (Gefahr), WARNING (Warnung) und CAUTION (Vorsicht) versehen. Vor möglichen Sachschäden an der Maschine durch Fehlbenutzung warnt hingegen das Signalwort NOTICE (Hinweis).

Ist die Betriebsanleitung und vor allem die darin enthaltenen Handlungsanweisungen im Passiv formuliert, signalisiert das nicht die gegebene Dringlichkeit. Die Handlung versteht der Ausführende dann so, dass nicht (sofort) eine Handlung durchzuführen ist. Zudem ist eine aktive Schreibweise auch die verständlichere. Deswegen sollte der Text einer Betriebsanleitung im Aktiv formuliert sein.

Bei Sicherheits- und Warnhinweise in der Technischen Dokumentation nach ANSI muss man die strikte Trennung zwischen Personen- und Sachschäden beachten. Ebenso die Abstufung der Gefährdungsklassen von leichten Verletzungen bei Missachtung der Warnhinweise bis hin zu lebensbedrohlichen Situationen bei Missachtung.

Ein Sicherheitszeichen wird in einer Betriebsanleitung mit einem Piktogramm ohne Text oder dazugehörigen Text dargestellt. Im wenigen Fällen, wie bspw. durch Platzmangel, darf das Piktogramm allein stehen. Das kombinierte Sicherheitszeichen mit Text sollte immer bevorzugt zum Einsatz kommen. Diese Darstellung verdeutlicht den Warnhinweis dementsprechend bildlich und erläutert ihn zeitgleich noch textuell. Ein Text ohne Piktogramm darf nie als Sicherheitszeichen ausgegeben werden. Das Bild bzw. Piktogramm muss vor dem Text stehen.

Die Sicherheitszeichen werden nach Verbots-, Gebots- und Warnzeichen klassifiziert.

• Verbotszeichen: Untersagt ein gewisses Verhalten
• Gebotszeichen: Schreibt ein gewisses Verhalten vor
• Warnzeichen: Warnt vor einer Gefahr

Die Sicherheitszeichen sind von ihrer Darstellung jedoch genormt. Je nach Klassifizierung ergibt sich daher die Form und Farbe für das jeweilige Sicherheitszeichen.

Die ANSI-Norm macht klare Vorgaben, wie Warnhinweise in amerikanischen Betriebsanleitung aussehen müssen. Beispielsweise werden die Begriffe DANGER, WARNING, CAUTION und NOTICE als Signalwörter laut ANSI Z535.6 verwendet. Die Signalwörter sind den Farben Rot, Orange, Gelb und Blau zugeordnet.

Sicherheitshinweise müssen schon vor der Konstruktion entstehen. Für jede Maschine muss eine Risikobeurteilung vorgenommen werden, um die für die Maschine geltenden Sicherheits- und Gesundheitsschutzanforderungen zu ermitteln. Die Risikobeurteilung muss alle Restrisiken enthalten, die von einer Maschine während der festgelegten Lebensdauer in all ihren Lebensphasen ausgeht. Die Sicherheitshinweise ist dann unter Berücksichtigung der Ergebnisse der Risikobeurteilung in ihren jeweiligen Risikoklassen zu konstruieren und zu gestalten.

Warnhinweise, nach dem SAFE-Prinzip erstellt, sind folgendermaßen aufgebaut:

• S = Signalwort (Wahl des Signalwortes wie Gefahr, Warnung, Vorsicht oder Hinweis entsprechend von der Gefahrensituation)
• A = Art und Quelle der Gefahr (Woher kommt die Gefahr / Was ist die Gefahrenquelle?)
• F = Folgen bei Nichtbeachtung (Was passiert bei Nichtbeachtung des Hinweises)
• E = Entkommen / Vermeiden (Wie vermeidet bzw. löst man die Gefahrensituation?)

Hier erhalten sie weitere Informationen zu Sicherheits- und Warnhinweisen.

Für die Gliederung des Kapitels Sicherheitshinweise in der Betriebsanleitung bieten sich verschiedene Hierarchien an:

• Chronologisch (entsprechend der Lebensphasen der Nutzung)
• Von offensichtlichen Gefährdungen bis hin zu versteckten/unbekannten Gefährdungen
• Zielgruppenspezifisch (wenn es mehrere Zielgruppen gibt)

Warnschilder welche an der Maschine angebracht sind, müssen in der Betriebsanleitung als Warnhinweise erläutert sein. Ebenso sind die Anbringungsorte der Warnschilder in der Betriebsanleitung zu kennzeichnen.

Eine Möglichkeit die Größe zu ermitteln, ist die ISO 3864.
In Teil 2 dieser Norm gibt es eine Formel mit welcher sich die Höhe eines Zeichens für eine bestimmte Erkennungsweite errechnen lässt.

Sie lautet

h = D / 40

Dabei ist

h die Höhe des Zeichens in mm

D die Entfernung auf die das Zeichen sicher erkannt sein muss

40 der für die Berechnung erforderliche Distanzfaktor.

Beispiel:

Ein Sicherheitszeichen an einer stationären Maschine zur Holzbearbeitung soll auf eine Distanz von 2 m sicher erkannt werden.
Damit ergibt sich für h = 200 cm / 40 = 5 cm.
Das Sicherheitszeichen muss also eine Mindesthöhe von 5 cm haben.

Diese Berechnung kann allerdings möglicherweise nicht ausreichend sein, da sie Faktoren wie den Winkel aus dem das Zeichen betrachtet werden kann, die Beleuchtung des Umfeldes und der Maschine oder die Sehstärke des Betrachters nicht berücksichtigt.
Eine komplexere Formel für eine entsprechende Berechnung findet sich in Anhang 1 der ISO 3864-1.

Eine weitere Möglichkeit bieten die Technischen Regeln für Arbeitsstätten (ASR = Arbeitsstättenregeln): In der Tabelle 3 der ASR A1.3 (Sicherheits- und Gesundheitsschutzkennzeichnung) sind beispielsweise, abhängig von der Erkennungsweite, die entsprechenden Werte für Schriftzeichen, Verbots- und Gebotszeichen, Warnzeichen sowie Rettungs-, Brandschutz- und Zusatzzeichen festgelegt.

Grundsätzlich lässt sich wohl sagen, dass je größer der Gefahrenbereich (beispielsweise bei einem Industrieroboter) ist, desto größer müssen die Warnzeichen sein, damit sie rechtzeitig aus einer ausreichend sicheren Entfernung erkannt werden.

Ja, wenn das Produkt personenbezogene Daten verarbeitet (z. B. Smart Devices, Überwachungskameras und Software oder Cloud-Dienste), gehört ein Hinweis zur DSGVO-konformen Nutzung in die Dokumentation.

Ja, wenn das Produkt personenbezogene Daten verarbeitet (z. B. Smart Devices, Überwachungskameras und Software oder Cloud-Dienste), gehört ein Hinweis zur DSGVO-konformen Nutzung in die Dokumentation.

Bei Sicherheits- und Warnhinweise in der Technischen Dokumentation nach ANSI muss man die strikte Trennung zwischen Personen- und Sachschäden beachten. Ebenso die Abstufung der Gefährdungsklassen von leichten Verletzungen bei Missachtung der Warnhinweise bis hin zu lebensbedrohlichen Situationen bei Missachtung.

Die ANSI-Norm macht klare Vorgaben, wie Warnhinweise in amerikanischen Betriebsanleitung aussehen müssen. Beispielsweise werden die Begriffe DANGER, WARNING, CAUTION und NOTICE als Signalwörter laut ANSI Z535.6 verwendet. Die Signalwörter sind den Farben Rot, Orange, Gelb und Blau zugeordnet.