Wie man ein Handbuch schreibt (mit Bildern)

Inhaltsverzeichnis:

Wie man ein Handbuch schreibt (mit Bildern)
Wie man ein Handbuch schreibt (mit Bildern)
Anonim

Eine Bedienungsanleitung zu schreiben mag eine entmutigende Aufgabe sein, aber es ist einfacher als Sie denken! Diese Schritte gelten für jede schriftliche Anweisung, von der sehr einfachen (Wie man klatscht) bis hin zu sehr kompliziert (Wie man einen Halbleiter baut).

Schritte

Teil 1 von 4: Lernen Sie das Thema kennen

Schreiben Sie ein Handbuch Schritt 1

Schritt 1. Dies ist der Schlüssel

Es mag selbstverständlich erscheinen, aber Wissen ist der Schlüssel zum Schreiben eines erfolgreichen Handbuchs. Wenn du zum Beispiel ein Kamerahandbuch schreibst und weißt, dass Blende und Verschlusszeit nicht nur zwei separate Funktionen sind – sie sind es –, sondern zu wissen, wie sie miteinander interagieren, wird es dir viel einfacher machen, sie zu beschreiben Funktion in Bezug auf das Ganze.

Schreiben Sie ein Handbuch Schritt 2

Schritt 2. Sprechen Sie mit Experten

Wenn Ihre Rolle eher die des Autors als des Fachexperten ist, beziehen Sie sachkundige Personen in den gesamten Prozess ein und stellen Sie sicher, dass sie Ihre Arbeit überprüfen. Ihr Wissen und ihre Ratschläge sind von unschätzbarem Wert.

Schreiben Sie ein Handbuch Schritt 3

Schritt 3. Probieren Sie einen praktischen Ansatz aus

Wenn möglich, gibt Ihnen das, worüber Sie schreiben, zumindest ein Gefühl dafür, was der Benutzer lernen möchte.

Schreiben Sie ein Handbuch Schritt 4

Schritt 4. Informieren Sie sich über das Thema

Lernen Sie, das Gespräch zu führen, und machen Sie sich mit dem Produkt vertraut, über das Sie schreiben.

  • Handbücher ähnlicher Produkte zeigen Ihnen, wie andere Autoren das Thema angegangen sind.

    • Suchen Sie nach Ähnlichkeiten zwischen den Autoren, die sowohl auf gemeinsame Funktionen als auch auf gemeinsame Ansätze zum Beschreiben von etwas hinweisen.
    • Suchen Sie nach Unterschieden, die auffallen. Dies sind wahrscheinlich Funktionen, die für ein bestimmtes Produkt einzigartig sind. Ihr Produkt kann diese Funktionen enthalten oder nicht, oder es gibt andere Möglichkeiten zur Lösung des Problems, die Sie beschreiben können, um den Wert Ihres Produkts zu steigern. Während Ihr Job vielleicht darin besteht, eine Anleitung zu schreiben, ist es eine großartige Möglichkeit, den Kunden den Wert ihres Kaufs zu zeigen, um sie zum Weiterlesen zu ermutigen.
  • Verschlingen Sie Fachzeitschriften. Finden Sie heraus, wie die Menschen, die die Produkte verwenden, täglich mit ihnen arbeiten. Sie möchten vielleicht, dass es eine Funktion gibt, die ihr spezielles Problem löst, und wenn Ihr Produkt die Lösung ist, muss dies hervorgehoben werden.

Teil 2 von 4: Planen Sie Ihr manuelles Layout

Schreiben Sie ein Handbuch Schritt 5

Schritt 1. Zerlegen Sie es

Ob eine einfache Schritt-für-Schritt-Anleitung oder ein Handbuch für eine 35-mm-Digitalkamera, die Aufteilung in verdauliche Stücke hat mehrere Vorteile:

So können Sie sich auf einzelne Teile des Ganzen konzentrieren. Ihr Ziel ist es, den Benutzer mit dem Erlernen des Prozesses vertraut zu machen. Wie die Funktion ausgeführt wird, kann auf Wunsch einem Tutorial am Ende überlassen oder dem Benutzer selbst überlassen werden

Schreiben Sie ein Handbuch Schritt 6

Schritt 2. Folgen Sie einer logischen Sequenz

