people text - Technische Dokumentation. Verständlich. Schnell. Professionell. Technische Dokumentation. Verständlich. Schnell. Professionell.

Handbuch schreiben: Richtlinienkonforme Gebrauchsanleitungen erstellen und mit den Inhalten der Technischen Dokumentation auf der sicheren Seite sein

Zu den Hauptaufgaben bei der Erstellung von Handbüchern gehört es, Verständlichkeit und Nachvollziehbarkeit sowie die Erfüllung gesetzlicher und normativer Anforderungen sicherzustellen:

  • Hochwertige Neuerstellung Ihrer Handbücher. Wie schreiben beispielsweise Installationsanleitungen, Gebrauchsanleitungen, Bedienungsanleitungen.
  • Akkurate Pflege und systematische Optimierung der Handbücher.
  • Übersetzungsmanagement. Erstellung übersetzungsoptimierter Texte durch einen hohen Grad an Konsistenz und Standardisierung. Organisatorische Aufgaben im Zusammenhang mit dem Übersetzungsdienstleister und Qualitätssicherung der übersetzten Handbücher.

Die DIN EN 82079 gibt allgemeine Grundsätze zur Erstellung von Gebrauchsanleitungen vor. Diese Norm ist eine hilfreiche Unterstützung für das Schreiben eines Handbuchs.

Die Maschinenrichtlinie 2006/42/EG hat speziell die Handbücher für Maschinen und Anlagen im Fokus. Wir haben für Sie die wichtigsten Infos zusammengestellt.

DIN EN 82079: Handbuch schreiben leichtgemacht. Wir machen Ihrer Doku Beine

Die Norm gibt eine Anleitung an die Hand, die die wesentlichen inhaltlichen Aspekte des Handbuchschreibens enthält, sowie einen Anhang mit einer Prozessbeschreibung für die Planung und Erstellung. Sie ist also sowohl eine inhaltliche Richtschnur als auch ein Vorgehensmodell für die Erstellung.
Folgende Abschnitte sind für das Schreiben vom Handbuch besonders interessant.

Wer erstellt Ihre Handbücher? Sie haben Fragen zur Dokumentationserstellung?
Beratung in Sachen Dokumentation

Die wesentlichen Punkte der Norm für Ihr Handbuch in kompakter Form:

  • Prinzipien
    Das Niveau sowie die Informationstiefe des Handbuchs sollen zielgruppengerecht aufbereitet sein. Dabei steht auch die Sprache im Vordergrund: Zielgruppenorientierung wird durch verständlich geschriebene Handbuchtexte sowie konsistente Terminologie erreicht. Eine Hauptaufgabe eines Handbuchs besteht in der Warnung vor den Gefahren, die von einem Produkt ausgehen. Dies soll durch Sicherheitshinweise gewährleistet werden. Die Dokumentation muss mediengerecht sein, beispielsweise sollte eine Installationsanleitung für eine Software als gedrucktes Handbuch vorliegen und nicht in der Online-Hilfe, die erst nach der Installation zur Verfügung steht.
  • Inhalt von Gebrauchsanleitungen
    Die Norm enthält 15 Abschnitte darüber, was ein Handbuch enthalten sollte. Die Themen reichen von der Identifikation durch beispielsweise Drucknummer und Ausgabedatum des Dokuments über Modell- oder Seriennummer des Produkts bis hin zur bestimmungsgemäßen Verwendung. Infos über die Erlaubnis zur Veränderung des Produkts sowie sicherheitsbezogene Hinweise in verschiedenen Handbüchern sollen entsprechend beschrieben sein. Wie muss das Produkt transportiert, in Betrieb genommen, instand gehalten und entsorgt werden? Welche Informationen über mitgelieferte Zubehörteile, spezielle Werkzeuge oder zur Reparatur gehören in Ihr Handbuch? Darüber hinaus geht es auch um die Struktur der Gebrauchsanleitung: Wenn Sie mehr als ein Handbuch für die Gebrauchsanleitung schreiben müssen, dann müssen die verschiedenen Handbücher eindeutig zu erkennen sein.
  • Gestaltung von Gebrauchsanleitungen
    Die Norm widmet der Textverständlichkeit einen eigenen Abschnitt. Neben den allgemeinen Regeln, die auch für das Schreiben eines Handbuchs gelten, sollten Informationsklassen für die Handbücher entwickelt werden, die den Textfunktionen entsprechen. Die Struktur des Handbuchs sowie Schreibstil und Formulierung bedingen sich und sollten in einem Redaktionsleitfaden festgehalten werden.
    Redaktionsleitfaden
  • Anhänge A bis E: Bewertung der Konformität mit diesem Teil der Normenreihe 82079
    Die Anhänge enthalten Checklisten, mit deren Hilfe die Konformität mit der Norm überprüft werden kann. Ist Ihr Handbuch normenkonform erstellt oder müssen Sie es umschreiben? Die Norm enthält auch eine Prozessbeschreibung des redaktionellen Ablaufs für die Erstellung von Handbüchern.

