Betriebsanleitung erstellen

Sie müssen eine Betriebsanleitung oder Bedienungsanleitung erstellen und fragen sich, wie das geht und was Sie dabei beachten müssen? Hier erhalten Sie wertvolle Tipps sowie Muster und Vorlagen zum Download.

Was ist eine Betriebsanleitung und welchen Zweck erfüllt sie?

Die Betriebsanleitung ist ein Teil der Technischen Dokumentation. Sie enthält Informationen, die für den sicheren Betrieb der Maschine, der Anlage oder des Geräts notwendig sind. Der Hersteller ist beim Inverkehrbringen eines Produkts dazu verpflichtet, dem Kunden eine Betriebsanleitung bereitzustellen. Der Nutzer muss diese Anleitung lesen und die im Dokument beschriebenen Informationen in der Praxis umsetzen. Die Betriebsanleitung gewährleistet somit den sachgemäßen Gebrauch und den korrekten Umgang mit der Maschine.

Eine Betriebsanleitung muss so erstellt werden, dass sie den rechtlichen Anforderungen genügt. Darüber hinaus soll sie dem Nutzer auf möglichst einfache und verständliche Art und Weise den sicheren Umgang mit dem Produkt erläutern. Um diesen Anforderungen gerecht zu werden, müssen einige Normen, Richtlinien und Regeln berücksichtigt werden.

Was beinhaltet eine Betriebsanleitung und was muss bei der Erstellung beachtet werden?

Die inhaltlichen Anforderungen an eine Betriebsanleitung sind unter anderem in der Norm DIN EN 82079–1 geregelt. Im Speziellen sind hier grundlegende Regeln und Prinzipien für eine vollständige und benutzerfreundliche Dokumentation definiert. Diese Regeln gelten jedoch nicht nur für reine Betriebsanleitungen, sondern können auf alle Anleitungen im Bereich der Technischen Dokumentation angewendet werden. Die Einhaltung der Normen und Richtlinien ist notwendig für eine erfolgreiche Konformitätsbewertung und die damit verbundene Vergabe der CE-Kennzeichnung.

Weitere Normen und Richtlinien, die bei der Erstellung von Betriebsanleitungen eine Rolle spielen, sind abhängig von der Art des Produkts. Daher müssen die normativen Anforderungen bei jeder Anleitung neu bestimmt werden. Beispiele für zu beachtende Richtlinien und Normen sind:

Maschinenrichtlinie
Niederspannungsrichtlinie
IEC/IEEE 82079–1 (Erstellen von Nutzerinformationen)
ISO 17644 (Herstellerangaben für Medizinprodukten)
ISO 26511 (Software und System-Engineering)

Im Folgenden werden nun wichtige Prinzipien für das Erstellen von Betriebsanleitungen beschrieben:

Beim Erstellen einer Anleitung jeglicher Art ist es sehr wichtig, die Zielgruppe und deren Eigenschaften, Gewohnheiten und Erwartungen zu berücksichtigen. Hierfür kann eine Zielgruppenanalyse durchgeführt werden, bei der folgende Fragen geklärt werden:

Welche Altersgruppe wird angesprochen? Muss die Anleitung besonders kind- oder seniorengerecht gestaltet und geschrieben werden?
Müssen kulturelle oder soziale Besonderheiten beachtet werden?
Sind bestimmte Kenntnisse / Fähigkeiten vorhanden? Dem entsprechend können Fachbegriffe oder Handlungsschritte ohne zusätzliche Erklärung verwendet und beschrieben werden.
Wie ist das sprachliche Niveau? Eine Anleitung für Kinder / Jugendliche sollte anders geschrieben werden als eine Anleitung für Maschinenbau Ingenieure
Wird das Produkt unter besonderen Bedingungen genutzt und verwendet?
Wie wird die Zielgruppe diese Anleitung nutzen? Dient sie eher als Nachschlagewerk, Schulungsgrundlage, Handbuch oder Lerngrundlage?
Welche Erwartungen hat die Zielgruppe an die Anleitung?
Welche Erwartungen hat die Zielgruppe an das Produkt? Hieraus lässt sich das erwartungsgemäße Nutzerverhalten ableiten.

