Wie schreibe ich ein Handbuch

Autor: Eugene Taylor
Erstelldatum: 12 August 2021
Aktualisierungsdatum: 12 Kann 2024
Anonim
Windows 10 für Senioren: Einführung in WordPad – Finden, Öffnen, Briefe schreiben und vieles mehr!
Video: Windows 10 für Senioren: Einführung in WordPad – Finden, Öffnen, Briefe schreiben und vieles mehr!

Inhalt

Das Schreiben einer Bedienungsanleitung mag wie eine herausfordernde Aufgabe erscheinen, ist aber einfacher als Sie denken! Diese Schritte gelten für alle schriftlichen Anweisungen, von den einfachsten (wie man klatscht) bis zu den kompliziertesten (wie man einen Halbleiter baut).

Schritte

Methode 1 von 4: Kennen Sie das Thema

  1. Das ist der Schlüssel. Es mag ziemlich offensichtlich erscheinen, aber Wissen ist der Schlüssel zum Schreiben eines erfolgreichen Handbuchs. Wenn Sie beispielsweise ein Kamerahandbuch schreiben, ist es viel einfacher zu beschreiben, dass Offenheit und Verschlusszeit nicht nur zwei separate Funktionen sind - obwohl dies der Fall ist -, sondern auch, wie sie miteinander interagieren jede Funktion und wie sie sich auf das Ganze bezieht.

  2. Sprechen Sie mit Experten. Wenn Ihre Aufgabe einfach darin besteht, zu schreiben und kein Experte auf diesem Gebiet zu sein, sollten Sie Personen einbeziehen, die wissen, was Sie schreiben, und sicherstellen, dass sie Ihre Arbeit überprüfen. In diesem Bereich sind Wissen und Beratung von unschätzbarem Wert.

  3. Versuchen Sie einen praktischen Ansatz. Wenn möglich, gibt Ihnen das, worüber Sie schreiben, zumindest eine Vorstellung davon, was der Benutzer lernen möchte.
  4. Lese darüber. Lernen Sie, über das Produkt, über das Sie schreiben, zu sprechen und sich mit ihm vertraut zu machen.
    • Handbücher oder ähnliche Produkte zeigen Ihnen, wie andere Autoren sich dem Thema näherten.
      • Suchen Sie nach Ähnlichkeiten zwischen Autoren, die sowohl auf eine gemeinsame Funktionalität als auch auf einen gemeinsamen Ansatz zur Beschreibung von etwas hinweisen.
      • Suchen Sie nach Unterschieden, die auffallen. Dies sind wahrscheinlich eindeutige Funktionen für ein bestimmtes Produkt. Ihr Produkt ist möglicherweise in diesen Funktionen enthalten oder nicht, oder es gibt alternative Möglichkeiten zur Lösung des Problems, das Sie möglicherweise schreiben, wodurch der Wert Ihres Produkts erhöht wird. Während die Aufgabe darin besteht, einen Artikel darüber zu schreiben, wie etwas zu tun ist, ist es eine gute Möglichkeit, den Kunden den Wert Ihres Kaufs zu zeigen, um sie zum weiteren Lesen zu ermutigen.
    • Verschlingen Sie Produktmagazine. Finden Sie heraus, wie die Menschen, die die Produkte verwenden, täglich mit ihnen arbeiten. Möglicherweise möchten sie eine Funktion haben, die ein bestimmtes Problem löst. Wenn Ihr Produkt die Lösung ist, muss es hervorgehoben werden.

