Tipps zum Erstellen Ihrer eigenen Formatvorlagen für Benutzerhandbücher
Beachten Sie Ihre Zielgruppe
Entwerfen Sie kein Design, wie es Designern gefallen würde. Entwerfen Sie ein Design, das auf die Bedürfnisse Ihrer Zielgruppe passt.
▶ Wer sind Ihre Leser?
▶ Wo und unter welchen Bedingungen werden Ihre Leser Ihre Handbücher lesen?
Beispiele für Anforderungen, die sich aus der Zielgruppe ergeben:
▶ Ältere Menschen benötigen eine größere Schriftgröße und mehr Abstand zwischen den Zeilen als jüngere Zielgruppen.
▶ Techniker bevorzugen im Allgemeinen ein schlichteres Design als Endverbraucher.
▶ Leser mit eher geringem Bildungsniveau benötigen eine klarere Führung als Hochschulabsolventen.
Beispiele für Anforderungen, die sich daraus ergeben, wo und wie die Zielgruppe Ihre Handbücher liest:
▶ Leser in einer lauten Produktionshalle brauchen eine größere Schriftgröße und mehr Zeilenabstand als Leser in einem ruhigen Büro.
▶ Leser in einem fahrenden Auto, Bus, Zug, Flugzeug oder Schiff brauchen eine größere Schriftgröße und mehr Zeilenabstand als Leser in einer erschütterungsfreien Umgebung.
▶ Leser in direktem Sonnenlicht brauchen glanz- und spiegelfreie Seiten.
▶ Leser in Räumen mit schlechter Beleuchtung brauchen einen starken Kontrast zwischen Papier und Text sowie zwischen verschiedenen Farbtönen.
▶ Leser, die ein gedrucktes Handbuch mit sich führen müssen, brauchen möglicherweise ein Dokument in einem kleineren Seitenformat, das in ihre Tasche passt oder in ein speziell dafür vorgesehenes Fach am Produkt. Zum Beispiel sollte das Bordbuch eines Autos ins Handschuhfach passen.
▶ Leser eines elektronischen Benutzerhandbuchs auf einem Mobilgerät brauchen ein platzsparendes Layout auf kleinem Raum.
Halten Sie das Design einfach und übersichtlich
Weniger ist mehr. Halten Sie die Gestaltung der Formatvorlage für Ihre Bedienungsanleitungen so schlicht wie möglich. Lenken Sie die Leser nicht von den Inhalten ab. Erstellen Sie ein Design, das den Lesern dabei hilft, die im Handbuch gegebenen Informationen schnell zu finden und mit wenig Mühe aufzunehmen.
Vermeiden Sie überflüssige Vielfalt
▶ Verwenden Sie nur einige wenige Farben. Verwenden Sie unterschiedliche Farben nur dann, wenn diese einen bestimmten Zweck erfüllen. Reservieren Sie optisch hervorstechende Farben für besonders wichtige Dinge.
▶ Verwenden Sie nur wenige verschiedene Schriftarten und Schriftgrößen. Setzen Sie eine abweichende Schriftart oder Schriftgröße nur dann ein, wenn Sie damit einen klaren Zweck verfolgen. Reservieren Sie große und fette Schrift ausschließlich für besonders wichtige Informationen sowie für Überschriften.
▶ Versuchen Sie, mit möglichst wenigen Formaten auszukommen.
▶ Verwenden Sie dieselben Formate einheitlich im gesamten Handbuch.
▶ Verwenden Sie dieselben Formate auch in allen anderen Dokumenten zum Produkt: Montageanleitungen, Installationsanleitungen, Bedienungsanleitungen, Benutzerhandbücher, Referenzhandbücher, Betriebshandbücher, Wartungsanleitungen usw.
▶ Verwenden Sie beim Anordnen von Objekten immer dieselben Positionen. Richten Sie alle Objekte an einem einheitlichen Gestaltungsraster aus.
Vermeiden Sie Redundanz
Lassen Sie alles weg, was keinen wirklichen Nutzen besitzt: Buchstaben, Symbole, Linien, sonstige Objekte.
▶ Objekte, die wichtige oder hilfreiche Informationen vermitteln, sind nicht überflüssig.
▶ Objekte, die den Lesern dabei helfen, Informationen zu finden und zu verarbeiten, sind nicht überflüssig.
▶ Objekte, die nur dazu da sind, leeren Platz zu füllen, sind überflüssig!
Beispiele:
▶ Verzichten Sie auf Hintergrundbilder.
▶ Verzichten Sie darauf, Ihr Logo auf jede Seite zu setzen. Es genügt auf der Titelseite.
▶ Wiederholen Sie nicht auf jeder Seite den Namen des Autors.
▶ Wiederholen Sie nicht auf jeder Seite den Hinweis zum Copyright.
▶ Wiederholen Sie nicht auf jeder Seite Versionsnummer und Datum.
▶ Wiederholen Sie nicht auf jeder Seite den Dokumenttitel.
▶ Ein laufender Kolumnentitel mit der Überschrift des jeweils aktuellen Kapitels kann Lesern jedoch die Orientierung im Handbuch erleichtern und stellt damit einen wirklichen Mehrwert da.
Tipp: Manchmal erfordern es die Designvorgaben eines Unternehmens, dass bestimmte Elemente zwangsweise auf jeder Seite erscheinen müssen, egal ob dies nun Sinn macht oder nicht. Falls Sie in einem solchen Fall keine Einflussmöglichkeiten auf eine Änderung dieser Vorgaben haben (Sie sollten es zumindest versuchen), halten Sie die betreffenden Elemente so unauffällig wie möglich: verkleinern Sie die Elemente, verzichten Sie auf Farben, machen Sie Text hellgrau statt schwarz, positionieren Sie die Elemente an einem möglichst wenig beachteten Ort, klar abgegrenzt vom wirklichen Inhalt.
Vermeiden Sie Überfrachtung
Überfrachten Sie die Seiten Ihrer Benutzerhandbücher und Bedienungsanleitungen nicht mit einem Zuviel an Informationen. Setzen Sie gezielt Weißraum ein, um die Aufmerksamkeit der Leser zu steuern, um zusammengehörige Dinge zu gruppieren und um an den richtigen Stellen für Lese- und Atempausen zu sorgen.
Sollte durch ein aufgeräumtes Layout Ihr Benutzerhandbuch ein wenig länger werden, ist das kein Problem. Wenn Sie nützliche Inhalte bieten, sind Leser auch dazu bereit, am Bildschirm zu scrollen oder eine Seite umzublättern. Sie sind jedoch nicht dazu bereit, Handbücher zu lesen, die sie überfordern.
Sehen Sie semantische, am Inhalt orientierte Formate vor
Verwenden Sie Formatnamen, die die Bedeutung eines Formats beschreiben und nicht dessen Aussehen. Benennen Sie ein Format zum Beispiel „Betonung“ und nicht „Fett-Rot“.
Semantische Formate haben wesentliche Vorteile:
▶ Der Formatname zeigt Ihnen, wann Sie das Format sinnvollerweise einsetzen.
▶ Sie können das Erscheinungsbild des Formats jederzeit ohne negative Seiteneffekte ändern. Beispiel: Stellen Sie sich vor, Sie haben ein spezielles Format angelegt, das Sie immer dann verwenden, wenn der Name eines Bedienelements im Text vorkommt. Wenn Sie das Format zum Beispiel „Element“ genannt haben, können Sie später die Schrifteinstellungen jederzeit einfach ändern. Wenn Sie die Schriftart von Arial auf Verdana ändern möchten oder die Schriftgröße von 10pt auf 12pt, ist das kein Problem. Was wäre aber, wenn Sie Ihr Format “Arial-10pt-Fett” genannt hätten? Das würde jetzt nicht mehr viel Sinn ergeben …
▶ Semantische Formate sind eine der Grundvoraussetzungen für strukturiertes Schreiben in XML und DITA. Wenn Sie semantische Formate verwenden, sind Ihre Bedienungsanleitungen automatisch darauf vorbereitet, falls Sie eines Tages einmal zu einer strukturierten Texterfassung und -verarbeitung übergehen möchten.
Verwenden Sie eine durchdachte Namenskonvention
Um Ihre Handbuch-Formatvorlage möglichst anwendungsfreundlich für die Autoren zu machen, überlegen Sie sich ein effektives Benennungsschema für die Formatnamen:
▶ Wählen Sie Namen, die Sie sich leicht merken können.
▶ Wählen Sie die Namen so, dass verwandte Formate im Formatekatalog Ihres Autorenwerkzeugs zusammenstehend aufgelistet werden. Sie können dies erreichen, indem Sie die Namen verwandter Formate mit demselben Präfix beginnen.
▶ Wählen Sie für Tastenkürzel solche Tasten, die Sie sich leicht merken können. Verwenden Sie dasselbe Schema einheitlich für alle Absatzformate und ein anderes Schema einheitlich für alle Zeichenformate. Zum Beispiel könnten Sie für alle Absatzformate verwenden Alt+Umschalttaste+Buchstabe und für alle Zeichenformate Strg+Umschalttaste+Buchstabe.
Vermeiden Sie beim Schreiben amateurhafte Formatierungstechniken
Verzichten Sie auf:
▶ leere Absätze
▶ wiederholte Leerzeichen
▶ Tabulatoren
▶ alle Arten individueller lokaler Formatierung
Verwenden Sie ausschließlich die in Ihrer Formatvorlage definieren Formate!
Probleme mit leeren Absätzen
Verwenden Sie keine leeren Absätze, um den Abstand oberhalb oder unterhalb eines Absatzes zu vergrößern. Verwenden Sie stattdessen die dafür vorgesehenen Absatzeigenschaften.
Verwenden Sie leere Absätze außerdem nicht dazu, Seitenumbrüche zu erzeugen. Wenn Sie später einmal einzelne Zeilen zu Ihrem Benutzerhandbuch hinzufügen oder daraus löschen, rutscht sonst alles auf eine falsche Position. Verwenden Sie stattdessen immer manuelle Seitenumbrüche. Besser noch: Automatisieren Sie Seitenumbrüche nach Möglichkeit vollständig.
Alle Arten leerer Absätze führen zu Konflikten mit automatischen Seitenumbrüchen.
Probleme mit wiederholten Leerzeichen
Verwenden Sie keine Leerzeichen, um einen Text einzurücken. Definieren Sie stattdessen immer einen entsprechenden Einzug in den Absatzeigenschaften. Wenn Sie Leerzeichen zum Einrücken eines Absatzes verwenden, müssen Sie alle Folgezeilen manuell anpassen, sobald Sie etwas ändern.
In Online-Benutzerhandbüchern mit variabler Spaltenbreite funktionieren Einzüge mit Leerzeichen überhaupt nicht.
Die einzige Stelle, an der das Formatieren von Texten mit Leerzeichen in einem Benutzerhandbuch sinnvoll ist, sind Zitate von Programmcode. Wenn Sie über die Zwischenablage Programmcode in Ihr Handbuch einfügen, ist dieser typischerweise bereits mit Leerzeichen oder Tabulatoren eingerückt.
Probleme mit Tabulatoren
Vermeiden Sie das Verwenden der Tabulator-Taste. Tabulatoren können zu Problemen führen, wenn Sie ein Handbuch auch online verfügbar machen wollen, denn HTML kennt keine Tabulatoren. Tabulatorzeichen müssen dann in ein oder mehrere Leerzeichen oder in Einzüge umgewandelt werden, was nur selten sauber gelingt.
Anstelle von Tabulaturen verwenden Sie besser Absatzeinzüge oder eine Tabelle ohne Linien. Bedenken Sie: Selbst falls Sie heute noch keine Online-Version eines Benutzerhandbuchs bereitstellen möchten, sollten Sie sich diese Option für die Zukunft offenhalten.
Probleme mit lokaler Formatierung
Weisen Sie nicht manuell einzelnen Absätzen oder Zeichen Formateigenschaften zu. Verwenden Sie immer nur die in Ihrer Formatvorlage definierten Absatzformate und Zeichenformate. Wenn Sie ein Absatzformat für einen einzelnen Absatz manuell überschreiben, oder wenn Sie die Formatierung einzelner Zeichen manuell überschreiben, führt dies unweigerlich zu Problemen, wenn Sie später einmal das Design Ihres Benutzerhandbuchs ändern möchten. Dies mag Ihnen heute noch unwahrscheinlich erscheinen, passiert in der Praxis aber häufiger als gedacht.
Wenn Sie ausschließlich Formate der Formatvorlage verwendet haben und das Design ändern möchten, brauchen Sie lediglich in der Formatvorlage die Formatdefinitionen anzupassen und Ihr komplettes Handbuch erhält automatisch das neue Aussehen. Wenn Sie jedoch manuelle Formatierungen verwendet haben, müssen Sie diese alle einzeln von Hand anpassen. Bei mehreren Handbüchern, vielleicht sogar noch in mehreren Sprachen, kann das schnell viele Stunden zusätzlicher Arbeit bedeuten.
Möchten Sie viel Zeit sparen und mögliche strategische Fehler vermeiden?
Die Starter-Formatvorlage für Benutzerhandbücher hilft Ihnen dabei.
