Extra #004 Dokucheck für die technische Dokumentation

Wie prüfen wir eine Technische Dokumentation? Wir sprechen heute über die üblichen Mängel in einer Betriebsanleitung und worauf wir bei einem Dokucheck alles achten.

Dass die Technische Dokumentation alle Anforderungen aus Normen und Richtlinien einhält und die Betriebsanleitung auch noch verständlich geschrieben ist, stellt die Maschinenbauer immer wieder vor eine große Herausforderung. Nicht selten herrschen unter den Herstellern Unsicherheiten bezüglich der Angaben, die in einer Betriebsanleitung stehen müssen. Häufig sind die Angaben in der Anleitung mangelhaft oder es fehlen viele notwendige Informationen. Die GFT Akademie prüft mithilfe eines Dokucheck immer wieder die Anleitungen von Herstellern und prüft diese auf Einhaltung von Anforderungen aus Normen und Richtlinien sowie die Verständlichkeit der Anleitung.

Wir bekommen häufig Betriebsanleitungen zugeschickt, die nicht den Anforderungen entsprechen. Ist diese unverständlich geschrieben oder es fehlen wichtige Angaben, herrscht ein hohes Haftungsrisiko. Eine fehlerhafte Technische Dokumentation führt dazu, dass auch die Maschine bzw. das Produkt laut dem Produkthaftungsgesetz als fehlerhaft anzusehen ist. Die Betriebsanleitung ist ebenfalls ein Teil des Produktes und sollte daher vor dem Inverkehrbringen des Produktes auf ihre sachliche Richtigkeit überprüft werden. Häufig sind die Anleitungen, die wir bekommen, in einem sehr schlechten Zustand. Ich möchte heute auf einige Kritikpunkte eingehen, die wir immer wieder bei Anleitungen bemängeln.

Bei der sachlichen Richtigkeit der Anleitung spielt die Einhaltung von Anforderungen aus Normen und Richtlinien eine sehr wichtige Rolle.

Im Bereich der Betriebsanleitung ist die bekannteste Norm die DIN EN 82079-1, welche die Erstellung von Anleitungen aller Art regelt.

Für den Maschinenbau ist im Januar 2018 die ergänzenden Norm DIN EN ISO 20607 als Entwurf erschienen. Dieser ergänzt die vorhandene allgemein gehaltene Norm 82079-1 und ist speziell dem Bereich der Sicherheit von Maschinen zugewandt. Falls Sie, lieber Zuhörer, nähere Informationen zu der Norm 20607 wünschen, kann ich Ihnen die passende Podcast Folge 13 aus der Reihe „Betriebsanleitung erstellen“ von meinem Kollegen Florian Schmider empfehlen mit dem Titel Betriebsanleitung erstellen mit der DIN EN ISO 20607.

Der Hersteller eines Produktes muss zudem einige Gesetze, Unfallverhütungsvorschriften und Regelwerke für sein Erzeugnis beachten. Je nach Art des Erzeugnisses gelten unterschiedliche europäische Richtlinien und bringen spezielle Anforderungen mit sich. Ein gutes Beispiel ist die CE-Kennzeichnung mit der die Konformität zur Einhaltung von harmonisierten Normen nachgewiesen wird.

Mehrere Richtlinien fordern für die Produkte unter ihrem Geltungsbereich die Ausstellung einer Konformitätserklärung und die Anbringung des CE-Zeichens an dem Produkt. Die Ausstellung der Konformitätserklärung fällt unter die Zuständigkeit des Herstellers und ist Teil der Technischen Dokumentation.

Ebenfalls legen die erwähnten europäischen Richtlinien auch fest, welche Angaben in einer Betriebsanleitung stehen müssen. Ich zähle kurz einige wichtige Anforderungen auf, welche die Maschinenrichtlinie 2006/42/EG in Bezug auf die Betriebsanleitung beinhaltet:

• Firmenname und vollständige Anschrift des Herstellers
• Bezeichnung der Maschine
• Bestimmungsgemäße Verwendung
• Jede vernünftigerweise vorhersehbare Fehlanwendung
• Schutzeinrichtungen an der Maschine und deren Verwendung
• Verschleißteile und nach welchen Kriterien sie auszutauschen sind
• Angaben über Inspektions- und Wartungsarbeiten
• EG-Konformitätserklärung hinsichtlich der CE-Kennzeichnung
• Sicherheits- und Warnhinweise

