Tipps zum Schreiben Bedienungsanleitungen

Vermeidung verwirrenden Jargon und die Konzentration auf eine klare, genaue Beschreibung der Technologie, die Sie beschreiben, können Sie eine einfache , intuitive Benutzerhandbuchsunabhängig von dem Thema Natur zu schaffen . Vor dem Schreiben das Handbuch , bereiten Sie die Inhalte sorgfältig planen, wie Sie es in Lehr- Prosa entwickeln und beurteilen die Detailebene erforderlich. Immer darauf achten, nicht den Leser fühlen sich durch komplexe , überarbeitet Beschreibung überschwemmt . Erste Eindrücke

Eine hässliche , schwer, bunten Handbuch mit vielen Abbildungen, Witze und unnötige Details werden die meisten Leser abschrecken , auch auf die gewünschte Seite zu öffnen. Als solcher, die Abdeckung , Größe und Design des Handbuchs und die ersten paar Seiten eine wichtige Rolle spielen . Erstellen Sie eine einfache , informative und Einführung Abdeckung und halten den allgemeinen Leser im Auge zu allen Zeiten. Eine effektive Anleitung wird eine gut geschriebene , leicht zu bedienende Inhalte Seite mit einer genauen Liste der relevanten Kapitelüberschriften , Seitenzahlen und Unterabschnitte für die schnelle und einfache Suche haben .
Details von Design und Layout

Hardcopy- Benutzerhandbücher mit einfachen, geräumigen , schwarz -weiß- Layouts sind am einfachsten zu lesen und zu verdauen . Ein Handbuch sollte genug Informationen, damit der Leser alle notwendigen Aufgaben, die mit dem Produkt oder Aufgabe in Frage (z. B. Anweisungen zu arbeiten und zu reparieren, eine Mikrowelle ) zugeordnet vervollständigen enthalten , aber es sollte nicht so groß und technisch detailliert, dass wird es sein, schwer und somit schwierig, um das Haus zu transportieren. Bemühen Sie sich um die richtige Balance zwischen Design und Inhalt zu erreichen; nicht in die Falle der Schaffung einer schön gestalteten Handbuch mit schlecht durchdachte Konzepte und schlechte Schreib fallen . Das gleiche Prinzip gilt für alle Diagramme und Bilder : Halten Sie sie einfach, klar, auf der Seite gut positioniert und relevant. PNG -Dateien haben kleine, überschaubare Dateigrößen , aber denken Sie daran , das wiedergegebene Bild für Klarheit und Lesbarkeit zu überprüfen.
Know Your Subject

Wir können nicht alle verwendet die gleiche Mikrowelle, Computer oder Bleistiftspitzer . Entwickeln Sie eine klare Vorstellung davon, wie ein oder zwei Modelle der Ausrüstung arbeiten, dann beginnen zu überlegen, wie gut Sie können jede Komponente beschreiben denken. Verwenden Sie Standard- Terminologie , und nie machen Namen für die verschiedenen Komponenten. Behandeln potenzielle Leser , als ob sie Kenntnis von der Position auf einer bestimmten Ebene müssen aber zusätzliche Hilfe mit den Details; sonst könnte man riskieren, sie zu beleidigen die Intelligenz . Fügen Sie so viele Details wie möglich, aber es ist einfach zu präsentieren und in einer freundlichen, hilfsbereiten Art und Weise .
Farbcodierung

Wenn Sie denken, Sie können mit dem Grundhandfügen Sie erstellt haben, sanft -Farbcode bestimmte Tatsachen und verknüpfen sie den gesamten Text. (Verwenden Sie keine fluoreszierende rosa , halten Sie sich an Licht, einfache Farben wie Pastell Grün und Blau . ) Diese Verknüpfung ist eine Art von " Indizierung " und macht Gebrauch von Erkenntnis der Menschen und die Psychologie des Lesens. Es erlaubt ihnen, ein besseres Verständnis für die Funktionsweise und die Funktionen eines Gerätes anstatt ihnen eine simple oder "flach" Landschaft des Denkens zu entwickeln.
Verschiedenen Stile der Prosa

Entwicklung und Verbesserung der Effektivität Ihrer Bedienungsanleitung durch das Experimentieren mit leicht unterschiedlichen Schreibstile . Brechen Sie jeden Abschnitt und Unterabschnitt nach unten in einen kurzen beschreibenden Absatz für die Einführung , was eine grundlegende Beschreibung der beteiligten Elemente , und fügen Sie eine Schritt-für -Schritt- Satz von Anweisungen nach dem ersten Absatz , den Leser genau sagen , wie eine bestimmte vervollständigen Reparatur oder Funktion. Diese Technik hält das Handbuch fließenden und interessant , während das meiste Wissen in kurzer Zeit verliehen wird. Selbst wenn man versucht fortgeschrittene Techniken für das Erstellen einer Bedienungsanleitung, immer wieder zurück zu den Grundlagen : Prüfen Sie die Rechtschreibung , Grammatik , Konsistenz, Sprache und Formatierung auf einer regelmäßigen Basis

.