Das Intro legt das Handbuch. Erklären, wer das Dokument lesen sollte und wer es nicht , welche Informationen enthalten ist und unter welchen Umständen gemeint ist, ist es sinnvoll . Produkthandbücher, davon ausgehen, der Leser hat das Produkt gekauft haben und bereit ist, zu lernen, wie man es benutzt. Halten Sie die Einführung kurz , damit der Benutzer so schnell wie möglich auf die technischen Aspekte der manuellen bekommt .
Outlines
Technische Handbücher werden oft in Abschnitte und Unterabschnitte festgelegt , die auch eine ideale Kontur. Liste aller geplanten Abschnitten für die manuelle und enthalten detaillierte Unterabschnitten , wo nötig. Haben Sie keine Angst , um die Abschnitte neu zu ordnen , wie Sie Fortschritte sein nicht . Nur weil Sie von Thema A dachte zuerst , bedeutet nicht, der Leser muss zunächst , dass etwas von Informationen. Die endgültige Reihenfolge der Abschnitte soll die natürliche Entwicklung der Benutzer beim Lernen das Thema machen zu reflektieren. Verwenden Sie ein Substantiv und Verb in der Abschnittsüberschrift , um die Position und Aktion innerhalb der Sektion zu definieren.
Aktiv sein
Jeder Schritt in einem technischen Handbuch weist die Lesegerät mit einem Handgriff , der , wenn er mit anderen Schritten durchgeführt wird, führt zu einem vollständigen Aktion. Anzahl der Schritte oder Grafik " Kugeln" , die Schritte zeigen . In einigen Fällen können die Schritte Unterschritte durch Zahlen oder Buchstaben, die der grundlegenden Schritte identifiziert werden . Autoren haben einen Ermessensspielraum , wie sie Schritte zu identifizieren , sollten aber in diesem Handbuch einheitlich sein.
Keep It Simple
Verwenden Sie die einfachste Sprache, die angemessen vermittelt die Informationen. Sie wissen nicht, wer das Handbuch und wie gut sie in der Fachsprache des Themas versiert lesen werden . Keine hohe Details oder Einzelheiten nicht notwendig , um die Informationen zu vermitteln. Lange Sätze , mehr als 20 Wörter , neigen dazu, die Leser abzuschrecken . Sätze von weniger als 10 Worte können das Dokument geben einen Hacken Sound.
Veranschaulichen die Themen
Mit Fotografien, Diagramme oder Grafiken , um das Thema zu veranschaulichen . Diese Bilder können wert sein als tausend Worte und neigen dazu, das Auge des Lesers zu ziehen. Wenn Grafikbilder sind nicht möglich , verwenden Sie beschreibende Sätze. Verbale Beispiele und Abbildungen erlauben auch der Leser , das Thema zu visualisieren.