Sie haben ein Produkt entwickelt und möchten eine kleine Bedienungsanleitung schreiben? Die Grundidee einer Bedienungsanleitung kann man schon bei vielen Höhlenmalerien erkennen. Versteht man diese Malerien als Anleitung zum Jagen (was sie vielleicht sind), wird schnell deutlich, worum es auch heute noch geht:

Den sicheren Umgang mit Technik lernen.

Bedienungsanleitungen zu schreiben, ist auch eine Tätigkeit, die heute voller Formalismen steckt, was mit den zahlreichen rechtlichen Anforderungen zusammenhängt. In diesem kurzen Tutorial erfahren Sie, wie man eine erste Bedienungsanleitung schreibt und dabei auf der sicheren Seite bleibt.

Untersuchungen beweisen, dass die Akzeptanz eines Produkts auch davon abhängig ist, ob die Features des Produkt wirklich bekannt sind. Gerade bei komplexen und innovativen Produkten mit vielen Funktionen ist Verständlichkeit besonders wichtig. Insofern lohnt sich das Thema.

Eine Bedienungsanleitung soll eine sichere und effiziente Nutzung eines Produkts ermöglichen. In Prinzip enhält eine Bedienungsanleitung genau die Informationen, die Sie auch einen guten Freund mitteilen würden. Dass dazu auch Sicherheitsinformationen gehören, versteht sich von selbst.

Wenn Sie diesen Satz im Hinterkopf behalten (und Sie stimmen sicher zu.), kennen Sie die Richtschnur, der letztendlich auch die vielen verwinkelten Normen folgend, die es dazu gibt.

In diesem Tutorial lernen hier, wie Sie eine Bedienungsanleitung anhand einer Word-Vorlage schreiben. Es handelt sich bei der Vorlage um ein Dokument, dass erfolgreich in Maschinenbau- und Software-Firmen eingesetzt wurde und wird. Die Vorlage deckt einen großen Teil dessen ab, was in einer typischen Bedienungsanleitung begegnen kann.

Um mit dieser Vorlage arbeiten zu können, sollten Sie sich ein wenig mit der Verwendung von sog. Formatvorlagen vertraut machen. Formatvorlagen sind wiederverwendbare Einstellungen für die Formatierung von Absätzen und anderen Elementen. Formatvorlagen reduzieren die Zeit, die Sie mit einem Dokument verbringen, um 80 % im Vergleich zu herkömmlichen Arbeitsweisen.

Sie benötigen einen kleinen Word-Kurs als Einstieg? Schreiben Sie uns eine Nachricht über unser Kontakt-Formular.

Was muss eine Bedienungsanleitung enthalten?

Was eine Bedienungsanleitung enthalten muss, ergibt sich aus rechtlichen Anforderungen (v.a. bei Maschinen), aus Empfehlungen von Berufsverbänden (VDI, tekom) und natürlich aus didaktischen Grundsätzen.

Jede Bedienungsanleitung sollte mindestens die folgenden Elemente enthalten:

  • Titelblatt mit Abbildung und Produktbezeichnung (zur Identifikation)
  • Leistungsbeschreibung, aus der hervorgeht, wozu das Produkt dient, inklusive der vorhersehbaren Fehlanwendung.
  • Sicherheitskapitel
  • Eine Übersicht über alle Bedienelemente (bei Software über die Oberfläche)
  • Anleitungen zu den allen Tätigkeiten, die man mit dem Produkt ausführen kann/soll.
  • Zusätzliche technische Informationen (Tabellen und Zeichnungen)

Diese 6 Punkte geben eine erste Orientierung, worauf des bei der Bedienungsanleitung ankommt. Die Grundidee lautet: Die Nutzer müssen alle Informationen erhalten, die sie für die (sichere) Nutzung eines Produkt während jeder Phase des Produktlebenszyklus benötigen. Bei Bedarf (und je nach rechtlicher Rahmenbedingung) muss diese Liste um viele weitere Punkte ergänzt werden.

Die hier angeführten Punkte sind eine Mindestanforderung, die fast immer gilt.

Es ist von großer Bedeutung, dass Bedienungsanleitungen alle Sicherheitsinformationen enthalten. Bevor Sie jetzt ihr Dokument mit Warnhinweisen füllen, orientieren Sie sich an folgendem Grundsatz:

Was würden Sie Ihrem besten Freund sagen, bevor er mit dem Produkt arbeitet?

Das Wort „sagen“ ist hier bewusst fett markiert. Damit soll erreicht werden, dass sie nicht sofort auf die rechtlichen Bedingungen schauen, sondern gesunden Menschenverstand walten lassen. Der gesunde Menschenverstand ist wichtiger als die formaljuristischen Anforderungen.

Wenn Sie wissen, was Sie ihrem besten Freund sagen, bevor er mit der Maschine arbeitet, haben Sie eine wichtige Grundlage gelegt. Sie werden nicht langatmig beschreiben, sondern kurz und bündig anleiten. Sie werden ihrem Freund auf Gefahren hinweisen. Sie werden eine Sprache benutzen, die ihr Freund versteht. Somit erfüllen Sie all das, was stilistische gute Dokumentationen ausmacht. Dass dies im einwandfreien Deutsch geschehen muss, versteht sich von selbst.

Natürlich bleibt es nicht dabei. Schauen Sie im zweiten Schritt, welche Normen und Gesetze berücksichtigt werden müssen. Verwenden Sie eine klare Sprache mit ordentlichen Formulierungen. Orientieren Sie sich an didaktischen Ratgebern. In diesem zweiten Schritt geben Sie dem Handbuch den genau den Schliff, der formell verlangt wird.

Sicherheit und Risikobeurteilungen

Formell gesehen ist die Quelle für die Sicherheitsinformationen eine Risikobeurteilung. Risikobeurteilungen sind interne Dokumente, in denen vor und während der Produktentwicklung Gefahren, Risiken und Möglichkeiten der Abwendung aufgelistet werden. Je nach Branche existieren unterschiedliche Möglichkeiten, Risikobeurteilungen anzufertigen. In sensiblen Bereichen sind die Methoden vorgeschrieben.

Zwei wichtige Orte für Sicherheitsinformationen sind das Sicherheitskapitel und die Anleitungstexte. Das Sicherheitskapitel enthält eine Zusammenfassung über alle Punkte, die beachtet werden müssen. Im Sicherheitskapitel geht es nur um die Sicherheit, wie der Name schon sagt.

In den Anleitungstexten müssen ebenfalls Sicherheitsinformationen gegeben werden. Man spricht hier auch von Warnhinweisen. Im Gegensatz zu den Informationen im Sicherheitskapitel werden an handlungsbezogene Warnhinweise bestimmte Ansprüche an die Formatierung gestellt.

Ein gutes Sicherheitskapitel zeichnet sich dadurch aus, dass es durch eine didaktisch sinnvolle Gestaltung zum Lesen einlädt. Alle geforderten Informationen aus der Risikobeurteilung müssen hier auftauchen.