Auf Basis der Zielgruppenanalyse muss die Betriebsanleitung konzipiert werden. Dabei gilt es Folgendes zu beachten:

Eine zielgruppengerechte und einheitliche Terminologie-Liste anlegen und verwenden.
Einen sprachlichen Formulierungsstil festlegen, der möglichst einfache Satzkonstrukte verwendet. Hierbei helfen Styleguides und Technical Writing Sheets.
Grafiken und Illustrationen erstellen und im Dokument platzieren.
Eine übersichtliche Dokumentationsstruktur festlegen, bei der möglicherweise unterschiedliche Dokumente für unterschiedliche Zielgruppen erstellt werden. (Der Installateur bekommt eine andere Anleitung als der Bediener)
Eine inhaltliche Gliederung für das Dokument festlegen. Hier kann man sich zum Beispiel am Lebenszyklus der Maschine oder des Geräts orientieren.
Festlegen, wie die Qualität des Dokuments gesichert werden kann. Hierbei können Korrektur-Programme und Reviewprozesse angewendet werden.

Die Anleitung(en) eines Produkts haben einen genauso hohen Stellenwert wie das Produkt selbst. Das heißt, wenn die Anleitung fehlt, ist das Produkt unvollständig und wenn die Anleitung fehlerhaft ist, ist auch das Produkt fehlerhaft. An diesem Ansatz wird deutlich, welche Wichtigkeit der Dokumentation zuzuschreiben ist.

Die Anleitung als Teil des Produkts dient dazu, dessen Bestimmungsgemäßen Gebrauch zu gewährleisten. Somit muss der Bestimmungsgemäße Gebrauch definiert und beschrieben werden. Darüber hinaus muss zusätzlich vor absehbarem Nicht-Bestimmungsgemäßen (zweckentfremdeten) Gebrauch gewarnt werden.

Um dem Nutzer die Installation, Bedienung, Wartung, Reinigung und sonstige Anwendungen möglichst leicht verständlich zu vermitteln, ist es sinnvoll, gerade bei komplizierteren Anlagen und Maschinen, das Dokument in mehrere Teildokumente zu gliedern. Dieser Ansatz wurde auch schon im Zusammenhang mit der zielgruppengerechten Dokumentation erwähnt.

Mehrere Dokumentationen sind ebenfalls vorteilhaft, wenn das Produkt in verschiedenen Produktvarianten existiert. Hier ist es nutzerfreundlicher, genau die passende Dokumentation zu liefern, anstatt einem großen Dokument, indem der Nutzer vorab die passende Variante identifizieren muss.

Zuletzt sei erwähnt, dass eine bleibende Verfügbarkeit sowie die Möglichkeit zur Aktualisierung gegeben sein muss. Dies lässt sich beispielsweise über eine Internetpräsenz realisieren, bei der die Nutzer immer die aktuellste Version der Dokumentation herunterladen können.

Die erstellten Betriebsanleitungen müssen dem Nutzer so leicht wie möglich zur Verfügung gestellt werden. Hierbei ist auch wieder die Zielgruppe zu berücksichtigen, da ältere Menschen eventuell schwerer Zugang zu z.B. mobilen Endgeräten haben als Jüngere. Bei der Bereitstellung stehen dem Hersteller unterschiedliche Medien zur Verfügung:

Anbringung auf dem Produkt

Je nach Größe und Beschaffenheit des Produkts können Symbole, Hinweise, kurze Erklärungen und Handlungsanweisungen auf der Produktoberfläche angebracht werden. Dies bietet sich bei kleinen Handlungsschritten oder wichtigen Sicherheitshinweisen an. Wichtig zu beachten ist hierbei, dass diese Informationen nicht die eigentliche Betriebsanleitung ersetzen, sondern lediglich als Ergänzung zu sehen sind.

