Ein gutes Handbuch erstellen in 11 Schritten

Im ersten Schritt definieren wir, wer die eigentlichen Benutzer sind. Stellen Sie sich Fragen wie:

• Wer sind die Benutzer?
• Wie können die Benutzer beschrieben werden?
• Welche Sprache sprechen die Benutzer?
• Was ist deren Hintergrund?
• Was ist deren Alter, Geschlecht usw.?
• Welche Aufgaben müssen sie bewältigen?
• Wie oft werden sie durchgeführt?
• In welcher Umgebung wird das Produkt benutzt?
• Haben die Benutzer Zugang zum Internet?
• Stehen die Benutzer unter Stress?
• Wird das Produkt professionell, kommerziell oder privat genutzt?
• Welche technischen Erfahrungen, Qualifikationen, Ausbildungen, Schulungen, Kenntnisse oder Fähigkeiten haben die Benutzer?

Sich Wissen über Ihre Nutzer anzueignen, hilft Ihnen dabei herauszufinden, was deren Bedürfnisse sind. Dadurch wird keine wertvolle Zeit verschwendet, indem Dinge erklärt werden, die der Nutzer entweder schon weiß oder die irrelevant sind.

Üblicherweise beschreiben wir die Benutzer immer in der Einleitung des Handbuchs. Zum Beispiel:

Dieses Handbuch ist für Endverbraucher des [Gerätename] gedacht. Als Endbenutzer kann jede Person beschrieben werden, die direkt mit dem Produkt interagiert. Der Begriff „Endbenutzer“ umfasst üblicherweise unter anderem:

• Installationspersonal
• Bediener
• Wartungstechniker
• Demontagepersonal

Diesem Beispiel können Sie entnehmen, dass es unterschiedliche Arten von Benutzern gibt. Oftmals bestimmt das Zielpublikum darüber, welche Art von Handbuch benötigt wird.

Möchten Sie eine Online-Hilfe für die Mitarbeiter eines Kundendienstes oder ein Software-Tool erstellen? Ein Handbuch für Installateure? Oder ein Handbuch für Bediener?

Unabhängig davon, wer die Nutzer sind, sie konsultieren das Handbuch dann, wenn sie etwas erledigen oder ein Problem lösen wollen: Sie möchten die aktuelle Version ihres Textverarbeitungsprogramms
installieren, ihre Jogging-Runden mithilfe einer App verfolgen oder herausfinden, was das blinkende Licht auf dem Display ihres Elektrowerkzeugs bedeutet.

Diese zu lösenden Probleme oder Aufgaben sind sehr spezifisch, z. B.:

• Wie montiere ich die Füße meiner Mikrowelle?
• Wie tausche ich die Gussform an meiner Maschine aus?
• Was bedeutet das rot blinkende LED-Licht?
• Kann ich das Gehäuse meines Produkts mit einem Reinigungsmittel reinigen?
• Wie füge ich einen neuen Benutzer hinzu?

Wenn Sie Ihre Benutzer kennen, können Sie konsistenter schreiben. Es hilft Ihnen, die richtigen Informationen auszuwählen und sich auf die Aufgabe zu konzentrieren, die Ihre Nutzer erledigen möchten.

Beim Erstellen eines Handbuchs stellen wir stets sicher, dass das Produkt, für das wir das Handbuch verfassen, zu 100 % verstanden wird.

Das erreichen wir, indem wir das Produkt analysieren und austesten, Experten befragen und bestehende Dokumentationen studieren.

Wir versuchen es zu installieren, drücken alle Knöpfe, öffnen Abdeckungen, bestimmen Signale, klicken uns durch Assistenzprogramme etc.

Oft liegen schon Informationen zum Produkt vor, z. B.
Bedienungsanleitungen, eine Risikoanalyse oder Werbeunterlagen. Diese Informationen lesen wir genau, bis wir ein umfassendes Verständnis der Funktionen des Produkts über dessen gesamten Lebenszyklus haben, von der Beschaffung bis zur Entsorgung.

Es gehört zu unserem Beruf, kritisch zu sein, daher berücksichtigen wir ausschließlich Informationen, die wir vollständig verstehen und bewerten können.

Ein vollständiges Bild des Produkts entwickelt sich nur langsam. Alle aufkommenden, noch offenen Fragen werden notiert und für ein 100 %iges Verständnis mit Fachexperten geklärt.

Die Aufgaben der Benutzer sind der Ausgangspunkt für unsere Analyse und die Interviews mit den Fachexperten (Subject-Matter-Experts, SMEs). Die gesammelten Informationen werden im nächsten Schritt geordnet.

Eine klare Struktur ist ausschlaggebend für ein Handbuch.

Die im vorangegangenen Schritt gesammelten und analysierten Informationen müssen nun genau und logisch nach Themen strukturiert werden, damit sie den Benutzern eindeutige Antworten geben.

Das Ziel sollte sein, alle Informationen zu behalten, die wichtige Themen behandeln und die Fragen der Nutzer beantworten.

Alle diese Informationen zu ordnen ist eine der großen Herausforderungen eines technischen Redakteurs. Die gesammelten Informationen müssen analysiert, verstanden, selektiert, aussortiert, organisiert und strukturiert werden.

Ist ein Benutzerproblem zu komplex und hat der Leser Schwierigkeiten, die passenden Informationen zu finden, muss das Thema in weitere Segmente aufgeteilt werden.