Neben der Einhaltung von Normen und Richtlinien sind vor allem die Warn- und Sicherheitshinweise in einer Anleitung eine häufig vorkommende Fehlerquelle. Diese sind nur selten entsprechend den Anforderungen aus den Normen gestaltet. Die Unterteilung der Hinweise nach den einzelnen Gefahrenstufen mittels den Signalwörtern Gefahr, Warnung und Vorsicht wird nicht immer angewendet. Allgemein wird das aus der Norm DIN EN 82079-1 geforderte SAFE-Prinzip nur selten eingehalten.

Dieses Prinzip beinhaltet:

• Das erwähnte Signalwort, das die Gefährdungssituation klassifiziert
• Die Art und Quelle der Gefährdung
• Die Folgen, die bei einer Missachtung des Hinweises eintreten
• Maßnahmen zum Entkommen aus der Gefährdungssituation

In den Anleitungen mangelt es meistens an der Beschreibung der möglichen Folgen, wenn ein Sicherheits- oder Warnhinweis nicht beachtet wird. Häufig sind die Elemente des SAFE-Prinzips zwar in der Anleitung abgebildet, jedoch sind diese so in den Fließtext der Anleitung eingearbeitet, dass die einzelnen Elemente nur schwer zu erkennen sind. Nur wenn die Warn- und Sicherheitshinweise sich klar vom restlichen Text abheben, können die Hinweise auch wirkungsvoll vor Gefahren warnen. Dies gilt sowohl für Anleitungen für den deutschen Markt, wie auch für Anleitungen für andere Länder.

Ist die Technische Dokumentation für ein anderes Zielland bestimmt, wie beispielsweise die USA kommen andere Besonderheiten zu tragen als das für den deutschen oder europäischen Markt der Fall wäre. Im Falle von den USA sind die Gestaltung von Sicherheits- und Warnhinweise strenger reglementiert als in anderen Ländern. Die Regeln der ANSI Z535 spielen hierbei die größte Rolle, deren man besondere Beachtung schenken sollte. In diesem Zusammenhang empfehle ich Ihnen auch die Podcast Folge Nummer 2 aus der Reihe Produkthaftung USA anzu hören, der genauer auf die wichtigsten Normen und Richtlinien für Produkte in den USA eingeht.

Der Aufbau und das Layout einer Dokumentation ist ebenfalls ein wichtiger Kritikpunkt. Wie ist die Anleitung aufgebaut und ist die gewählte Gliederung für den Leser nachvollziehbar?

Der logische und leicht nachvollziehbare Aufbau einer Anleitung trägt zur Verständlichkeit für den Leser bei. Es ist sinnvoll die Informationen in der Anleitung entsprechend den Lebensphasen des Produktes anzuordnen. Angaben, welche der Leser vor der Benutzung des Produktes wissen muss, sollten in der Anleitung nicht erst nach dem eigentlichen Kapitel zur Benutzung aufgeführt werden.

Neben der Reihenfolge von Informationen ist auch die Art der Darstellung dieser Informationen ein Aspekt der Bewertung. Die jeweiligen Elemente einer Seite sollen die Aussagen in der Dokumentation unterstützen. Daher überprüfen wir die Wirkung der Elemente wie Satzarten, Satzspiegel, Zeilenlänge, Spaltenaufteilung, Abstände und Freiräume.

Auch die Leserlichkeit der Anleitung ist von enormer Wichtigkeit. Bei einem regulären Leseabstand sollten die gewählten Schriftgrößen, Strichstärken und Linienabstände dem Leser einen optimalen Zugang zu den enthaltenen Informationen in der Dokumentation gewähren. Abhängig von den Umgebungsbedingungen und dem Einsatz der Dokumentation ist eine für die Zielgruppe gebräuchliche Schriftart zu wählen.

Allgemein sollte die Anleitung so geschrieben sein, dass die Anleitung dem Wissensstand und der Verständnisfähigkeit der Benutzer entspricht. Daher prüfen wir neben der Leserlichkeit auch, ob die Anleitung Wort- und Satztechnisch verständlich geschrieben ist.

Nicht verständliche Sätze wie langgezogene Schachtelsätze sorgen bei dem Leser der Anleitung für Unklarheiten. Die Handlungsanweisungen sollten klar und kurz formuliert sein. In einen Satz sollte auch nicht mehr als eine Handlung vorkommen.

Der Leser sollte zudem aktiv angesprochen werden. Passive Formulierungen wie „Der Schalter ist zu drücken“ sind indirekt formuliert und sprechen den Benutzer nicht an. Eine direkte Anrede wie „Drücken Sie den Schalter“ fordert den Benutzer zu Handlungen auf.

Abkürzungen sind nicht immer verständlich. Deswegen sollte nach Möglichkeit auf die Verwendung von Abkürzungen verzichtet werden. Kommen die Begriffe kaum vor, sollte man diese ausschreiben. Sollte immer wieder auf eine Abkürzung verwiesen werden, sollte diese bei der ersten Nennung erläutert werden, damit der Leser später die Bedeutung der Abkürzung kennt.

