Sie suchen auf: {{ keyword }}

Leitfaden für das Erstellen einer Bedienungsanleitungen

Ferry Vermeulen Bedienungsanleitungen

In diesem Artikel werde ich Ihnen zeigen, wie wir eine benutzerfreundliche, ansprechende UND rechtskonforme Bedienungsanleitung für unsere Kunden erstellen.

Nachdem Sie ihn gelesen haben werden Sie vielleicht schon eigene Bedienungsanleitungen schreiben können, ohne einen Abschluss in Technischer Kommunikation, Design UND Jura . Es geht viel schneller als Sie denken!

Befolgen Sie einfach die Schritte des INSTRKTIV-5-STEP-USER-MANUAL PROCESS.

Oder wie wir bei uns sagen: die I LUV MANUALS TECHNIQUE (L=Liability [Haftung], U=Usability [Benutzerfreundlichkeit] und V=Visibility [Sichtbarkeit]).

Zu wissen, wie man ein Produkt sicher, effektiv und effizient verwendet, ist ausschlaggebend für ein erfolgreiches Benutzererlebnis. Sie bieten ihren Endverbrauchern professionelle Benutzeranweisungen und sorgen im Umkehrschluss für zufriedenere Kunden, verbesserte Rechtskonformität und geringere Kosten für Kundenservice.

Möchten Sie wissen, wie Sie eine Bedienungsanleitung schreiben, von der alle beeindruckt sind, wie diese, die wir für AEG/Electrolux erstellt haben?

Wie diese Kurzanleitung für LIDL?

Wie diese Bedienungsanleitung für Gazelle?

Wie diese Produktdokumentationen und Online-Hilfen?

 Oder diese Beispiele?

Dann lesen Sie weiter.

INHALTSVERZEICHNIS

Wie wir die 'I LUV Manuals Technique‘ einsetzen, um die Kundenzufriedenheit um 63 % und mehr zu steigern
Kapitel 1 - Wie Sie eine Produktdokumentation erstellen, in der Ihre Kunden finden, wonach sie suchen
Kapitel 2 - Bedienungsanleitungen schreiben, die verständlich sind und eine sichere Verwendung des Produkts garantieren
Kapitel 3 - Eindeutige Grafiken erstellen
Kapitel 4 - Darstellung ihrer Bedienungsanleitung
Kapitel 5 - Finalisierung und Vertrieb ihrer
Fazit

MÖCHTEN SIE EINE VORLAGE FÜR EINE BEDIENUNGSANLEITUNG NUTZEN, DIE BEREITS ALLE RECHTLICHEN ASPEKTE ENTHÄLT?

Nehmen Sie den schnellsten Weg zu einer konformen Anleitung. Wir haben Vorlagen (in deutscher Sprache) für Bedienungsanleitungen für Maschinen, Medizinprodukte und Elektrogeräte entwickelt, die bereits alle rechtlichen Inhalte beinhalten. 

HIER BESTELLEN!

Wie wir die ‚I LUV Manuals Technique‘ einsetzen, um die Kundenzufriedenheit um 63 % und mehr zu steigern

Trifft eine der folgenden Aussagen auf Sie zu:

  • Sie brauchen eine Bedienungsanleitung für ihr Produkt, ... SOFORT!
  • Ihr Kundenservice ist überlastet,
  • Ihre Kunden sind unzufrieden,
  • Ihr Produkt konnte nicht zertifiziert werden, da die Produktdokumentation nicht den Bestimmungen entspricht,
  • Sie sorgen sich um Ihre Haftung, da die Bedienungsanleitung nicht rechtskonform ist und/oder darin nicht alle Sicherheitshinweise abgedeckt sind,
  • Sie möchten eine ansprechende Produktdokumentation, die zu einem verbesserten Benutzererlebnis beiträgt,
  • Sie verwenden viel Zeit für die Erstellung Ihrer Bedienungsanleitungen und fragen sich, wie Sie effizienter arbeiten könnten. Denn: die meisten Ihrer Bedienungsanleitungen sind ohnehin zu X % identisch. 

Mit der I LUV Manuals-Technik können wir:

  • Ihre Kundenzufriedenheit um 63 % steigern
  • Anrufe, E-Mails und Chat-Unterhaltungen um unglaubliche 71 % senken
  • Die Haftung um 98 % reduzieren
  • Sicherstellen, dass alle Konformitätsprüfungen bestanden werden
  • Sicherstellen, dass Zollvorschriften eingehalten werden

Los geht’s!

Kapitel 1 - Wie Sie eine Produktdokumentation erstellen, in der Ihre Kunden finden, wonach sie suchen

Damit Ihre Kunden finden können, wonach sie suchen, müssen Informationen strukturiert werden. 

Unstrukturierte Informationen sind nicht besonders hilfreich. Sie sollten festlegen, welche Informationen wichtig sind und welche nebensächlich. 

Wenn Sie die Informationen für Ihre Kunden ordentlich strukturieren, sparen diese Zeit und Energie auf der Suche nach der Lösung eines bestimmten Problems. 

Sind Informationen nicht ordentlich gegliedert, werden Ihre Kunden schnell aufgeben. Oder noch schlimmer: sie machen eine negative Erfahrung in Verbindung mit Ihrer Marke.

Lernen Sie Ihre Benutzer kennen und bedienen Sie somit deren Informationsbedarf

Der erste Schritt hin zu den richtigen Inhalten für Ihre Kunden besteht darin, das Produkt und die Benutzer kennenzulernen. 

Gehen Sie zunächst davon aus, dass die Benutzer kein Wissen oder Erfahrungen mit dem Produkt mitbringen, bevor Sie definiert haben, welche Beschreibung auf Ihre Benutzer zutrifft. . 

Stellen Sie sich Fragen wie:

  • Wie können die Benutzer beschrieben werden? Was ist deren Alter, Geschlecht usw.?
  • Welche Aufgaben müssen sie bewältigen?
  • Warum werden diese Aufgaben durchgeführt?
  • Wie oft werden sie durchgeführt?
  • In welcher Umgebung wird das Produkt benutzt?
  • Welche Sprache sprechen die Benutzer?
  • Stehen die Benutzer unter Stress?
  • Was ist der Hintergrund?
  • Wird das Produkt professionell, kommerziell oder privat genutzt?  
  • Welche technischen Erfahrungen, Qualifikationen, Ausbildungen, Schulungen, Kenntnisse oder Fähigkeiten haben die Benutzer? (Z. B.: Wenn Sie Informationen zu einem Softwareupdate erstellen, haben Ihre Benutzer höchstwahrscheinlich bereits Erfahrung mit der Software);
  • Falls zutreffend, stehen etwaige Werkzeuge zur Verfügung?
  • Haben die Benutzer Zugang zum Internet?

Warum ist das wichtig? Sehen wir uns das anhand eines Beispiels an.

Die Deutsche Bahn AG (DB) hatte vor, ihre gesamte in Papierform vorliegende Dokumentation zu ihren Zügen in digitale Onlinedokumentation und Videos zu konvertieren.

Um ein Video abzuspielen, bedarf es zumeist einer High-Speed-Internet-Verbindung. Obwohl der Empfang in Deutschland generell gut ist, ist High-Speed-Internet in den ländlichen Gebieten nicht immer gewährleistet. 

Darüber hinaus, wenn ein Zug in einem Tunnel liegen bliebe, gäbe es höchstwahrscheinlich gar keinen Internetempfang und somit bliebe der Zugang zu den Informationen gänzlich verwehrt.

Daher entschieden Sie sich, alle Informationen elektronisch vorliegen zu haben, jedoch im Offlineformat.

Indem Sie die richtigen Fragen stellen und dadurch feststellen, wer die Leser sind und wo und wie Informationen konsumiert werden, können Sie deren Informationsbedürfnissen viel besser begegnen. 

Vergessen Sie auch nicht die Bedürfnisse von Menschen mit Behinderungen. Es könnte Benutzer mit verringertem Sehvermögen oder Farbenblindheit geben. Für diese Benutzer möchten Sie vielleicht eine alternative Produktdokumentation in Brailleschrift, großer Schrift oder Audioformat anbieten.

Entwerfen Sie eine Persona, um ihre Benutzer besser zu verstehen

Da ich ein großer Freund davon bin, Dinge zu visualisieren, ermutige die Menschen dazu, eine Persona zu erstellen. 

Eine Persona ist ein virtuell dargestelltes Benutzerprofil unter dem einige begründete Annahmen über Benutzereigenschaften zusammengefasst sind. 

Das Erstellen solcher Personas habe ich während meines Masterkurses Industrial Design Engineering gelernt. Personas zu erstellen ist nicht nur hilfreich wnne Sie Ihre Bedienungsanleitung schreiben, sondern auch als erster Schritt bei der Entwicklung eines Produkts oder einer Software. 

So kreieren Sie eine Persona:

  1. Stellen Sie sich die richtigen Fragen, um Ihre Benutzer zu identifizieren und kennenzulernen.
  2. Sammeln Sie Bilder aus Magazinen oder dem Internet, die für die Benutzer, deren Hobbies, Umwelt, Fähigkeiten usw. stehen.
  3. Erstellen Sie digital oder ganz klassisch mit Schere und Kleber eine Collage ihres Benutzers.
  4. Beschreiben Sie ihre Benutzer in einer Einführung in ihrer Bedienungsanleitung. Zum Beispiel:

Diese Bedienungsanleitung 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: 

  • Installateure
  • Wartungspersonal oder -techniker
  • Bediener
  • Demontagepersonal

Jede Verwendung des Produkts darf nur durch eine befugte und ordnungsgemäß qualifizierte und erfahrene Person ab 18 Jahren durchgeführt werden, die:

  • diese Bedienungsanleitung gelesen und verstanden hat
  • mit der Bedienung dieses oder eines ähnlichen Geräts vertraut ist
  • weiß, wie man dieses Produkt steuert
  • sich aller möglichen Gefahren bewusst ist und entsprechend handelt
  • geschult und berechtigt ist, in der Höhe zu arbeiten
  • eine Sprühlizenz besitzt, falls zutreffend

Sofern dies nicht ausdrücklich untersagt ist, können die erforderlichen Wartungs und/oder Inspektionsarbeiten, die in dieser Bedienungsanleitung beschrieben werden, durch die oben benannten Personen durchgeführt werden. 

