Bedienungsanleitung erstellen. So geht’s. Mit Beispielen.

Sie müssen in nächster Zeit eine Bedienungsanleitung schreiben oder haben gerade richtig Lust darauf eine Bedienungsanleitung zu erstellen?

Dann lesen Sie hier weiter. Denn Bedienungsanleitungen schreiben wir als Technische Redakteure täglich. Wir zeigen Ihnen, welche Schritte beim Erstellen einer Bedienungsanleitung wichtig sind. Und wie Sie den Überblick bei all den gesetzlichen Anforderungen behalten.

Schreiben Sie eine Bedienungsanleitung, die gerne gelesen wird und wirklich weiterhilft. Das nennen wir in der Technischen Dokumentation heute UX (User Experience Design).

Um das geht’s in diesem Artikel:

Wann müssen Sie eine Bedienungsanleitung erstellen?
Schritt 1: Erst Zielgruppe kennen, dann Bedienungsanleitung erstellen.
Schritt 2: Tätigkeitsanalyse – wer macht was?
Schritt 3: Aufbau, Inhalt, Struktur – Das muss in die Bedienungsanleitung.
Schritt 4: Recherche und Infosammlung – so füllen Sie die Bedienungsanleitung mit Inhalt.
Schritt 5: Das sind unsere Tools, mit denen wir Bedienungsanleitungen schreiben.
Schritt 6: Der Sprachstil – schreiben Sie eine Bedienungsanleitung für die Nutzer.
Schritt 7: Illustrationen, Animationen, Videos ergänzen.
Schritt 8: Eine Bedienungsanleitung schreiben mit Qualität – jetzt geht’s ans Testen und Korrekturlesen.
Schritt 9: Gedruckt oder digital? Bedienungsanleitung bereitstellen.
Bedienungsanleitung schreiben: Unsere Muster und Beispiele.
Sie müssen nicht alles selbst machen: Bedienungsanleitung erstellen lassen.

Wann müssen Sie eine Bedienungsanleitung erstellen?

Eines ist sicher: Sobald Sie ein Produkt herstellen und vertreiben, das in irgendeiner Weise bedient werden kann, müssen Sie dazu eine Bedienungsanleitung erstellen.

Es ist sogar so, dass die Bedienungsanleitung Teil des Produkts ist. Fehlt die Bedienungsanleitung, ist Ihr Produkt schlichtweg unvollständig. Enthält die Bedienungsanleitung Fehler, ist auch Ihr Produkt fehlerhaft. Wurde die Bedienungsanleitung dagegen qualitativ hochwertig erstellt, wirkt sich das auch gut auf Ihr Produkt aus. Bedienungsanleitung und Produkt hängen also zusammen.

In der Bedienungsanleitung beschreiben Sie den sicheren und bestimmungsgemäßen Gebrauch Ihres Produkts. Damit stellen Sie sicher, dass Ihr Produkt eben nicht einfach nur ‚irgendwie‘ bedient wird. Sondern so, wie Sie es vorsehen – bestimmungsgemäß. Daneben warnen Sie vor möglichen Risiken beim Gebrauch des Produkts.

Sie können eine ausführliche Bedienungsanleitung schreiben oder eine knackige Kurzanleitung mit vielen Bildern. Machen Sie es so, wie es die Nutzer benötigen (Stichwort ‚Zielgruppenanalyse‘), und was Normen, Gesetze und Richtlinien dazu sagen.

Wie geht das nun, Bedienungsanleitungen schreiben?

Schritt 1: Erst Zielgruppe kennen, dann Bedienungsanleitung erstellen.

Ist es das erste Mal, dass Sie für das Produkt eine Bedienungsanleitung schreiben? Dann beschäftigen Sie sich im Idealfall erst einmal mit der Zielgruppe der Bedienungsanleitung. Also mit den Menschen, für die Produkt und Bedienungsanleitung bestimmt sind.

Je nach Ausbildung, Vorwissen und Arbeitsfeld der Anwender ergeben sich andere Inhalte für Ihre Bedienungsanleitung. Kennen Sie die Zielgruppe, können Sie etwa Terminologie, Sicherheitshinweise und Informationstiefe darauf abstimmen. Und Sie werden feststellen: Sie haben nicht nur eine Zielgruppe, sondern gleich mehrere (Bediener, Administratoren, Installateure, Techniker, …).

