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.