Wir haben beispielsweise für ein bestimmtes Gerät, das sich Roof Washer nennt, ein Handbuch geschrieben. Einer der wichtigsten Schritte darin ist die Inbetriebnahme des Roof Washers durch den Benutzer.

Das Hauptproblem wäre also: Wie nehme ich den Roof Washer in Betrieb?

Nachdem die Inbetriebnahme ein riesiges Thema ist, haben wir sie in folgende Segmente aufgeteilt:

• Überprüfung des Lieferumfangs
• Vorbereitung der mobilen Plattform
• Vorbereitung des Roof Washers
• Aufsetzen des Top Cleaners auf das Gewächshaus
• Anpassung der mobilen Plattform
• Anpassung des Roof Washers
• Anpassung der Hauptbürsten
• Anpassung des optionalen Fensterschutzschalters
• Anpassung der optionalen Regenrinnenbürste
• Anpassung der Schalthebel des Vorderrads

Üblicherweise werden diese Themen dann in einer klaren Reihenfolge und identifizierbar im Inhaltsverzeichnis oder der Menüstruktur zu sehen sein – chronologisch zum Lebenszyklus Ihres Produkts. Ein Thema kann in Form eines Kapitels oder (Unter-)Absatzes behandelt werden.

Wenn Benutzer ein Problem haben und im Handbuch nach einer Lösung suchen, werden sie höchstwahrscheinlich im Inhaltsverzeichnis nachsehen,
um herauszufinden, wo sich die jeweilige Problemlösung innerhalb des Handbuchs befinden könnte.

Ein eindeutig formuliertes Inhaltsverzeichnis unterstützt die Nutzer auf der Suche nach den richtigen Anweisungen, ohne dabei verzweifelt das gesamte Handbuch lesen zu müssen.

Wir organisieren die Themen im Inhaltsverzeichnis bevorzugt nach den Bedürfnissen der Leserschaft und den am Lebenszyklus des Produkts orientierten Informationen.

In den meisten Fällen beginnen wir mit einem Standardinhaltsverzeichnis. Beim Sammeln von Informationen und Festlegen der Themen, wie oben
beschrieben, optimieren wir das Inhaltsverzeichnis mit den produktspezifischen Themen.

Beispiel eines Standardinhaltsverzeichnisses

Wir wenden Methoden und Tools an, wie Mind Mapping, Information Mapping und die klassischen Post-its, um Inhalte zu strukturieren und organisieren. Manchmal erstellen wir das Inhaltsverzeichnis auch einfach „on the go“.

Ein weiterer wichtiger Aspekt und eine wichtige Hilfe für Ihre Benutzer bei der Suche nach Lösungen im Inhaltsverzeichnis ist die durchdachte Formulierung der Überschriften.

Die Beschreibung eines Themas ist eine Überschrift und wird im Inhaltsverzeichnis aufgelistet. Das Inhaltsverzeichnis wird von den Lesern konsultiert, um so schnell wie möglich das Kapitel mit den von ihnen
benötigten Informationen zu finden.

Dieses Beispiel zeigt eine Überschrift, die eindeutig auf den Kapitelinhalt hinweist.

Überschriften in Handbüchern kommen wichtige Funktionen zu:

• Sie bieten einen Überblick über die Struktur des Handbuchs.
• Sie zeigen die logische Aufteilung der Produktinformationen, angelehnt an den Lebenszyklus des Produkts.
• Sie zeigen den hierarchischen Zusammenhang der Themen (Überschriften, Unterüberschriften).
• Sie ermöglichen es den Benutzern, zur richtigen Seite zu blättern.
• Sie ermöglichen es den Lesern, zu überspringen, wonach sie nicht suchen.

Eine Überschrift markiert die Grenzen zwischen Themenbereichen und Unterthemen eines Handbuchs. Eine gute Überschrift deckt den gesamten Inhalt des zugehörigen Themas ab.

Es ist daher wichtig, die Überschriften wohl überlegt zu formulieren und sich an konsistenten Stil und Formatierung zu halten, damit Ihre Benutzer die Informationen finden, nach denen sie suchen.

Aufgabe-Überschriften sollten so ausgearbeitet werden, dass sie selbsterklärend sind. Die Überschrift Wie man Pfannkuchen backt ist viel benutzerorientierter als Verwendung des MagicMix2000.

Laden Sie unsere kostenlose MS Word Vorlage für eine Bedienungsanleitung herunter mit vollständigem Inhaltsverzichnis (leider nur noch auf Englisch).

Unser vorrangiges Ziel ist es stets, ein Handbuch zu erstellen, das eine sichere, effiziente und effektive Verwendung eines Produkts ermöglicht.

Der Ausgangspunkt ist, ein Handbuch zu erstellen, das so verständlich wie möglich ist. Es gibt da einige Dinge, die wir beachten, wenn wir verständliche Handbücher erstellen.

Fachjargon vermeiden

Zunächst versuchen wir, Terminologie zu vermeiden, die nicht Teil des alltäglichen Vokabulars Ihrer Leser ist.
Sehen wir uns das anhand eines Beispiels an:

Sie können einfach schreiben „Ziehen Sie den unteren Näherungsschalter sicher fest“. „Näherungsschalter“ ist hier ein notwendiger Fachbegriff.