Ausgenommen hiervon sind die zur Verfügung gestellten Hebe- und Klettermaterialien sowie die persönliche Schutzausrüstung. Diese müssen stets von dazu befugten Firmen geprüft und zertifiziert werden.

Zweck dieses Dokuments ist es, den Endverbraucher mit der Installation, Verwendung und Wartung des Geräts vertraut zu machen.

Charakter der Benutzer der IsoVox-Tonkabine

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. 

Ein oft gesehener Fehler ist, dass beim Bedienungsanleitung schreiben oft Marketing- oder Verkaufsinformation enthalten werden. Das lenkt die Benutzer davon ab, die wirklich wichtigen Informationen zu finden.

Nutzer konsultieren die Gebrauchsanweisung dann, wenn sie etwas erledigen oder ein Problem lösen wollen: Sie möchten die aktuelle Antivirensoftware installieren, Brot backen oder herausfinden, was das blinkende Warnlicht auf ihrem Gerät bedeutet. 

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.

Technisches Wissen, aber nicht zu viel

Es mag selbstverständlich klingen, aber Wissen ist ausschlaggebend, um Bedienungsanleitungen zu schreiben, die wirklich hilfreich für Ihre Benutzer sind. 

Wenn Sie beispielsweise eine Bedienungsanleitungen für eine Kamera schreiben, hilft es ungemein zu wissen, wie Verschlusszeit und Blende miteinander interagieren. Da sie eng mit der gesamten Funktionsweise verbunden sind, erleichtert Ihnen dieses Wissen, die einzelnen Funktionen der Kamera zu beschreiben.

In vielen Unternehmen werden die Bedienungsanleitungen von Mitarbeitern aus dem Marketing oder der Forschungs- und Entwicklungsabteilung erstellt. 

Ich möchte nicht alle über einen Kamm scheren, aber Angestellte aus dem Marketing haben womöglich nicht immer das technische Wissen, um Dinge korrekt zu erklären.

Andererseits nutzen die Kollegen aus der Forschungsabteilung die Bedienungsanleitung oft als Medium, um der Außenwelt die Fortschrittlichkeit ihrer Erfindung zu präsentieren, indem sie übermäßig unverständliche und irrelevante Terminologie, Formulierungen und Beschreibungen verwenden. 

Techniker sind also oft nicht die richtigen, um Kunden zu motivieren. 

Sowohl zu wenig als auch zu viel technisches Wissen kann Nachteile haben. 

Es ist die Aufgabe des technisches Redakteurs den Benutzern eines Produkts technische Informationen klar und deutlich darzulegen.

Eine technische Ausbildung, Hintergrundwissen, Erfahrung und Kommunikationsfähigkeit sind von Vorteil für jeden Technischen Redakteur

Lernen Sie das Produkt kennen, indem Sie es testen und vorhandene Dokumentation studieren

Sie müssen das Produkt zu 100 % verstanden haben, wenn Sie eine Bedienungsanleitung dazu erstellen.

Am besten schaffen Sie das, indem Sie das Produkt selbst verwenden: versuchen Sie, es zu installieren, drücken Sie die Knöpfe, öffnen Sie Abdeckungen, verstehen Sie Signale usw. WARNUNG! Denken Sie immer an ihre eigene Sicherheit!

Wahrscheinlich liegen schon Informationen zum Produkt vor, z. B. Bedienungsanleitungen, eine Risikoanalyse oder Werbeunterlagen. Studieren Sie dieses Material und gehen Sie den gesamten Lebenszyklus des Produkts im Kopf durch, vom Kauf bis zur Entsorgung.

Hilfreiche Fragen dabei sind:

  • Was ist die bestimmungsgemäße Verwendung?
  • Wie werden die wichtigsten Bestandteile genannt?
  • Wie wird das Produkt an den Endverbraucher geliefert?
  • Wie wird das Produkt transportiert und gelagert?
  • Wie installiere/montiere ich das Produkt?
  • Wie nehme ich das Produkt in Betrieb?
  • Wie wird das Produkt benutzt?
  • Wie ändere ich die Einstellungen?
  • Wie warte ich das Produkt?
  • Wie repariere ich das Produkt?
  • Was sind mögliche Fehler und wie behebe ich sie?
  • Wie wird das Produkt abgebaut und entsorgt?
  • Stehen Ersatzteile zur Verfügung?
  • Was sind die technischen Spezifikationen?
  • Welche Risiken bestehen im Verlauf des Produktlebenszyklus?

Ein praktischer Ansatz (indem Sie das Produkt selbst testen) verleiht Ihnen ein Gefühl dafür, welche Informationen an die Benutzer übermittelt werden müssen.

Ist etwas unklar, suchen Sie nach Informationen im Internet oder in existierenden, ähnlichen Bedienungsanleitungen. Andere Bedienungsanleitungen können Ihnen zeigen, welche Lösungen andere Technische Redakteure für ähnliche Probleme gefunden haben. Aber seien sie vorsichtig ...

Vertrauen Sie stets auf sich selbst und verlassen Sie sich nicht vollständig darauf, was andere tun. Bleiben Sie kritisch und erwägen Sie nur Informationen zu erstellen, die sie vollständig verstehen und überprüfen können. 

Zudem kann bereits existierendes Material auch unklar sein. Oft zeigen sich fehlende Struktur, Inkonsistenz oder vage Formulierungen. Darüber werden wir später noch sprechen.

Beim studieren von existierendem Material stoßen Sie höchstwahrscheinlich auf Ähnlichkeiten und Unterschiede.

Ihr Produkt hat vielleicht nicht alle Funktionen wie das, in der bestehenden Dokumentation. Finden Sie die Unterschiede. Was macht Ihr Produkt einzigartig? Welche Funktionen sind identisch? Welche Informationen können Sie für ein besseres Verständnis Ihres eigenen Produkts nutzen? 

Wenn sich langsam ein vollständiges Bild ihres eigenen Produkts entwickelt, werden Fragen aufkommen. Nicht alles wird nach Ihrer Recherche klar sein. Halten Sie jegliche Unklarheiten fest. Diese werden in der nächsten Phase geklärt.

Sprechen Sie mit Experten für 100 %-ige Klarheit

Ihre Fragen lassen sich am besten im Gespräch mit sachkundigen Personen klären, die das Produkt am besten kennen.

Meistens handelt es sich dabei um die Personen, die an der Entwicklung oder anderen Phasen im Lebenszyklus des Produkts beteiligt sind. Wir nennen diese Personen Fachexperten (Subject-Matter-Experts, SMEs). 

Was ist also genau ein Fachexperte?

Ein SME ist eine Person mit tiefgreifendem Wissen in einem bestimmten Feld (das kann entweder ein Job oder ein Thema sein). Fachexperten können Ingenieure aus den Bereichen Mechanik, Industriedesign, Software oder Elektrik sein. Es können Support-Mitarbeiter, Wartungspersonal oder Monteure sein. 

Aber auch Manager, Wissenschaftler, Testpersonen, Händler oder Geschäftsinhaber können weitreichendes Wissen über das Thema mitbringen, über das Sie schreiben und genau die Fachexperten sein, nach denen Sie suchen.

Einige Tipps für das Gespräch mit ihrem SME:

Machen Sie ihre Hausaufgaben. Informieren Sie sich gründlich über Ihr Fachgebiet und bereiten Sie eine Liste mit eindeutigen Fragen vor.

Sammeln Sie alle Fragen und vereinbaren Sie einen Termin. Fachexperten sind aufgrund ihres Wissens sehr wertvoll für ein Unternehmen. Sie sind aber auch beschäftigte Leute. Behalten Sie das im Hinterkopf, wenn Sie mit ihnen Sprechen. Verschwenden Sie nicht deren Zeit.

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. Sie verwenden womöglich viel Fachjargon. Diese ganzen Zahlen, technischen Begriffe usw. sind nicht immer notwendig, um klare Anweisungen zu schreiben. Zwingen Sie ihren Fachexperten nicht dazu, auf das Jargon zu verzichten. Es ist ihre Aufgabe als Technischer Redakteur die richtigen Fragen zur Bedeutung von Fachtermini zu stellen und zu entscheiden, welche Informationen genutzt werden. Stellen Sie sicher, dass sie sich wohl fühlen und für ihr Wissen und die wertvollen Informationen wertgeschätzt werden. 

Ihre Fragen sollten nicht einfach nachzulesen sein, sonst riskieren Sie ihre Glaubwürdigkeit in den Augen eines intelligenten Ingenieurs.

Am besten Befragen Sie Ihren Fachexperten im persönlichen Gespräch. Alternativ bietet sich auch ein Telefonat an. Manchmal wird man Sie auffordern, Ihre Fragen per E-Mail oder in einem Spreadsheet zu übermitteln. Nach meiner Erfahrung verzögert sich ein Projekt dadurch: Antworten auf Fragen führen zu neuen Fragen. Es ist Ihre Aufgabe so lange Fragen zu stellen, bis Sie jedes kleine Detail verstehen.

Nehmen Sie das Gespräch mit dem Fachexperten auf. Ich nutze immer mein Handy, um Videos von meinen Fragerunden und Gesprächen zur Produktfunktion aufzunehmen. Dadurch stellen Sie in einem zweiten Gespräch nicht die selben Fragen oder notieren sich Dinge, die in den Augen Ihres Fachexperten keinen Sinn ergeben.

Z. Bsp.: Fachexperten werden in einem Gespräch automatisch die richtigen Begriffe für Produktteile benutzen. Ein Display könnte „Bedienpanel“ und nicht „Benutzerbildschirm“ genannt werden. Daran mögen Sie sich vielleicht nicht erinnern, aber wenn Sie noch einmal Ihr Material sichten, können Sie diese Informationen herausfiltern. Das bewahrt Sie vor viel Frustration. Wenn Sie Ihr Gespräch online über Videotelefonie und/oder Screen-Sharing abhalten, zeichnen Sie auch dies via Screencasting auf.

Bitten Sie ihren Fachexperten auch, Ihre Arbeit zu Überprüfen. Dessen Wissen und Feedback ist von grundlegender Bedeutung um klare Benutzeranweisungen zu formulieren. 

Lösen Sie die Probleme Ihrer Nutzer

Eine Sache, der ich etwas mehr Aufmerksamkeit schenken möchte, ist die Aufgabe, die Probleme Ihrer Nutzer zu lösen. Das ist der Ausgangspunkt sowohl des Gesprächs mit ihrem SME als auch des Mappings, der Strukturierung und Organisation Ihrer Informationen (siehe folgende Phasen).