Abbildungen sollen dem Benutzer neben dem Text zusätzliche Informationen zu Handlungen und Abläufe liefern. Die Darstellungen helfen, das Gesehene dann leicht in die Realität zu übertragen. Gute Abbildungen erhöhen die Qualität der Dokumentation, zusätzlich auch die Außendarstellung des Herstellers. Abbildungen können zudem das Textvolumen reduzieren und somit auch die Übersetzungskosten schmälern.

Aber auch im Bereich der Abbildungen sind häufig Dinge zu bemängeln. Objekte und Details im Bild sind unscharf dargestellt und benötigte Informationen für den Betrachter sind nicht zu erkennen. Wir prüfen eine Dokumentation, ob die gewählten Darstellungen gut gewählt ist und ob die Bedeutung der Darstellung auch nachvollziehbar ist.

Auch die farbliche Gestaltung spielt eine Rolle. Bei einer Anleitung fragen wir uns häufig:

• Kommt ein monochromes Bild besser heraus oder sollte eine farbige Abbildung für die Anleitung gewählt werden?
• Erreichen die gewählten Farben auch die erwartete Informationshaltung?

Im Bereich der Warn- und Sicherheitshinweise sind auch immer die verwendeten Piktogramme ein zu prüfender Aspekt. Entsprechen die jeweiligen Warn- und Gefahrensymbole auch den für die Zielgruppe entsprechenden Standard? Im deutschen bzw. europäischen Markt sind die Piktogramme nach dem ISO 7010 Standard zu wählen. Während im amerikanischen Markt die Symbole stattdessen dem ANSI Standard Z535.3 entsprechen müssen.

Nach diesen ganzen Kriterien, die wir bei einer Dokumentation überprüfen, werden Sie sich jetzt sicher fragen: Entspricht meine Betriebsanleitung allen Vorgaben aus Normen und Richtlinien? Sollte ich meine Dokumentation überprüfen?

Möchten Sie Ihre Dokumentation nicht selber prüfen oder bestehen gewissen Unsicherheiten bezüglich den Normen und Richtlinien? Wir können Sie dabei natürlich gerne unterstützen. Wenn Sie Ihre Technische Dokumentation durch uns prüfen lassen wollen, können wir Ihnen hierfür zwei Möglichkeiten geben.

Wir haben in unserem Leistungsangebot sowohl einen kostenpflichten ausführlichen Langcheck als auch einen günstigeren Kurzcheck Ihrer Dokumentation.

In unserem Kurzcheck prüfen wir Ihre Technische Dokumentation stichpunktartig auf mehrere der bereits erwähnten Kritikpunkte. Der Schwerpunkt unserer kurzen Überprüfung liegt auf dem Aufbau der Sicherheitshinweise und ob eine Anleitung übersichtlich dargestellt ist. Am Ende unseres Kurzchecks erhalten Sie eine Zusammenfassung aller Kritikpunkte in einem Prüfdokument.

Der ausführliche Langcheck prüft eine Technische Dokumentation genau auf Herz und Nieren. Bei dieser Variante nehmen wir uns ausführlich Zeit und untersuchen die Betriebsanleitung von Anfang bis Ende genau auf Unstimmigkeiten. Dabei prüfen wir die Anleitung auch genau auf die Einhaltung der Anforderungen aus Normen und Richtlinien, die für die Maschine bzw. das Produkt in dem genannten Zielland relevant sind.

Bei einem Langcheck erhalten Sie eine kommentierte Fassung Ihrer Betriebsanleitung, an der Sie direkt unstimmige Stellen in Ihrer Anleitung erkennen können. Dadurch ist eine direkte Überarbeitung der Betriebsanleitung mithilfe der Kommentare möglich. Zusätzlich erhalten Sie einen umfassenden Prüfbericht, der neben einem ausführlichen Fazit der Prüfung auch eine Checkliste enthält, welche die wichtigsten Anforderungen aus Normen und Richtlinien zusammenfasst. Auch redaktionelle und gestalterische Anmerkungen zur Umsetzung der Betriebsanleitung sind in diesem ausführlichen Prüfbericht enthalten.

Der Kostenumfang eines Langchecks ist unterschiedlich je nach Themenkomplexität und Umfang der Anleitung. Wir können Ihnen gerne ein Angebot für einen ausführlichen Langcheck zukommen lassen, wenn Sie Ihre Technische Dokumentation durch uns überprüfen möchten. Schicken Sie uns hierfür einfach eine Anfrage über unser Kontaktformular zu und wir besprechen das weitere Vorgehen.