Wenn Sie aber schreiben „Wenden Sie ausreichend Drehmoment auf den unteren Näherungsschalter an, um sicherzugehen, dass die Näherungsschaltereinheit sicher an der Rampe befestigt ist und sodass sie sich unter extremen Wetterbedingungen nicht lösen kann“, benutzen Sie zu viel Fachjargon.

Wir sehen oft viel Fachjargon, wenn das Handbuch von Ingenieuren verfasst wurde.

Die meisten technischen SMEs fühlen sich in der Zahlenwelt wohler, arbeiten lieber mit Prozessen und technischen Prinzipien als mit Wörtern. Sie setzen sich eher damit auseinander, Dinge zum Laufen zu bringen als darüber zu kommunizieren, wie diese Dinge zum Laufen gebracht werden.

Diese ganzen Zahlen, technischen Begriffe usw. sind nicht immer notwendig, um klare Handbücher zu schreiben. Wir sehen es als unsere Aufgabe an, die richtigen Fragen über die Bedeutung von Begriffen zu stellen und zu entscheiden, welche Informationen verwendet werden und wie diese, mit den Benutzern im Blick (Schritt 1), auf die beste Weise kommuniziert werden können.

Verfügbare Informationstypen mit Bedacht auswählen

Der Inhalt aller Handbücher umfasst Informationen, die den folgenden drei Informationsarten zuzuordnen sind:

• Anweisende Informationen
• Beschreibende Informationen
• Referenzielle Informationen

Anweisende Informationen sind typischerweise eine Abfolge von Schritten, die Benutzer bei Aufgaben anleiten. Sicherheitsangaben gehören ebenfalls zu den anweisenden Informationen.

Ein Benutzer braucht ab und zu eine kurze Erklärung oder Hintergrundinformationen, um den Anweisungen folgen zu können oder zu entscheiden, ob die Anweisungen relevant sind, oder nicht. Diese Art von Informationen wird als beschreibende Informationen bezeichnet.

Referenzielle Informationen bieten den Benutzern zusätzliche Informationen.

Jedes Thema kann beschreibende, anweisende und referenzielle Informationen enthalten.

Es gibt dieses bemerkenswerte Paradoxon:

Man lernt etwas am besten, indem man es tut. Gleichzeitig müssen die Benutzer oft zunächst etwas lernen, um handeln zu können.

Es ist eine der wichtigsten Fähigkeiten von technischen Redakteuren, ein angemessenes Mittelmaß dazwischen zu finden, die Leser zum unmittelbaren Handeln anzuregen und ihnen daneben essenzielle beschreibende Informationen an die Hand zu geben.

Handbücher schreiben, die handlungsorientiert sind

Benutzer möchten Aufgaben erledigen und nicht über diese lesen.

Daher hat jede Anweisung ein klares Ziel, das stets handlungsorientiert und auf den Punkt formuliert sein sollte. Dies ist auch eines der Prinzipien des Minimalismus.

Die drei Informationstypen auf einer Seite des Handbuchs

Ein handlungsorientierter Ansatz sollte den Ausgangspunkt bilden für das gesamte Handbuch und jeden einzelnen Schritt. Ihre Nutzer sollten eine unmittelbare Möglichkeit zum Handeln erhalten.

Indem weniger beschreibende Informationen verwendet und der Fokus stattdessen auf Abläufe gelegt wird, können aktive Handlungen herbeigeführt werden.

Sehen wir uns das anhand des folgenden Beispiels an.

Auf der Seite dieses „Handbuchs für Drohnen“ sind zwei Schritte aufgelistet. Es sind zwei von insgesamt sechs Schritten der Anweisung/des Unterthemas Installation der Drohne. Jeder Schritt ist handlungsorientiert

Anweisungen in der richtigen Reihenfolge platzieren

Stellen sie sicher, dass Sie Schritt-für-Schritt-Abschnitte anbieten, die in der richtigen Reihenfolge angegeben sind und dem Timing und den Abläufen der tatsächlichen Vorgänge entsprechen.

Auch in einzelnen Sätzen sollten Sie sich an die richtige Reihenfolge halten. Sehen wir uns das anhand eines Beispiels an.

Um Deutsch als Ihre Standardsprache auszuwählen, wählen Sie Sprache im Dateimenü

... Ist wesentlich umständlicher als ...

Deutsch als Standardsprache festlegen:

1. Wählen Sie Datei > Sprache.
2. Wählen Sie Deutsch.

Klare Handbücher verfassen

Machen Sie Ihre Anweisungen nicht zu lang. Knappe, einfache Sätze mit nur einer Anweisung oder höchstens einer kleinen Anzahl eng miteinander verbundener Anweisungen in einem Satz funktionieren am besten.

Die Informationen müssen außerdem möglichst einfach und kurz sein. Anweisungen sollten im Präsens und Aktiv mit starken Verben formuliert werden.

Aktive Formulierungen stellen die Benutzer in den Vordergrund und Anweisungen im Aktiv sind einfacher zu lesen und zu verstehen.

Subjekt und Verb sind im Aktiv immer klar zu identifizieren. Beispiel:

„Schließen Sie eine Tastatur an einem USB-Anschluss des Fernbedienungsterminals an.“

In diesem Satz ist anschließen das aktive Verb und Tastatur, USB-Anschluss und Fernbedienungsterminal sind die Subjekte.

