Glisser entre les pages d'un document technique

Lorsque vous préparez un manuel d'utilisation prolongée, inclure tous les lecteurs de l'information ont besoin et font l'information facile à trouver. Voici des lignes directrices pour les éléments à inclure.

Table des matières

Dès que le manuel est de plus de 15 pages, inclure une table des matières pour aider les lecteurs à trouver facilement ce dont ils ont besoin. Utilisez dirigeants (.......) Pour relier les sujets sur les numéros de page afin que les lecteurs peuvent exécuter leurs yeux à travers la page.

Certains auteurs utilisent des numéros de chapitre internes. Par exemple, le chapitre 1 est numérotée 1.1, 2.1, 03.01, 1-4- chapitre 2 est numérotée 1.2, 2.2, 3.2, 4/2, et ainsi de suite. Ceci est différent de la numérotation séquentielle (1, 2, 3, 4). Utilisez les numéros de chapitre internes lorsque vous prévoyez de mettre à jour un ou plusieurs chapitres. Cela vous empêche de renumérotation (et la réimpression) l'ensemble du manuel.

Lexique

Si il ya un soupçon que vos lecteurs peuvent ne pas comprendre toute la terminologie dans le manuel, un glossaire à la fin. Définir un mot la première fois que vous utilisez, il ne suffit pas toujours parce que les lecteurs ne liront pas votre manuel d'une couverture à comme si elle est le grand roman américain. Ils vont l'utiliser pour référence quand ils ont une question.

Si vous écrivez aide en ligne, utiliser des fenêtres pop-up pour les termes. Si vous écrivez des documents Web, de créer un lien vers le glossaire.

Index

Pas tous les manuels ont besoin d'un index. Le contenu du manuel est le facteur de déclenchement, pas la longueur. Mettez-vous dans l'esprit du lecteur et demandez: Si je lis ce document, serait un indice utile? Si vous pensez que l'indice pourrait vous aider, comprendre un. Soyez très sensible aux termes de recherche logiques que le lecteur peut rechercher.

Voici une histoire d'une femme qui a acheté une nouvelle voiture. Elle a conduit à environ 25 miles quand elle a couru sur du verre et a crevé un pneu. La femme voulait changer le pneu elle-même et a sorti le manuel du propriétaire. Elle a vérifié sous les lettres suivantes à l'indice:

  • F pour plat
  • t pour les pneus
  • j pour Jack
  • c pour changer

La femme ne pouvait pas trouver les informations et ne pouvait pas croire que le manuel négligé une telle entrée importante. Elle a finalement abandonné et a téléphoné à l'American Automobile Association (AAA). Quand elle est retournée chez elle, elle a commencé la vérification de chaque entrée d'index. Oui, il y avait une entrée pour changer un pneu à plat. Il était sous h pour "Comment changer..."

Lors de l'écriture pour le Web, inclure un plan du site ou quelque chose d'équivalent.

Dépannage

Peu importe la façon dont vous écrivez un manuel technique, les lecteurs auront des questions. La façon d'aborder ces questions est d'inclure une section sur le dépannage. Tableau 1 est une section de dépannage de la grande Kodak DC215 Zoom numérique emploi de l'appareil. Il éclate le problème, la cause et la solution.

Tableau 1: Dépannage d'un appareil photo Kodak DC215 Zoom numérique

Difficulté

Cause

Solution

L'image est trop claire.

Flash est inutile.

Changer pour Flash automatique. Voir page 13.

Le sujet était trop près lorsque le flash a été utilisé.

Déplacez donc il ya au moins 1,6 pi (0,5 m) entre l'appareil et le sujet.

Le capteur de lumière est couvert.

Tenez l'appareil photo de sorte que vos mains ou d'autres objets ne couvrent pas le capteur de lumière.

La compensation de l'exposition est mal réglé.

Diminuez la compensation d'exposition. Voir page 14.

Les photos stockées sont endommagées.

La carte mémoire de l'appareil photo a été supprimée lorsque la lumière clignotait.

Assurez-vous que le voyant Prêt ne clignote pas avant de retirer la carte.

Nombre d'images restantes ne diminue pas après avoir pris une photo.

Paramètres image résolution et la qualité ne prennent pas suffisamment d'espace pour diminuer le nombre d'images restantes.

L'appareil photo fonctionne normalement. Continuez à prendre des photos.

L'image est pas clair.

L'objectif est sale.

Nettoyez l'objectif. Voir page 65.

Sujet était trop proche lors de photo a été prise.

Tenez-vous à moins de 1,6 pi (0,5 m) en grand angle, 3,3 pieds (1m) en téléobjectif.

Sujet ou l'appareil a bougé lors de la prise de vue.

Tenez caméra stable jusqu'à ce que la photo est prise.

Le sujet est trop éloigné pour que le flash soit efficace.

Déplacez sorte que le sujet est à moins de 10 pieds (.3m) à l'abri.

Lorsque vous incluez une section sur le dépannage - ou des questions fréquemment posées (FAQ) dans un document électronique - vous épargne les gens à l'oreille Help desk de chou-fleur. Voici comment faire pour réfléchir à ce qu'il faut inclure dans la section de dépannage:

  • Si ceci est la première édition du manuel, pensez aux questions ou des problèmes à vos lecteurs peuvent avoir. Assurez-vous d'inclure des questions que les testeurs ont eu cours alpha et bêta-test.
  • Si cela est une deuxième ou une troisième édition, demander aux gens au Help Desk pour le questions les plus fréquemment posées.

Formulaire de commentaires

Pour améliorer la qualité de votre manuel pour l'impression suivante et d'améliorer la qualité de votre propre écriture, inclure un formulaire de rétroaction. Cette forme donne aux lecteurs une chance de vous faire savoir ce qu'ils aimaient et aimaient pas sur le manuel et laissez vous connaissez des erreurs qu'ils ont trouvés.

Ne pas être dérangé si vous obtenez la rétroaction essentiellement négatif. Les lecteurs qui sont heureux avec le manuel général ne se soucient pas de répondre. Les lecteurs qui ne sont pas heureux veulent que vous sachiez. Prenez cette rétroaction constructive et l'utiliser comme une occasion d'améliorer votre technique d'écriture. Ne pas le prendre personnellement.


» » » » Glisser entre les pages d'un document technique