Anbringung auf der Verpackung

Da die Verpackung meistens direkt entsorgt wird, muss sich der Hersteller genau überlegen, welche Informationen er hier anbringen will. Im Regelfall bietet es sich hier an, Transport- und Lageranweisungen sowie Tipps zum Entfernen der Verpackung zu platzieren.

Dokumentation in Papierform

Dies ist bislang die geläufigste Bereitstellungsmethode. Der Nutzer findet alle wichtigen Informationen gebündelt in einem Dokument (oder gegebenenfalls in mehreren Teildokumenten). Wichtig hierbei ist es, gerade bei großen Dokumentationen, den Inhalt gut zu strukturieren und mit Inhaltsverzeichnis und Index leicht auffindbar zu machen.

Dokumentation auf einem Datenträger

Es ist weiterhin möglich, die Dokumentation beispielsweise als PDF auf einem Datenträger (CD, USB-Stick) zu liefern. Hierdurch kann der Nutzer mittels Suchfunktion leichter nach bestimmten Inhalten suchen. Weiterhin können zusätzliche Dokumentationsmethoden zur Anwendung kommen. Zum Beispiel können Informationen mithilfe von Videos, Utility-Filmen oder Animationen übermittelt werden. Durch diese Medien lassen sich beispielsweise schwierige Handlungs- oder Montageschritte leicht und anschaulich erklären. Voraussetzung für diese Art von Dokumentation ist jedoch, dass der Nutzer im Anwendungsbereich des Produkts die Möglichkeit hat, auf einen PC, Laptop oder Tablet zuzugreifen.

Dokumentation im Internet

Diese Art der Bereitstellung ähnelt der Dokumentation auf einem Datenträger. Der Nutzer hat Zugriff auf die Dokumentation über die Internetseite des Herstellers. Vorteilhaft ist hierbei, dass der Hersteller die Informationen immer aktuell halten kann und der Nutzer somit immer Zugriff auf den aktuellsten Dokumentationsstand hat. Wenn die Dokumentation nicht für jedermann einsehbar sein soll, lässt sich der Zugriff steuern, z. B. über Benutzerkonten oder einem Zugriffscode.

Wie oben erwähnt, ist die Technische Dokumentation ein Teil des Produkts und gewährleistet den Sicheren und Bestimmungsgemäßen Gebrauch. Des Weiteren ist sie notwendig für eine erfolgreiche Konformitätsbewertung und die Vergabe der CE-Kennzeichnung. Aus diesem Grund ist es wichtig, ein Qualitätssicherungskonzept bei der Erstellung zu verfolgen. Ein solches Konzept kann unter anderem folgende Regeln enthalten:

Erstellen einer Terminologie-Liste und striktes Anwenden dieser Terminologie. Das heißt man einigt sich auf eine feste Menge von Fachbegriffen, die im gesamten Dokument einheitlich verwendet werden. So wird vermieden, dass die gleiche Sache im Dokument verschiedene Bezeichnung bekommt (z.B.: Sechskantschlüssel und Schraubenschlüssel)
Konsequente Stilregeln in den Texten sowie im Layout
Erstellen eines Grafikkonzepts (Software, Farben, Stil der Grafiken)
Inhalte strukturiert erfassen, verwalten und wiederverwendbar gestalten (Dafür ist es ratsam, mit einem Redaktionssystem oder geeigneter Software zu arbeiten)
Durchführen von redaktionellen Reviewprozessen (Kontrolle von Layout, Inhalt, Rechtschreibung, Stil, Grafiken, usw.)

Wie ist eine Betriebsanleitung aufgebaut?

Die Inhalte einer Betriebsanleitung lassen sich in unterschiedliche Teile gliedern. Dieser Aufbau ist jedoch nicht allgemein gültig, sondern muss je nach Größe und Komplexität des Produkts angepasst werden.

