Ein Benutzerhandbuch schreiben (mit Bildern)

Schritte
Tipps

Software, Computer, Spiele und Geräte erfordern Benutzerhandbücher; Anleitungen, die erklären, wie das Produkt verwendet wird (und wie nicht). Ein Benutzerhandbuch ist ein formelles Dokument mit einer bestimmten Struktur und sollte von jemandem verfasst werden, der das Produkt durch und durch kennt, z. B. ein technischer Redakteur oder der Produktdesigner. Das Verfassen eines effektiven Benutzerhandbuchs erfordert, dass Sie wissen, wer das Produkt verwenden wird, und dass Sie das Handbuch unter Berücksichtigung dieser Benutzer schreiben. Halten Sie Ihr Schreiben klar, präzise und einfach, um eine problemlose Benutzererfahrung zu gewährleisten.

Schritte

Teil1 von 4: Planung Ihres Benutzerhandbuchs

1. Machen Sie eine Nutzeranalyse. Das Benutzerhandbuch sollte für die Benutzer geschrieben werden – diejenigen, die Ihr Produkt oder Ihre Dienstleistung kaufen und das Benutzerhandbuch lesen. Eine Nutzeranalyse sagt Ihnen, wer Ihre Haupt- oder Zielgruppe sein wird und leitet Sie beim Verfassen des Textes an.

Sprechen Sie mit Personen, die Ihr Gerät verwenden werden. Testbenutzern unter kontrollierten Bedingungen Prototypen des Geräts und einen Entwurf des Benutzerhandbuchs zur Verfügung stellen. Bitten Sie diese Testbenutzer um Feedback zu Dingen, die im Benutzerhandbuch nicht klar oder verwirrend sind, und nehmen Sie basierend auf diesem Feedback Änderungen an Ihrem Benutzerhandbuch vor.
Sie können nie Ihrem gesamten Publikum gefallen; Schreiben Sie das Handbuch, das auf die Zielgruppe oder die größte Zielgruppe zugeschnitten ist.
Denken Sie an Alter, Gesundheit (haben sie irgendwelche Krankheiten, Lernschwierigkeiten oder Behinderungen?)?) und den Bildungsstand der Öffentlichkeit, um den besten Ansatz für die Erstellung des Benutzerhandbuchs zu bestimmen.

2. Koordinieren Sie das Design der Bedienungsanleitung. Wenn Sie Teil des Teams waren, das das Gerät oder Produkt entworfen und entwickelt hat, kann es schwierig sein, das Produkt objektiv zu betrachten, um zu erklären, wie es funktioniert. Sie sollten sich daher bei der Erstellung des Benutzerhandbuchs von einem Autor (vorzugsweise jemand mit Erfahrung im Schreiben von Anleitungen) und einem Grafikdesigner beraten lassen. Sie können diese Personen durch eine externe Beratung oder aus Ihrem eigenen Unternehmen oder Ihrer Organisation auswählen.

3. Machen Sie eine Jobanalyse. Eine Jobanalyse ist der Prozess der Identifizierung und Organisation der Schritte, die für die Verwendung des Geräts erforderlich sind. Eine gründliche Jobanalyse identifiziert die für jeden Schritt erforderlichen Materialien und Geräte (wie Batterien, Medikamente oder andere vom Benutzer bereitgestellte Produkte) sowie die Aktionen, Fehler und Ratschläge zur Fehlerbehebung, die jeder Schritt möglicherweise erfordert.

Wenn Sie ein Produkt haben, das viele verschiedene Aufgaben oder Teilaufgaben ausführen kann, müssen Sie für jede Aufgabe eine Aufgabenanalyse durchführen. Zum Beispiel: Im Auto können Sie hupen, sich anschnallen und die Scheinwerfer ein- oder ausschalten. Erstellen Sie bei Bedarf für jede dieser Stellen eine Stellenanalyse.

4. Stellen Sie sicher, dass Ihr Produkt die Kennzeichnungs- und Zulassungsanforderungen erfüllt. Diese Anforderungen stellen sicher, dass die Produkte unter Berücksichtigung der Sicherheit des Benutzers hergestellt werden und dass die Exposition des Benutzers gegenüber gefährlichen Bedingungen wie Strahlung und Stromschlag begrenzt ist. Anzeigen sollten den Zweck und die grundlegenden Betriebsrichtlinien eines Produkts klar angeben, und Sie sollten diese Ressourcen verwenden, wenn Sie Ihr Benutzerhandbuch schreiben.