Vergleichen wir den Satz mit diesem passiv formulierten Satz:

„Eine Tastatur muss an einen USB-Anschluss des Fernbedienungsterminals angeschlossen werden.“

Im aktiv formulierten Satz ist es viel deutlicher, dass der Leser die Person ist, die die Aufgabe durchführen wird.

Durch die aktive Formulierung werden Ihre Anweisungen verständlicher, deutlicher und direkt.

Konsistenz für eine bessere Benutzererfahrung

Konsistenz ist eines der wichtigsten Merkmale eines klaren Handbuchs. Beispielsweise kann Verwirrung vermieden werden, indem stets dieselbe Formulierung für Produktelemente verwendet wird.

Es ist besonders wichtig, Informationsarten wie Warnungen, Schritte, Fehlererkennung und Tipps stets konsistent zu formatieren und darzustellen.

Eine konsistente Formatierung hilft den Nutzern dabei, die gesuchte Information zu identifizieren. Beispielsweise zieht eine deutliche Formatierung eines Warnhinweises, wie GEFAHR, WARNUNG und VORSICHT, mehr Aufmerksamkeit auf sich, da die Leser ihn visuell als Warnhinweis identifizieren.

Wenn Sie Informationsarten konsistent formatieren, werden Ihre Leser sie bewusst oder unbewusst erkennen und sie mit der Funktion der Informationsart verbinden.

In diesem Beispiel, das wir für Gazelle erstellt haben, wurden alle Informationsarten wie Überschriften der 1. und 2. Ebene, Warnungen/Hinweise, Kontextinformationen, Anweisungsüberschriften, Anweisungen, Produktteile und Illustrationen konsistent dargestellt.

Verwenden Sie Simplified Technical English für verständliche Texte

Wir wenden auch gerne die Regeln des Simplified Technical English an.

Die Verwendung des Simplified Technical English hilft außerdem, konsistent und verständlich zu schreiben.

Nochmal: Seien Sie sich bewusst, dass die Wörter, die Sie wählen, einen großen Einfluss auf die Bedeutung oder Verständlichkeit Ihrer Texte haben können.

Schauen wir uns das englische Wort „SET“ genauer an.

Dieses einfache Wort kann im Englischen u. a. anpassen, einstellen, befestigen oder positionieren bedeuten. Es ist besonders wichtig, dass dieses Wort so eingesetzt wird, dass dessen Bedeutung stets eindeutig ist.

Noch immer nicht überzeugt? Sehen wir uns das folgende Beispiel an:

“Turn off the engines not required”

Dieser Satz kann im Englischen bedeuten:

• „Die nicht benötigten Motoren abschalten“ oder
• „Es ist nicht notwendig, die Motoren abzuschalten“

Der ASD-STE100 Simplified Technical English-Standard enthält ein Wörterbuch, um Mehrdeutigkeiten zu vermeiden.

Das Wörterbuch umfasst lediglich 850 erlaubte Wörter.

Es enthält Einträge erlaubter und nicht erlaubter Wörter. Die erlaubten Wörter dürfen nur im Zusammenhang ihrer spezifischen Bedeutung verwendet werden. Beispielsweise darf das Wort „close“ (schließen) nur im Fall der folgenden beiden Bedeutungen verwendet werden:

1. Um einen Schutzschalter zu bedienen und einen Stromkreis herzustellen.
2. Um etwas zusammenzustellen oder so zu stellen, dass Material weder hinein noch hinaus kann.

Das Wort „close“ darf nur als Verb, nicht als Adverb verwendet werden. „Do not go close to the test rig during the test“ ist demnach keine erlaubte Verwendung des Wortes.

Wir haben unser eigenes Online-Wörterbuch erstellt, um festzustellen, ob ein Wort erlaubt oder nicht erlaubt ist: Online Technical English Dictionary.

Verwenden Sie einen Style Guide für konsistenten Stil

Style Guides unterstützen Sie dabei, Handbücher klarer zu schreiben und zu formatieren und einen konsistenten Stil beizubehalten.

Es ist besonders wichtig, Begriffe, Produktelemente und Einheiten auf konsistente Art und Weise zu benennen.

Verwenden Sie eine konsistente Terminologie im Handbuch, auf der Verpackung, in anderen zusätzlichen Unterlagen und auf dem Produkt selbst (Kennzeichnung und Beschriftung).

Natürlich sollten Sätze dabei grammatikalisch korrekt, für das Zielpublikum formuliert und mit möglichst wenig Fachjargon versehen sein.

Vermeiden Sie Abkürzungen, außer es kann davon ausgegangen werden, dass das Zielpublikum mit ihnen vertraut ist. Sollten Sie doch Abkürzungen verwenden, erklären Sie diese im Style Guide und/oder Glossar, wenn sie zum ersten Mal erscheinen.

Alle oben genannten Richtlinien können in einem Style Guide zusammengefasst werden. Ein Style Guide sorgt für Konsistenz und regt dazu an, genau auf alle Details zu achten: Er wird sie dazu bringen, sich jeden Satz ganz genau anzuschauen.

Ein Style Guide fördert Verständlichkeit.

Wenn Sie Ihren eigenen Style Guide erarbeitet haben, der z. B. Ihren Schreibstil, Formulierungen, konsistente Verwendung von Begriffen, Ansprache der Leser, Textdesign und Seitenlayout (dazu kommen wir später) umfasst, müssen Sie ihn auf die gesamte Produktdokumentation anwenden.