Maschinenrichtlinie 2006/42/EG: Handbuch für den Maschinen- und Anlagenbau schreiben.

Die Technische Dokumentation im Maschinen- und Anlagenbau beschreibt den gesamten Lebenszyklus des Produkts. Die Handbücher decken sämtliche Aspekte ab und lehnen sich dabei an die EG-Maschinenrichtlinie 2006/42/EG an, die sowohl für interne als auch für externe Technische Dokumentation gilt. Unter externer Dokumentation versteht man die Handbücher, die der Hersteller mit der Maschine an den Kunden ausliefert.

Handbuch übersetzen

Die Handbücher sind fester Bestandteil der Maschine, sie enthalten alle erforderlichen Informationen und Anleitungen zur sicheren Benutzung. Deshalb sind sie auch in die Amtssprache des jeweiligen Landes übersetzt, in das die Maschine geliefert wird.
Übersetzung

Ausgabeformate: gedruckt oder online

Die Betriebsanleitungen, die für die Sicherheit und den Gesundheitsschutz der Benutzer relevant sind, sollen als gedrucktes Handbuch vorliegen. Der Grund dafür ist, dass nicht jeder Benutzer immer die Möglichkeit hat, die Betriebsanleitung in elektronischer Form zu lesen. Es ist aber auch üblich, ein gedrucktes Handbuch mit auszuliefern und die Dokumentation zusätzlich online zur Verfügung zu stellen. Online angebotene Handbücher werden in letzter Zeit gerne in Content Delivery Portalen zur Verfügung gestellt. Auf diese Weise können Hersteller sicherstellen, dass Ihren Kunden immer Zugriff auf die aktuellste Dokumentation haben.
Content Delivery Portale

Textverständlichkeit und Zielgruppenorientierung

Eine sehr wichtige Motivation für ein gut geschriebenes und verständliches Handbuch ist es, die Sicherheit der Benutzer zu gewährleisten. Dabei ist in vielen Richtlinien zu lesen, dass die Textverständlichkeit und Zielgruppenorientierung einen immer höheren Stellenwert bekommen: Die Betriebsanleitung soll dem allgemeinen Wissenstand und der Verständnisfähigkeit der Benutzer Rechnung tragen.
Textverständlichkeit

Folgende Themen müssen im Handbuch beschrieben sein:

  • Produkteigenschaften, Leistungen und Funktionen
  • Bestimmungsgemäße Verwendung
  • Vorhersehbare Fehlanwendungen, die konstruktiv nicht vermieden werden können

Für die Warn- und Sicherheitshinweise, die die Benutzer vor Gefahren schützen sollen, haben die Redakteure auf eine ordnungsgemäße Risikobeurteilung zugegriffen.

Hersteller müssen folgende Handbuch-Typen erstellen und mit ausliefern:

  • Montageanleitung
  • Installationsanleitung
  • Betriebsanleitung
  • Instandhaltungsanleitung

Online-Hilfe für Software schreiben und als Handbuch publizieren

Auch Softwaredokumentation, die zunächst als Online-Hilfe erstellt wird, kann als Handbuch publiziert werden. Das Handbuch für eine Softwareanwendung wird in der Regel mit dem Softwareprodukt als Online-Hilfe ausgeliefert. Hier liegt auch schon der größte Unterschied zum Handbuch für den Maschinenbau: Eine Online-Hilfe bietet ganz andere Möglichkeiten im Erstellungsprozess als ein Handbuch, das gedruckt wird. Dennoch machen moderne Redaktionssysteme es möglich, verschiedene Ausgabeformate crossmedial zu publizieren. So ist es möglich, die Softwaredokumentation nicht nur als Online-Hilfe, sondern auch als Handbuch zu publizieren.

Neben den Unterschieden zwischen der Online-Hilfe für Softwaredokumentation und Handbüchern gibt es freilich auch eine Reihe von Überschneidungen mit der Textsorte Handbuch. Im Bereich der Softwaredokumentation haben Online-Hilfen aus einer Reihe von guten Gründen die Nachfolge von Handbüchern angetreten, dabei allerdings auch einige Strukturmerkmale von ihnen übernommen: Ordnungsstrukturen wie etwa ein hierarchisch gegliedertes Inhaltsverzeichnis mit Haupt- und Unterkapiteln oder ein Schlagwortregister wird man sowohl in Handbüchern als auch in Online-Hilfen antreffen.
Softwaredokumentation