Damit das Benutzerhandbuch eines Produkts wirksam ist, muss es in Übereinstimmung mit den direkt am Produkt angebrachten Etiketten verfasst sein.

Stellen Sie vor dem Schreiben des Benutzerhandbuchs sicher, dass Ihr Gerät über offizielle Verkaufslizenzen verfügt.

5. Entscheiden Sie sich für das Layout Ihres Handbuchs. Es gibt mehrere wichtige Möglichkeiten, wie Sie Ihr Handbuch optimieren können. Sie müssen am Anfang jedes Abschnitts eine fette Überschrift setzen, wobei jedes Wort in Großbuchstaben geschrieben ist. Beispielsweise können "Gerät einrichten", "Gerät steuern" und "Fehlerbehebung" fett gedruckte Abschnittsüberschriften sein.

Eine andere Möglichkeit, Ihr Handbuch zu optimieren, besteht darin, zwei Spalten zu verwenden, eine rechts mit Text und die andere direkt links neben dem Text mit Aufzählungszeichen, Zahlen oder kleinen Symbolen wie Warnzeichen oder roten Ausrufezeichen.

Das Handbuch kann hauptsächlich aus Bildern mit etwas Text unter jedem Bild bestehen, um das Gerät zu erklären, oder es kann hauptsächlich aus Text mit nur wenigen begleitenden Bildern bestehen. Sie können auch ein Flussdiagramm verwenden, um den Benutzer zu führen. Denken Sie über Ihr Produkt nach und wie jede Methode Ihnen beim Schreiben Ihres Handbuchs helfen kann. Vermeiden Sie jedoch das Mischen verschiedener Layouts innerhalb eines Handbuchs. Such dir einen aus und bleib dabei.

Teil2 von 4: Einbetten wesentlicher Informationen

1. Organisieren Sie das Handbuch logisch. Das Handbuch sollte so aufgebaut sein, dass der Benutzer den größtmöglichen Nutzen daraus zieht. Unterteilen Sie das Handbuch in Kapitel oder Abschnitte, die für die Verwendung des Produkts sinnvoll sind, und fügen Sie ein Inhaltsverzeichnis am Anfang des Handbuchs ein, damit jeder Abschnitt schnell gefunden werden kann.

Ein Inhaltsverzeichnis ist vor allem bei längeren Anleitungen notwendig.
Ein Glossar oder Index ist erforderlich, wenn viele Begriffe zu erklären sind, die Ihr Publikum möglicherweise nicht kennt. Ein Glossar wird jedoch nicht empfohlen; am besten erklären Sie verwirrende Begriffe im Handbuchtext selbst. Wenn Sie ein Glossar hinzufügen möchten, platzieren Sie es am Anfang des Handbuchs, direkt nach dem Inhaltsverzeichnis.
Ein Tabellen- oder Abbildungsverzeichnis wird nur benötigt, wenn das Handbuch mehr als wenige Tabellen oder Abbildungen enthält.
Ein Anhang wird für Dinge benötigt, die erklärt werden müssen, aber nicht an anderer Stelle im Handbuch erklärt werden können, da dies den Fluss und die Konzentration stören würde.

2. Notwendige Warnungen einfügen. Die allgemeinen Warnungen oder Vorsichtshinweise sollten auf potenzielle Gefahren hinweisen, die durch unsachgemäßen Gebrauch des Produkts entstehen können, einschließlich Tod oder schwerer Verletzung. Diese Warnungen sollten ganz vorne im Handbuch nach der Titelseite platziert werden, damit der Benutzer sie zuerst sieht. Spezifische Warnhinweise sollten auch kurz nach oder kurz bevor ein potenziell gefährlicher Schritt vorgeschlagen wird, in den Text des Handbuchs aufgenommen werden.

Eine allgemeine Warnung für ein Elektrogerät könnte beispielsweise sein, es nicht bei Regen zu benutzen.

Ein besonderer Hinweis könnte sein, sicherzustellen, dass sowohl Ihre Hände als auch das Gerät trocken sind, bevor Sie das Gerät anschließen.

Stellen Sie Bilder (z. B. Totenkopf) oder Text in einer anderen Farbe (z. B. roter Text) bereit, um die Warnung vom Rest der Anweisungen im Handbuch zu unterscheiden und die Benutzer darauf aufmerksam zu machen.