Die Benutzer, für die Sie schreiben, stoßen bei der Verwendung des Produkts vermutlich auf Probleme. Diese Probleme möchten sie lösen. Und das ist Ihre Aufgabe.

Wenn Sie also mit Ihrem Fachexperten sprechen, Informationen sammeln etc., versuchen Sie stets die möglichen Probleme der Nutzer im Blick zu behalten.

Typische Probleme sind ähnlich den oben beschriebenen Fragestellungen und liegen in den Bereichen Installation, Betrieb, Wartung, Reparatur, Reinigung und Entsorgung des Produkts. 

Dabei handelt es sich um sehr spezifische Problemstellungen:

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

Manchmal ist ein Benutzerproblem zu komplex und der Leser hat Schwierigkeiten, die passenden Informationen zu finden. In dem Fall können Sie die Informationen in so genannte Chunks gruppieren. 

Wir haben beispielsweise für ein bestimmtes Gerät, das sich Roof Washer nennt, eine Bedienungsanleitung 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 Chunks 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 des Schalthebels des Vorderrads

Damit beginnen Sie bereits, Themen zu erstellen. Themenbasiertes Authoring ist ausschlaggebend, um klare Anweisungen zu formulieren.

inhoudsopgave

Die Themen einer Bedienungsanleitung 

Mapping, Strukturierung und Organisation ihrer Informationen

Sie überladen sich mit Informationen: von der Nutzung des Produkts über die Analyse aller erhältlichen Dokumentation bis hin zu den Informationen ihrer Fachexperten. 

Diese Informationen umfassen die Beschreibung der Probleme, die ihre Benutzer lösen möchten, dazugehörige Lösungsvorschläge, aber auch alle möglichen weiteren Angaben wie elektrische Schaltbilder, Ersatzteillisten etc. 

Die größte Herausforderung eines technischen Redakteurs ist es, alle Informationen zu sammeln, sie zu analysieren, zu entscheiden, welche davon relevant sind, Informationen zu verwerfen, sie zu organisieren und strukturieren. 

Wie sollen Sie all das verarbeiten und organisieren? 

Es ist dabei unentbehrlich, ihre Informationen zu strukturieren, sie zu mappen. Nochmals: Ihr Ziel sollte es sein, alle Informationen zu behalten, die wichtige Themen behandeln und die Fragen ihrer Nutzer beantworten.

Diese Themen werden dann in einer klaren Reihenfolge und identifizierbar in Ihrem Inhaltsverzeichnis oder Menüstruktur zu sehen sein - chronologisch zum Lebenszyklus Ihres Produkts (siehe nächste Phase).

Bevor Sie aber schlussendlich Ihr Meisterstück, das Inhaltsverzeichnis, in Händen halten, sollten Sie alle Informationen strukturieren und organisieren.

Dabei können einige Methoden und Werkzeuge helfen:

  1. Erstellen Sie eine Mindmap;
  2. Gehen Sie zu mind mapping
  3. Nutzen Sie information Mapping-Techniken;
  4. Benutzen Sie Old School-Post-its.

Beispiel einer Mindmap

Allen Methoden liegen folgende Prinzipien zugrunde:

  • Brechen Sie alle wichtigen Informationen in kleine, überschaubare Chunks auf;
  • Jede Einheit sollte nur ein einziges Thema behandeln;
  • Überschreiben Sie jede Einheit so, dass dadurch die Inhalte identifiziert werden können. D. h., die Beschreibung des Chunks sollte dessen Inhalt wiedergeben. Z. B. wäre es besser das Kapitel „wie mache ich ein Softwareupdate“ mit Installation anstatt Nutzung zu überschreiben.
  • Organisieren und strukturieren Sie die Informationen und geben Sie dabei acht, bei der Organisation, Formatierung und Abfolge der Informationen konsistent zu arbeiten. (Auch bei der Terminologie sollte Konsistenz herrschen.)

Damit definieren Sie automatisch weiter Ihre Themenbereiche.

Ein bestimmtes Thema gibt dem Nutzer die Antwort auf eine bestimmte Frage. Benutzer wollen ein Problem nach dem anderen lösen, nicht mehrere auf einmal. Das verwirrt die Benutzer. 

Hat Ihr Benutzer ein Problem gelöst, wird er/sie sich dem nächsten Thema widmen und das nächste Problem lösen.

Jedes Thema hat seinen eigenen Platz in der Bedienungsanleitung. Ein Thema kann in Form eines Kapitels oder (Unter-)Absatzes behandelt werden. Oder vielleicht passt ein Thema auch besser in ein separates Dokument, das noch erstellt werden muss. Schauen wir uns das im Zusammenhang an. 

Die Norm 82079-1:2019 Erstellen von Nutzungsinformationen (Gebrauchsanleitungen) für Produkte, strukturiert Informationen um Informationsarten und -produkte.

Die Beziehung zwischen verschiedenen Informationsarten, wie Themen und Anweisungen, lässt sich auch auf eine andere Art und Weise darstellen, z. B. mit dem folgenden Modell:

 

Neben der Position „Thema“ im größeren Zusammenhang zeigt dieses Modell wie ein Thema in verschiedene Prozesse unterteilt werden kann. 

Sehen wir uns einmal näher an, wie ein strukturierter Schritt-für-Schritt-Prozess aussieht.

Informationsprodukte

Der Inhalt der „Nutzungsinformationen“ umfasst Informationen basierend auf drei Grundpfeilern: 

  • Anweisende Informationen
  • Beschreibende Informationen 
  • Referenzinformationen

Nutzungsinformationen können um verschiedene Informationsprodukte strukturiert sein, die in unterschiedlichen Medien ausgewählt, präsentiert und bereitgestellt werden, um den Bedürfnissen der verschiedenen Zielgruppen Rechnung zu tragen.

Bedienungsanleitung

Eine Bedienungsanleitung ist eine Art Informationsprodukt. Andere Arten sind Installationsanleitungen, Wartungsanleitungen, Online-Hilfen etc. 

Eine Bedienungsanleitung in Papierform ist ein ganzes Heft in dem beschrieben wird, wie ein bestimmtes Produkt benutzt wird. Es umfasst alle Themen, Anweisungen und Schritte, die notwendig sind, um ein Nutzerproblem zu lösen.

Thema

Gebrauchsanweisungen sind um Themen herum strukturiert. Jedes Thema bezieht sich auf die Lösung einer bestimmten Nutzerfrage. 

Ein Thema kann beschreibend (z. B. die Beschreibung, wie ein Prozess abläuft), referenziell (z. B. ein Wartungsplan) oder anweisend (z. B. Prozesse und Sicherheitshinweise) sein.

Beispiel für anweisende Themen sind die „Inbetriebnahme“, der „Austausch der Batterien“ oder „Pfannkuchen backen“.

Themen müssen logisch angeordnet sein. 

Anleitung

Ist ein Thema besonders komplex, kann es mehrere Chunks umfassen, die im Modell der Informationsarten oben als Anweisungen dargestellt sind. Anweisungen sind sozusagen Unterthemen. 

Das oben beschriebene Thema, das die Vorbereitung und Anpassung eines Geräts beschreibt, ist in Chunks mit (Unter-)Anweisungen wie „Anpassung der Hauptbürsten“ und „Anpassung des optionalen Fensterschutzschalters“ aufgeteilt. 

Schritte

Ein Schritt ist eine detaillierte Beschreibung innerhalb einer Anweisung. Anweisungen beinhalten mehrere Schritte. Gemeinsam beschreiben sie den Schritt-für-Schritt-Prozess einer bestimmten Aufgabe. 

Jede Anweisung hat ein klares Ziel, das stets aufgabenorientiert und auf den Punkt formuliert sein sollte (Prinzipien des minimalism). 

Sehen wir uns das anhand des folgenden Beispiels an.

Auf der Seite dieser „Bedienungsanleitung für Drohnen“ sind zwei Schritte aufgelistet. Es sind zwei von insgesamt sechs Schritten der Anweisung / des Unterthemas Installation der Drohne. Jeder Schritt orientiert sich an der Aufgabe und wird durch Illustrationen untermalt. 

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

Die Benutzer folgen den Schritten, wenn sie die Anweisungen lesen. Im nächsten Kapitel lernen Sie mehr darüber, wie sie klare Anweisungen formulieren. 

