Technische Dokumente – Gebrauchsanweisungen richtig erstellen, Bedienungsanleitungen richtig erstellen

By | Februar 13, 2015

Banner_MBeconsulting_750_90

Technische Dokumente, wie Gebrauchsanweisungen, Montageanleitungen, Handbücher usw. sind ein wichtiger Bestandteil ihres Produktes. Richtlinien und Gesetze fordern, dass alle notwendigen Informationen für den Installateur, den Betreiber und den Benutzer ihres Produktes bereit stehen und eine ordentliche, vollständige und übersichtliche Anleitung definiert die Qualität ihres Produktes mit. Ist die Anleitung für den Kunden gut verwendbar, hat er subjektiv auch das Gefühl ein Produkt guter Qualität gekauft zu haben. Doch welche Informationen muss eine Anleitung enthalten? Wie soll diese strukturiert sein, damit sie diesen Anforderungen gerecht wird?

Inhalt
Der Inhalt von Bedienungsanleitungen ist grundsätzlich von den Eigenschaften und Funktionen des Produktes abhängig. Folgende Inhalte dürfen aber nie fehlen:
Einsatzgebiet: beschreibt das Umfeld in welchem das Produkt verwendet werden darf. z.B. Verwendung im Heim und Gewerbebereich in Innenräumen und geschützten Außenbereichen.

  • bestimmungsgemäßer Gebrauch: Beschreibt für welchen Bedarf das Produkt zu verwenden ist. Es empfiehlt sich auch zu beschreiben, wofür es keinesfalls verwendet werden darf.
  • Gefahren- und Warnhinweise: Auf Handhabung und Verwendung des Produktes, welche zu Schäden, aber ganz besonders zu Verletzungen und auch zum Tod führen kann, muss hingewiesen werden. Verwenden Sie dafür die Darstellung der Warnhinweise nach ANSI Z535.
  • Beschreibung der Installation und Inbetriebnahme:
  • Wie muss das Produkt montiert und verkabelt werden? Welche Einstellungen sind vor Inbetriebnahme zu machen? usw.
  • Beschreibung der Funktionen zur Verwendung:
  • richtige Handhabung, Betriebsverhalten, Normalbetrieb, Sonderfunktionen, Schnittstellen zu Fremdsystemen,…
  • Fehleranzeigen, Warnanzeigen, Hinweise zur Fehlersuche:
  • Hinweise und Vorgehen bei Wartung und Instandhaltung: Ist ein Produkt wartungsfrei ist das auch anzuführen.
  • Hinweise zur Entsorgung des Produktes:
  • Hinweis zu Copyright und Gültigkeit, sowie eine Identifikationsnummer zur vorliegenden Version, Ausgabedatum.

 


Struktur / Aufbau

Bedienungsanleitungen sind Nachschlagewerke! Kaum jemand liest eine Anleitung wie ein Buch von vorne nach hinten durch, sondern man blättert und/oder sucht im Inhaltsverzeichnis oder im Glossar nach der Beantwortung seiner Frage. Wichtig ist, dass der Kunde die gewünschten Informationen schnell findet. Folgende Struktur hat sich für diesen Zweck als unterstützend erwiesen.

 

  • Inhaltsverzeichnis: umfasst die Anleitung mehr als 4 Seiten ist diese zu erstellen.
  • Glossar / Stichwortverzeichnis: ab einem Umfang von 20 Seiten empfohlen.
  • Gliederungsebenen: maximal 3 Dezimalklassifikationen (1.; 1.1; 1.1.1).
  • Seitennummerierung: bei mehr als 2 Seiten unbedingt notwendig.
  • Marginalspalten mit Überschriften oder Stichwörtern unterstützen die Informationsfindung enorm.
  • minimale Schriftgröße: Zielgruppe beachten, 8pt sollte nie unterschritten werden (1 pt = 0,353mm = 1/72Inch).

Lesbarkeit

Wie schon erwähnt ist der Zweck der Anleitung dem Kunden schnell und unmissverständlich Informationen zur Verfügung zu stellen. Eine Anleitung ist sicher kein literarisches Werk, sondern dient ausschließlich dem Zweck das Produkt richtig zu verwenden. Beim Schreiben der Texte müssen sie unbedingt auf diese Anforderung Rücksicht nehmen. Folgende Leitsätze können Sie dabei unterstützen:
Bilder sagen mehr als 1000 Worte!

 

  • Kurze Sätze mit Befehlscharakter bei Schrittanweisungen, nur eine Handlungsanweisung pro Satz: z.B. Taste “OK” drücken; Netzstecker ziehen
  • einfacher Satzbau: Subjekt, Prädikat, Objekt; z.B. Der Anschlussplan steht auf der Rückseite. Keine Passivkonstruktionen.
  • Das Wort “Bitte” hat in einer Anleitung nichts zu suchen.
  • “sollten, können, dürfen, müssen”, führen zu Satzklammern. Vermeiden Sie diese Wörter.
  • Adjektive meiden.
  • Querverweise vermeiden: Das erschwert die Informationsfindung und die Lesbarkeit.
  • Verwenden Sie eine klare Sprache: Verwenden Sie für ein Produktteil nicht unterschiedliche Begriffe.
  • Keine doppelten Verneinungen.
  • Machen Sie keine Variationen: Auch wenn wir im Deutschunterricht etwas anderes gelernt haben und es oft beim Lesen holprig klingt: “Steuerungen steuern“, „Regelungen regeln“; Beschreiben Sie es genauso.

