Eine Bedienungsanleitung schreiben

PDF herunterladen

PDF herunterladen

In diesem Artikel:

Eine angemessene Benutzungsdokumentation erstellen

Die Bestandteile einer Bedienungsanleitung

Ein gut lesbares Handbuch erstellen

Verwandte Artikel

Literaturhinweise

Bedienungsanleitungen sind geschriebene Dokumente, die entweder in Druckform (Papier) oder als elektronisches Dokument (PDF oder XPS) vorliegen und Anweisungen enthalten, wie man etwas macht oder benutzt. Obwohl “Benutzerhandbücher“ meist mit Anleitungen für Computer-Software in Verbindung gebracht werden, liegen Bedienungsanleitungen auch Computern sowie anderen elektronischen Geräten, wie z.B. Fernsehern, Stereo-Anlagen, Telefonen, MP3-Playern, Haushalts- und Gartengeräten, bei. Gute Bedienungsanleitungen enthalten Informationen über die Produktbesonderheiten, lehren den Konsumenten, diese richtig einzusetzen und sind dabei leicht verständlich geschrieben. Im Folgenden finden sich Punkte, die bei der Erstellung des Inhalts sowie des Layouts einer Bedienungsanleitung zu beachten sind.

Vorgehensweise

Teil 1

Teil 1 von 3:

Eine angemessene Benutzungsdokumentation erstellen

PDF herunterladen

1. 
   1
   Bestimme, an wen sich deine Anleitung richtet. Um erfolgreich eine Bedienungsanleitung zu verfassen, musst du zunächst ein Profil der Verwender deiner Anleitung erstellen, indem du entweder ein geschriebenes Profil erstellst, oder indem du dir die Zeit nimmst, nachvollziehbare Vermutungen über die Charakteristika deiner Zielgruppe anzustellen. Ein solches Profil ist nützlich, wenn du teil eines Teams bist, welches die Benutzungsdokumentation erstellt und kann ebenfalls hilfreich dabei sein, das Produkt vom Konzept zur endgültigen Form zu entwickeln. Bei der Erstellung eines solchen Profils, ist zu beachten:

   • Wo die Benutzer die Anleitung verwenden werden, wie beispielsweise zu Hause, im Büro, an einem entfernten Arbeitsort oder im Auto. Das würde nicht nur den Inhalt bestimmen, sondern auch den Stil, in dem die Anleitung geschrieben ist.
   • Wie die Benutzer das Handbuch verwenden. Wenn die Verwender es nur sporadisch verwenden oder nur bestimmte Informationen nachschlagen wollen, sollte es in erster Linie als Referenzdokument verfasst sein. Wenn die Nutzer es jedoch ständig zu Rate ziehen, sollte die Referenzsektion von einem Einführungsteil und Anweisungen zu den gebräuchlichsten Verwendungsmöglichkeiten des Produktes begleitet werden.
   • Wie viel Erfahrung haben die Benutzer mit diesem oder ähnlichen Produkten. Wenn das Produkt brandneu ist oder sich völlig von ähnlichen Produkten unterscheidet, wirst du in der Anleitung erklären müssen, inwiefern es sich von anderen Produkten unterscheidet und Informationen beifügen müssen, wie man beginnen sollte. Beschäftigt sich das Produkt mit Schwierigkeiten, mit denen sich Benutzer häufig auseinandersetzen müssen, wie das z.B. bei vielen PC-Anwendungen der Fall ist, wirst du die entsprechenden Informationen und Details in einer verständlichen Form darstellen müssen.
2. 
   2
   Entspreche den Bedürfnissen deiner Leser in einer für sie verständlichen Form. Vorrausgesetzt der Benutzer verfügt nicht über ein ausgeprägtes Technikverständnis, ist es am Besten technische Fachbegriffe zu vermeiden und sich stattdessen auf klare und simple Erklärungen zu beschränken. Der Text sollte außerdem in einer Weise angeordnet sein, die die Denkweise des Nutzers nachzeichnet; es macht mehr Sinn die Produkteigenschaften nach ihrer Funktion aufzulisten, als einfach nur die meistverwendeten.

   • Manchmal ist es unmöglich Fachbegriffe zu vermeiden, wie beispielsweise bei einer Software zur Erstellung von Diagrammen, welche Fibonacci-Diagramme, sowie üblichere Torten- und Säulendiagramme enthält. In solch einem Fall kann es hilfreich sein, die Begriffe zu erklären und Hintergrundwissen dazu zu liefern, wie z.B. eine Erklärung, was Fibonacci-Diagramme sind und wo sie Verwendung finden.
