Bedienungsanleitung schreiben

Bedienungsanleitung schreiben: Definition

Mit einer Bedienungsanleitung werden alle Funktionen eines Geräts für den Endbenutzer beschrieben. Autoren schreiben eine Bedienungsanleitung für die Aufbereitung in Papierform oder anderer medialer Form, beispielsweise als PDF-Datei.

Weitere Begriffe für Bedienungsanleitungen sind Gebrauchsanleitung, Gebrauchsanweisung, Benutzerhandbuch und Handbuch oder auch Installationsanleitung. Auch Packungsbeilagen von Arzneimitteln sind im weitesten Sinne als Bedienungsanleitungen zu sehen.

Als Oberbegriffe können Technische Dokumentation beziehungsweise Technische Kommunikation gesehen werden. Damit sind sämtliche technische Dokumente gemeint, die für die Kommunikation mit Externen gedacht sind und die interne Dokumentation bereichsübergreifend sicherstellen. Für den gesamten Lebenszyklus eines Produktes schreiben technische Redakteure technische Dokumentationen. Dazu gehören die interne Dokumentation, Pre-Sales-Informationen, After-Sales-Dokumentationen sowie Dokumentationen in elektronischen Medien.

Funktionales Schreiben für die Bedienungsanleitung

Technische Redakteure schreiben neben Bedienungsanleitungen auch Schulungsunterlagen und Produktpräsentationen. Redakteure, die eine Bedienungsanleitung schreiben, achten darauf, dass die Anleitung verschiedene Funktionen erfüllt:

Eine Bedienungsanleitung stellt sicher, dass sich Anwender über alle Funktionen eines Geräts informieren können. Zusätzlich leitet eine Bedienungsanleitung dazu an, das betreffende Gerät sicher zu verwenden, zu warten und zu entsorgen. Da Hersteller gemäß dem Geräte- und Produktsicherheitsgesetz dazu verpflichtet sind, ihren Produkten Bedienungsanleitungen beizulegen, versuchen Hersteller über Bedienungsanleitungen, die Risiken einer möglichen Produkthaftung zu minimieren.

Anleitungen müssen sich an Gesetzen, Normen und Richtlinien orientieren, dürfen dabei aber nie den Anwender und das Produkt aus dem Blick verlieren. Häufig schreiben Online-Redakteure mit einer Bedienungsanleitung auch für den Schutz von Anwendern und Herstellern. Die Vorgaben für Bedienungsanleitungen finden sich auf EU-Ebene, nationaler Ebene oder branchenintern. Zum Teil ist beispielsweise geregelt, wie Bilder und Texte zueinander angeordnet werden und welche Schriftgrößen erlaubt sind.

Bedienungsanleitung schreiben: Vorgehen

Zunächst sollten sich Redakteure, die eine Bedienungsanleitung schreiben, mit dem betreffenden Produkt auskennen. Gegenstände, für die man eine Bedienungsanleitung schreiben muss, sind: Produkte, (komplexe) Maschinen, Software-Produkte, Produkte der Medizintechnik und Luftfahrt. Auch bei der Übergabe von technischen Anlagen oder Maschinen sowie bei der Baumusterprüfung sind Anleitungen vorgeschrieben.

Außerdem sollten sie die Zielgruppe kennen, damit sie für diese relevante Informationen auswählen können. Mögliche Adressaten von Bedienungsanleitungen sind:

• Anwender / Bediener
• Servicemitarbeiter
• Installateure
• Systemintegratoren
• Entwickler
• Patentanwälte
• Staatsanwälte mit Schwerpunkt Produkthaftung
• Entsorgungsunternehmen

In einem nächsten Schritt beim Bedienungsanleitung schreiben strukturieren Autoren die ausgewählten Informationen und Dokumente. Diese Strukturierung ist, anders als etwa beim Romanschreiben, extrem wichtig, damit Anwender schnell die Auskunft finden, die sie suchen. Selten wird eine geschriebene Bedienungsanleitung komplett und chronologisch gelesen. Je nach Vorkenntnis der Anwender werden bestimmte Stellen übersprungen. Weiterhin sollten in der Bedienungsanleitung Warnhinweise gut erkennbar geschrieben sein. Die Strukturierung ist möglich über Kapitel. Gängige Kapitel einer Bedienungsanleitung sind Sicherheitsinformationen, Anleitung, Beschreibung der Funktionen sowie Hinweise zur Wartung.

Elemente einer Bedienungsanleitung:

• Inhaltsverzeichnis
• Überschriften
• Kapitel
• Texte
• Abbildungen
• Warnhinweise
• Multimediale Inhalte

Bedienungsanleitung: Die Kunst, langweilig zu schreiben

Die Zeiten, in denen man fragte, ob man Technik-Redakteuren so etwas antun könne, sind vorbei: Gute Technik-Dokumentation muss »langweilig« geschrieben sein. Die Sprache von guter Technik-Dokumentation kennt keinen Wechsel von Sequenzmustern zur Erhöhung der Lesespannung, kein Spiel mit der Sprachrhythmik zum »farbigeren« Lesen, kein Variieren von Begriffen (eine »Ölablassschraube« wird keine »Schraube«), »kein Salz in der Sprachsuppe« durch die Verwendung vieler Adjektive etc. (Dieter Gust, Autorenunterstützung – die schleichende Revolution, In: Technische Dokumentation)