Wenden Sie den ANSI Z535.6-Standard an für klare Sicherheitsanweisungen

Die korrekte Verwendung von Signalwörtern, die auf Bedingungen und Empfehlungen hinweisen, ist im amerikanischen ANSI Z535.5-Standard festgelegt.

Unabhängig davon, dass es sich hier um einen US-amerikanischen Standard handelt, wenden wir ihn auch gerne für Produktdokumentationen für andere Märkte an.

Der ANSI-Standard legt als korrektes Verb, um auf eine Bedingung hinzuweisen, das Verb shall (sollen/müssen) fest. Das Wort shall ist vorgeschrieben. Das weithin anerkannte Wort must (müssen) statt shall wird vom Standard nicht anerkannt.

Beispiel: The product shall only be used by persons who have fully read and understood the contents of the User Manual. (Das Produkt darf nur von Personen verwendet werden, die den Inhalt dieses Handbuchs vollständig gelesen und verstanden haben.)

Das richtige Verb, um auf eine Empfehlung hinzuweisen, ist laut ANSI das Wort should (sollte). Oder, um es in ANSI-Terminologie auszudrücken: Das Wort should ist als Empfehlung zu verstehen.

Beispiel: After each use, the device should be disconnected from the mains. (Nach jeder Verwendung sollte das Gerät vom Stromnetz getrennt werden.)

Ist das Verhalten überwiegend freigestellt oder rechnet man nicht damit, dass etwas passiert, kann das Wort may (kann) verwendet werden. Das Wort wird als erlaubend, permissiv angesehen. Stattdessen might (könnte) zu verwenden, ist nicht zulässig.

Beispiel: Some individuals may experience a mild tingling sensation when first using the device. (Es kann ein leichtes Kribbeln zu spüren sein, wenn Sie das Gerät zum ersten Mal benutzen.)

Es ist bereits vorgekommen, dass die US-Zollbehörde die Einfuhr eines Geräts nicht gestattet hat, weil diese Wörter in der Produktdokumentation nicht richtig verwendet wurden.

Grafiken in Handbüchern bedeuten viel mehr als Screenshots oder Illustrationen.

Grafiken umfassen alle möglichen grafischen Darstellungen, wie Strichzeichnungen, Fotos, Screenshots, Videos, Symbole, Tabellen, Diagramme, Grafiken und Infografiken.

Jede dieser Grafiken dient einem anderen Zweck.

Illustrationen im IKEA-Stil

Wir sind bekannt für unsere Illustrationen im IKEA-Stil und verwenden sie, um Text zu unterstützen, zu ersetzen oder zu ergänzen und Prozesse oder Schritte in chronologischer Sequenz darzustellen.

Illustrationen tragen zu einem besseren Verständnis der zu erfüllenden Aufgabe bei.

Die Abfolge der im Handbuch verwendeten Illustrationen muss logisch und nachvollziehbar sein.

Im Vergleich zu Fotos, haben Sie mit Illustrationen viel mehr Freiheiten, den Fokus auf wichtige Details zu legen. Sie können ganz einfach weniger wichtige Informationen auslassen oder gewisse Teile hervorheben.

Ein Vorteil, Text vollständig mit Illustrationen zu ersetzen liegt darin, dass Illustrationen nicht übersetzt werden müssen. Denken Sie daran, dass es einiges an Fachwissen erfordert, um verständliche Illustrationen für Handbücher zu erstellen.

Obwohl es viele Tools gibt, die Sie dabei unterstützen können, kann es klug sein, die Illustrationen von einem kompetenten Grafiker oder technischen Zeichner entwerfen zu lassen.

Bei der Erstellung von Illustrationen lassen wir irrelevante Informationen aus oder heben wichtige Informationen hervor. Mit Fotos ist das komplizierter, daher verzichten wir weitestgehend darauf.

Verwenden Sie Screenshots für die Darstellung von Benutzeroberflächen

Screenshots können eingesetzt werden, um die Benutzeroberfläche eines Bedienpanels, eine Software auf einem Computer oder eine App visuell darzustellen.

Screenshots können einen Überblick über Funktionen bieten oder genutzt werden, um zu zeigen, was getan werden soll oder was das Ergebnis einer bestimmten Handlung ist.

Nutzen Sie Tabellen, um Daten zu organisieren

Wir verwenden Tabellen, um Daten in Form von Text oder Zahlen zu ordnen. Technische Daten sind z. B. besser lesbar, wenn sie in einer Tabelle dargestellt werden. In vielen Fällen kann eine Tabelle den Text vollständig ersetzen.

Achten Sie darauf, dass Sie Tabellen klar, informativ und in einem konsistenten Design erstellen. Tabellen werden meistens neben dem zugehörigen Text platziert. Referenztabellen (wie Ersatzteillisten) können als Ausnahme im Anhang platziert werden.

Verwenden Sie eher Videos als Illustrationen

Videos oder Animationen können in vielerlei Hinsicht hilfreich sein.

Der Einsatz von Videomaterial könnte sinnvoll sein, wenn Sie etwas ganz genau zeigen oder Bewegungen, einen Zustand oder eine Kraft demonstrieren möchten. Da das Format Video immer beliebter wird, könnten Sie es auch einsetzen, wenn Sie so viele Menschen wie möglich erreichen möchten.