Es würde zum Beispiel nichts nützen, die Funktionsweise des Blitzes an einer Kamera zu beschreiben, bevor Sie nicht gezeigt haben, wie Sie das Objektiv anbringen, den Film einlegen, die Kamera einschalten und den Fokus einstellen. Dies ist besonders nützlich, wenn Sie das Thema nicht gut kennen.

Schreiben Sie ein Handbuch Schritt 7

Schritt 3. Verwenden Sie dies als Vorlage für Ihr Inhaltsverzeichnis

Schreiben Sie ein Handbuch Schritt 8

Schritt 4. Überprüfen Sie Ihre Schritte

Nachdem Sie die logischen Abschnitte definiert haben, überprüfen Sie sie, um sicherzustellen, dass alles abgedeckt ist.

Schreiben Sie ein Handbuch Schritt 9

Schritt 5. Sammeln Sie Ihre Vorräte

Halten Sie die von Ihnen beschriebenen Gegenstände griffbereit und gebrauchsfertig, wie im Handbuch beschrieben. Wenn Sie eine Papierschachtel herstellen, halten Sie Papier, Schere, Klebeband, Kleber und ein Lineal bereit. Wenn Sie über eine Kamera schreiben, stellen Sie sicher, dass Ihre Kamera zerlegt ist. Wenn möglich, sollte sich das Produkt, über das Sie schreiben, zu diesem Zeitpunkt wieder im Karton befinden.

Teil 3 von 4: Beginnen Sie mit dem Schreiben

Schreiben Sie ein Handbuch Schritt 10

Schritt 1. Schreiben Sie die Einleitung

Dies wird den Ton des gesamten Handbuchs bestimmen und dem Benutzer eine Vorstellung davon geben, welche Art von Handbuch er verdauen wird. Wird es leicht und amüsant oder geradlinig und geradlinig sein? Es hängt von Ihrer Leserschaft ab. Es gibt viel mehr Raum für verbale Spiele, um Kindern beizubringen, eine Papierschachtel zu basteln, als einem Arzt beizubringen, wie man bei einer Operation am offenen Herzen vorgeht. Legen Sie den Ton frühzeitig fest und behalten Sie diesen Ton während des gesamten Handbuchs bei.

Schreiben Sie ein Handbuch Schritt 11

Schritt 2. Führen Sie jeden Schritt während des Schreibens aus

Dies verleiht Ihrem Schreiben nicht nur einen Hauch von Ehrlichkeit und Authentizität, Sie stellen auch sicher, dass nichts ausgelassen wird.

Wenn es aus irgendeinem Grund nicht möglich ist, die Schritte durchzuführen, denken Sie gründlich darüber nach und wenden Sie sich an einen Experten

Schreiben Sie ein Handbuch Schritt 12

Schritt 3. Nummerieren Sie die Schritte

Dies macht es für die Leute einfacher, mitzumachen und auf sie zurückzugreifen, wenn sie ihren Platz verlieren.

Wenn du auf Papier schreibst, achte darauf, dass du zwischen jedem Schritt Platz für Ergänzungen lässt. Denken Sie daran, Ihre Schritte neu zu nummerieren, wenn Sie weitere hinzufügen

Schreiben Sie ein Handbuch Schritt 13

Schritt 4. Fügen Sie Tipps und Warnungen hinzu

Während Sie schreiben, stellen Sie möglicherweise fest, dass ein Problem auftreten kann, wenn der Benutzer einen Schritt nachlässig ausführt.

Umgekehrt, wenn es ein bisschen Wissen gibt, das die Aufgabe des Benutzers einfacher oder interessanter macht, fügen Sie es hinzu

Schreiben Sie ein Handbuch Schritt 14

Schritt 5. Testen Sie es

Verwenden Sie nur Ihre schriftlichen Anweisungen und tun Sie das, worüber Sie schreiben. Sollten Sie Stellen finden, an denen Ihre Anweisungen fehlen, fügen Sie die erforderlichen Informationen hinzu. Wiederholen Sie diesen Schritt, bis Sie alle Schritte haben und das tun können, was Sie lehren, ohne Notizen hinzufügen zu müssen.