Versuchen Sie, nicht mehr als 10-12 Schritte anzugeben, damit Ihre Anweisungen effektiv sind. Nutzen Sie 5-7 Schritte, wenn die Benutzer sich die Aufgabe merken können sollen. Das ist die magische Zahl an Dingen, die sich eine durchschnittliche Person in ihrem Kurzzeitgedächtnis merken kann (Miller, 1956

Falls nötig, kann ein Schritt auch mit Sicherheitswarnungen, Tipps mit einer detaillierteren Beschreibung zu dessen Durchführung oder einer Fehlererkennung bei Falschausführung versehen werden.

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

Eine konsistente Formatierung hilft den Nutzern dabei, die Information, nach der sie suchen zu identifizieren. Beispielsweise zieht eine deutliche Formatierung eines Warnhinweises mehr Aufmerksamkeit auf sich, da die Leser ihn visuell als Warnhinweis identifizieren.

Fassen wir zusammen.

Wir haben verschiedene Methoden und Modelle besprochen, die ihnen dabei helfen, ihre Informationen zu mappen, strukturieren und organisieren. 

Es gibt nicht den einen richtigen Weg, aber ich denke, eine Kombination aus den oben genannten Techniken zusammen mit einem guten technischen Hintergrund ist der richtige Weg, klare und eindeutige Bedienungsanleitungen zu schreiben. 

Eine letzte Sache, die ich mit Ihnen besprechen möchte, ist die Ähnlichkeit, die ich zwischen Informationsentwicklungsprozessen und Produktentwicklungsprozessen entdeckt habe. 

Der Prozess, Informationen zu sammeln und zu strukturieren ähnelt in vielen Punkten diesem Modell zu Innovationsprozessen, das mir an der Universität beigebracht wurde. 



Links beschreibt das Modell den klassischen Entwicklungszyklus. Es beginnt mit einer Beschreibung der Funktion, die das Produkt oder der Service leisten muss.

Nach einer breiten Analyse von Stärken, Möglichkeiten, Schwächen und Gefahren, können Sie ihre Kriterien auflisten (Anforderungsliste). Durch einen Prozess aus Synthese, Simulation und Prototyping, Evaluation und technischer Ausarbeitung werden sie schlussendlich ein Design erarbeiten, dass sich zur Massenproduktion eignet. 

Im rechten Modell wird der Prozess der Forschung, Ideenentwicklung, Konzepterstellung und -realisation beschrieben. Jede dieser Phasen zeichnet sich durch einen Prozess aus Divergenz und Konvergenz aus. Sie sammeln zuerst zahlreiche Alternativen, bevor Sie die besten auswählen.

Wenn ich dieses Modell zur Erstellung von Bedienungsanleitungen anwende, sieht das wie folgt aus:

Organisieren Sie ihre Themen zur einfachen Lesen

Ich möchte gerne mehr darüber sprechen, wie wichtig das Inhaltsverzeichnis ist und daher auch, wie Sie ihre Themen in der Bedienungsanleitung anordnen.

Das Inhaltsverzeichnis sollte besonders sorgfältig zusammengestellt werden.  Es sollte ein gut durchdachtes Meisterstück sein. Das Inhaltsverzeichnis ist das Rückgrat ihrer Bedienungsanleitung! 

Warum spielt das Inhaltsverzeichnis eine so wichtige Rolle?

Wenn Ihre Benutzer ein Problem haben und in der Bedienungsanleitung nach einer Lösung suchen, werden sie höchstwahrscheinlich im Inhaltsverzeichnis nach einer Antwort suchen.

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

Ich organisiere die Themen im Inhaltsverzeichnis bevorzugt nach den Bedürfnissen meiner Leserschaft und den am Lebenszyklus des Produkts orientierten Informationen.

In den meisten Fällen beginne ich mit einem Standardinhaltsverzeichnis. Beim Informationssammeln, wie wir in den vorangegangenen Kapiteln bereits besprochen haben, schreibe ich die Themenbezeichnungen auf Post-its, gebe ihnen einen Titel und klebe sie an meine Wand. Oder ich erstelle online eine Mindmap. 

 
Beispiel eines Standardinhaltsverzeichnisses.

Sobald ich denke, dass alle Themen vollständig sind, füge ich meine jeweiligen Themen in das Inhaltsverzeichnis ein, ordne sie und stelle mein endgültiges Inhaltsverzeichnis fertig. Meistens besprechen wir das Inhaltsverzeichnis mit unserem Auftraggeber.

Ein weiterer wichtiger Aspekt, der ihren Benutzern eine wichtige Hilfe bei der Suche nach Lösungen im Inhaltsverzeichnis ist, ist die durchdachte Formulierung der Überschriften. Darüber werden wir später noch genauer sprechen.

Zuletzt möchte ich noch erwähnen, dass die Abschnitte zum Mapping, Organisieren und Strukturieren zwar sehr theoretisch sind, aber in diesen Gebieten geschickt arbeiten zu können ist eine der wichtigsten Kompetenzen eines guten technischen Redakteurs. 

Der einzige Weg, wie sie überprüfen können, ob sie Ihren Job gut gemacht haben, ist zu testen, ob Ihre Nutzer schnell die Informationen finden können, nach der sie suchen. Sollte das nicht der Fall sein, haben Sie vermutlich einen Fehler im Mapping, Organisieren oder Strukturieren gemacht.

Kapitel 2 - Bedienungsanleitungen schreiben, die verständlich sind und eine sichere Verwendung des Produkts garantieren

Sobald wird unsere Themen für das Inhaltsverzeichnis (oder die Menüstruktur einer Online-Hilfe) festgelegt und strukturiert haben, können wir damit beginnen, die Kapitel mit Inhalt zu füllen.

Das vorrangige Ziel sollte stets sein, eine Produktdokumentation zu erstellen, die eine sichere, effiziente und effektive Verwendung eines Produkts ermöglicht.

Schauen wir uns das genauer an.

Schreiben Sie anregend für ihr Publikum, ohne zu viel Fachjargon

Bedienungsanleitungen, die von Technikern geschrieben wurden, enthalten meistens viel Fachsprache.

Was ist Fachsprache?

Fachsprache ist eine unnötig komplizierte Sprache, die eher dazu genutzt wird, Leser zu beeindrucken als sie zu informieren.

Damit möchte ich nicht sagen, dass sie keine Fachbegriffe nutzen sollten. Oft brauchen Sie sie, um ein Produkt richtig zu erklären.

Die sollte damit beginnen, dass Sie eine Bedienungsanleitung schreiben möchten, die so verständlich wie möglich ist. Terminologie, die nicht Teil des üblichen Vokabulars ihrer Leser ist, trägt nicht dazu bei. 

Sehen wir uns das anhand eines Beispiels an:

Sie können einfach schreiben „Ziehen Sie die untere Sechskantschraube sicher fest“. „Sechskantschraube“ ist hier ein notwendiger Fachbegriff.  

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

Oft sind spezielle Begriffe hilfreich und sind sogar die einzig bekannte Terminologie eines bestimmten Publikums. In diesen Fällen ist die Verwendung der Fachterminologie die verständlichste Kommunikationsweise mit ihrem Zielpublikum. 

Wenn ihr Publikum aus Spezialisten besteht, kann ein übermäßiger Gebrauch technischer Begriffe aber zu Missverständnissen führen und ihre Leser irritieren. 

Eine der meist gehörten Beschwerden über Bedienungsanleitungen ist, dass zu viel Fachjargon benutzt wird. Autoren solcher Bedienungsanleitungen ist es oft nicht bewusst, dass die Leser nicht denselben Wissenshintergrund zu einem Produkt haben.

Um es noch einmal zu erwähnen: es ist wichtig, dass Sie ihr Zielpublikum kennen.

Sollten Sie keine andere Möglichkeit sehen, als eine Sache mit Fachjargon zu beschreiben, dann erklären Sie diese Fachterminologie (inklusive Abkürzungen) in einem externen Glossar. 

Erinnern Sie sich daran, dass Sie schreiben, um den Gebrauch eines technischen Produkts zu kommunizieren, nicht um anzugeben. Wenn Sie sich dessen bewusst sind, schreiben Sie automatisch verständlicher. 

Unterstützen Sie ihre Leser bei der Suche, indem Sie aussagekräftige Überschriften verwenden

Eine Überschrift ist ein Titel am Anfang einer Seite oder eines Abschnitts eines Buchs.

Die Beschreibung ihres Themas ist eine Überschrift und taucht im Inhaltsverzeichnis auf. 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 Bedienungsanleitungen kommen wichtige Funktionen zu:

  • Sie bieten einen Überblick über die Struktur der Bedienungsanleitung;
  • Sie zeigen die logischen 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 einer Bedienungsanleitung. Eine gute Überschrift deckt den gesamten Inhalt des zugehörigen Themas ab.

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

Versuchen Sie, nicht mehr als drei Überschriftenebenen zu nutzen: Überschriften auf erster, zweiter und dritter Ebene. Übertreiben Sie es nicht mit der Anzahl der Ebenen.

Sehen wir uns diese Beispiele an:

Beachten Sie dabei, dass die Formulierung der Überschriften konsistent ist: Die Überschrift auf erster Ebene beschreibt, worum es im Kapitel geht. Auf der zweiten Ebene, wird mit einer Wie-Formulierung gearbeitet. Auf der dritten Ebene wird mit Nominalphrasen gearbeitet.

Stellen Sie sicher, dass Ihre Überschriften selbsterklärend formuliert sind. Die Überschrift Wie man Pfannkuchen backt ist viel benutzerorientierter als Verwendung des MagicMix2000.

Ein klares Design Ihrer Überschriften unterstützt ihre Leser, die Ebene eines Themas zu identifizieren. Zudem wird das Design oft schon in den Richtlinien zur Corporate Identity eines Unternehmens festgelegt.

Gibt es kein ‚hauseigenes Design‘, könne Sie die Überschriften selbst gestalten. Obwohl es nicht die eine richtige Lösung gibt, gebe ich Ihnen hier ein Gestaltungsbeispiel:

  • Überschriften der ersten Ebene werden immer groß geschrieben;
  • Auf der zweiten Ebene werden das erste Wort, Substantive und Verben groß geschrieben;
  • Bei Überschriften der dritten Ebene wird nur das erste Wort groß geschrieben.

Dies ist ein gutes Beispiel für Englisch, es mag nicht für alle Sprachen anwendbar sein. Im Deutschen werden Substantive beispielsweise immer groß geschrieben.

Beschreiben Sie die ‚bestimmungsgemäße Verwendung‘ und verringern Sie so ihre Haftung

Eine verständliche Bedienungsanleitung sollte beschreiben, wie ein Produkt verwendet werden sollte anhand dessen Funktion und der erwarteten Produktlebensdauer. 

Der Zweck ihres 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 einer Bedienungsanleitung 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 Ansatz für die weiteren Inhalte ihrer Bedienungsanleitung.

Haben Sie die bestimmungsgemäße Verwendung festgelegt, können Sie sich darauf konzentrieren, NUR die Sicherheits- und Nutzerinformationen für die bestimmungsgemäße Verwendung aufzuschreiben.

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): 

An exhaustive range of functions or foreseen applications defined and designed by the supplier of the product. („umfassender Funktionsumfang oder vorgesehene Anwendungen, die vom Anbieter des Produkts definiert und konzipiert wurden“.)

Einige Beispiele der bestimmungsgemäßen Verwendung:

Bestimmungsgemaesse Verwendung

 Und dieses:

Neben der bestimmungsgemäßen Verwendung sollten Sie auch eine Beschreibung von vernünftigerweise vorhersehbarer Fehlanwendung des Produkts hinzufügen.

Was ist eine vernünftigerweise vorhersehbare Fehlanwendung?

Die folgende Definition von vernünftigerweise vorhersehbarer Fehlanwendung stammt aus dem Standard IEC/IEEE 82079-1:2019:

The use of a product or system in a way not intended by the supplier, but which can result from readily predictable human behaviour. („Die Verwendung eines Produkts oder Systems in einer laut Hersteller nicht vorhergesehenen Art und Weise, die sich jedoch aus leicht absehbarem menschlichen Verhalten ergeben kann.“)