Ein Video kann realistisch (mit einer Kamera aufgenommen), eine 3D-Animation oder eine illustrierte Animation sein, solange Sie bedenken, dass Videos immer kurz und prägnant sein sollten.

Je nach Produkt, für das Sie ein Handbuch schreiben, besteht die Möglichkeit, dass es für dessen Inhalt, die Darstellung und das Format rechtliche Vorschriften gibt.

Diese können von US-amerikanischen Bundesgesetzen, Richtlinien oder Verordnungen der EU oder aus ähnlicher Legislatur anderer Länder oder Staaten stammen.

Standards können dazu verwendet werden, wenn es nicht sogar vorgeschrieben ist, den Vorschriften (CE) zu entsprechen.

Maschinen und medizinische Geräte sind zum Beispiel die am stärksten regulierten Produkte. In der EU werden die gesetzlichen Anforderungen an Handbücher in der Maschinenrichtlinie und der Verordnung über Medizinprodukte festgehalten.

Um die Anforderungen der Maschinenrichtlinie zu befolgen, sollten Sie der harmonisierten Norm EN ISO 20607 und dessen Kapiteln zu den Gestaltungsgrundsätzen von Handbüchern für Maschinen folgen.

Eine weitere wichtige Norm ist die EN IEC/IEC 82079 zu Nutzungsinformationen.

Durch die Einhaltung rechtlicher Anforderungen und gegebener Standards erstellen wir rechtlich konforme Handbücher.

Dadurch umgehen Sie mögliche rechtliche Fallstricke, Ihr Produkt besteht die Zulassungstests und Zollvorschriften, Ihre Haftung verringert sich, Sie haben einen Wettbewerbsvorteil und sorgen dafür, dass Ihre Nutzer das Produkt noch sicherer verwenden können.

Generell folgen wir dem folgenden Prozess, um rechtskonforme Handbücher zu erstellen:

• Rechtsvorgaben identifizieren (Gesetze/Richtlinien)
• Standards identifizieren
• Rechtsanforderungen und Standards identifizieren, die auf Ihr Produkt anzuwenden sind
• Rechtliche Inhalte in die Produktdokumentation aufnehmen

In vielen Fällen verwenden wir eine unserer Vorlagen, um unsere Handbücher für Ihre Maschinen, Elektrogeräte oder Medizinprodukte zu erstellen.

Bestimmungsgemäße Verwendung: Das Herzstück des Handbuchs

Ein verständliches Handbuch sollte beschreiben, wie ein Produkt gemäß dessen Funktion und der erwarteten Produktlebensdauer verwendet werden sollte.

Der Zweck eines Produkts wird auch bestimmungsgemäße Verwendung eines Produkts, einer Maschine oder eines Geräts genannt.

Eine eindeutige Beschreibung der bestimmungsgemäßen Verwendung ist das Herzstück eines Handbuchs und definiert (mit anderen Nutzungseinschränkungen, z. B. technische oder umweltbedingte Einschränkungen) den Schutzrahmen der Nutzung Ihres Produkts: Es ist die Grundlage einer sicheren, effizienten und effektiven Nutzung des Produkts.

Die Beschreibung der bestimmungsgemäßen Verwendung gibt den Rahmen für Ihre Haftung vor und ist der Ausgangspunkt für die weiteren Inhalte Ihres Handbuchs.

Sobald wir die bestimmungsgemäße Verwendung festgelegt haben, können wir uns darauf konzentrieren, die Sicherheits- und Nutzerinformationen ausschließlich für die bestimmungsgemäße Verwendung des Produkts bereitzustellen.

Gesetze zur Produktsicherheit, wie Richtlinien und Normen, erfordern für die meisten Produkte eine Definition der bestimmungsgemäßen Verwendung.

Die folgende Definition für die bestimmungsgemäße Verwendung stammt aus dem internationalen Standard zur Erstellung von Gebrauchsanleitungen (IEC/IEEE 82079-1:2019):

Umfassender Funktionsumfang oder vorgesehene Anwendungen, die vom Anbieter des Produkts definiert und konzipiert wurden

Ein Beispiel der bestimmungsgemäßen Verwendung:

Sicherheit ist eines unserer Lieblingsthemen. Denn es hat mit Konformität (Compliance) zu tun, die von vielen technischen Redakteuren und Agenturen größtenteils nicht beachtet wird.

Darüber hinaus gefällt es uns etwas zu schaffen, das auf den ersten Blick vielleicht widersprüchlich erscheint: ein konformes und gleichzeitig benutzerfreundliches Handbuch.

Manche technischen Redakteure neigen dazu, zu viel zu warnen. Wir haben Handbücher gesehen, die nur aus Warnungen bestanden, ohne eine einzige Anweisung.

Übermäßiges Warnen steht im Widerspruch zu einem handlungsorientierten Ansatz (Schritt 4). Welchen Eindruck hätten Sie, wenn die erste Handlungsanweisung eines 40-seitigen Handbuchs auf Seite 32 erschiene, nach über 30 Seiten aus Warnungen und Verfahrensbeschreibungen?

Es gibt eine Alternative!

Schauen wir uns zunächst an, warum wir Sicherheitsanweisungen in Handbüchern verwenden.

Egal, wie gut und sicher ein Produkt entwickelt wurde, ist dessen Verwendung doch mit einigen Risiken verbunden. Risiken können mithilfe einer Risikoanalyse identifiziert werden.