3. 
   3
   Beschreibe das Problem, mit dem der Nutzer konfrontiert ist und liefere eine Lösung dazu. Eine bestimmte Eigenschaft eines Produkts als Lösung für ein generelles Problem zu liefern funktioniert gut bei der Vermarktung des Produkts aber hat der Kunde das Produkt einmal erworben, wird er oder sie wissen wollen, wie es dafür zu verwenden ist. Erkenne die Probleme, die den Kunden erwarten werden und beschreibe sie in deinem Handbuch gefolgt von Anweisungen zur Lösung.

   • Wenn es sich um ein komplexes Problem handelt, zerlege es in kleinere Teile. Beschreibe jeden Teil zusammen mit Anweisungen zur Lösung und verfahre so mit jedem nachfolgenden Teil. Ein solches Zerlegen von Informationen wird auch “chunking“ genannt.
   Werbeanzeige

Teil 2

Teil 2 von 3:

Die Bestandteile einer Bedienungsanleitung

PDF herunterladen

1. 
   1
   Ein angemessenes Deckblatt und Titelseiten. Benötigt wird ein Cover, welches mehr als nur eine Schnellübersichtskarte ist und ein Titelblatt, welches aus mehr besteht als nur einem gefalteten Blatt Papier (4 oder mehr Seiten lang).

   • Ist das Handbuch Copyright-geschützt, muss das sowohl auf dem Cover als auch auf der Titelseite vermerkt sein.
   • Wenn es irgendwelche Konditionen oder Bestimmungen zur Verwendung der Anleitung und dem dazugehörigen Produkt gibt, beschreibe diese auf der Innenseite des Deckblatts.
2. 
   2
   Vermerke zu ähnlichen Dokumenten gehören in das Vorwort. Wenn die Benutzungsdokumentation mehr als eine Anleitung umfasst, dann erstelle hier Vermerke zu diesen anderen Dokumenten. Ins Vorwort gehört auch die “Wie diese Anleitung zu verwenden ist“-Sektion, soweit vorhanden.
3. 
   3
   Ist die Anleitung länger als 10 Seiten, füge ein Inhaltsverzeichnis hinzu.
4. 
   4
   Anweisungen und Referenzmaterialien kommen in den Hauptteil der Anleitung. In den meisten Fällen sollten Anweisungen und Referenzmaterialien jeweils ihre eigene Sektion haben, obwohl der Nutzer von einer Sektion auf Informationen einer anderen Sektion verwiesen werden kann. Auf diese Weise findet der Leser die benötigten Informationen schneller.

   • Anweisungen sollten in einer einheitlichen Struktur geschrieben werden. Beginne mit einem Überblick über den nächsten Schritt, beschreibe dann, was zu tun ist und wie das Resultat aussehen sollte. Die einzelnen Schritte sollten durchnummeriert sein und mit Tätigkeitsverben eingeleitet werden.
   • Referenzmaterialien können eine Liste von Zusätzen, Ratschläge zur Fehlerbehebung und häufig gestellte Fragen enthalten. Glossare und Indices können an das Ende der Anleitung gesetzt werden, obwohl eine Liste wiederkehrender Fachbegriffe auch am Anfang erscheinen kann. Ein Index kann weggelassen werden, sollte die Anleitung weniger als 20 Seiten lang sein.