Einfaches Schreiben ist bei Bedienungsanleitungen zum einen sinnvoll, um für User die Produkte klar und präzise zu beschreiben. Zum anderen hilft es Herstellern dabei, die Kosten für Übersetzungen zu senken. Denn für eine Maschine innerhalb der EU können Übersetzungen in bis zu 23 Amtssprachen anfallen. Auch Fachübersetzer Medizin profitieren davon, wenn die Bedienungsanleitung leicht zu erschließen ist und sie beim Schreiben auf bereits übersetzte Bausteine zurückgreifen können. Außerdem hilft reduziertes Schreiben bei Bedienungsanleitungen bei der effizienten Verwendung von Terminologien der Fachsprache.

Für das Schreiben von Bedienungsanleitungen empfehlen sich ein reduzierter Wortschatz ohne Füllwörter, Phrasen und ein Übermaß an Komposita. Auch schwerfällige Satzkonstruktionen werden vermieden. Auch auf Synonyme verzichten Autoren, die eine Bedienungsanleitung schreiben, um Anwender nicht zu verwirren. Eine Bedienungsanleitung ist kein Text, den Anwender zum Zeitvertreib lesen. Sie ist ein funktionaler Text, den Anwender gezielt und so kurz wie möglich in die Hand nehmen.

Autoren schreiben eine Bedienungsanleitung zudem handlungsorientiert. Sie sorgen mit Übersichten wie Illustrationen, Tabellen oder Bildern für eine gute Navigation durch den Text. Redakteure achten beim Schreiben der Bedienungsanleitung darauf, dass alle Informationen für die Inbetriebnahme, Warnhinweise und Lösungen für die häufigsten Fehler und Probleme enthalten sind. Daher ist häufig eine Abstimmung mit Grafikern und Entwicklern, Lektoren und Mediengestaltern nötig. Oft müssen gesetzliche Normen berücksichtig werden, sodass Juristen mit ins Boot geholt werden müssen.

Viele Bausteine können wiederverwendet werden: Warnhinweise, Kontaktinformationen, allgemeine technische Daten sollten auch konsistent sein. Für die neue Version eines Produktes muss nicht die ganze Bedienungsanleitung neu geschrieben werden. Daher arbeiten technische Redakteure oft mit Redaktionssystemen, in denen Textbausteine der Bedienungsanleitung archiviert und schnell abgerufen werden können. So müssen Autoren beispielsweise für die neue Variante eines bereits auf dem Markt bestehenden Geräts nur einzelne Passagen neu formulieren.

Freelancer Texter, die eine Bedienungsanleitung schreiben, fragen sich häufig: Wie können Warn- und Sicherheitshinweise rechtssicher und verständlich formuliert werden? Was muss alles beschrieben werden und auf welche Einzelschritte kann eventuell verzichtet werden, da sie beispielsweise durch eine Illustration erklärt werden? Wie kann die Schwierigkeit, beziehungsweise die Einfachheit des selbst geschriebenen Textes ermittelt werden, um ihn so zu verbessern? Mit welchen Medien (Illustration, Piktogramm, Screenshot, Foto, Video, Animation) ist der Inhalt am besten zu unterstützen? Wie kann das Layout die Anleitung unterstützen (Einsatz von Farben, Elementen zum Hervorheben wie Pfeile etc.)? Für welche Zielgruppe schreibe ich die Bedienungsanleitung und welche Kenntnisse kann ich voraussetzen?

Technische Redaktion – Ausbildung

Die Berufsbezeichnung ist nicht geschützt und der Zugang nicht geregelt. Auch, wenn es einige Universitäten und Fachhochschulen gibt, die zum Technischen Redakteur (“Technische Kommunikation”) ausbilden, ist es ein Beruf für Quereinsteiger. Zum Teil bieten Unternehmen auch bezahlte Volontariate an, in denen Autoren zum technischen Redakteur ausgebildet werden.

Studiengänge im Bereich Technische Dokumentation sind seit den 1990er Jahren vorhanden. Technische Redakteure sind als Schnittstelle zwischen Anwender und Entwickler in der Lage, ein Produkt aus verschiedenen Perspektiven zu betrachten. Diese Fähigkeit ist nötig, um gute Bedienungsanleitungen schreiben zu können. Darüber hinaus werden Redakteure auch mit unterschiedlichen Autorentools wie zum Beispiel Redaktionssystemen vertraut gemacht, die die Zusammenarbeit mit anderen Abteilungen vereinfacht.

Bedienungsanleitung schreiben auf Lass-andere-schreiben.de

Wer für ein Produkt eine Bedienungsanleitung schreiben oder lektorieren lassen möchte, kann sich Unterstützung von Experten holen. Auf Lass-andere-schreiben.de können Auftraggeber kostenlos inserieren. Im Inserat können sie exakt beschreiben, wofür sie eine Bedienungsanleitung brauchen und sich unverbindlich Angebote einholen. Textexperten finden über das Portal Lass-andere-schreiben.de neue Aufträge. Vor endgültiger Vergabe des Auftrages können Experten und Inserenten über das Portal kommunizieren und alle Fragen klären.