Kategorien
Uni-Wissen

Wie kann ich eine Bedienungsanleitung schreiben?

Was man braucht: Computer, Drucker
Zeitaufwand: mehrere Stunden
Schwierigkeit: mittel bis schwer
Anmerkungen: Beim Schreiben einer Bedienungsanleitung sollten die Zielgruppe und der Verwendungszweck der Anleitung berücksichtigt werden. Danach richtet sich neben dem Detailgrad der Ausführungen auch die fachliche Tiefe der Anleitung.
1
Zunächst einmal muss man sich über den Umfang der Bedienungsanleitung, die es zu schreiben gilt, im Klaren sein. Soll es eine Kurzbeschreibung oder eine sehr ausführliche Anleitung aller Funktionalitäten des Beschreibungsgegenstandes sein?
2
Anschließend sollte ein Inhaltsverzeichnis aufgebaut werden, welches gleichzeitig als Struktur für das Dokument dient.
3
Vom Aufbau her sollte eine Bedienungsanleitung immer mit der Erläuterung der wichtigen, essenziellen Komponenten und Funktionalitäten beginnen und dann erst die etwas weniger wichtigen beschreiben. Da eine Bedienungsanleitung für den Leser eher ein Nachschlagewerk ist, sollten die Ausführungen prägnant sein und Schlagwortcharakter besitzen.
4
Der Aufbau der Kapitel sollte nach Möglichkeit logisch anhand von Funktionsgruppen aufgebaut sein.
5
Je nach gewünschter Ausführlichkeit sind nun die Funktionalitäten zu beschreiben und durch Querverweise miteinander logisch zu verknüpfen. Dies ermöglicht dem Leser hinterher, benötigte Informationen schneller und einfacher zu finden.
6
Wo eine Erklärung mit Worten sehr umständlich ist oder missverständlich sein kann, können Bilder helfen, die zu beschreibende Funktionalität besser deutlich zu machen. Sie sind zudem schneller verständlich und nachvollziehbar.
7
Hilfreich ist ein abschließendes Glossar mit den wichtigsten Schlagwörtern. Alternativ können ein FAQ (frequently asked questions, zu Deutsch die häufigsten Fragen) angefügt werden oder ein sogenanntes Troubleshooting – die Erläuterung der häufigsten Fehler und wie man diese löst.
8
In einem Anhang können weitere Hinweise zur Nutzung oder Informationen für eine andere Zielgruppe, beispielsweise Schaltpläne für Servicetechniker, Servicenummern und Kontaktadressen aufgenommen werden.