Inhaltsverzeichnis
Definition eines guten Handbuchs
Die Definition eines guten Handbuchs konzentriert sich auf nur ein Wort: handlungsorientiert. Ein Handbuch enthält Anweisungen, um etwas zum Laufen zu bringen oder am Laufen zu halten. Das klingt sehr offensichtlich.
Dennoch sind viele Handbücher im Umlauf, die überhaupt nicht handlungsorientiert sind. Es ist durchaus vorstellbar, dass in einem Handbuch zunächst beschrieben wird, wozu ein Ventil dient. Oder welche Vorteile dieses Ventil gegenüber anderen Ventilen hat. Oder welche Farbkombinationen des Ventils es gibt. Jemand, der das Ventil bedienen, reparieren, warten oder austauschen möchte, ist an diesen Informationen nicht interessiert. Er oder sie möchte loslegen.
Arten von Handbüchern
Welche Arten von Handbüchern gibt es? Die Antwort lautet: Es gibt so viele Handbücher wie die unterschiedlichen Zwecke, denen die Handbücher gerecht werden müssen.
Am bekanntesten sind die Benutzerhandbücher: Handbücher, die die Verwendung eines Produkts oder einer Software erklären. Wenn für das Produkt ein gesondert zugewiesener Bediener erforderlich ist, beispielsweise ein Maschinist, wird eine Bedienungsanleitung häufig als Betriebsanleitung bezeichnet. Am gebräuchlichsten ist jedoch der Begriff „Benutzerhandbuch“.
Wer eine Maschine installieren muss, benötigt eine Installationsanleitung. Diese Handbücher sind üblich. Eine Produktionsmaschine erfordert eine ziemlich umfangreiche Installation: von der Verankerung am Boden über einen spezifischen Anschluss an das Stromnetz bis hin zur Installation von Sicherheitsvorrichtungen (z. B. transparenten Bildschirmen). Der Installationsvorgang für einen Drucker passt in das erste Kapitel eines Benutzerhandbuchs. Aber für die Inbetriebnahme eines Schweißroboters oder einer Ampel ist mit ziemlicher Sicherheit eine separate Anleitung erforderlich.
Manchmal sind die Produkte so komplex, dass auch spezielle Wartungshandbücher erforderlich sind. Denken Sie an ein Verkehrsflugzeug, das von Zeit zu Zeit überprüft oder renoviert werden muss. Wann eine Inspektion erforderlich ist und wann eine Komplettüberholung erforderlich ist, ist im Wartungshandbuch angegeben. Für komplexe Produkte wie Flugzeuge, Schiffe und Züge sind diese Handbücher unverzichtbar. Auch für Pkw und Lkw sind sie unverzichtbar. In den Garagenregalen liegen viele Wartungshandbücher.
Ein Benutzerhandbuch hat oft ein abschließendes Kapitel mit dem Titel „Fehlerbehebung“. Insbesondere bei komplexen Produkten sind häufig spezielle Handbücher erforderlich, in denen tatsächlich eine vollständige Sammlung von Fehlermeldungen aufgeführt ist. Eine solche Fehlermeldung hat oft einen Code, zum Beispiel EK76-AA: „Grünes Lampendreieck signalisiert keine Verriegelung des Fahrwerks“. In diesem speziellen Fall gibt ein Handbuch zur Fehlerbehebung an, was die Besatzung eines Flugzeugs tun muss. Möglicherweise funktioniert das Fahrwerk, aber das Problem liegt an der Signalisierung der Lampe. Ein Fehlerbehebungshandbuch enthält Anweisungen, um das genaue Problem zu identifizieren und es so weit wie möglich zu beheben.
Kriterien für ein gutes Handbuch
Eine Reihe von Schreibregeln bestimmen, ob ein Handbuch eine hohe, mittlere oder niedrige Qualität aufweist. Eine offensichtliche Schreibregel wurde bereits weiter oben in diesem Artikel erwähnt: Ein Handbuch sollte Anweisungen enthalten. Hintergrundinformationen zur Verfügbarkeit von Ventilen in verschiedenen Farben gehören nicht in ein Handbuch, sondern in eine Broschüre. Also: Schreiben Sie nicht in ein Handbuch, warum die Tragfähigkeit eines Flugzeugs optimal ist. Schreiben Sie, wie Sie die Steuerkabel sicher spannen, damit die Querruder an den Flügeln sicher funktionieren.
Sollten in einem Handbuch überhaupt keine Hintergrundinformationen enthalten sein? Um ehrlich zu sein, sind einige Hintergrundinformationen nützlich. Es gibt jedoch eine Bedingung: Die Hintergrundinformationen müssen minimal sein. Darüber hinaus müssen die Hintergrundinformationen der Handlungsorientierung dienen. Ein Beispiel macht dies konkret.
Angenommen, das System zum Abbrechen von Eis von einem Flugzeugflügel hat eine völlig neue Variante (Eis auf den Flügeln kann die Tragfähigkeit der Flügel erheblich beeinträchtigen). Dann ist es eine gute Idee, dies im Handbuch zu erwähnen. Schließlich kann ein solches neues System dazu führen, dass die Bedienung anders ist. Um zu verhindern, dass jemand an der alten Vorgehensweise festhält, ist es gut zu wissen, dass das „Enteisung“-System jetzt mit anderen technischen Spielereien funktioniert. Angenommen, das neue System arbeitet selbst bei kleinsten Eismengen viel schneller. Dann weiß der Nutzer – hier der Pilot –, dass eine wesentlich schnellere Aktivierung möglich ist. Eine schnellere Aktivierung kann nur besser funktionieren, um von Anfang an das gesamte Eis von einem Flügel zu entfernen. Dem Piloten wird sozusagen ein neues mentales Modell an die Hand gegeben, das ihn dazu bringt, anders über die notwendigen Handlungen nachzudenken.
Solche Hintergrundinformationen dienen dem Zweck des Handelns. Aber auch diese Informationen sollten minimalistisch sein, das heißt, es sollten nicht zu viele Hintergrundinformationen in einem Handbuch enthalten sein. Dann verschwindet der Fokus auf das Handeln. Dieser handlungsorientierte Charakter führt dazu, dass im Handbuch klar steht: Zum Einschalten des „De-Ice“-Systems sind diese und jene Tasten erforderlich.
Zusammenfassend: Stellen Sie als technischer Redakteur ein mentales Modell des Handlungshintergrunds bereit, sofern der Leser mit diesem mentalen Modell nicht bereits vertraut ist. Seien Sie jedoch minimalistisch mit den bereitgestellten Informationen.
Wer diesem Mittelweg folgt und Wert auf handlungsorientierte Anweisungen legt („Klicken Sie die weißen Kippschalter gleichzeitig nach oben, um die Enteisung auf beiden Flügeln zu aktivieren“), wird ein gutes Handbuch schreiben.
Tipps zur Gestaltung und Gestaltung von Handbüchern
Bisher geht es in diesem Artikel um den Inhalt von Handbüchern. Genauso wichtig ist aber auch eine ansprechende Präsentation.
Die „Präsentation“ in einem Handbuch ist in zwei Teile gegliedert.
Zunächst einmal muss das Design ansprechend sein. Das bedeutet beispielsweise, dass ein Handbuch ein modernes, schlichtes Erscheinungsbild erhält, das zur Corporate Identity des Herstellers passt. Solche Vereinbarungen werden in einem sogenannten „Template“ festgehalten: einer Vorlage mit einer Übersicht über die erstellten Formatierungsregeln.
Diese Formatierungsregeln sorgen nicht nur für ein ansprechendes Erscheinungsbild, sondern tragen auch zur Lesbarkeit bei. Ein Beispiel: Wenn es in der Anleitung um ein Mobiltelefon geht, das speziell für Menschen über 50 gedacht ist, dann ist es durchaus eine Überlegung wert, die Schriftgröße leicht zu erhöhen, beispielsweise von 11 Punkt auf 12 Punkt.
Zur „Präsentation“ gehört neben einem ansprechenden Design, das die Lesbarkeit fördert, auch der Einsatz von Bildern. Menschen sind visuell, sie sind es traditionell gewohnt, in Bildern zu denken. Daraus leitet sich das bekannte Sprichwort „Ein Bild sagt mehr als 1.000 Worte“ ab. Die Schrift ist erst Jahrtausende alt. Das visuelle Erlebnis unserer Vorfahren ist möglicherweise 100-mal älter. Kurz gesagt: Ein gutes Handbuch verwendet, wann immer möglich, Bilder. Bilder sagen auf einmal viel.
Beispiele für gute und schlechte Handbücher
Es gibt viele Beispiele für gute und schlechte Handbücher. Zunächst ein Beispiel für ein schlechtes Handbuch.
Ein Handbuch für eine unbenannte Wasch-Trockner-Kombination sieht gut aus. Bei näherer Betrachtung fallen jedoch eine Reihe klassischer Fehler auf:
- Wenn die Kombination zu viel Lärm macht, empfiehlt es sich, das Gerät richtig zu nivellieren. Der erwähnte Verweis auf das Kapitel „Montage“ ist jedoch unangemessen, da er nicht im Handbuch enthalten ist. Gibt es vielleicht eine separate (nicht im Lieferumfang enthaltene) Installationsanleitung? Das ist nicht klar.
- Manchmal ist im Handbuch von „Wasserenthärter“ die Rede und manchmal von „Wasserenthärter“. Bedeutet der Hersteller hier dasselbe oder handelt es sich um zwei unterschiedliche Ratschläge, um die Maschine in gutem Zustand zu halten?
- Die Kapitel haben nicht immer einen eindeutigen Titel. So lauten die drei wichtigsten Kapitel nacheinander:
- Täglicher Gebrauch
- Täglicher Gebrauch: nur trocken
- Täglicher Gebrauch: Waschen und Trocknen.
Der Unterschied zwischen diesen drei ist nicht sofort klar. Es wäre klarer gewesen, wenn unter a. gestanden hätte: „Täglicher Gebrauch: nur waschen“. Nun muss der Leser darüber rätseln, was unter täglicher Anwendung zu verstehen ist.
- Die Texte werden kontinuierlich fortgesetzt, nicht nur nach einem Absatz, sondern auch nach einem Kapitel. Ein neues Kapitel beginnt also nicht auf einer neuen Seite. Dadurch entstehen Seiten voller Text, ohne dass der Leser eine klare Vorstellung vom Layout des Handbuchs erhält.
Es gibt natürlich auch Beispiele für gute Handbücher. Dabei handelt es sich um Handbücher, in denen Verweise auf andere Seiten und Handbücher immer korrekt sind. Dies ist auch ein Handbuch, in dem die Terminologie klar ist: Erwähnen Sie also nicht einmal das Wort „Deckel“ und ein anderes Mal das Wort „Abdeckung“.
Nehmen Sie eine multifunktionale Internetbox, die Ihnen ein Internetanbieter zur Verfügung stellt. Glücklicherweise scheinen die folgenden Kapitel klar hervorzustechen: Fernsehen, Surfen im Internet und Telefonieren. Es klingt einfach und das ist es auch. Doch etwas einfach zu halten ist manchmal nicht einfach, siehe Beispiel der Wasch-Trockner-Kombination.
Lassen Sie das Handbuch von Manualise schreiben
Ein Handbuch, das allen fachlichen und gesetzlichen Anforderungen, vor allem aber den Wünschen des Kunden gerecht wird: Das ist das Mindestziel von Manualise. Alle technischen Redakteure haben ihren Sitz in der TU-Stadt Delft und verfügen über einen technischen Hintergrund. Sie alle verfügen über eine Ausbildung, die Technik und Sprache vereint. Diese Sprache muss sicherlich keine Sprache sein, die nur aus Wörtern besteht. Im Gegenteil: Manualise setzt auf seine visuelle Haltung. Wo ein Bild ausreicht, verwendet das Unternehmen ein Bild. Das oberste Ziel des jungen Unternehmens lautet daher: das Beste aus allen Welten.