3. Beschreiben Sie das Gerät. Ihre Beschreibung sollte sowohl eine schriftliche Erklärung des Verwendungszwecks des Geräts als auch eine kleine grafische Darstellung des Aussehens des Geräts enthalten. Die Abbildung sollte alle im Gerät enthaltenen Schalter, Tasten und Anbauteile beschriften und benennen.

4. Installationsanweisungen bereitstellen. Der Installationsabschnitt sollte grundlegende Informationen zur Vorbereitung der Verwendung des Produkts oder Geräts enthalten. Wenn das Gerät nicht von einem Heimanwender gebaut oder eingerichtet werden kann, geben Sie dies in einer fetten Überschrift oben im Installationsabschnitt deutlich an. Sie sollten auch Folgendes enthalten:

Eine Stückliste

Anweisungen zum Auspacken

Installationswarnungen

Folgen einer falschen Installation

Ansprechpartner bei Installationsschwierigkeiten

5. Geben Sie Betriebsinformationen an. Dieser Abschnitt ist der wichtigste Teil der Bedienungsanleitung und soll konkrete und detaillierte Informationen zum Umgang mit dem Gerät geben. Beginnen Sie mit den grundlegenden Vorbereitungen, bevor Sie das Gerät benutzen, wie z. B. den Stecker einstecken oder sich die Hände waschen. Fahren Sie mit logischen, nummerierten Schritten fort, die die Verwendung des Geräts beschreiben, sowie Feedback (z. B. „Sie hören ein Klicken...`), die der Benutzer bei richtiger Verwendung des Geräts erwarten kann.

Am Ende dieses Kapitels sollten Benutzer auf das Kapitel Fehlerbehebung verwiesen werden, um Probleme zu lösen, die nicht schnell erklärt werden können.

Bilder bei Bedarf posten. Einige Schritte lassen sich am besten mit Bildern und Worten erklären. Denken Sie daran, Fotos oder Illustrationen in Ihrem Handbuch zu verwenden.

In diesem Teil, wie in jedem anderen Teil, sollten Sie relevante Sicherheitswarnungen über unsachgemäßen Gebrauch oder Betrieb einfügen. Sie könnten beispielsweise Kettensägenbenutzer warnen, keinen Alkohol zu trinken oder die Kettensäge zu verwenden, während Sie bestimmte Medikamente einnehmen.

Wenn Sie der Meinung sind, dass dies für die Benutzer von Vorteil wäre, ziehen Sie in Erwägung, Links zu Online-Videos hinzuzufügen, die die ordnungsgemäße Verwendung und Bedienung des Geräts demonstrieren. Sie können diese Videos entweder am Anfang dieses Abschnitts oder (bei Videos, die nur einen Schritt veranschaulichen) am Ende jedes Schritts einfügen.

6. Fügen Sie am Ende eine Zusammenfassung des Produkts hinzu. Die Zusammenfassung sollte am Ende des Handbuchs, kurz vor dem Index, stehen, um die grundlegenden Schritte der Bedienung zu beschreiben. Dies sollte eine vereinfachte, abgespeckte Version der Betriebsinformationen sein und sollte eine Seite nicht überschreiten. Fassen Sie die Verwendung des Geräts oder Produkts zusammen. Fügen Sie grundlegende Warnungen, nummerierte Schritte zur Erläuterung der Verwendung des Produkts sowie Telefonnummern oder E-Mail-Adressen hinzu, die Benutzer zur Hilfe anweisen.

Wenn Sie erwarten, dass der Benutzer das Zusammenfassungsblatt entfernt oder häufig darauf zurückgreifen muss, können Sie es auf eine entfernbare laminierte Karte oder dicken Karton drucken, um es dem Benutzer zu erleichtern, es zu tragen und zu lesen.

Alternativ können Sie zum schnellen und einfachen Nachschlagen für den Benutzer eine Zusammenfassung direkt auf dem Produkt platzieren.

Teil 3 von 4: Beschreibung der Produktwartung

1. Erklären Sie, wie Sie das Gerät reinigen. Wenn Ihr Gerät oder Produkt gereinigt werden muss, erklären Sie, wie es geht. Nennen Sie die benötigten Reinigungsmittel. Sagen Sie dem Leser, wie oft er reinigen soll. Fügen Sie dann, wie in jedem anderen Teil des Handbuchs, eine nummerierte Schritt-für-Schritt-Anleitung zur Reinigung hinzu.

Wenn die Reinigung das Zerlegen des Produkts oder das Entfernen eines oder mehrerer Teile erfordert, geben Sie bitte an, wie das Produkt zerlegt wird.
Geben Sie eine Warnung über die Folgen einer nicht durchgeführten Reinigung des Geräts. Sie könnten beispielsweise sagen: „Wenn das Gerät nicht gereinigt wird, ist die Leistung nicht optimal.`

2. Zählen Sie den Benutzer, wie er grundlegende Wartungsarbeiten durchführt. Wenn das Produkt oder Gerät vom Benutzer gewartet werden kann, um Leistungsprobleme zu beheben, geben Sie nummerierte Anweisungen dazu durch den Benutzer an. Beispiel: Wenn die Batterien alle 300 Betriebsstunden ausgetauscht werden müssen, geben Sie Anweisungen, wie Sie überprüfen können, ob die Batterien ausgetauscht werden müssen, wie Sie die verbrauchten Batterien entfernen und die neuen Batterien einsetzen.

Wenn bestimmte Wartungsaufgaben nur von einem zertifizierten Techniker durchgeführt werden können, teilen Sie den Wartungsabschnitt des Handbuchs in zwei Teile auf.

3. Speicheroptionen besprechen. Das Handbuch sollte ggf. erklären, wie das Produkt oder Gerät richtig gelagert wird. Sie sollten auch angeben, warum eine Speicherung erforderlich ist und welche Folgen eine falsche Speicherung hat. Du könntest zum Beispiel schreiben:

`Lagern Sie das Produkt an einem kühlen, trockenen Ort. Unsachgemäße Lagerung kann die Lebensdauer Ihres Produkts aufgrund von Feuchtigkeitsbildung verkürzen.`

`Setzen Sie das Produkt keiner Hitze aus und lagern Sie es nicht bei Temperaturen über 50 Grad Celsius. Andernfalls kann es zu einer Entzündung kommen.`

4. Geben Sie Informationen zur Fehlerbehebung an. Sie können diesen Abschnitt als Liste häufig auftretender Probleme und ihrer Lösungen organisieren. Gruppieren Sie ähnliche Probleme unter einer logischen Überschrift. Auf diese Weise können Benutzer schnell spezifische Probleme finden.

Wenn es beispielsweise mehrere Probleme mit dem Computer gibt, die einen blauen Bildschirm anzeigen, gruppieren Sie diese unter einer Unterüberschrift, z. B. "Häufige Bildschirmprobleme".

Sie müssen in diesem Abschnitt auch eine Kundenservice-Telefonnummer und/oder E-Mail-Adresse angeben.

Teil4 von 4: Einen lesbaren Leitfaden schreiben

1. Lesen Sie andere Benutzerhandbücher. Bevor Sie ein Handbuch für Ihr eigenes Produkt schreiben, sehen Sie sich andere effektive Benutzerhandbücher an. Auf Struktur, Wortwahl und Satzbau achten. Große Marken wie Apple, Google und Microsoft produzieren starke, effektive Benutzerhandbücher, die Ihnen bei der Erstellung eines durchdachten Benutzerhandbuchs helfen können.

Nicht nur lesen alle Bedienungsanleitung. Lesen Sie die Handbücher ähnlicher Produkte, die Sie verkaufen. Zum Beispiel: Wenn Sie Babyprodukte verkaufen, lesen Sie Babyhandbücher, keine technischen.

2. Wählen Sie Ihre Standards. Durch die Vereinheitlichung von Rechtschreibung, Wortwahl und Formulierung wird die Benutzerführung benutzerfreundlicher. Das Chicago Manual of Style und das Microsoft Manual of Style können auch hilfreiche Styleguides beim Schreiben Ihres Benutzerhandbuchs sein; Überprüfen Sie beide, um zu sehen, ob einer für Ihr Handbuch geeignet ist.

Anstatt beispielsweise sowohl "Ein/Aus-Schalter" als auch "Ein/Aus-Taste" in Ihrem Handbuch zu verwenden, wählen Sie einen der beiden Begriffe und bleiben Sie dabei.

3. Verwenden Sie die aktive Stimme. Die aktive Stimme ist eine Schreibweise, die Dinge aus der Perspektive des Benutzers erklärt. Es ist leichter zu verstehen als die Alternative, das Passiv, in dem das Thema undefiniert ist.

Probieren Sie die Hemingway-App aus (www.hemmingwayapp.com) um passive Passagen in Ihrem Schreiben zu erkennen.

Studieren Sie diese beiden Beispielsätze – der erste ist aktiv und der zweite passiv:

Du musst das Paket langsam und vorsichtig öffnen.

Die Verpackung muss langsam und vorsichtig geöffnet werden.

4. Schreiben Sie nummerierte Anweisungen. Numerisch geordnete Anweisungen helfen dem Leser, sich besser auf den Prozess der Verwendung, Verbindung oder Herstellung des betreffenden Produkts zu konzentrieren. Anstatt einen langen, ausführlichen Absatz oder eine Reihe nicht nummerierter Absätze zu schreiben, schreiben Sie Ihr Benutzerhandbuch mit einfachen, eindeutigen Schritten, die jeweils klar nummeriert sind.

5. Beginnen Sie jeden Schritt mit einem Imperativ. Ein Imperativ ist ein handlungsorientiertes Verb. Indem Sie jeden Schritt mit einem Verb beginnen, geben Sie dem Leser einen Hinweis auf die erforderliche Aktion, um den Schritt abzuschließen. Abhängig von dem Produkt, über das Sie schreiben, können Sie Ihre Schritte beispielsweise mit einem Befehl wie "Verbinden", "Bestätigen" oder "Schieben" beginnen. Beginnen Sie Ihre Schritte jedoch nicht mit einer Antwort vom System.

Wenn der Bildschirm beispielsweise blau wird und zu blinken beginnt, beginnen Sie den Schritt nicht mit „Der Bildschirm blinkt und wird blau.` Versuchen Sie: `Drücken und halten Sie die Home-Taste. Der Bildschirm blinkt und wird blau.`

6. Entscheiden Sie, welches Vokabular Sie verwenden werden. Wenn Sie eine Bedienungsanleitung für ein Jo-Jo schreiben, besteht Ihr Publikum hauptsächlich aus kleinen Kindern. Verwenden Sie einfache Wörter und Vokabeln, um zu erklären, wie das Jo-Jo funktioniert. Wenn Sie ein Handbuch für ein Rasterelektronenmikroskop schreiben, besteht Ihr Publikum aus hochqualifizierten Wissenschaftlern, die sehr detaillierte Informationen verstehen können.

Versuchen Sie im Allgemeinen, Jargon und Fachsprache zu vermeiden.

Um für eine möglichst breite Benutzerbasis effektiv zu sein, versuchen Sie, auf einem Niveau von der sechsten bis zur siebten Klasse zu schreiben.

7. Achten Sie beim Versand eines Produkts ins Ausland darauf, dass Ihre Übersetzungen korrekt sind. Beauftragen Sie einen Übersetzer, um Ihr Benutzerhandbuch in die Muttersprache des Landes zu übersetzen, in das Sie Ihr Produkt versenden. Sie können auch ein Online-Übersetzungstool verwenden, aber bitten Sie einen Muttersprachler, die Übersetzung zu lesen und auf Fehler zu prüfen.

Wenn in Ihrem Publikum mehrere Sprachgruppen vertreten sind, fügen Sie bitte Übersetzungen des Benutzerhandbuchs in jede relevante Sprache bei.

Der Übersetzer sollte mit dem Produkt vertraut sein, da es für bestimmte Begriffe in der Zielsprache möglicherweise andere Wörter gibt, die keine Wort-für-Wort-Übersetzungen sind.

8. In kurzen Sätzen schreiben. Verwenden Sie statt ein paar langen Absätzen viele kurze Absätze. Suchen Sie in jedem Abschnitt nach logischen Unterbrechungen und verdauen Sie nützliche Informationen in Blöcken mit einem oder zwei Sätzen. Das gleiche gilt auf Satzebene. Halte deine Sätze kurz und einfach, anstatt lang und ausführlich.

Wenn ein Schritt zu lang wird, unterteilen Sie ihn in kleinere Schritte. Dadurch wird die Wortzahl nicht verringert, aber die Zeilenumbrüche erleichtern das Lesen.

9. Überprüfen Sie das Handbuch auf Fehler. Ein Handbuch kann aufgrund von Grammatik- und Rechtschreibfehlern an Glaubwürdigkeit verlieren. Lassen Sie das Handbuch auch von einem Kollegen oder technischen Redakteur bearbeiten und Korrektur lesen. Neben Rechtschreibung und Grammatik sollte ein Korrektor auf Folgendes achten:

Passive Stimme

Unklare oder verwirrende Sprache

umschlossener Satzbau

Zu lange Absätze

Tipps

Menschen lernen auf unterschiedliche Weise; Wenn möglich und angemessen, fügen Sie visuelle Hilfsmittel oder Links zu Online-Videos in das Handbuch ein, um visuell orientierte Leser zu unterstützen.