Einige Beispiele:

  • Der Einsatz von aggressivem Reinigungsmittel in der Lebensmittelverarbeitung.
  • Das Nutzen eines automatischen Schiebetors zum Personentransport (Kinder bleiben darin stehen, wenn es sich öffnet/schließt)

Beispiel einer vernünftigerweise vorhersehbaren Fehlanwendung einer Helikopterlandefläche

Schenken Sie der Beschreibung der vernünftigerweise vorhersehbaren Fehlanwendung zu wenig Aufmerksamkeit, kann das auch Ihre Haftung betreffen.

Wenn es beispielsweise vorhersehbar ist, dass ein bestimmtes Kühlsystem, das in Krankenhäusern angewendet wird, als Kühlsystem für Organe genutzt werden könnte, sollte dies in den Anweisungen beschrieben werden. 

Unvorhersehbare Fehlanwendungen sollten nicht in der Bedienungsanleitung enthalten sein, da dies ihre Haftung nicht betrifft.

Vernünftigerweise vorhersehbare Fehlhandlung oder unvorhersehbare Fehlhandlung?

Unterstützen Sie die Verständlichkeit mit eindeutigen Bedienungsanleitungen

Wie bereits zuvor besprochen, besteht eine Bedienungsanleitung aus verschiedenen Arten von Informationen, die einem bestimmten Zweck dienen, den so genannten Informationsarten

Beispiele für Informationsarten sind Themen/Überschriften, Beschreibungen, Ziele, Voraussetzungen, Bedingungen, Handlungen, Ergebnisse, Warnungen, Anweisungen und Erinnerungen, Beispiele und Bildunterschriften. 

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

Das Layout der Informationsarten erleichtert es, die verschiedenen Informationselemente voneinander zu unterscheiden. Ein unterschiedliches Layout ermöglicht eine leichtere Unterscheidung unterschiedlicher Informationsarten. 

In diesem Beispiel wurden die unterschiedlichen Informationsarten wie Überschriften, Anweisungsüberschriften, Anweisungen, Produktteile und Illustrationen in der gesamten Bedienungsanleitung unterschiedlich konsistent formatiert. 

Und auch in diesem Beispiel wurden alle Informationsarten wie Überschriften der 1. und 2. Ebene, Warnungen/Hinweise, Kontextinformationen, Anweisungsüberschriften, Anweisungen, Produktteile und Illustrationen unterschiedlich konsistent dargestellt.

Welche Informationsarten können SIE hier unterscheiden?

Eine andere Sache, der Sie sich bewusst sein sollten, wenn Sie Bedienungsanleitungen schreiben, ist es, vage Wörter zu vermeiden. Beispiele dafür sind Wörter wie Ding, Teil und Zeug. Die Verwendung solcher Wörter wird zu einer missverständlichen Bedienungsanleitung führen.

Tendieren Sie dazu, diese Wörter zu verwenden, fehlen Ihnen möglicherweise noch Informationen. Fragen Sie also jemanden oder finden Sie eine unmissverständliche Alternative.

Eine klare und auf den Punkt gebrachte Wortwahl wird den Benutzer helfen, eine Aufgabe so sicher, schnell und gut wie möglich zu absolvieren.

Grundsätzlich sollte ein handlungsbezogener Ansatz bevorzugt werden. Ihre Nutzer sollten eine unmittelbare Möglichkeit zum Handeln erhalten.

Dabei kann die Verwendung von Simplified Technical English Ihnen helfen, unmissverständlich zu schreiben. 

Anweisungen schreiben: Bieten Sie eine unmittelbare Handlungsmöglichkeit an

Sie können zu Handlungen bewegen, indem Sie weniger beschreibende Informationen anbieten und sich auf Vorgehensweisen konzentrieren. Die Benutzer wollen die Dinge erledigen, nicht darüber lesen.

Es gibt dieses bemerkenswerte Paradoxon:

Man lernt etwas am besten, in dem 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 zu unmittelbaren Handeln anzuregen und ihnen daneben essentielle beschreibende Informationen an die Hand zu geben. 

Sehen wir uns dieses Beispiel auf Grundlage des principle of minimalism an, das dieses Gleichgewicht mitbringt:

Oder dieses minimalistische Beispiel

In vielen konventionellen Produktdokumentationen wird am Anfang einer Bedienungsanleitung nicht viel Wert darauf gelegt, die Nutzer bei den Aufgaben zu unterstützen, die Sie ausführen müssen.

Viele Bedienungsanleitungen beginnen mit Erklärungen, technischen Daten, Sicherheitshinweisen, Beschreibungen von Abläufen etc. Diese Informationen sind mit Sicherheit von Bedeutung, lenken den Benutzer aber von ihrem eigentlichen Ziel ab.

Versuchen Sie, wenn Sie Ihr Benutzerhandbuch schreiben das absolute Minimum an Must-Know-Informationen anzugeben und alle Nice-to-Know-Informationen als obsolet zu betrachten. 

Schaffen Sie es, sich kurz zu halten, wird ihre Bedienungsanleitung den Eindruck erwecken, dass die Aufgabe des Nutzers keinen besonderen Aufwand erfordert, sondern leicht zu erledigen ist. 

Wenn Sie nicht jeden Zusammenhang erklären, regt eine Bedienungsanleitung die Benutzer dazu an, relevantes Vorwissen zu aktivieren und sich mehr auf ihre eigenes Denken zu verlassen.

Beherrschen Sie es, die Hintergrundinformationen auf ein Minimum zu reduzieren und gerade genug Informationen zu geben, damit der Nutzer seine Aufgabe erfüllen kann oder ein Konzept versteht, werden Ihre Anweisungen viel verständlicher werden.

Viele Bedienungsanleitungen enthalten Anweisungen, die unvollständig oder falsch sind. Es könnte Ihnen helfen, alle Schritte selbst durchzuführen, während Sie sie aufschreiben.

Das stellt sicher, dass was sie schreiben der tatsächlichen Anwendung entspricht und hilft Ihnen, sich auf die Must-Know-Informationen zu konzentrieren. Darüber hinaus hilft es dabei, dass nichts vergessen wird und verbessert die allgemeine Qualität.

Manchmal ist es nicht möglich, alle Schritte selbst durchzugehen, wenn das Produkt z. B. gefährliches oder komplexes Material umfasst. Besprechen Sie in diesen Fällen alle Schritte mit einem Fachexperten, gehen Sie sie genau im Kopf durch und lassen Sie alles aufgeschriebene überprüfen.

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.

To select German as your default language, select Deutsch when clicking on Language in the File menu 

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

To select German as your default language:

  1. Go to File>Language.
  2. Select Deutsch.

Dieses Beispiel enthält sichtbare Abschnitte: die Schritte sind mit 1, 2 usw. nummeriert. Dadurch verstehen die Benutzer, dass hier eine wichtige Reihenfolge der Schritte besteht. Alternativ können sie sogar „Schritt 1“, „Schritt 2“ etc. schreiben.

Ziemlich direkt, nicht wahr?

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. 

Geben Sie jeden Schritt bis zur Vollendung der Aufgabe an, d. h., dass Sie ihren Nutzern genau sagen, was sie zur Vervollständigung einer Aufgabe zu tun haben. 

Vermeiden Sie es, Sackgassen zu schaffen und stellen Sie sicher, dass der Nutzer nach den Schritten eines bestimmten Abschnitts das Problem gelöst hat: jedes Thema hat einen klaren Anfang und ein Ende, im Gegensatz zu einem Buch, das von vorne bis hinten komplett durchgelesen wird.

Verwenden Sie aktive Formulierungen um simpler und verständlicher zu schreiben

Die Informationen, die Sie angeben, sollten so einfach und kurz wie möglich gehalten werden. 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 aktive Formulierungen werden Ihre Anweisungen verständlicher, deutlicher und direkt.

Weitere Beispiele:

Und dieses:

 Und dieses Beispiel sah ich kürzlich in einem Büro:

Weiterhin ist es wichtig, bei der Formulierung der einzelnen Schritte keinen eigenständigen Schritt für Reaktionen des Systems oder Produkts zu erstellen. Schreiben Sie z. B. für „das Einstellungsmenü öffnet sich“ keinen einzelnen Schritt. 

Es ist in Ordnung, wenn Sie die Reaktion des Systems oder Produkts (wenn notwendig) in den Schritt eingliedern, der diese Reaktion ausgelöst hat. 

Oder Sie erwähnen die Reaktion zu Beginn des darauf folgenden Schritts.

Zwei Beispiele:

Deutsch als Standardsprache festlegen:

  1. Klicken Sie auf die SPRACHENtaste. Das Sprachenfenster öffnet sich.
  2. Wählen Sie Deutsch.
  3. Klicken Sie auf SPEICHERN.

Deutsch als Standardsprache festlegen:

  1. Klicken Sie auf die SPRACHENtaste
  2. Im Sprachenmenü Deutsch auswählen. 
  3. Klicken Sie auf SPEICHERN.

Vermeiden Sie Querverweise, um Verwirrung vorzubeugen

Ab und zu möchten Sie vielleicht Querverweise in Ihrer Produktdokumentation einsetzen. 

Wenn Sie beispielsweise auf eine Schrittabfolge hinweisen möchten, die bereits an anderer Stelle in der Bedienungsanleitung erwähnt wurde. Oder Sie möchten einfach auf ein ganzes Kapitel verweisen.



Beispiel eines Querverweises auf das gesamte Kapitel zu den Sicherheitshinweisen

Die Verwendung von Querverweisen sollte generell auf ein Minimum reduziert werden. Ihre Leser in der Bedienungsanleitung hin und her zu schicken ist nicht benutzerfreundlich und führt zu Verwirrung.

Auf ein ganzes Kapitel zu verweisen (wie im oberen Beispiel), das kein Zusatz zu einem bestimmte Thema ist, sondern ein eigenständiges Thema behandelt, ist grundsätzlich in Ordnung. 

Auf einen Abschnitt von Schritten zu verweisen, sollte dagegen vermieden werden.

Inbetriebnahme der Batterie ihres eBikes:

  1. Drücken Sie die Ein/Aus-Taste, um die Batterie einzuschalten. Wenn mindestens eine LED der Batterieanzeige leuchtet, jedoch nicht alle LEDs leuchten, muss die Batterie aufgeladen werden. 
  2. Laden Sie die Batterie. Siehe 2.1.2. Aufladen des Akkus.

Ein Style Guide für den Blick auf‘s Detail