Man ist sich generell darüber einig (in internationalen Standards), dass es drei Möglichkeiten gibt, diese Risiken zu reduzieren:

Sie können das Design des Produkts anpassen, die Benutzer oder das Produkt mit Sicherheitsvorkehrungen ausstatten (Schutzmaßnahmen, persönliche Schutzausrüstung) oder Sicherheitshinweise angeben.

Diese drei Maßnahmen zur Risikoreduzierung sollten genau in dieser Reihenfolge ergriffen werden. Ein Handbuch sollte also niemals dazu genutzt werden, um vor Risiken zu warnen, wenn das Design des Produkts noch verbessert werden könnte.

Die Faustregel ist: Warnen Sie dort, wo das Risiko eines Zwischenfalls am höchsten ist.

Im Falle des Handbuchs bedeutet das, dass zwischen vier Arten von Sicherheitshinweisen unterschieden werden kann: ergänzende Anweisungen, zusammengefasste Sicherheitshinweise, abschnittsweise Sicherheitshinweise und eingebettete Sicherheitshinweise (siehe diesen Artikel für zusätzliche Informationen).

Der Abschnitt mit den zusammengefassten Sicherheitsanweisungen (üblicherweise im Kapitel SICHERHEIT) kann weniger überfordernd sein, wenn nur Sicherheitsanweisungen erwähnt werden, die auf den gesamten Lebenszyklus des Produkts zutreffen, von Anschaffung bis Entsorgung.

Abschnittssicherheitshinweise betreffen ausschließlich bestimmte Abschnitte, z. B. die Installation. Üblicherweise erscheinen diese zu Beginn des spezifischen Abschnitts.

In Sachen Benutzerfreundlichkeit haben Sie hier zwei Möglichkeiten. Zunächst können Sie alle Sicherheitshinweise zusammenfassen, die zu diesem Abschnitt gehören.

Gemessen an der Anzahl der Warnungen scheint die Verwendung dieser elektrischen Zahnbürste genauso gefährlich zu sein, wie die Arbeit in einem Atomkraftwerk.

Ein benutzerfreundlicherer Ansatz wäre Folgendes:

Wir sagen nicht, dass Sie überhaupt keine Sicherheitshinweise verwenden sollen, aber es ist in vielen Fällen möglich, die Anzahl der Warnungen drastisch zu reduzieren.

Eingebettete Sicherheitshinweise sind im Handbuch selbst integriert.

Sollten wir uns entschließen, eine Warnung anstatt einer Anweisung einzufügen, achten wir darauf, die Warnung gut zu strukturieren.

Eine gute Warnung besteht aus drei Teilen:
● Art und Quelle der Gefahr
● Konsequenzen bei Nichtbeachtung
● Maßnahmen zur Gefahrenvermeidung

Einem Sicherheitshinweis gehen die Signalwörter Gefahr, Warnung, Vorsicht oder Hinweis voraus.

Heutzutage sind die Bedeutungen von Signalwörtern in zahlreichen Standards zu Risikostufen ähnlich.

Handbücher in einfachen MS Word-Dateien zu präsentieren ist eine Sache der Vergangenheit.

Benutzer möchten auf Informationen oft online und in Druckversion zugreifen können. Und wie diese Informationen aussehen, ist ein ausschlaggebender Punkt des Benutzererlebnisses.

Neben einem ansprechenden Design führen Formatierungsprinzipien wie die Auswahl der richtigen Schrift und Schriftgröße, effektiv und zielgerichtet eingesetzte Farben, Absätze, der Einsatz eines richtigen Schriftbildes, Kontraste etc. zu einem besseren Benutzererlebnis.

Für Informationen, die im Internet abzurufen sind, können Sie sowohl für die Darstellung als auch die Navigation die Normvorgaben der Richtlinie ISO/IEC 40500:2012 für Barrierefreiheit von Web-Inhalten konsultieren.

Obwohl es für viele Produkte oft noch immer Pflicht ist, ein Handbuch oder zumindest die Sicherheitsanweisungen als Printversion zur Verfügung zu stellen, beobachten wir einen langsamen Wandel. Für einige Produkte liegen die Handbücher vollständig in elektronischem Format vor und für andere Produkte eignet sich eine hybride Lösung, wodurch Druckerkosten gespart und der ökologische Fußabdruck verringert werden kann.

Dies eröffnet viele Möglichkeiten eine bessere Nutzererfahrung zu ermöglichen, indem Medien wie Videos, Augmented Reality, Online-Hilfen oder interaktive Handbücher eingesetzt werden.

Verfügbare CCSM- oder CSM-Lösungen (Technical Authoring-Tools) unterstützen Handbücher unterschiedlicher Formate.

Da es viele Wege gibt, die Funktionen eines Produkts den Nutzern zu übermitteln, ist es wichtig, das Informationsmedium auf Grundlage der Bedürfnisse des Zielpublikums festzulegen.

Die Medien sollen einen einfachen Zugang zu den Informationen über den gesamten Lebenszyklus des Produkts ermöglichen.

Nachdem die Inhalte (Text und Bilder) und Form (Vorlagen) erstellt wurden, wird der erste Entwurf einer Überprüfung unterzogen.