Zu Beginn der Anleitung befindet sich der Titel, das Impressum mit Kontaktdaten vom Hersteller und das Inhaltsverzeichnis. Ein optionales Vorwort kann einleitende Informationen zum Produkt liefern, die Zielgruppe definieren, die Lebenszyklen des Produkts vorstellen und den Umgang mit der Betriebsanleitung erläutern.

Das Kapitel Sicherheit enthält sämtliche Sicherheitshinweise, die im Umgang mit dem Produkt zu beachten sind. Der Nutzer sollte instruiert werden, bevor er eine Handlung am Produkt vornimmt, dieses Kapitel ausführlich zu lesen und zu verinnerlichen. Das Kapitel Sicherheit dient auch als Grundlage für Schulungen und Sicherheitsunterweisungen im Unternehmen.

Das Kapitel zur Leistungsbeschreibung enthält Informationen zum Bestimmungsgemäßen Gebrauch, den Anforderungen an die Umwelt und den Technischen Daten.

Die Gerätebeschreibung beinhaltet eine Liste aller im Lieferumfang enthaltenen Teile. Diese Teile werden vorgestellt und erklärt. Zusätzlich kann das Kapitel Informationen zu Aufstellung, Lagerung, Transport, Verpackung sowie Außerbetriebnahme und Entsorgung enthalten.

Die Tätigkeits- oder Bedienbeschreibung nimmt meistens den größten Teil der Dokumentation ein. Hier werden die einzelnen Bedienelemente vorgestellt und deren Funktionen erläutert. Es können Use Cases beschrieben werden, die mithilfe von Schritt für Schritt Anweisungen die wichtigsten Bedienprozesse verdeutlichen. Darüber hinaus enthält der Abschnitt Informationen zu Wartung, Fehlersuche, Schnittstellen und möglichen Zusatzelementen.

Ein Kapitel zur Funktionsweise kann erforderlich sein, wenn der Nutzer die Funktionsweise verstehen muss, um die Maschine / Anlage sicher bedienen zu können.

Auch technische Unterlagen wie Zuliefererdokumentation, Konformitätserklärung, Ersatzteillisten, Elektro- und Pneumatikplan müssen, wenn vorhanden, Teil der Betriebsanleitung sein.

Abschließend dient ein Index zur besseren Suche nach Stichwörtern und ein Änderungsverzeichnis kennzeichnet alle durchgeführten Änderungen und Aktualisierungen.

Wie werden Betriebsanleitungen erstellt?

Für die Erstellung von Betriebsanleitungen ist die Technische Redaktion zuständig. Hier arbeiten ausgebildete und erfahrene Technische Redakteure, die mit den Normen und Richtlinien zur Technischen Dokumentation vertraut sind.

Die Technische Redaktion benutzt in der Regel Software, die speziell für das Schreiben von Betriebsanleitungen konzipiert ist. Hier ist in erster Linie die Software Adobe FrameMaker zu nennen. Mit Adobe FrameMaker lassen sich sehr umfangreiche Dokumentationen erstellen und strukturieren. Aber auch gewöhnlichere Programme wie Microsoft Word oder Adobe InDesign können zum Schreiben von Betriebsanleitungen verwendet werden. Eine detaillierte Übersicht zu dieser Software finden Sie in dem Artikel Technische Dokumentation.

Vorlage / Muster einer Betriebsanleitung bzw. Bedienungsanleitung

Hier können Sie sich eine Word-Vorlage einer Betriebsanleitung herunterladen. Die Vorlage enthält eine beispielhafte Gliederung und Struktur, die eine Betriebsanleitung für Maschinen, Anlagen und Produkte gemäß Maschinenrichtlinie enthalten sollte. Sie müssen nur noch die Inhalte für Ihre Maschine an den richtigen Stellen einfügen. Natürlich können Sie die Vorlage auch für alle anderen Produkte nutzen, indem Sie sie einfach für Ihren Zweck anpassen.

Wann ist eine Betriebsanleitung erforderlich?

