Die häufigsten Fehler und Risiken einer technischen Dokumentation
29.04.2021 - Max Hoehle
Jedes technische Erzeugnis hat eine ganz bestimmte Aufgabe zu erfüllen. Das kann es nur, wenn es richtig bedient wird. Zweckentfremdeter Einsatz, falsche Handhabung oder unbedachte Verwendung können schnell Schaden anrichten. Den soll die technische Dokumentation abwenden. Schleichen sich in eine Anleitung Fehler ein, verfehlt das Dokument mitunter seinen Zweck. Kommt es deswegen zu einem Unfall, können Haftungsansprüche gegen den Hersteller entstehen. Dieser Beitrag hilft, Risiken durch fehlerhafte Anleitungen zu vermeiden.
Fehler 1:
Risikobeurteilung unvollständig oder ungenau
Die Grundlage für die Informationen, die dem Nutzer den sicheren Umgang mit dem Produkt ermöglichen, ist die Risikobeurteilung. Alle Vorschriften für Erzeugnisse sehen vor, dass der Hersteller die Gefahren ermittelt und möglichst beseitigt. Über die verbleibenden Risiken muss er den Nutzer nachdrücklich informierten. Die fehlerfreie technische Dokumentation enthält immer Angaben zum bestimmungsgemäßen Gebrauch und zu den Randbedingungen, die bei der Verwendung einzuhalten sind. Dazu gehören zum Beispiel die richtige Energieversorgung, die Einhaltung von Sicherheitsabständen zu unbeteiligten Personen, die maximale Drehzahl für Werkzeuge oder die persönliche Schutzausrüstung, die bei der Arbeit erforderlich ist.
Fehler 2: mangelnde Struktur, unübersichtlicher Aufbau
Der Nutzer muss sich in der Anleitung zurechtfinden, sonst legt er sie ungelesen beiseite. Eine klare Struktur hilft ihm, Arbeitsabläufe korrekt durchzuführen. Die folgenden Bestandteile gehören in jede Betriebsanleitung:
- Inhaltsverzeichnis
- Beschreibung des Erzeugnisses
- allgemeine Sicherheitsanforderungen
- Beschreibung der einzelnen Tätigkeiten im normalen Betrieb
- notwendige Pflege- und Wartungsmaßnahmen
- Verhalten bei auftretenden Störungen
- Hinweise zu Reparaturen
- Hinweise zur Entsorgung
In vielen Fällen sind Montageanleitungen Bestandteil der technischen Dokumentation. Dann ist es hilfreich, zu Anfang alle benötigten Werkzeuge aufzulisten. Wann immer sich Informationen in einer Tabelle zusammenstellen lassen, sollte diese Darstellungsform genutzt werden.
Fehler 3: zu viel Text, zu wenig Bilder
Grafische Darstellungen werden vom Nutzer viel schneller erfasst als Text, den er erst lesen muss. Zwei, drei Bilder, die den Fortgang eines Arbeitsschritts zeigen, kann er mit einem Seitenblick im Auge behalten, während er handelt. Das spart Zeit und trägt zur Fehlervermeidung bei. Geeignet sind vor allem Strichzeichnungen, auf denen das Wesentliche sofort auffällt. Ergänzt werden die Bilder durch Gefahrensymbole und Gebotszeichen für Schutzmaßnahmen.
Fehler 4: unverständliche Fachsprache
Jedes Fachgebiet hat eigene Begriffe, die im Alltag selten, manchmal sogar in einer abweichenden Bedeutung vorkommen. Innerhalb des Fachbereiches tragen diese Wörter zu einer schnellen, verlustfreien Verständigung bei. Außenstehende sind oft überfordert. Deshalb sollte die technische Dokumentation auf diese Begriffe möglichst verzichten. Das gilt vor allem dann, wenn sie sich an Privatpersonen richtet. Findet sich kein passendes Wort, sollte der Fachbegriff sofort erklärt werden. Ein Glossar am Ende der Anleitung kann einen zusätzlichen Überblick über die verwendeten Fachwörter geben.
Fehler 5: unvollständige Informationen
Viele Arbeiten werden routinemäßig durchgeführt. Was man vielleicht über viele Jahre immer wieder erledigt, wird zur Gewohnheit. Wer voraussetzt, dass der Nutzer einer Anleitung ebenso routiniert ist, kann irren. In der technischen Dokumentation müssen auch die Arbeitsschritte erklärt werden, die "normal" sind.
Hinweise über die Informationen, die die technische Dokumentation berücksichtigen muss, liefern die gesetzlichen Vorschriften und Normen zu den konkreten Erzeugnissen. Beispiele für gesetzliche Vorschriften sind:
- die Maschinenrichtlinie
- die Produktsicherheitsrichtlinie
- die Druckgeräterichtlinie
- die Niederspannungsrichtlinie
- die ATEX-Richtlinie für explosionsgefährdete Bereiche
- die VGB-Richtlinie VGB-S-831-00 für Kraftwerksanlagen
Fehler 6: ausschweifende, irreführende Textgestaltung
Niemand erwartet eine unterhaltsame Anleitung. Die technische Dokumentation soll die benötigten Informationen kurz, klar und eindeutig vermitteln. Gleiche Werkzeuge oder Bauteile müssen immer mit der gleichen Bezeichnung genannt werden. Ein Kabel ist immer ein Kabel. Es irritiert den Nutzer, wenn es einmal als Kabel und an anderer Stelle als Leitung bezeichnet wird. Wortwiederholungen sind wertvoller als ein literarisch formvollendet gestalteter Text. Um Verwechslungen zu vermeiden, brauchen unterschiedliche Werkzeuge oder Bauteile selbstverständlich einen eigenen Namen oder einzusätzliches Zeichen (Nummer, Buchstabe), an dem erkennbar ist, worum es geht.
Fehler 7: Widersprüche zwischen Anleitung und Erzeugnis
Erzeugnisse werden ständig verändert und verbessert. Die technische Dokumentation muss mit der Entwicklung Schritt halten. Bei einer neuen Anordnung von Bedienelementen, besseren Werkzeugen oder anderen Neuerungen ist eine überarbeitete Anleitung erforderlich. Wichtig ist, dass die Zuordnung der jeweiligen Anleitungsversion zum zugehörigen Erzeugnis sichergestellt wird.
LinoPro – Ihr Partner in Sachen Technische Dokumentation
Sie benötigen eine Maschinen- Anlagen- oder Softwaredokumentation? Dann lassen Sie diese doch von LinoPro erledigen. Unsere langjährige Erfahrung, motivierte Mitarbeiter und unsere Expertise im Bereich der technischen Dokumentation kann garantiert auch ihnen weiterhelfen. Wir freuen uns auf Ihre Anfrage!
