Vue d’ensemble
Les documents inachevés d’utilisateur déçoivent vos lecteurs. Deux attitudes de beaucoup d’auteurs techniques ont comme conséquence les documents inachevés d’utilisateur. Ces deux attitudes sont :
. « Chacun sait que », et
. « L’utilisateur peut figure le dehors »
Cet article décrit ces attitudes et méthodes actuelles pour les surmonter. Le résultat est des documents d’utilisateur plus efficace et plus d’utilisateurs satisfaits.
1. « Chacun sait cela »
Le « chacun sait que » l’attitude fait des prétentions au sujet de la connaissance de votre lecteur. Ces prétentions causent votre peine de lecteur.
Voici un exemple d’un possible « chacun sait cela. » Vous savez ceci :
Tomates. La plupart d’entre nous les maintient dans un réfrigérateur. Cependant, le stockage de elle dans un réfrigérateur ruinera le goût et la nutrition des tomates. Des tomates devraient être stockées sur un compteur de cuisine à la température ambiante, jusqu’à ce qu’elles soient coupées. Couper une fois, des tomates devrait alors être stocké dans le réfrigérateur.
Est-ce que chacun sait cela ? Que supposez-vous que chacun sait votre produit ?
Parfois vos documents d’utilisateur doivent surmonter une expérience précédente d’utilisateur. Chacun pense qu’ils savent correctement (sans risque) coupent un barbecue… qu’ils pas ! La méthode d’arrêt sûr est décrite dans la plupart des documents d’utilisateur de barbecue, mais elle « n’est pas annoncée » (avec force présenté) dans les documents d’utilisateur.
Il est rarement vrai que « chacun sache cela ». Juste parce que vous trouvez quelque chose être évident, il ne signifie pas que chacun sait que quelque chose.
Voici un autre exemple : Comment employez-vous shampooing d’a (produit combiné – `2 dans un le’) et le conditionneur de cheveux ? Shampooing, le shampooing est massé dans le cuir chevelu et immédiatement rincé. En conditionnant les cheveux, le conditionneur est massé dans les cheveux, et reste allumé les cheveux pendant environ deux minutes. Maintenant, ce qui font les utilisateurs font pour le produit combiné : rincer rapidement, ou laisser le produit rester dans les cheveux ?
Si vous avez « chacun sait cela » attitude quand vous écrivez, vous tendra à laisser le matériel dehors nécessaire de votre document d’utilisateur. Vous ferez un service à vos lecteurs, et à votre écriture.
Quand dans le doute si « chacun sait quelque chose, » supposer qu’ils pas. Puis,
. ajouter un certain texte expliquant la matière, ou
. dire au lecteur où trouver l’information qui expliquera la matière
Une autre attention
Faire attention au sujet d’assumer cela juste parce que vous avez expliqué quelque chose plus tôt dans votre document d’utilisateur, votre lecteur se rappellera (ou même avoir lu) cette information. Il est rare pour que les utilisateurs lisent la documentation de produit du début à la finition.
Quand dans le doute, ajouter une référence à cette première information (de fond). Dire à votre lecteur où la trouver, ou lui fournir un lien si votre document est électronique.
Voici une expérience de pensée : Vous êtes un utilisateur des produits : Combien de fois lisez-vous la documentation de produit du début à la finition ? Si vous toujours, alors demander à quelques autres certains. (La grande chose au sujet de ce fait que les utilisateurs ne lisent pas la documentation du début à la finition – est qu’elle a comme conséquence la grande flexibilité dans l’écriture, composant et éditant la documentation de produit.)
2. « L’utilisateur peut figure la dehors »
L’utilisateur ne veut pas devoir figurer des choses dehors. L’utilisateur ne lit un roman de mystère ou aucune autre littérature, où he/she veut penser à ce que se produit.
Quand quelqu’un emploie votre produit, ils l’emploient pour satisfaire leurs propres besoins. Votre produit peut être central à votre vie, mais à vos utilisateurs, votre produit est des moyens à une extrémité. Et ils ne veulent pas devoir déchiffrer votre documentation de produit.
Voici un exemple simple. Un E-mail vous indique qu’appeler quelqu’un, mais le message omet le nombre de téléphone. On s’attend à ce que vous trouviez le nombre de téléphone sur vos propres. L’auteur a probablement su le nombre de téléphone, mais à gauche lui dehors. Cette « inadvertance de l’information » devient chère au sein d’une compagnie quand l’E-mail est envoyé à beaucoup d’employés… chacun qui recherche le nombre de téléphone sur ses propres.
Mon animal de compagnie préféré irritent : dates. Dans la mémoire récente nous « survécus » la transition Year-2000. Pourtant nous écrivons toujours des dates sans soin. Nous employons « le ″ 06 pendant une année, au lieu « de 2006. » Quand voyons-nous des choses comme « 07/11/04 ″ ce qui est la date où il se rapporte ? Est lui les 4 novembre 2007,11 avril 2007, ou une autre permutation des nombres. Les normes pour le format des dates changent autour du monde. C’est un exemple des deux prétentions :
. « chacun sait cela » (parce qu’il y a un format de date « standard » – il n’y a pas), et
. « l’utilisateur peut le figurer dehors » (en voyant si mes autres dates fournissent des indices au format)
Ne pas omettre les choses pour l’utilisateur/lecteur à la figure pour lui-même. Cela te prend seulement quelques moments pour inclure le matériel vos besoins de lecteur, et sauvera beaucoup de lecteurs beaucoup d’heures en figurant des choses dehors.
Le faire :
La littérature d’écriture vous indique que « connaître votre lecteur. » Voici où vous employez cette connaissance pour améliorer votre écriture.
L’un ou l’autre
. trouver quelqu’un qui est comme votre lecteur prévu, ou
. « faire votre meilleur » pour agir comme votre lecteur prévu (vous pouvez le faire si vous avez besoin)
La lecture et en évaluant le document, rechercher les endroits où
. l’écriture suppose que « chacun sait cela »
. l’écriture s’attend à ce que le lecteur puisse « le figurer dehors »
. l’écriture fait les sauts que votre lecteur ne peut pas suivre
. l’écriture fait la prétention que le lecteur a lu et s’est rappelé le document entier
Fixer ces endroits. Elle prend seulement quelques mots ou phrases.
Chacun sera plus heureux.