Wir bitten stets unsere Kunden, alle Personen mit weitreichendem Wissen zum Produkt, die Informationen beigesteuert haben, die bisherige Arbeit zu überprüfen.

Die Überprüfung kann anhand der Revisions-Funktion einer Authoring-Software oder ganz einfach mittels Google Docs stattfinden. Ist das Feedback abgegeben, kann das Handbuch finalisiert werden.

Nach der technischen Prüfung ist es Zeit, das Dokument Korrekturlesen zu lassen. Dabei wird das geschriebene Handbuch auf Fehler überprüft.

Nachdem es aufgrund der so genannten „Betriebsblindheit“ problematisch sein kann, die eigene Arbeit zu prüfen, wird die Korrekturlesung über eine professionelle Übersetzungsagentur abgewickelt.

Ist die Korrekturlesung erledigt, ist das ein guter Ausgangspunkt für die Übersetzung. Es ist darüber hinaus allgemein anerkannt, dass ein englischsprachiges Handbuch die beste Ausgangssprache für eine Übersetzung ist.

Meistens ziehen wir es vor, das originale Handbuch auf Englisch zu verfassen. Zunächst ist es im Englischen einfacher, eindeutige Befehlssätze zu formulieren, wie „Push the On/Off button“. Auf Deutsch würde dies zum Beispiel „Drücken Sie den Ein/Aus-Schalter“ heißen.

Wäre Zweiteres die Ausgangssprache, könnte der Satz schnell zu „You can now push the On/Off button“ übersetzt werden, da der Übersetzer das Wort „Sie“ sieht und es im Satz verwenden möchte, sich aber nicht darüber bewusst ist, wie wichtig es ist, den Satz mit einem aktiven Verb zu beginnen.

Darüber hinaus ist es deutlich günstiger aus dem Englischen zu übersetzen, da es die meistgesprochene Fremdsprache der Welt ist. Es ist leichter, jemanden zu finden, der von Englisch ins Deutsche übersetzt, als umgekehrt.

Wir achten stets darauf, Ihr Handbuch von einem Übersetzer mit einschlägiger Erfahrung übersetzen zu lassen. Das könnte ein Übersetzer mit Erfahrung mit technischen Inhalten, der Übersetzung ähnlicher Produkte oder der Übersetzung von Handbüchern sein.

Oft stellen wir dem Übersetzer oder der Agentur ein Glossar oder eine Terminologieliste zur Verfügung, um die Qualität der Übersetzungen zu verbessern.

Wenn das Handbuch in mehrere Sprachen übersetzt werden muss, kann auch hier der Einsatz eines Content-Management-Systems (CMS) oder eines Component Content Management-Systems (CCMS) von großem Vorteil sein. Die meisten dieser Tools basieren auf Industriestandards, wie XML, CSS und XLIFF.

Die Übersetzungen werden im Translation Memory verwaltet, und nur die noch nicht übersetzten Teile werden an ein Übersetzungsbüro weitergeleitet.

Wenn Sie mehrere Handbücher für ähnliche Produkte und/oder in mehreren Sprachen erstellen müssen, könnte ein CCMS von Vorteil sein. Die meisten dieser Tools basieren auf Industriestandards, wie XML, CSS und XLIFF.

Einige dieser Tools sind Paligo, MadCap Flare, Author-it, Framemaker, Oxygen XML und SCHEMA ST4.

Die grundlegende Funktionsweise dieser Tools ist es, Inhalte wiederzuverwenden. Indem Inhalt und Form strikt getrennt werden, ist der Output-Prozess automatisiert, wohingegen Sie in InDesign mehrere Stunden am DTP sitzen.

Darüber hinaus ermöglichen es Ihnen die meisten CMS- oder CCMS-Programme für technisches Authoring mit den selben Inhalten sowohl Online- als auch Printversionen zu erstellen.

Auf Ihre Bedürfnisse abgestimmt wählen wir das passende CMS/CCMS.

Wir unterstützen Sie bei der Erstellung Ihrer Handbücher.

Von Handbücher wird häufig angenommen, dass diese erst nach der Entwicklung des Produkts erstellt werden können. Um jedoch qualitativ hochwertige Informationen zu erhalten, sollte die Erstellung von Handbücher als integraler Bestandteil des Produkts selbst betrachtet werden. Die Entwicklung von qualitativ hochwertigen Handbücher erfordert eine spezielle Planung.

Wir bei INSTRKTIV haben daher unseren eigenen 5-Schritte-Prozess entwickelt, den wir zur Erstellung von Handbücher anwenden. Dieses Verfahren basiert auf dem Produktentwicklungsprozess, da der Prozess des Sammelns und Strukturierens von Informationen dem Modell für Innovationsprozesse recht ähnlich ist.

Er besteht aus den folgenden Phasen:

1. Festlegung des gesetzlichen Rahmens
2. Analyse des Produkts und Verfassen der Texte
3. Erstellung der Illustrationen
4. Entwicklung von Vorlagen
5. Erzeugung von Output

Unser Team besteht aus einer Reihe von Fachleuten, von denen jeder über ein eigenes Fachwissen verfügt. Zu unseren internen Experten gehören Rechtsexperten, technische Redakteure, Illustratoren, Designer, CMS-Experten und DTP-Designer.

Sind Sie interessiert an den Möglichkeiten, Ihr eigenes Handbuch herzustellen? Dann setzen Sie sich einfach mit uns in Verbindung!