Und je nach Zielgruppe können sich Textmenge und Inhalte unterscheiden, denn zum Beispiel braucht nicht jeder Anwender super detailreiche Handlungsanweisungen oder technische Hintergrundinformationen zum bloßen Bedienen des Produkts.

Zielgruppenanalyse – wie geht das jetzt?

Sammeln Sie erst einmal statistische Daten zu Ihrer Zielgruppe (Alter, Ausbildung, Sprache, …). Diese basieren etwa auf vorherigen Befragungen und Forschungen sowie auf Ihrer Feldkenntnis.

Beantworten Sie dann Fragen wie:

Welche Ausbildung oder Berufserfahrung hat die Zielgruppe? Welche Kenntnisse und Fähigkeiten?
Welchen Informationsbedarf hat die Zielgruppe?
Welches Nutzerverhalten erwarten Sie im Umgang mit dem Produkt?
Was erwartet die Zielgruppe von der Bedienungsanleitung?
Richtet sich die Bedienungsanleitung an Menschen mit besonderen Bedarfen (ältere Menschen, Kinder oder Jugendliche, Menschen mit Beeinträchtigungen)?
Wo wird die Bedienungsanleitung genutzt? Gibt es hier Einsatzbedingungen, die bereits klar sind (z. B. von einem Techniker auf Montage, im Außendienst oder online am PC während des Bedienens einer Software)?
Brauchen die Anwender bestimmte Mittel für den Zugang zur Bedienungsanleitung (Internetzugang, Handynetz, Audio, Video, …)?
Was sind die Arbeitsbedingungen (Temperatur, Feuchtigkeit, Schmutz, Licht, …)?

Schritt 2: Tätigkeitsanalyse – wer macht was?

Sie haben die Zielgruppe(n) für Ihr Produkt herausgefunden? Sehr gut.

Dann geht’s jetzt weiter mit dem Produkt selbst. Eine super Sache, um den Inhalt für Ihre Bedienungsanleitung herauszufinden, ist die ‚Was macht wer‘-Matrix.

Die nutzen wir sehr gerne. Wir nennen sie auch die Task-Analyse: wir gehen davon aus, dass Bedienungsanleitungen Handlungsanweisungen für die Nutzer enthalten, eben den Tasks.

Wie gehen Sie hier vor?

Überlegen Sie, welche Handlungsanweisungen oder Funktionen der Anwender kennen muss, um Ihr Produkt bedienen zu können. Zu diesen müssen Sie dann etwas in der Bedienungsanleitung schreiben. Welche Kenntnisse können Sie dabei voraussetzen?

Beispiel: Sie sind Hersteller eines Software-Produkts, das zum Management von Proben in einem mittelgroßen Labor eingesetzt wird. Sie müssen den Anwendern nicht mehr beschreiben, wie ein PC gestartet wird, wohl aber wie die Software installiert wird.

Überlegen Sie sich also alle Tasks und schreiben diese in eine Liste, Mindmap oder Tabelle.

Software installieren.
Log in.
Einen neuen Benutzer anlegen.
Eine neue Aufgabe anlegen und zuweisen.
Einen xy-Alarm beheben.
…

Überlegen Sie sich dann, wer diese Tasks durchführen wird.

Software installieren. (Service oder Administrator)
Log in. (Anwender)
Einen neuen Benutzer anlegen. (Administrator)
Eine neue Aufgabe anlegen und zuweisen. (Administrator)
Einen xy-Alarm beheben. (Service)
…

Inhalte, die für den Service gedacht sind, sollten Sie nicht in eine Bedienungsanleitung schreiben, die für Endanwender ist. Wenn sich das z. B. aus logistischen Gründen nicht vermeiden lässt, dann müssen Sie zusätzliche Warnungen einfügen oder mit Zugriffsrechten arbeiten.

Gruppieren Sie nun zusammenhängende Handlungsanweisungen. Ordnen Sie die Inhalte nach Zeitpunkt der Durchführung oder nach Lebensphasen des Produktes. Machen Nutzer diese Schritte eher einmalig am Anfang bei der erstmaligen Nutzung des Produkts oder regelmäßig während des Routinebetriebs? So erhalten Sie schon sehr detailliert eine Struktur für die Bedienungsanleitung.

Schritt 3: Aufbau, Inhalt, Struktur – Das muss in die Bedienungsanleitung.

Inhalt und Aufbau der Bedienungsanleitung können sich aus der gerade beschriebenen ‚Was macht wer‘-Matrix ergeben. Definitiv aber auch durch Normen, Gesetze und Richtlinien. Sie sind also nicht ganz frei, was den Inhalt Ihrer Bedienungsanleitung angeht.