Methode 2 von 4: Planen Sie das Layout Ihres Handbuchs


  1. Dinge trennen. Ob es sich um ein einfaches Blatt mit einer schrittweisen Anleitung oder ein Handbuch für eine 35-mm-Digitalkamera handelt, die Aufteilung der Texte in kleine Teile bietet mehrere Vorteile:
    • Sie können sich auf einzelne Teile eines Ganzen konzentrieren. Ziel ist es, den Benutzer mit dem Prozess des Lernens im Umgang mit dem Produkt vertraut zu machen. Wenn Sie möchten, sollten Sie die Funktionalität des Produkts in einem Lernprogramm am Ende des Handbuchs erläutern oder den Benutzer selbst davon überzeugen lassen.
  2. Folgen Sie einer logischen Reihenfolge. Es hilft beispielsweise nicht, die Funktionsweise des Blitzes einer Kamera zu beschreiben, bis Sie gezeigt haben, wie Sie das Objektiv anbringen, den Film einlegen, die Kamera einschalten und den Fokus einstellen. Dies ist sehr nützlich, wenn Sie mit dem Thema nicht vertraut sind.
  3. Verwenden Sie dies als Modell für Ihren Index.
  4. Überprüfen Sie Ihre Schritte. Wenn Sie die logischen Abschnitte definiert haben, überprüfen Sie sie, um sicherzustellen, dass Sie alles abdecken.
  5. Er sammelte seine Vorräte. Halten Sie die von Ihnen beschriebenen Elemente bereit und verwenden Sie sie wie im Handbuch beschrieben. Wenn Sie eine Papierbox erstellen, halten Sie Papier, Schere, Klebeband, Kleber und ein Lineal in der Hand. Wenn Sie auf einer Kamera schreiben, stellen Sie sicher, dass Ihre Kamera zerlegt ist. Wenn möglich, sollte das von Ihnen beschriebene Produkt jetzt wieder in der Verpackung sein.

Methode 3 von 4: Schreiben beginnen

  1. Schreiben Sie die Einführung. Dies gibt den Ton für Ihr gesamtes Handbuch an und gibt dem Benutzer eine Vorstellung davon, welche Art von Handbuch er lesen wird. Wird es leicht und lustig sein oder wird es direkt und bedeutungslos sein? Dies hängt von Ihrer Auflage ab. Es gibt viel mehr Raum, um mit Worten zu spielen, wenn Kinder lernen, eine Papierbox zu erstellen, als wenn sie versuchen, einem Arzt beizubringen, was bei Operationen an der offenen Brust zu tun ist. Geben Sie den Ton früh an und behalten Sie ihn im gesamten Text bei.
  2. Führen Sie jeden Schritt während der Eingabe aus. Dies verleiht Ihrem Schreiben nicht nur Ehrlichkeit und Authentizität, sondern stellt auch sicher, dass Sie nichts vergessen haben.
    • Wenn es aus irgendeinem Grund nicht möglich ist, die Schritte zu befolgen, denken Sie vollständig darüber nach und konsultieren Sie jemanden, der ein Experte ist.
  3. Nummerieren Sie die Schritte. Dies erleichtert es den Menschen, in die Fußstapfen zu treten, und kann später zurückkehren, wenn sie sich verlaufen.
    • Wenn Sie auf Papier schreiben, lassen Sie zusätzlichen Platz, um zwischen den einzelnen Schritten Ergänzungen vorzunehmen. Denken Sie daran, die Schritte neu zu nummerieren, wenn Sie einen weiteren Schritt dazwischen hinzugefügt haben.
  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 der Schritte achtlos befolgt.
    • Wenn es andererseits andere Kenntnisse gibt, die die Aufgabe des Benutzers einfacher oder interessanter machen, fügen Sie diese Kenntnisse hinzu.
  5. Prüfung. Verwenden Sie nur Ihre schriftlichen Anweisungen, um das zu tun, was Sie geschrieben haben. Wenn Sie Stellen finden, an denen die Anweisungen unvollständig sind, fügen Sie die erforderlichen Informationen hinzu. Wiederholen Sie diesen Schritt, bis Sie alle Schritte ausgeführt haben und das tun können, was Sie unterrichten, ohne sich Notizen zu machen.
    • Bitten Sie einen oder zwei Freunde, das Handbuch zu lesen. Schauen Sie genau hin, wenn sie lernen, das Produkt zu verwenden. Überprüfen Sie, ob sie das Handbuch vervollständigen können. Sehen Sie, wo sie verloren gehen, verwirrt sind oder versagen, wenn Sie versuchen, die Aufgabe abzuschließen. Hören Sie sich an, was sie zu sagen haben, und nehmen Sie dann Anpassungen gemäß den Kommentaren vor.
  6. Überprüfen Sie Ihr Handbuch. Sie möchten Ihrem endgültigen Prüfer (sei es eine Agentur oder Ihre Frau) kein Handbuch voller offensichtlicher Fehler schicken.