Ziehen Sie in Erwägung, dass ein oder zwei Freunde das Handbuch verwenden. Beobachten Sie sie genau, wenn sie lernen, das Produkt zu verwenden. Sehen Sie, wo sie es durchziehen. Sehen Sie, wo sie verloren gehen, verwirrt sind oder bei der Aufgabe versagen. Hören Sie zu, was sie zu sagen haben, und passen Sie dann Ihr Handbuch entsprechend an

Schreiben Sie ein Handbuch Schritt 15

Schritt 6. Lesen Sie Ihr Handbuch Korrektur

Sie möchten Ihrem letzten Korrekturleser (sei es Ihre Agentur oder Ihren Ehepartner) kein Handbuch voller eklatanter Fehler schicken.

Teil 4 von 4: Formatieren

Schreiben Sie ein Handbuch Schritt 16

Schritt 1. Beginnen Sie auf der obersten Ebene

Wenn Sie alle notwendigen Schritte detailliert haben, gehen Sie Ihr Handbuch durch, um die offensichtlichen Kategorieköpfe zu finden.

Benennen Sie sie und notieren Sie ihre Positionen

Schreiben Sie ein Handbuch Schritt 17

Schritt 2. Schreiben Sie ggf. ein Inhaltsverzeichnis

Schauen Sie sich als Beispiel an, wie wikiHow aufgebaut ist. Die Hauptseite bietet viele Abschnittsüberschriften. Wenn Sie auf einen Abschnitt zugreifen, werden viele Unterkategorien aufgelistet, und die Unterkategorien listen Artikel auf. Je detaillierter Ihr Handbuch ist, desto mehr Kategorien und Unterkategorien benötigen Sie. (How to Whistle braucht keine, How to Carve a Whistle braucht ein paar und How to Play the Flute braucht viele!)

Schreiben Sie ein Handbuch Schritt 18

Schritt 3. Nochmals Korrekturlesen

Ja, das hast du schon einmal gründlich gemacht. Wenn Sie es ein zweites Mal tun, werden zweifellos noch ein paar kleinere Fehler oder Stellen festgestellt, an denen Ihr Handbuch einfach nicht klar ist.

Für ein umfassenderes Handbuch können Sie bei dieser Gelegenheit auch alle kleinen Themen notieren und diese Informationen verwenden, um einen Index zu erstellen

Schreiben Sie ein Handbuch Schritt 19

Schritt 4. Wählen Sie einen Titel aus

Tipps

  • Auch wenn Ihnen etwas offensichtlich erscheint, schreiben Sie die Schritte auf! Es hilft Ihnen zu vermeiden, etwas zu beschönigen, das Ihr Benutzer nicht kennt. Es ist besser, zusätzliche Informationen einzugeben, als wichtige Schritte auszulassen.
  • Wenn Sie ein sehr detailliertes Handbuch schreiben, das Kapitel erfordert, wie z. B. Wie man die Flöte spielt, könnte Ihr erster Schritt darin bestehen, alle Kapitel aufzulisten, z Erstes Stück usw. Sie würden dann die Grundregeln für das Schreiben eines Handbuchs auf jedes Kapitel anwenden, da jedes Kapitel wie ein separates Handbuch für sich ist!
  • Veranschaulichen Sie Ihre Anweisungen nach Möglichkeit! Wenn Sie keine Bilder einfügen können, verweisen Sie Ihren Schüler auf ein allgemeines Beispiel. Zum Beispiel in Formatieren, Schritt 2 In dieser Anleitung wird das Aussehen des wikiHow-Layouts verwendet, um zu veranschaulichen, wie ein Inhaltsverzeichnis erstellt werden könnte.
  • Das Schreiben jedes Abschnitts auf einer separaten Seite (oder auf einem Computer) erleichtert die Bearbeitung. Sie können leichter neu anordnen, wenn Sie Platz zum Arbeiten haben und Ihre Bearbeitungsmarkierungen finden. Lassen Sie auf dem Computer 3 oder 4 Zeilen (durch Drücken von Eintreten mehrmals) zwischen den einzelnen Schritten, damit Sie die Pausen leicht finden können.
  • Wenn Sie können, lassen Sie einen Neuling einen Testlauf Ihres Handbuchs durchführen und schreiben Sie jede Frage auf, die er stellt! Dies wird Ihnen helfen, die Lücken auszufüllen und Ihr Handbuch viel nützlicher zu machen.

Beliebt nach Thema