Eine der Normen, die Sie hier zu Rate ziehen sollten, ist die DIN EN 82079-1 Erstellen von Gebrauchsanleitungen – Gliederung, Inhalt und Darstellung. Das ist quasi DIE Norm für Technische Redakteure wie uns.

Wie der Name schon vermuten lässt, macht die Norm Vorgaben für Inhalt und Aufbau einer Bedienungsanleitung.

Im Groben schreiben Sie in der Bedienungsanleitung über folgende Bereiche im Umgang mit Ihrem Produkt:

Vor dem Gebrauch:

Warnungen vor Risiken, Sicherheitsanweisungen
Transport und Lagerung
Technische Daten
Beschreibung des Produkts, Gerätebeschreibung
Installation und Montage
Inbetriebnahme

Während des Gebrauchs:

Bedienung des Produkts (Routine)
Umgang mit Fehlern und Notsituationen (Troubleshooting)
Instandhaltung und Wartung des Produkts
Verbrauchsmaterialien und Ersatzteile
Reparatur und Austausch von Verbrauchsmaterialien und Ersatzteilen

Nach dem Gebrauch:

Außerbetriebsetzung
Abbau und Entsorgung des Produkts

Zusatz:

Zuliefererdokumentation
Elektro- und Pneumatikpläne
Konformitätserklärung
Ersatzteillisten

Je nach Produkttyp und Anwendungsfall entfallen manche der genannten Punkte.

Sehen Sie hier Beispiele für den Aufbau und Inhalt für Bedienungsanleitungen:

Schritt 4: Recherche und Infosammlung – so füllen Sie die Bedienungsanleitung mit Inhalt.

Wir wissen aus Erfahrung: Sie fangen beim Schreiben einer Bedienungsanleitung selten bei Null an. Oft gibt es schon Lastenhefte mit Anforderungen an das Produkt oder Dokumente von Entwicklern, die auf Funktionen schließen lassen.

Sprechen Sie mit den Experten für das jeweilige Produkt. Das sind Entwickler, Technische Produktmanager für Hardware oder Software, sowie Trainer.

Lassen Sie sich eine Einweisung in das Produkt geben. Wie ist es zu installieren? Wie zu bedienen? Wie zu warten? Diese Fragen sind selten in nur einem Meeting zu klären. Am besten finden wir es, wenn wir das Produkt auch selbst anfassen, bedienen und testen können. Das gilt sowohl für kleine Produkte als auch für große Geräte und Systeme. Machen Sie also einen Termin ab mit dem Produkt vor Ort. Häufig können Sie damit einen Beitrag zur Usability – also der Gebrauchstauglichkeit – liefern.

Manchmal ist es aber so, dass Sie mit dem Erstellen der Bedienungsanleitung anfangen müssen, während das Produkt noch entwickelt wird. Dann können Sie nur auf Fotos und Dokumente zugreifen und haben, wenn’s gut läuft, Zugang zu einer Demo-Software oder einem Prototyp.

Für das Erstellen der richtigen und notwendigen Sicherheitshinweise in der Bedienungsanleitung ist eine Risikobeurteilung Pflicht. In jedem Unternehmen gibt es zur Erstellung der Risikobeurteilung einen Verantwortlichen. Die Risikoanalyse führt die möglichen Risiken auf, beurteilt Art und Dauer der Gefahr und gibt Hinweise zur Verringerung der Risiken.

Etwa: Warnhinweis zur Umgebungstemperatur in Bedienungsanleitung schreiben, oder Hinweis zum bestimmungsgemäßen Gebrauch in Bedienungsanleitung aufnehmen, usw.

Schritt 5: Das sind unsere Tools, mit denen wir Bedienungsanleitungen schreiben.

Jetzt haben Sie schon viel Input und Ideen zum Schreiben der Bedienungsanleitung. Kleinen Moment aber noch. Lassen Sie uns noch kurz was zu unserem meistgenutzten Tool sagen, dass wir beim Bedienungsanleitungen schreiben nutzen: Adobe FrameMaker.

Adobe FrameMaker ist ein leistungsstarkes Programm, mit dem Sie vor allem Inhalte mit großen Umfang schreiben, strukturieren und layouten können. Auch für anschließende Übersetzungen oder die Ausgabe in unterschiedliche Formate (PDF, HTML5, …) eignet sich das Programm sehr gut. Mit dem Redaktionssystem ST4 von Quanos arbeiten wir auch mit FrameMaker als Editor.