Ich hab bereits mehrmals darauf hingewiesen, wie wichtig Konsistenz ist, aber ich erwähne es noch einmal: Es ist sehr wichtig, Begriffe, Produktbestandteile und Einheiten konsistent zu benennen. 

Verwenden Sie konsistente Terminologie in der eigentlichen Bedienungsanleitung, 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. 

Vergessen Sie nicht, Marketinggeschwafel zu vermeiden: Sie schreiben an einer Bedienungsanleitung, nicht an Werbematerial. Ihre Leser haben das Produkt bereits gekauft.

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. 

Schauen Sie sich dieses Onlinebeispiel eines Style Guides an, den IBM Style Guide oder den SAP Style Guide.

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

Sorgen Sie für Sicherheit durch den richtigen Einsatz von müssen und sollen

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, wende ich 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 dieser Bedienungsanleitung 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: Should wird als konsultativ angesehen.

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/n) 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 mir bereits passiert, dass die US-Zollbehörde die Einfuhr eines Geräts nicht gestattet hat, weil diese Wörter in der Produktdokumentation nicht richtig verwendet wurden.

Fügen Sie eine Fehlerbehandlung ein, um ihren Nutzern Zeit, Frustration und Angst zu (er)sparen

Egal, wie gut ein Produkt oder eine Software entwickelt wurde, bei der Verwendung geht immer etwas schief. Dessen sollten Sie sich als Technischer Redakteur bewusst sein.

Benutzer von Produkten machen viele einfache Fehler. Diese Fehler zu beheben, kann viel Zeit in Anspruch nehmen. Laut Forschung [1] verbringen Benutzer zwischen 25 % und 50 % ihrer Zeit damit, Fehler zu beheben.

Daher ist es wichtig, den Anweisungen, die Nutzer falsch verstehen könnten, Fehlerinformationen hinzuzufügen.

Fehlerinformationen anzubieten UND sie anzubieten, wo sie gebraucht werden, ist der am meisten unterschätzte Aspekt einer Bedienungsanleitung. Es gibt verschiedene Wege, wie gut gestaltete Bedienungsanleitungen verhindern können, dass die Nutzer Fehler machen.

Zum Beispiel, indem eine sichere Abfolge von Schritten angeboten wird, kurze und einfache Sätze verwendet werden, Fachjargon vermieden wird, aktive Formulierungen verwendet werden usw.

Aber wie können Sie wissen, welche Fehlerinformationen beigefügt werden sollen?

Die Forschung [1] hat gezeigt, dass selbst erfahrene technische Redakteure nicht besonders gut vorhersehen können, welche Probleme sich bei der Verwendung ihrer Produktdokumentation ergeben. 

Am besten lassen sich mögliche Fehler durch einen Usability-Test identifizieren. Siehe Usability-Test durchführen, um zu überprüfen, was Sie geschrieben haben.

Wenn Sie die häufigsten Fehler identifiziert haben, schlägt ein Modell für Fehlerbehebung in Bedienungsanleitungen die folgenden Schritte vor: 

  • Problem erkennen;
  • Problem benennen; 
  • Informationen zur Problembehebung verarbeiten. 

In anderen Worten: Achten Sie bei der Erstellung von Fehlerinformationen darauf, Ihre Nutzer dabei zu unterstützen, Fehler zu erkennen, zu diagnostizieren und sie zu beheben.

Sehen wir uns das anhand eines alten Beispiels an:

 

Fehlerinformationen aus einer minimalistischen Bedienungsanleitung zu WordPerfect.

Fehlerinformationen sind am effektivsten, wenn Sie so nah wie möglich dort zur Verfügung stehen, wo und wann ein Fehler auftaucht. Oft ist das direkt nach einer bestimmten Anweisung. 

Wenn Sie Fehlerinformationen direkt hinzufügen, kann der Fehler entdeckt und hoffentlich behoben werden, bevor es zu weiteren Problemen kommt.

Ein separater Abschnitt zur Fehlerbehebung, der üblicherweise vorhanden ist, ist nicht falsch, aber es erschwert den Nutzern die Suche nach den Informationen und deren Verständnis, da sie aus dem Kontext gerissen sind. 

Stellen Sie die Fehlerinformationen an gleicher Stelle zur Verfügung, sparen die Nutzer Zeit und es reduziert Frustration und Angst davor, die Verwendung des Produkts zu lernen. 

Darüber hinaus führt gutes Fehlermanagement dazu, dass produktiver gelernt wird, wie mit dem Produkt umzugehen ist.

Dieses Thema bespreche ich eingehender in diesem Podcast.

Achten Sie auf die Sicherheitshinweise für eine sichere Verwendung

Sicherheit ist mein liebstes Thema. Warum?

Erstens, weil es mit Konformität (Compliance) zu tun hat, die von vielen technischen Redakteuren größtenteils nicht beachtet wird. Aber ich nehme es ihnen nicht übel.

Informationen zu Konformität, Produktsicherheit und was genau Teil Ihrer Bedienungsanleitung sein muss, sind schwer zu finden. Die Webseiten der Gesetzgeber können zuweilen überwältigend sein.

Zweitens gefällt mir das Gegenspiel, eine konforme und gleichzeitig benutzerfreundliche Produktdokumentation zu erstellen. 

Manche technische Redakteure neigen dazu, zu viel zu warnen. Ich habe Bedienungsanleitungen gesehen, die nur aus Warnungen bestanden, ohne eine einzige Anweisung. 

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

Es gibt eine Alternative!

Zunächst würde ich gerne erklären, warum wir Warnungen in Bedienungsanleitungen integrieren.

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. Eine Bedienungsanleitung sollte also niemals dazu genutzt werden, um vor Risiken zu warnen, wenn das Design des Produkts noch verbessert werden könnte.

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

Im Falle der Bedienungsanleitung bedeutet das, dass zwischen vier Arten von Sicherheitshinweisen unterschieden werden kann: ergänzende Anweisungen, zusammengefasste Sicherheitshinweise, abschnittsweise Sicherheitshinweise, und eingebettete Sicherheitshinweise.

Wie der Name bereits verrät, befinden sich abschnittsweise Sicherheitshinweise am Anfang eines bestimmten Absatzes.

In Sachen Usability, haben Sie hier zwei Möglichkeiten. 

Zunächst können Sie alle Sicherheitshinweise sammeln, 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:

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

Sollten Sie sich entschließen, eine Warnung anstatt einer Anweisungen anzubieten, achten Sie darauf, die Warnung gut zu strukturieren. 

Eine gute Warnung besteht aus drei Teilen: 

  • Die Art und Quelle der Gefahr;
  • Die 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. 

 

ISO 3864-2

ANSI Z535.6

GEFAHR

Dieses Symbol weist auf eine unmittelbare Gefahrensituation hin, die, falls sie nicht vermieden wird, zu schweren Verletzungen oder sogar zum Tod führt

weist auf eine unmittelbar gefährliche Situation hin, die, falls sie nicht vermieden wird, zum Tod oder zu schweren Verletzungen führen kann. 

WARNUNG

Dieses Symbol weist auf eine potenziell gefährliche Situation hin, die, falls sie nicht vermieden wird, zu schweren Verletzungen oder sogar zum Tod führen kann

weist auf eine unmittelbar gefährliche Situation hin, die, falls sie nicht vermieden wird, zum Tod oder zu schweren Verletzungen führen kann.

VORSICHT

Dieses Symbol weist auf eine potenziell gefährliche Situation hin, die, falls sie nicht vermieden wird, zu leichten bis mittelschweren Verletzungen führen kann

weist auf eine unmittelbar gefährliche Situation hin, die, falls sie nicht vermieden wird, zu leichten bis mittelschweren Verletzungen führen kann. 

HINWEIS

-

Kennzeichnet Informationen, die wichtig sind, aber nicht mit potenziell gefährlichen Situationen in Verbindung stehen

Und so sollte ein Gefahrenhinweis nach ISO 3864 und ANSI aussehen:

ISO 3864-2 ANSI Z535
 

Da ANSI auch die Gefahrenhinweise von ISO übernommen hat, können Sie sie für zahlreiche Märkte verwenden.

Vermeiden Sie rechtliche Fallen und sorgen Sie für eine rechtskonforme Bedienungsanleitung

Je nach Produkt, für das Sie eine Produktdokumentation 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 Vorschritten zu entsprechen.

Medizinische Geräte sind zum Beispiel die am stärksten regulierten Produkte. In den USA gibt es die Guidance on Medical Device Patient Labelling (Anleitung zur Beschriftung medizinischer Geräte), wohingegen in der EU die Anforderungen an die Gebrauchsanweisung in der Medizinprodukte-Verordnung angegeben werden.

Halten Sie sich an die rechtlichen Anforderungen und wenden Sie gegebene Standards an, so erstellen Sie eine Produktdokumentation, die rechtlich konform ist. 

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. 

Grundsätzlich sollten die folgenden Punkte eingehalten werden, um ein rechtskonformes Benutzerhandbuch zu schreiben:

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

Über dieses Thema habe ich ausführlicher geschrieben, sowohl für den amerikanischen, als auch für den europäischen Markt. 

Darüber hinaus können diese Vorlagen Ihnen helfen, rechtskonforme Bedienungsanleitungen für Ihre Maschinen, Elektrogeräte, Spielzeuge, Medizinprodukte usw. zu erstellen. 

 

Navigationshilfen optimieren die Suche in der Bedienungsanleitung

Ein wichtiger Teil einer Bedienungsanleitung ist, wie die Benutzer zu den Informationen finden, nach denen sie suchen. 

Vieles davon wurde bereits in den vorangegangenen Kapiteln besprochen. Aber es geht um mehr als ein Inhaltsverzeichnis, nummerierte Seiten, eindeutige Überschriften und eine logische Struktur.

Anstatt die Themen anhand des Lebenszyklus des Produkts anzuordnen (vom Auspacken bis zur Entsorgung), können Sie die Abschnitte auch nach der Chronologie der Anwendung, Sachkenntnis (Experte oder Laie), nach funktionalen Kategorien oder der Häufigkeit der Anwendung ordnen.

Die Reihenfolge der Themen gibt in wesentlichen vor, wie schnell die Benutzer finden, wonach sie suchen.

Sie können die Reihenfolge mit Registerkarten oder Farben verdeutlichen oder die Bedeutung verschiedener Informationsarten mit Kontrasten, Farben, Schattierungen oder Fettschreibung hervorheben, was ein Bestandteil der Darstellung einer Gebrauchsanweisung ist (siehe Kapitel 4).