5. 
   5
   Verwende graphische Darstellungen zur Verdeutlichung des Texts. Solche Darstellungen können bestimmte Schritte besser verdeutlichen als reiner Text, vor Allem bei komplexeren Anweisungen als Bestätigung, dass der Nutzer die einzelnen Schritte richtig durchführt. Graphische Darstellungen könne mit Hilfe computergestütztem Zeichnen (CAD), Zeichenprogrammen Bildbearbeitungsprogrammen und Digitalkameras erstellt werden.

   • Hast du so eine graphische Darstellung erstellt, speichere es ab, so weit komprimiert, wie es deine Textverarbeitungs- oder Desktop-Publishing-Software zulässt. Du solltest die Größe des Bildes soweit reduzieren, dass es besser auf die Seite des Handbuches passt und dabei immer noch detailreich genug ist. (Falls nötig, zerlege das Originalbild in kleinere Teile und zeige den jeweils relevanten Teil zusammen mit dem passenden Text.)
   • Möchtest du bei bestimmten Schritten mehrere Bilder verwenden, achte darauf, dass alle dieselbe Größe haben, entweder in den selben Längen- und Breitendimensionen oder in derselben proportionalen Verkleinerung zur Originalgröße. Das macht sie optisch ansprechender für die Verwender. Achte bei Screenshots auch auf die korrekte Farbdarstellung für den Fall, dass das Handbuch in Farbe ist.
   • Auch wenn Bildbearbeitungsprogramme, wie Photoshop und Paint Shop Pro ordentliche Screenshots liefern, bieten spezielle Programme, wie SnagIt außerdem die Möglichkeit, Screenshots auf einfache Weise zu verändern, zu katalogisieren und sie mit Anmerkungen zu versehen.
   Werbeanzeige

Teil 3

Teil 3 von 3:

Ein gut lesbares Handbuch erstellen

PDF herunterladen

1. 
   1
   Suche dir ein paar gut lesbare Schriftarten aus. Auch wenn Computer eine Vielzahl verschiedener Schriftarten darstellen können, ist das Ziel eines Benutzerhandbuchs immer gut lesbar zu sein. Um dieses Ziel zu erreichen ist es am Besten, nur ein paar wenige Schriftarten zu wählen, die gut miteinander aussehen. Es gibt zwei Sorten von Schriftarten: serif- und sans serif-Schriftarten.

   • Serif-Schriftarten weisen kleine Verschnörkelungen an den Strichen der einzelnen Buchstaben auf. Beispiele dafür sind Times New Roman, Baskerville und Book Antiqua. Diese Schriftarten eignen sich vor Allem für 10- bis 12-Punkt große Textstücke im Hauptteil einer gedruckten Bedienungsanleitung.
   • Sans serif-Schriftarten haben keine Verzierungen. Beispiele sind Arial, Calibri und Century Gothic. Diese könne für Textstücke der Größen 8- bis 10-Punkt in einem PDF oder einem webbasierenden Handbuch verwendet werden, obwohl die fehlenden Verzierungen Sätze von 12-Punkt oder mehr weniger leicht lesbar machen. Allerdings können sie in größerer Schriftgröße für Überschriften und in kleinerer Größe für Fußnoten und Ziffern in Diagrammen verwendet werden.
   • Generell solltest du schlichte Schriftarten, wie z.B. Arial oder Times New Roman für dein Handbuch verwenden. Schreibst du eine Anleitung z.B. für ein Fantasy-Videospiel kannst du für die Überschriften auch dekorative Schriftarten verwenden.
   • Hast du dich einmal für die Schriftarten entschieden, die du verwenden möchtest, erstelle eine Testseite, um sicherzugehen, dass die verschiedenen Schriftarten auch gut zusammenpassen. Diese solltest du auch der Person zeigen, die für das Gesamtbild des Handbuchs verantwortlich zeichnet, bevor du fortfährst.