Methode 4 von 4: Formatierung

  1. Beginnen Sie auf der obersten Ebene. Wenn Sie alle Schritte detailliert beschrieben haben, lesen Sie in Ihrem Handbuch nach Kategorienüberschriften.
    • Titel sie und notieren Sie ihre Standorte.
  2. Schreiben Sie gegebenenfalls einen Index. Schauen Sie sich zum Beispiel an, wie wikiHow aufgebaut ist. Die Hauptseite bietet dem Besucher die Abschnittsüberschriften. Wenn Sie auf einen Abschnitt zugreifen, finden Sie eine Liste von Unterkategorien und dann in den Kategorien eine Liste von Artikeln. Je detaillierter Ihr Handbuch ist, desto mehr Kategorien und Unterkategorien benötigen Sie. Zum Beispiel benötigt ein einfacher Artikel wie How to Whistle keine Unterkategorien, während ein Text wie "How to Sculpt a Whistle" dies benötigt.
  3. Überprüfen Sie erneut. Ja, Sie haben das gesamte Material bereits einmal überprüft. Wenn Sie es erneut tun, werden Sie auf jeden Fall einige kleinere Fehler oder Stellen in Ihrem Handbuch finden, die noch nicht so klar sind.
    • Für ein umfassenderes Handbuch können Sie diese Gelegenheit auch nutzen, um alle untergeordneten Themen aufzuschreiben und diese Informationen zum Erstellen eines Index zu verwenden.
  4. Wähle einen Titel.

Tipps

  • Wenn Sie ein sehr detailliertes Handbuch schreiben, für das Kapitel erforderlich sind, z. B. ein Handbuch, in dem das Spielen der Flöte erläutert wird, müssen Sie zuerst alle Kapitel auflisten, z Auswahl einer Flöte, Montage und Pflege, Klangproduktion, Spielmethoden, Ihre erste Flöte, etc. Nur dann sollten Sie die Grundregeln für das Schreiben eines Handbuchs auf jedes Kapitel anwenden, da jedes wie ein separates Handbuch ist!
  • Auch wenn Ihnen etwas offensichtlich erscheint, schreiben Sie die Schritte auf! Es wird Ihnen helfen, etwas nicht zu übersehen, das der Benutzer nicht kennt. Es ist besser, zusätzliche Informationen zu haben, als wichtige Schritte zu überspringen.
  • Illustrieren Sie nach Möglichkeit die Anweisungen! Wenn Sie keine Bilder einfügen können, geben Sie Ihrem Schüler ein Beispiel. Zum Beispiel in Formatierung, Schritt 2 In diesem Artikel wird das Erscheinungsbild des WikiHow-Layouts verwendet, um zu veranschaulichen, wie ein Index erstellt werden kann.
  • Wenn möglich, bitten Sie jemanden, der keine Erfahrung auf diesem Gebiet hat, Ihr Handbuch zu lesen und jede Frage aufzuschreiben, die er hat! Dies wird Ihnen helfen, die Lücken zu füllen und Ihr Handbuch viel nützlicher zu machen.
  • Das Schreiben jedes Abschnitts auf einer separaten Seite (oder auf einem Computer) erleichtert die Bearbeitung. Sie können leicht neu anordnen, wenn Sie Platz zum Arbeiten haben und Ihre Bearbeitungsmarken finden. Lassen Sie auf einem Computer 3 bis 4 Zeilen (drücken Sie Eingeben mehrmals) zwischen jedem Schritt, damit Sie die Pausen finden können.

Andere Abchnitte ARTIKEL VIDEO Menchen, die unter Angtzutänden leiden, brauchen in den beten Zeiten Untertützung. Während de COVID-19-Aubruch fühlen ie ich wahrcheinlich beonder &#...

Wie man Nigiri Sushi macht

Marcus Baldwin

Kann 2024

Andere Abchnitte Wenn ie chon einmal in einem uhi-Retaurant waren, haben ie wahrcheinlich Nigiri-uhi oder uhi-Rei mit Meerefrüchten gegeen. Diee handwerkliche Gericht wird traditionell von Hand g...

Wir Empfehlen Ihnen