Eine weitere Möglichkeit, Ihre Nutzer zur richtigen Information zu leiten, ist mithilfe eines Index oder eines Glossars.

Ein Index ist eine alphabetische Liste an Namen, Stichwörtern, Produktbestandteilen, Phasen des Lebenszyklus usw. mit Referenz zu der Seite, auf der diese erwähnt werden.

Achten Sie darauf, dass auch gängige Synonyme im Index enthalten sind.

Beispiel eines Index

Ein Glossar ist eine alphabetische Liste an Wörtern samt Erklärungen, die mit dem jeweiligen Thema zusammenhängen, über das Sie schreiben. Es ist also ein kleines Wörterbuch.

 
Beispiel eines Glossars

Ein weiteres Glossar-Beispiel

Überprüfung der Bedienungsanleitung zur Fehlerbehebung, Teil 1

Sobald Sie all diese Tipps und Beispiele zur Erstellung Ihrer Produktdokumentation angewendet haben, wird es Zeit, ihre Arbeit zu überprüfen.

Sie haben nun die Rohfassung ihrer Bedienungsanleitung erstellt. Intern nennen wir diese Fassung den Textinhalt-Entwurf oder das textual content design (das müssten wir ins Glossar aufnehmen, haha).

Bitten Sie alle Personen mit weitreichendem Wissen zum Produkt, die Informationen beigesteuert haben, die bisherige Arbeit zu überprüfen. 

Dabei arbeite ich gerne mit einem technical authoring tool oder mit Google Doc. 

Nutzen Sie deren Feedback, um die Bedienungsanleitung zu optimieren. 

Kapitel 3 - Eindeutige Grafiken erstellen

Mit Grafiken in Bedienungsanleitungen meine ich 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.

Nutzen Sie Illustrationen, um Texte zu untermalen

Sie können Illustrationen nutzen, um Geschriebenes zu unterstützen, ersetzen oder ergänzen und um eine chronologische Sequenz oder zu befolgende Schritte darzustellen. 

Achten Sie darauf, dass die Illustrationssequenz in Ihrer Bedienungsanleitung logisch und verständlich ist.

Illustrationen, die eine Schrittabfolge beschreiben

Platzieren Sie die Illustrationen so nah wie möglich an dem dazugehörigen Text, dann ist es klar, zu welcher Anweisung in Textform sie gehören. Zusammengehörende Texte und Illustrationen sollten gleichzeitig sichtbar sein und gemeinsam für mehr Verständlichkeit sorgen.

Im Vergleich zu Fotos haben Sie mit Illustrationen viel mehr Freiheiten, um sich auf wichtige Details zu konzentrieren. Sie können weniger wichtige Details auslassen oder bestimmte Teile vergrößern.

Vollständig auf Text zu verzichten und diesen mit Illustrationen zu ersetzen hat den Vorteil, dass diese Illustrationen nicht übersetzt werden müssen. Seien Sie sich bewusst, dass verständliche Illustrationen zu erstellen Fähigkeiten erfordert. 

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. 

Berücksichtigen Sie auch die Druckerqualität und Bildschirmauflösung, wenn Sie Illustrationen entwerfen. Auf Bildschirmen benötigen Illustrationen eine Auflösung von 72 dpi und für Drucke ist eine Auflösung von mindestens 300 dpi empfehlenswert. 

Versehen Sie ihre Illustrationen mit einer nummerierten Unterschrift, damit die Benutzer wissen, wovon die Illustration handelt und sie dadurch anhand eines Hinweises im Text leicht identifizieren können. 

Illustrationen können ebenfalls dazu dienen, Produktteile und Hauptfunktionsweisen darzustellen, eine schematische Darstellung ihres Produkts oder z. B. die Elektronik zu zeigen.

Eine Illustration, die die Hauptproduktbestandtteile identifiziert

Manchmal werden Fotos statt Illustrationen verwendet. Ich bevorzuge jedoch ganz klar die Verwendung von Illustrationen in Form von Strichzeichnungen, da diese oft viel deutlicher sind.

 

Verwendung eines Fotos statt einer Illustration, das einer unserer Kunden entworfen hat

 

Verwendung einer Illustration in der neuen Bedienungsanleitung, die wir erstellt haben

Wenn Sie Illustrationen erstellen, können Sie unwichtige Informationen auslassen oder wichtige Informationen hervorheben. Das gestaltet sich mit Fotos schwieriger.

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.

Screenshots mit einer Übersicht der Hauptfunktionen

Erklärung der Funktion einer App in einer Bedienungsanleitung

Nutzen Sie Tabellen, um Daten zu organisieren

Tabellen können genutzt werden, 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. Platzieren Sie Tabellen in der Nähe des dazugehörigen Texts. Referenztabellen (wie Ersatzteillisten) können als Ausnahme im Anhang platziert werden.

Technische Daten dargestellt in einer Tabelle

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.

Videos können realistisch (mit einer Kamera gefilmt), 3D-Animationen oder illustrierte Animationen sein, solange Sie beachten, dass Videos kurz und prägnant sein sollten.

Beispiel eines realistischen Videotutorials

 

 

Beispiel einer 3D-Animation

Beispiel eines Erklärvideos in Cartoonstil 

In Videos kann synchronisierter, gesprochener oder geschriebener Text genutzt werden, um die Szenen zu unterstützen.  

Interaktive Animationen für mehr Wirksamkeit und Effizienz

Eine weitere wichtige Form der Animation ist interaktive Animation. Interaktive Animationen können als eine Abfolge visueller und akustischer Elemente erklärt werden. Sie können am besten zur Erklärung komplexer Prozesse, z. B. einer Abfolge von Installationsanweisungen, genutzt werden. 

Wenn sie korrekt eingesetzt werden (nach den Prinzipien des Minimalismus), können Videos und interaktive Animationen of wirksamer sein, als jede andere Form von Anleitungen.

Laut der Forschung können Sich Zuseher länger an Informationen erinnern (was die Informationen wirksamer macht) und sie lernen schneller (was die Informationen effizienter macht).

Beispiel einer interaktiven Animation in Internet nach den Prinzipien des Minimalismus

Bedenken Sie, dass für das Abspielen eines Videos eine stabile Internetverbindung herrschen muss. Es ist also nicht für Orte mit schlechtem Empfang geeignet.

Seien Sie sich bewusst, dass für manche Produkte oder in manchen Ländern eine Produktdokumentation in Papierform vorgeschrieben wird und das Videoformat demnach nicht ihre gesamte schriftliche Gebrauchsanweisung ersetzen kann.

Sehen Sie sich dieses unglaublich lustige Video von Virgin America an, in dem deren Sicherheitshinweise präsentiert werden.

Sie können Infografiken, Grafiken und Diagramme verwenden, um Muster zu zeigen, Daten zu ordnen und sie zu visuell darzustellen, Zusammenhänge zu zeigen, Überblicke zu bieten etc.

Nutzen Sie Symbole, um sprachunabhängig zu kommunizieren

Symbole, Icons und Sicherheitszeichen werden in Bedienungsanleitungen sehr oft verwendet. Sie zeichnen sich dadurch aus, dass sie eine vorgegebene und erkennbare Bedeutung haben und zur sprachunabhängigen

Informationsübertragung genutzt werden.

Diese Bedeutung wird durch eine Kombination aus Farben und geometrischen Formen erzeugt.

Viele Symbole, Icons und Zeichen sind standardisiert. Einige oft verwendete Standards sind:

  • ISO 7010 - Graphische Symbole - Sicherheitsfarben und Sicherheitszeichen - Registrierte Sicherheitszeichen
  • ISO 3864 - Graphische Symbole - Sicherheitsfarben und Sicherheitszeichen
  • ANSI Z535.6 - Product Safety Information In Product Manuals, Instructions And Other Collateral Materials (Informationen zur Produktsicherheit in Produktdokumentation, Bedienungsanleitungen und dazugehörigen Dokumenten)
  • IEC 60617 - Graphical symbols for diagrams (Graphische Symbole für Schemazeichnungen)
  • IEC 14617 - Graphische Symbole für Schemazeichnungen
  • ISO 5807 - Informationsverarbeitung; Dokumentationssymbole und -konventionen für Daten, für Programm- und Systemabläufe, für Pläne von Programmnetzen und Systemhilfsquellen

Flussdiagrammsymbole nach ISO 5807

 

Sicherheitstafeln nach ISO 3864

Sicherheitstafeln nach ANSI Z535.6

Es ist höchst empfehlenswert, wenn ein grafisches Konzept in einer Norm von einem grafischen Symbol dargestellt wird, dieses Symbol zu verwenden.

Beispiel für eindeutige Symbole nach ISO 7010

Icons können verwendet werden, um Objekte oder Funktionen darzustellen. Achten Sie darauf, sie spezifisch und konsistent nur für eine Sache zu verwenden. Verwenden Sie nie verschiedene Icons für dasselbe Objekt oder dieselbe Funktion. 

Für mehr Tipps, wann Text oder Grafiken eingesetzt werden sollten, schauen Sie sich diesen Beitrag an.

Kapitel 4 - Darstellung ihrer Bedienungsanleitung

Glücklicherweise erkennen mehr und mehr Firmen, wie wichtig es ist, attraktives Design und den Einsatz verschiedener Medien zu vereinen, um den Lesern Informationen zu vermitteln. 

Das Thema Benutzererfahrung ist IN! Deswegen ise eine Bedienungsanleitung von Philips, Samsung, Panasonic, Huawei oder Siemens verständlich.

Bedienungsanleitungen einfach in Chinglish oder als simples, von einem der Techniker verfasstes und formatiertes Worddokument anzubieten, wird bald der Vergangenheit angehören. 

Es gibt zahlreiche Wege, Benutzern die Verwendung eines Produkts zu übermitteln. Richten Sie das Medium und das Format der Informationen auf die Bedürfnisse der Zielgruppen aus.

Achten Sie darauf, dass die Medien über die gesamte vorgesehen Lebensdauer des Produkts einen einfachen Zugang zu den Informationen bieten. Behalten Sie also immer die Lebensdauer des Produkts im Blick und ziehen Sie in Erwägung, es in der Gebrauchsanweisung anzugeben.