Denken Sie bei jedem Satz, ob er eindeutig ist und diesen auch Ihr Kunde nicht falsch interpretieren kann!

Normen / Richtlinien
Für die Erstellung von Bedienungsanleitungen gibt es Normen. Sie definieren den üblichen Inhalt einer Anleitung und sollen bei der Erstellung von Anleitungen unterstützen. Die relevanten Normen sind:

  •  DIN 82079-1: Erstellung von Gebrauchsanleitungen – Gliederung, Inhalt und Darstellung.
  • ANSI Z535.6 „Product Safety Information in Product Manuals, Instructions and other Collateral Materials“ definiert im Detail wie Warn- und Gefahrenhinweise auszusehen haben. Gerade dieser Bereich ist ganz wesentlich bei Sicherheitsfragen und bedarf einer klaren, unmissverständlichen Definition um Haftungsrisiken zu minimieren.

Prüfung und Freigabe
Technische Dokumente müssen vor Veröffentlichung und Druck geprüft werden. Dabei hat sich eine Prüfung in 3 Schritten bewährt:

  • Prüfung durch RedakteurIn
    Eine Person (Nicht der Ersteller!) im Unternehmen sollte die Anleitung begutachten und die Einhaltung der Regeln der technischen Dokumentation prüfen (eventuell mit Checkliste aus der Norm).
  • Prüfung durch TechnikerIn Hier wird geprüft, ob die technischen Beschreibungen zum Produkt und die Handlungsanweisungen korrekt sind. Besonderes Augenmerk ist auf die Gefahren – und Warnhinweise zu legen.
  • Prüfung durch Laien
    Die Anleitung einem unbedarften Benutzer samt dem Produkt in die Hand zu geben und das Produkt bedienen lassen ist der wichtigste Test. Hier erkennt man wie der Kunde mit der Anleitung umgeht. Achten Sie bei dieser Prüfung aber besonders auf die Sicherheit des Laienprüfers!

In der Norm DIN82029 ist auch eine Checkliste für die „Bewertung von Gebrauchsanleitungen“ eingearbeitet. Diese als Leitfaden zu verwenden ist durchaus zu empfehlen.

Beruf: Technische Redakteurin
Die Position des technischen Redakteurs, welcher mittlerweile zu einem Berufsbild geworden ist, gewinnt in innovativen Unternehmen immer mehr an Bedeutung. Die notwendigen Fähigkeiten, die dieser Spezialist im Unternehmen benötigt, umfassen:

  • technisches Verständnis des Produktes.
  • Wissen über gesetzliche Forderungen an die technische Dokumentation.
  • Wissen über eine für die Kunden verständliche Sprache.
  • Aufbau eines Terminologiemanagement: normierte Sprache und Autorenunterstützung.
  • Wissen über die Übersetzungs- und der Druckprozesse.

Das ist ein erheblicher Umfang an Wissen und ist von den Entwicklern und Technikern im Unternehmen, welche oft für die Erstellung der Anleitungen zuständig sind, kaum mit ausreichender Qualität machbar.

Zukunft der technischen Dokumentation
Technische Dokumente werden nach wie vor gedruckt. Neue Technologien führen aber wohl auch hier zu einem Umdenken. Daimler hat beispielsweise bei einem hochpreisigen Fahrzeug eine Zeit lang ein IPad mit der Anleitung in digitaler Form mitgeliefert.
Auch wenn das vorläufig nur wenige machen, werden wir wohl Anleitungen in Zukunft mit Tablet-PCs oder Smart- Phones usw. einsehen. Das wird neue Anforderungen an die Technische Dokumentation stellen. Bilder, Filme und Sprache werden wohl nach und nach dem geschriebenen Wort den Rang ablaufen und Anleitungen werden interaktiv werden.

Erfahrungen aus einer professionellen und strukturierten technischen Dokumentation
Mit zunehmendem Wachstum und steigender Produktvielfalt in einem Unternehmen steigt der Bedarf der strukturierten Dokumentation. Normierte Sprache und Wiederverwendung von Texten werden ein Muss. Das Thema “Technische

  • Dokumentation” möglichst früh auf professionelle Beine zu stellen, erspart viel an Geld und Mühen. Ihr Profit daraus wird sein:
  • Qualitätssprung des Produktes -> für den Kunden hebt sich die Qualität.
  • geringere Supportaufwände -> Der Kunde findet leichter die notwendigen Informationen.
  • geringere Feldrücklaufrate -> weniger Fehlbedienungen führen zu weniger Defekten.
  • erheblich geringere Erstellungskosten -> Wiederverwendung von Texten wird möglich.
  • geringere Druckkosten -> Die Texte werden kürzer und auf das Notwendige begrenzt, damit sinkt die Seitenanzahl von Anleitungen.
  • erheblich geringere Übersetzungskosten -> Übersetzungen werden nach Wörtern oder Sätzen abgerechnet. Normierte Sprache führt dazu, dass bereits übersetzte Texte nicht noch einmal übersetzt werden müssen.

Interessante Links zum Thema
Interessante Links:

www.tekom.de

www.tekom.eu

www.doku.info