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.