L’Importance de l’ajout d’Images à la Documentation technique

C’est le cliché?, mais l’image truea peindre un millier de mots. C’est important de se rappeler lors de l’écriture de toute sorte de documentation de l’utilisateur, comme un guide d’installation ou d’un manuel d’instruction. Un document qui fait judicieux des images et diagrammes sera beaucoup plus faciles à comprendre que celle qui est composée exclusivement de descriptions de texte.

J’ai observé cette première main ans plus tôt, quand un programmeur junior à une compagnie a demandé de mettre à jour le manuel d’installation de logiciels pour les contrôleurs de leurs machine. Une des premières choses qu’il a fait a été de déposséder de loin toutes les screen capture images, réduisant l’intégralité du document texte brut. Il a dit « ces images sont simplement stupide! ». « Ils occupent un espace et nous ne devons juste eux. J’ai confiance que quiconque lit ce document sera assez intelligent pour le comprendre. »

Cela s’est avéré être une erreur énorme. Les techniciens qui devaient utiliser le Manuel avaient un moment difficile, making sense of ses instructions. Ils devaient demander à plusieurs reprises des éclaircissements, et l’un d’eux m’a dit que les descriptions de texte pur étaient tout simplement trop lourdes à suivre. Ils ont peur d’utiliser ces instructions à tous, tout en sachant qu’un seul faux-pas pourrait verrouiller les contrôleurs dans un état non recouvrable. C’était une situation laide tout autour.
Le problème était que ce programmeur n’a pas essayer de faire les choses faciles pour les utilisateurs. D’une part, il n’a pas de considérer que certains techniciens n’étaient pas maternelle anglaise, et qu’ils pourraient luttent avec le libellé. Plus important encore bien, ce programmeur attend trop de son auditoire. Il voulait réduire ces instructions à leurs bare essentials, pensant que serait adéquat. Il n’a pas examiné que même un lecteur intelligent, sinon attentif pourrait être tenté de sauter par-dessus les instructions, ou serait oublieuses de détail critique. Il s’agit d’un écueil commun lorsque le temps est compté, et quand les utilisateurs sont confrontés à des pages et des pages de texte fade.

(Pour être parfaitement honnête, je pense que ce membre essayait juste faciliter son travail. Je soupçonne qu’il ne voulait pas donné la peine avec mise à jour des images, donc il a décidé de les déposséder juste là. Je ne peux pas prouver cela, bien entendu, mais il semble probable.)

Quelques images soigneusement choisis, avec des légendes convenables, peuvent passer un long chemin vers la prévention qui. Quand j’ai vu que le programmeur junior était décapage de loin toutes les images de capture de l’écran, je lui averti contre cela. « Ces images ne soient pas strictement nécessaires, » je l’ai dit, mais ils aident à clarifier beaucoup de détails. D’une part, elles montrent l’utilisateur exactement quel bouton de pousser, ou quelle fenêtre Sélectionner. Cela rend les instructions beaucoup plus facile à comprendre et réduit la probabilité d’une erreur humaine. » Je tiens à ce jour, qu’il avait entendu mon avertissement.

Étaient les utilisateurs suffisamment intelligents pour comprendre le manuel, comme il le prétend ? Certainlybut intelligence n’est aucune garantie contre l’erreur humaine. Pourraient les images ont été interprétées comme parler de l’utilisateur vers le bas ? Perhapsbut d’après mon expérience, utilisateurs sophistiquées répondent rarement de cette façon. La plupart d’entre eux semble plutôt comprendre la valeur que ces images apportent à la table. C’est peut-être parce que la plupart d’entre eux savent ce que c’est que d’être fatigué et pressé de temps et comment facilement important détails peuvent être perdus dans le texte.

Tellement remembera portrait peint un millier de mots et une capture d’écran unique peut être une valeur de plus d’une douzaine de pages de texte. C’est une leçon qui vaut la peine d’apprentissage.