Prinzipiell wird eine Betriebsanleitung immer dann benötigt, wenn ein Hersteller ein Produkt in Verkehr bringen will und Kunden dieses Produkt erwerben können. Der Begriff Produkt schließt hierbei alle Geräte von einem kleinen Feuerzeug bis hin zu großen Maschinen und Anlagen mit ein. In der DIN EN 82079–1 ist hierzu gefordert:

„Einem Produkt muss eine Gebrauchsanweisung beigefügt werden, die seinen bestimmungsgemäßen Gebrauch fördert und alle Informationen enthält, die der Nutzer bei Gebrauch des Produkts wissen muss“.

Was ist der Unterschied zwischen einer Betriebsanleitung und einer Bedienungsanleitung?

Im Bereich der Technischen Dokumentation werden unterschiedliche Begriffe für verschiedene Arten von Anleitungen verwendet. Dies liegt zum einen an den spezifischen Inhalten der Dokumentation und zum anderen an historisch bedingten Trends und Gebräuchlichkeiten bei der Namensvergebung. Auch die unterschiedlichen Normen und Richtlinien fordern teilweise unterschiedliche Bezeichnungen. So fordert unter anderem die EG-Maschinenrichtlinie die Bezeichnungen „Montageanleitung“ und „Betriebsanleitung“, während in der DIN EN 82079–1 von „Gebrauchsanweisungen“ gesprochen wird. Im Folgenden werden kurz einige Begriffe vorgestellt und erläutert:

Betriebsanleitung / Handbuch

Enthält Informationen, Hinweise und Anweisungen, die für den sicheren und bestimmungsgemäßen Betrieb notwendig sind
Gefordert nach der EG-Maschinenrichtlinie

Bedienungsanleitung / Gebrauchsanleitung

Kann Inhalte aus der Betriebsanleitung enthalten oder diese ersetzen
Enthält Bedienkonzepte und Schritt für Schritt Anweisung, die den Umgang mit dem Produkt erklären
Gefordert nach der DIN EN 82079–1

Montageanleitung / Installationsanleitung

Beschreibt den Ablauf der Installation / Montage unter Berücksichtigung der Sicherheitsstandards

Wartungsanleitung

Beschreibt den Ablauf und die Regelmäßigkeit der Wartung unter Berücksichtigung der Sicherheitsstandards

Softwareanleitung, Benutzerhandbuch, User guide, User manual

Sind gleichzusetzen mit einer Bedienungsanleitung in der Produktgruppe Software

Kurzanleitung / Quickguide

Eher gedacht für weniger komplizierte Geräte im Consumerbereich
Der Nutzer möchte das Gerät nach dem Kauf möglichst schnell in Betrieb nehmen ohne erst eine komplette Anleitung lesen zu müssen
Enthält die wichtigsten Sicherheitshinweise und eine Schritt-für-Schritt-Anleitung, um das Produkt in Betrieb zu nehmen
Beschränkt sich möglichst auf eine oder wenige Seiten
Ersetzt nicht die eigentliche Betriebs- oder Bedienungsanleitung

Wer erstellt die Betriebsanleitung?

Der Hersteller ist für die Erstellung der Betriebsanleitung verantwortlich. Die Anleitung muss dem Kunden zusammen mit dem Produkt, der Maschine oder der Anlage ausgeliefert werden. Wenn die Betriebsanleitung im eigenen Unternehmen erstellt wird, ist es ratsam, eine eigene Technische Redaktion zu haben. Da die Betriebsanleitung ein solch wichtiger Teil des Produkts ist und vielen rechtlichen Normen und Anforderungen gerecht werden muss, lässt sich der Erstellprozess nur schwer „nebenbei“ erledigen und sollte von einem erfahrenen Technischen Redaktionsteam bearbeitet werden. Falls das eigene Unternehmen keine Kapazitäten zur Erstellung der Anleitung hat, lässt sich dieser Prozess auf externe Dienstleister auslagern. Wie die Zusammenarbeit zwischen Dienstleister und Kunden im Speziellen aussieht, erfahren Sie im Artikel Technische Dokumentation Dienstleister.