La valeur d'ajouter des images à la documentation technique

C'est cliché, mais l'image vraie-un peint mille mots. C'est un message important à se rappeler en écrivant n'importe quelle sorte de documentation d'utilisateur, telle qu'un guide d'installation ou un manuel d'instruction. Un document que l'utilisation judicieuse de marques des images et des diagrammes sera beaucoup plus facile de comprendre qu'un qui se composent entièrement de descriptions des textes.

J'ai observé il y a ces années de première main, quand un programmeur junior à une compagnie a été invité à mettre à jour le manuel d'installation de logiciel pour leurs contrôleurs de machine. Une des premières choses qu'il était de dépouiller loin toutes images de la récupération d'écran, ramenant le document entier au texte plat. « Ces images sont simplement idiotes ! » il a dit. « Ils prennent l'espace, et ils sont non nécessaires simplement. J'espère que n'importe qui qui lit ce document sera assez futé pour le figurer dehors. »

Ceci s'est avérée être une erreur énorme. Les techniciens qui ont dû employer le manuel ont eu un temps difficile se comprendre de ses instructions. Ils ont dû à plusieurs reprises demander la clarification, et l'un d'entre eux m'a indiqué que les descriptions pures des textes étaient trop encombrantes simplement à suivre. Elles étaient craintives d'employer ces instructions du tout, sachant qu'un pas simple pourrait fermer les contrôleurs sur un état irrécouvrable. C'était une situation laide tout autour.

Le problème était que ce programmeur n'a pas essayé de rendre des choses faciles pour les utilisateurs. Pour une chose, il n'a pas considéré que quelques techniciens n'étaient pas les anglophones indigènes, et qu'ils pourraient lutter avec les mots. D'une manière primordiale cependant, ce programmeur a attendu trop de ses assistances. Il a voulu ramener ces instructions à leurs bases nues, pensant qui seraient proportionnées. Il n'a pas considéré que même un intelligent, autrement le lecteur soigneux pourrait être tenté pour sauter par-dessus des instructions, ou annoterait au-dessus d'un certain détail critique. C'est un piège commun quand le temps est court, et quand les utilisateurs sont confrontés avec des pages et des pages de texte doux.

Quelques images soigneusement choisies, avec des légendes appropriées, peuvent aller un long chemin vers empêcher cela. Quand j'ai vu que le programmeur junior dépouillait loin toutes images de la récupération d'écran, je l'ai averti contre celui. « Ces images peuvent ne pas être strictement nécessaires, » I dit, « mais elles aider à clarifier beaucoup de détails. Pour une chose, ils montrent à l'utilisateur exactement quel bouton à pousser, ou quel fenêtre à choisir. Ceci facilite les instructions beaucoup pour comprendre, et réduit la probabilité d'une erreur humaine. » À ce jour, je souhaite qu'il ait observé mon avertissement.

Les utilisateurs assez intelligents pour comprendre le manuel, comme il ont été réclamés ? Certain-mais l'intelligence n'est aucune garantie contre l'erreur humaine. Les images pourraient-elles avoir été interprétées comme parlant vers le bas à l'utilisateur ? Peut-être-mais dans mon expérience, les utilisateurs sophistiqués répondent rarement de cette façon. Plutôt, la plupart d'entre eux semble comprendre la valeur que ces images apportent à la table. Peut-être elle est parce que la plupart d'entre elle sait que comme ce que d'être elle est frazzled et a encouragé le temps, et facilement des détails importants peuvent être perdus dans le texte.

Se rappeler-un ainsi les peintures d'image mille mots, et une récupération d'écran simple peut valoir la peine davantage que les pages une douzaine du texte. C'est une leçon qui vaut la peine l'étude.