Adobe FrameMaker ist so umfangreich, dass wir es jetzt hier nur kurz anreißen können. Wir könnten ganze Blogartikel damit füllen. Auch das Thema Redaktionssystem öffnet ein ganzes Universum an Themen. Scheuen Sie sich also nicht, uns mit Ihren Fragen direkt anzusprechen!

Natürlich können Sie auch erst einmal Ihre Bedienungsanleitung mit Microsoft Word schreiben. Hier sollten Sie Absatzformate und Zeichenformate für Ihre Texte definieren und auch eine Vorlage für Ihr Layout mit Ihrem Corporate Design erstellen.

Für unsere Kunden schreiben wir Bedienungsanleitungen auch in Word. Wir haben nur die Erfahrung gemacht, dass die Software bei großen Textmengen, Nummerierungsserien und vielen Bildern instabil wird.

Schritt 6: Der Sprachstil – schreiben Sie eine Bedienungsanleitung für die Nutzer.

Eine Bedienungsanleitung schreiben Sie im besten Fall nicht nur informativ, sondern auch benutzerfreundlich und verständlich.

Beachten Sie folgende Schreibregeln, während Sie die Bedienungsanleitung erstellen:

Schreiben Sie eine Bedienungsanleitung simpel. Einfache, kurze Sätze, ohne Verschachtelung.
Nutzen Sie eine konsistente Terminologie. Das bedeutet, dass Sie sich vorher Gedanken dazu machen müssen, wie sie die Teile an Ihrem Produkt benennen. Ein bestimmtes Teil bekommt immer nur eine Benennung. Nennen Sie den Schlauch für die Wasserversorgung immer so – und nicht einmal Anschluss oder Leitung.
Ihre Anwender verstehen dann besser. Und auch die Übersetzung der Bedienungsanleitung wird leichter.
Legen Sie eine Konsistenz bei Handlungsanweisungen fest. ‚Drehen Sie die Schraube ein.‘ oder ‚Schraube eindrehen.‘
Entscheiden Sie, ob Sie die Leser direkt ansprechen oder nicht.
… und für aussagekräftige Überschriften: ‚Montage der Halterung‘ vs. ‚Halterung montieren‘
Ihr Unternehmen nutzt bereits Styleguides mit Schreibregeln oder achtet auf eine bestimmte Tonalität? Nutzen Sie das zum Schreiben der Bedienungsanleitung.
Welche Sprache nutzt Ihre Zielgruppe? Eine Bedienungsanleitung für Laien schreiben Sie in vereinfachter Sprache. Eine Bedienungsanleitung für Techniker sollte entsprechende Fachbegriffe enthalten.

Schritt 7: Illustrationen, Animationen, Videos ergänzen.

Eine reine Textwüste mag niemand so recht. Packen Sie in Ihre Bedienungsanleitung Bilder! Ergänzen Sie digitale Formate mit weiteren Medien. Je hochwertiger die Bilder sind, desto hochwertiger erscheint und ist auch Ihre Bedienungsanleitung. Das spielt gerade für Bedienungsanleitungen eine Rolle, die sich an Endanwender richten, also für Consumer Products, oder auch für Medizinprodukte.

Hier einige Beispiele für Illustrationen:

Fotos und fotorealistische Illustrationen: Realitätsnahe Bilder zeigen, wie Ihr Produkt aussieht, wo sich Bedienelemente oder Anschlüsse befinden.
Screenshots: Nutzen Sie Screenshots, um Ihre Software zu zeigen und Schritte zu deren Bedienung.
Infografiken und Workflows: Infografiken helfen Abläufe zu verstehen und sie visuell ansprechend darzustellen.
Animationen und Videos: Mit Videos zeigen Sie Ihre Inhalte anschaulich und unterhaltsam. Auch eine Software lässt sich durch Screencasts prima erklären.

Hier gibt’s ein paar Links zu unseren Leistungen rund um die Visualisierung von Bedienungsanleitungen:

Schritt 8: Eine Bedienungsanleitung schreiben mit Qualität – jetzt geht’s ans Testen und Korrekturlesen.

Geschafft. Wahnsinn. Da liegt sie nun vor Ihnen, Ihre Bedienungsanleitung. Und sie könnten die Füße auf den Tisch legen und sich entspannt zurücklegen. Machen Sie das ruhig. Denn damit haben Sie einen großen Schritt getan.