2. 
   2
   Mache dir Gedanken zum Layout. Wenn du dich für die Schriftarten entschieden hast, musst du entscheiden, wo auf der Seite welche Elemente sein sollen.

   • Im Normalfall kommt der Titel des Handbuchs oder des Kapitels in die Kopf- oder Fußzeile, häufig mit dem Handbuchtitel auf der linken und den Titel des Kapitels auf der rechten Seite. Auch die Zahl der Seite wird meist in der Kopf- oder Fußzeile landen, entweder am äußeren Rand (sowohl bei Kopf- als auch Fußzeile möglich) oder zentriert (nur bei Verwendung in der Fußzeile). Du könntest die jeweilige Zahl der ersten Seite einer Sektion oder eines Kapitels von den anderen unterscheidbar machen, indem du diese in die Mitte der Fußzeile und die Zahlen nachfolgender Seiten in die äußeren Ecken der Kopfzeile setzt.
   • Hinweistexte könntest du in farbigen oder schattierten Kästen unterbringen, um sie vom restlichen Text abzuheben. Benutze aber Farben oder Schattierungen, die den Text nicht unlesbar machen.
   • Verwende vernünftige Seitenabstände mit mehr Spielraum an den Kanten, wo das Buch gebunden wird.
3. 
   3
   Überlege dir die Art der Bindung deiner Anleitung. Wenn das Handbuch mehr als vier Seiten enthält, müssen diese irgendwie gebunden werden. Auch wenn interne Dokumente häufig an einer Ecke geklammert werden, ist es für einem Produkt beiliegenden Handbüchern üblich, in einer von drei Arten gebunden zu werden:

   • Das Klammern der Seiten ist üblich bei Handbüchern, die aus gefalteten Blättern der Größen 21x27,5 cm, 21x35 cm oder 27,5x42,5 cm bestehen. Die meisten billigeren Handbücher mit 48 oder weniger Seiten werden auf diese Art gebunden.
   • Sattelheftbindung findet sich seltener bei Bedienungsanleitungen, auch wenn ein paar längere Nutzerhandbücher auf diese Weise gebunden werden (Das originale, von JASC Software produzierte Paint Shop Pro wurde mit einem sattelheftgebundenem Handbuch ausgeliefert.)
   • Spiralbindungen finden sich bei Handbüchern, die eher in raueren Umgebungen, wie z.B. in der freien Natur, verwendet werden, da die anderen Bindungsarten diese Belastungen nicht aushalten würden. Manche spiralgebundene Handbücher haben außerdem laminierte Seiten, um sie vor Feuchtigkeit und Schmutz zu schützen.
4. 
   4
   Benutze die Dokumentenvorlage beim Erstellen des Handbuches. Viele Textverarbeitungsprogramme bieten die Möglichkeit eine Dokumentenvorlage für dein Handbuch zu erstellen. Parallel zum Erstellen deines Textes erscheint eine Vorlage in deiner gewählten Schriftart.

   • Viele Textverarbeitungsprogramme bieten ebenfalls die Möglichkeit, “styles“ zu erstellen, voreingestellte Formatvorlagen für Schriftarten und -größen für Kopfzeilen, Fußzeilen, Überschriften und den Haupttext. Du kannst dir eine der Vorlagen aussuchen (z.B. “Überschrift1“...) oder deine ganz eigene Vorlage erstellen und benennen. Folge dabei so weit wie möglich den Konventionen der Benennung solcher “styles“, wenn du mehrere davon für dieselbe Art von Text hast. Versuche alle Vorlagen, die du benötigst im Vorraus zu erstellen, um dir Zeit zu sparen.
   Werbeanzeige

Tipps

• Benutze Feldschlüssel oder Textvariablen, wo möglich. Diesen kannst du Werte zuordnen, wie z.B. den Namen des Produkts, den Titel des Handbuchs oder des Kapitels und verwende diese im Text anstatt die Dinge auszuschreiben. Siehst du dir die Vorlage an oder druckst den Text, wird statt der Zahl der eigentliche Text erscheinen. Falls sich der Name des Produkts ändert oder du den Titel des Handbuchs oder eines Kapitels änderst, wird es einfacher sein die Information durch änder der Variablen zu ändern als jede der Informationen zu suchen und zu ersetzen.

Werbeanzeige

Was du brauchst

• Textverarbeitungs- oder Desktop-Publishing-Programm
• Bildbearbeitungsprogramm oder ein Programm zur Erstellung von Screenshots