Einige Beispiele möglicher Medien für Bedienungsanleitungen sind Text, Visualisierungen (Fotos, Sicherheitszeichen, grafische Symbole und Illustrationen), Videos (mitsamt Audiounterstützung und Untertiteln), Animationen, Ansprache, Brailleschrift, Augmented Reality, Virtual Reality, Merkblätter oder geheftete Booklets mit Text, Illustrationen und gedruckte Informationen auf der Verpackung oder dem Produkt selbst. 

Obwohl Bestimmungen lockerer werden, sollten Sie sich stets über etwaige rechtlichen Anforderungen an die Art der Publikation informieren, die in dem Land herrschen, in dem Sie ihr Produkt verkaufen. Lesen Sie dazu auch diesen Artikel zu Online-Publikation.

Technical Authoring-Tools können Sie dabei unterstützen aus demselben single sourced-Inhalt sowohl eine Online- als auch Printversion ihrer Bedienungsanleitung zu erstellen.


Single-Sourcing mit MadClap Flare

Unabhängig vom ausgewählten Medium ist es ebenso wichtig, die Informationen sowohl für das Medium als auch das Zielpublikum passend zu formatieren.

Eine sehbehinderte Person könnte z. B. von einer größeren Schrift profitieren, wie Sie sich sicher denken können.

Sehen wir uns weitere Designprinzipien an.

Setzen Sie Farben sinnvoll und effektiv ein.

Lassen Sie viel unbeschrieben Freiraum.

Verwenden Sie eine klare, lesbare und serifenlose Schrift. Achten Sie darauf, dass die Schriftgröße auf das Publikum zugeschnitten ist.  Verwenden Sie nicht zu viele verschiedene Schriftgrößen.

Setzen Sie Fett-, Kursiv- oder Courierschrift für Terminologie, Referenzangaben oder Input ein. 

Produktbestandteile werden fett geschrieben.

Andere Abschnitte werden kursiv geschrieben.

Verschiedene Schriftschnitte können, sparsam eingesetzt, wichtige Stellen im Text hervorheben.

Achten Sie auf einen hohen Kontrast zwischen Text und Hintergrund. Eine schwarze Schrift auf weißem Hintergrund ist die beste Lösung.

Setzen Sie Farbe gegebenenfalls konsistent und gemäß anzuwendender Standards ein.

Halten Sie sich an ein konsistentes Layout auf jeder Seite.

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

Informationen, die auf ein Produkt gedruckt oder geprägt sind, müssen über die gesamte Lebensdauer des Produkts lesbar bleiben.

Sind Informationen nur auf der Verpackung oder in Beipackunterlagen angegeben, sollten diese 

möglichst langlebig sein. Sie sollten über die gesamte Lebensdauer des Produkts eine dauerhafte Verwendung in der  

Umgebung, in der das Produkt verwendet wird, überstehen.

Wie Sie ihre Produktdokumentation gestalten, hat teilweise mit der Sprache zu tun. 

Es herrscht generell Einigkeit darüber und ist in vielen Fällen vorgeschrieben, dass Bedienungsanleitungen in der Sprache des Landes zur Verfügung gestellt wird, in dem das Produkt verkauft wird.



Für einen einfachen Vertrieb stehen diese Anweisungen in 24 Sprachen zur Verfügung.

Kapitel 5 - Finalisierung und Vertrieb ihrer Bedienungsanleitung

In Kapitel 2 (Texte) und 3 (Visualisierung) haben wir den Inhalt erarbeitet und die Form in Kapitel 4, es ist also Zeit, die Bedienungsanleitung fertig zu stellen.

Als Erstes sollten Sie ihre Bedienungsanleitung Korrektur lesen. Beim Korrekturlesen überprüfen Sie ihre geschriebene Bedienungsanleitung auf Fehler.

Sie können das selbst erledigen, oder es outsourcen, was ich Ihnen empfehlen würde.

Es kann schwierig sein, ihre eigene Arbeit Korrektur zu lesen und dabei Fehler zu finden. Wenn Sie ihre eigene Arbeit durchlesen, wird ihr Gehirn so lesen, wie es geschrieben sein sollte. 

Das nennt man cognitive blindness oder Unaufmerksamkeitsblindheit.

Die meisten professionellen Übersetzungsagenturen bieten auch Korrekturlesungen an.

Ihre Bedienungsanleitung muss möglicherweise in die Sprache ihres Zielpublikums übersetzt werden. 

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

Warum ist eine englische Bedienungsanleitung besser als eine Bedienungsanleitung auf deutsch?

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 nach Niederländisch übersetzt, als umgekehrt.

Der richtige Übersetzer für die Übersetzung ihrer Bedienungsanleitung sollte einschlägige Erfahrung mitbringen.

Das könnte ein Übersetzer mit Erfahrung mit technischen Inhalten, der Übersetzung ähnlicher Produkte oder der Übersetzung von Bedienungsanleitungen sein.

Wenn in mehrere Sprachen übersetzt werden soll, kann Ihnen die Zusammenarbeit mit einer Übersetzungsagentur viel Zeit sparen, da diese sich um das komplexe Projektmanagement kümmern kann.

Sie sollten sich bei dem Übersetzer oder der Agentur über deren Qualitätssicherung und Korrekturlesung erkundigen. 

Oft angewandte Qualitätsstandards sind die ISO 17100 für Übersetzungsqualität und die ISO 9001 für Qualitätsmanagementsysteme.

Darüber hinaus bietet die IEC/IEEE 82079-1:2019 Kompetenzanforderungen für Übersetzer von technischer Dokumentation. 

Nach diesem Standard sollten Übersetzer über die in Stufe 1 angegebenen Kompetenzen verfügen, sowohl die Ausgangs- als auch die Zielsprache fließend beherrschen, Muttersprachler der Zielsprache sein und mit der Art des Produkts und der dazugehörigen produktspezifischen Terminologie vertraut sein.

Nachdem Sie wissen, wer ihr Zielpublikum ist und wie ihr Produkt funktioniert, können Sie auch die Qualität ihrer Übersetzung erhöhen, indem Sie dem Übersetzer oder der Agentur ein zu verwendendes Glossar oder eine Terminologieliste zur Verfügung stellen.

Suchen Sie einen Übersetzer, der direkt in MS Word-, Google Doc- oder InDesign-Dokumenten arbeiten kann oder finden Sie eine Agentur, die sich auch um das Desktop-Publishing DTP kümmert. 

Die Software, in der Sie ihre Produktdokumentation erstellen legt im Wesentlichen fest, wie der Output, das DTP  und der Übersetzungsprozess organisiert werden.

Tools wie Word und InDesign sind die meistgenutzten Softwares, zur Erstellung von Bedienungsanleitungen. 

Wenn Sie mehrere Bedienungsanleitungen 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. In dem 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. 

Wenn Sie ihre Produktdokumentation drucken, vergessen Sie nicht eine der Produktqualität angemessene Papierart zu wählen.

Sobald Sie ihre Bedienungsanleitung fertiggestellt und veröffentlicht haben, oder vielleicht einen Schritt zuvor, kann ein Usability-Test zeigen, ob ihre Benutzer verstehen, was Sie geschrieben haben. 

Setzen Sie dabei unvoreingenommene und echte Benutzer ein, die ihre Zielgruppe repräsentieren und keine Designer oder Produktexperten.

Beobachten Sie die Teilnehmer des Tests genau, wenn Sie ihre Bedienungsanleitung anwenden. 

Untersuchen Sie, wo sie durch das Dokument flitzen. Halten Sie fest, wo sie verunsichert oder völlig verloren sind oder an einer Aufgabe scheitern. Sie können die Studie auch aufnehmen und analysieren. 

Hören Sie genau zu, was die Benutzer zu sagen haben und nutzen Sie diese Angaben dann, um ihre Bedienungsanleitung entsprechend anzupassen. Vergessen Sie nicht, ihre Erkenntnisse in Form einer Fehlerbehandlung zur Verfügung zu stellen (siehe Fügen Sie eine Fehlerbehandlung ein, um ihren Nutzern Zeit, Frustration und Angst zu (er)sparen)

Für einen positiven ersten Eindruck, haben Sie möglicherweise eine sinnvolle und effektive Farbwahl getroffen. So genanntes Colour-Coding unterstützt auch die Navigation im Dokument. 

Wenn Sie über Farben und Kontraste entscheiden, bedenken Sie auch die Bedürfnisse von Benutzern mit Sehbehinderung oder Farbenblindheit. 

Testen Sie den Einsatz der Farben im Usability-Test, um sicherzustellen, dass sie auch von farbenblinden Benutzern gelesen werden können. 

Erwägen Sie, Bedienungsanleitungen in Brailleschrift, großer Schriftart oder Audio für diese Benutzer zur Verfügung zu stellen. 

Fazit

Nun, es gibt viel darüber zu sagen, wie eine Bedienungsanleitung geschrieben wird. Und ich habe nur die wichtigsten Themen angesprochen!

Wenn Sie wirklich außergewöhnlich gute Bedienungsanleitungen erstellen wollen, müssen Sie viel üben.

Oder wie es Malcolm Gladwell in seinem Buch „Überflieger“ beschreibt: es braucht 10.000 Stunden, bis man in einer Kompetenz meisterlich ist. 

Ich hoffe, ich konnte Ihnen in dieser Zusammenfassung auf Grundlage meiner Ansichten zur Erstellung von Bedienungsanleitungen nützlichen Input anbieten. 

Wenn Sie den Tipps aus diesem Artikel folgen und sich die Beispiele anschauen, haben Sie hoffentlich ein besseres Verständnis davon, wie Bedienungsanleitungen besser erstellt werden können. 

Also, machen Sie sich ans Werk und erstellen Sie großartige Anleitungen!

Wenn Sie diesen Beitrag als hilfreich empfinden, würde ich mich freuen, wenn Sie mir unten einen Kommentar hinterlassen.

MÖCHTEN SIE EINE VORLAGE FÜR EINE BEDIENUNGSANLEITUNG NUTZEN, DIE BEREITS ALLE RECHTLICHEN ASPEKTE ENTHÄLT?

Nehmen Sie den schnellsten Weg zu einer konformen Anleitung. Wir haben Vorlagen (in deutscher Sprache) für Bedienungsanleitungen für Maschinen, Medizinprodukte und Elektrogeräte entwickelt, die bereits alle rechtlichen Inhalte beinhalten. 

HIER BESTELLEN!