Slipping Zwischen den Abdeckungen eines Technical Document

Wenn Sie eine längere Bedienungsanleitung vorbereiten, sind alle Informationen Leser benötigen und die Informationen leicht zu finden. Im Folgenden sind Richtlinien für das, was aufzunehmen.

Inhaltsverzeichnis

Jedes Mal, wenn das Handbuch mehr als 15 Seiten ist, umfassen ein Inhaltsverzeichnis Leser leicht zu finden, was sie brauchen. Verwenden Sie Führer (.......) Die Themen auf die Seitenzahlen zu verbinden, damit die Leser die Augen über die Seite ausführen können.

Einige Autoren verwenden interne Kapitelnummern. Beispielsweise Kapitel 1 1-1, 1-2, 1-3, numeriert 1-4- Kapitel Februar 02-01 numeriert, 2-2, 2-3, 2-4 und so weiter. Dies unterscheidet sich von fortlaufende Numerierung (1, 2, 3, 4). Verwenden Sie Zahlen interne Kapitel, wenn Sie antizipieren Aktualisierung ein oder mehrere Kapitel. Dadurch hält, so dass Sie von Umnummerierung (und Neudruck) das gesamte Handbuch.

Glossar

Wenn es ein Hinweis ist, dass Ihre Leser die ganze Terminologie im Handbuch nicht verstehen können, umfassen ein Glossar am Ende. Definieren eines Wortes das erste Mal, wenn Sie es nicht immer ausreichend ist, verwendet werden, da die Leser in Ihrem Handbuch aus der Deckung nicht gelesen zu decken, als ob es der große amerikanische Roman ist. Sie werden es als Referenz verwenden, wenn sie eine Frage haben.

Wenn Sie Online-Hilfe schreiben, verwenden Pop-up-Fenster für Bedingungen. Wenn Sie Web-Dokumente schreiben, einen Link zum Glossar erstellen.

Index

Nicht alle Handbücher benötigen einen Index. Der Inhalt des Handbuchs ist der Gating-Faktor, nicht die Länge. Versetzen Sie sich in die Denkweise des Lesers und fragen: Wenn ich dieses Dokument gelesen haben, wäre ein Index hilfreich sein? Wenn Sie einen Index denken Sie helfen würde, umfassen ein. Sehr empfindlich auf die logischen Suchwörtern, die der Leser für aussehen.

Hier ist eine Geschichte einer Frau, die ein neues Auto gekauft. Sie fuhr etwa 25 Meilen, wenn sie etwas Glas lief über und bekam einen platten Reifen. Die Frau wollte den Reifen selbst zu ändern und zog die Bedienungsanleitung. Sie überprüfte unter den folgenden Buchstaben im Index:

• f für Flach
• t für Reifen
• j Jack
• c für den Wandel

Die Frau konnte nicht die Informationen finden, und konnte nicht glauben, dass das Handbuch eine so wichtige Eintrag vernachlässigt. Sie gab schließlich auf und rief die American Automobile Association (AAA). Als sie nach Hause zurückkehrte, begann sie jeden Indexeintrag zu überprüfen. Ja, es war ein Eintrag für einen platten Reifen zu verändern. Es war unter h für "Wie zu ändern..."

Wenn für das Web schreiben, umfassen eine Sitemap oder etwas Gleichwertiges.

Fehlerbehebung

Egal, wie gut Sie ein technisches Handbuch schreiben, werden die Leser Probleme haben. Die Möglichkeit, diese Probleme zu lösen ist es, einen Abschnitt zur Fehlerbehebung enthalten. Tabelle 1 ist ein großer Abschnitt zur Fehlerbehebung aus der Kodak DC215 Digitale Zoomkamera Benutzerhandbuch. Es bricht das Problem, Ursache und Lösung.

Tabelle 1: Fehlerbehebung bei einem Kodak DC215 Digitale Zoomkamera

Problem	Ursache	Lösung
Das Bild ist zu hell.	Flash ist nicht erforderlich.	Ändern Sie auf Auto-Blitz. Siehe Seite 13.
Das Thema war zu nahe, wenn der Blitz verwendet wurde.	Gehen Sie so weit mindestens 1,6 ft (0,5 m) zwischen der Kamera und dem Objekt.
Der Lichtsensor ist abgedeckt.	Halten Sie die Kamera so Ihre Hände oder andere Gegenstände nicht den Lichtsensor abdecken.
Die Belichtungskorrektur ist falsch eingestellt.	Verringern Sie die Belichtungskorrektur. Siehe Seite 14.
Die gespeicherten Bilder sind beschädigt.	Die Kamera-Speicherkarte entfernt wurde, wenn die Bereitschaftsanzeige blinkte.	Stellen Sie sicher, dass die Bereitschaftslampe blinkt nicht, bevor Sie die Karte entfernen.
Bilder die Anzahl der verbleibenden nicht verringert nach einer Aufnahme.	Bildauflösung und Bildqualitätseinstellungen nehmen Sie nicht genügend Platz, um das Bild verbleibende Anzahl zu verringern.	Die Kamera funktioniert normal. Weiter Bilder aufnehmen.
Das Bild ist nicht klar.	Das Objektiv ist verschmutzt.	Reinigen Sie das Objektiv. Siehe Seite 65.
Thema war zu schließen, wenn Bild aufgenommen wurde.	Stehen mindestens 1,6 ft (0,5 m) im Weitwinkel, 3,3 ft (1m) in Tele.
Das Motiv oder die Kamera bewegt, während das Bild aufgenommen wurde.	Halten Sie die Kamera ruhig, bis das Bild aufgenommen wird.
Das Motiv ist zu weit weg für den Blitz effektiv zu sein.	Gehen Sie so das Motiv weniger als 10 Fuß (.3M) entfernt.

Wenn Sie einen Abschnitt zur Fehlerbehebung enthalten - oder häufig gestellte Fragen (FAQs) in einem elektronischen Dokument - ersparen Sie die Leute an der Help-Desk-Blumenkohl Ohr. Hier ist, wie zu durchdenken, was im Abschnitt zur Fehlerbehebung enthalten:

• Wenn dies die erste Ausgabe des Handbuchs ist, denken Sie an die Fragen oder Probleme Ihre Leser haben kann. Achten Sie darauf, Fragen enthalten, die Tester bei Alpha und Beta-Tests hatte.
• Wenn dies eine zweite oder dritte Auflage ist, fragen Sie die Leute an der Help-Desk für die am häufigsten gestellten Fragen.

Feedback-Formular

Um die Qualität Ihrer Handbuch für den nächsten Druck verbessern und die Qualität Ihrer eigenen Schreiben zu verbessern, umfassen ein Feedback-Formular. Diese Form bietet dem Leser eine Chance, Sie wissen zu lassen, was sie wollten, und wusste nicht, wie über das Handbuch und Sie von Fehlern wissen zu lassen, sie zu finden.

Sie nicht gestört werden, wenn Sie hauptsächlich negatives Feedback bekommen. Leser, die mit der manuellen zufrieden sind in der Regel nicht die Mühe zu reagieren. Leser, die nicht zufrieden sind, wollen Sie wissen zu lassen. Nehmen Sie dieses Feedback als konstruktiv und verwenden Sie es als Chance, Ihre Schreibtechnik zu verbessern. Tun Sie es nicht persönlich.