Haben Sie aber auch schon daran gedacht, Ihre Bedienungsanleitung prüfen zu lassen? Auch das ist eine normative Forderung. Wir machen diese Reviews gerne auf unterschiedlichen Ebenen.

Lassen Sie die Bedienungsanleitung mindestens

sprachlich gegenlesen (Rechtschreibung, Terminologie, Sprachstil, Konsistenz)
und inhaltlich (fachliche Richtigkeit).

Das Korrekturlesen zählt zu einer qualitativ hochwertigen Bedienungsanleitung dazu. Wichtig ist: Lassen Sie die Bedienungsanleitung von jemandem Korrekturlesen, der die Bedienungsanleitung nicht selbst geschrieben oder übersetzt hat. Das können Trainer sein, Entwickler oder Muttersprachler, die das Produkt grob kennen.

Wichtig ist auch, dass Sie die Bedienungsanleitung testen lassen. Dabei nimmt der Tester die Bedienungsanleitung in die Hand und geht die Handlungsanweisungen (stichprobenartig) direkt am Produkt durch. Das kann etwa im Rahmen von Usability Tests gemacht werden, wenn Sie sowieso die Gebrauchstauglichkeit Ihres Produkts testen lassen.

Schritt 9: Gedruckt oder digital? Bedienungsanleitung bereitstellen.

Standardmäßig erstellen wir aus der Bedienungsanleitung immer eine PDF. Die kann gedruckt werden oder dem Kunden digital zur Verfügung stehen.

Es gibt auch andere Formate, die immer beliebter werden. Etwa die Ausgabe der Bedienungsanleitung in HTML5 für die Verwendung auf dem Handy als App, als Mobile Dokumentation, oder im Internet.

Was richtig gut ist: Sie müssen dafür nicht mehrere Bedienungsanleitungen erstellen. Aus einem Dokument lassen sich mehrere, unterschiedliche Formate ausgeben.

Überlegen Sie, ob einer dieser Punkte für das Bereitstellen der Bedienungsanleitung zutrifft:

Gibt es etwa schwierige Wartungsarbeiten, Montage- oder Handlungsschritte, die sich gut durch ein Anleitungsvideo ergänzen lassen?
Ist Ihr Produkt so komplex, dass die Anwender neben der Bedienungsanleitung auch eine Schulung am Produkt erhalten müssen?
Ist der Informationsbedarf so gering, dass auch eine Anbringung einer Bedienungsanleitung auf dem Produkt ausreicht?
Hat der Anwender Zugang zum Internet und ist für die Nutzung des Produkts ein PC erforderlich? Dann kann ein Teil der Bedienungsanleitung auch papierlos mitgegeben werden.

Sehen Sie hier unsere Leistungen zu Mobiler Dokumentation und Apps:

Bedienungsanleitung schreiben: Unsere Muster und Beispiele.

Sehen Sie hier Beispiele für Bedienungsanleitungen, die wir für Kunden aus dem Bereich Medizintechnik erstellt haben:

Dieses Beispiel zeigt eine Bedienungsanleitung für ein Consumer Product, die wir für die Sodastream GmbH erstellt haben.

Einmal als Bedienungsanleitung:

Einmal als Kurzanleitung mit vielen Bildern:

Hier ein Beispiel für eine Bedienungsanleitung aus dem technischen Bereich:

Sie müssen nicht alles selbst machen: Bedienungsanleitung erstellen lassen.

Die gute Nachricht ist: Sie müssen die Bedienungsanleitung nicht selber schreiben. Sie können die Bedienungsanleitung erstellen lassen. Das machen Technische Redakteure wie wir. Wir gehen dabei alle erklärten Schritte zum Schreiben einer Bedienungsanleitung selbst durch. So können Sie sich eine Bedienungsanleitung erstellen lassen, die hochwertig ist, ein tolles Layout hat, das zu Ihrem Unternehmen passt und rechtskonform ist.

Sie wollen wissen, wie Sie sich eine Bedienungsanleitung erstellen lassen können? Schreiben Sie uns hier direkt eine Nachricht.

Oder schauen Sie sich hier unsere Arbeitsweise an: commatec – so arbeiten wir

Sie wollen sich noch weiter informieren? Diese Artikel könnten Sie auch interessieren:

Was ist eine Bedienungsanleitung?

Mehr zu Anleitungen