Comment rédiger un excellent guide de l'utilisateur pour presque tout

Table des matières:

Anonim

Il était une fois, de solides manuels d'utilisation accompagnaient les nouveaux produits de toutes sortes, fournissant des instructions détaillées sur la façon d'apprendre toutes les fonctions et d'optimiser votre utilisation. De nos jours, toutefois, les guides de l'utilisateur fournis par l'usine sont beaucoup plus sommaires et souvent dans plusieurs langues, ce qui complique votre courbe d'apprentissage. Avoir un guide d’utilisation décent est une denrée précieuse et si vous savez comment l’écrire, c’est un talent très demandé. Il s’agit simplement de maîtriser quelques principes clés.

Articles dont vous aurez besoin

  • Microsoft Word ou autre programme de traitement de texte

  • Collection de clipart ou de photographies numériques

  • Logiciel de création de page Web simple

Décidez du format, des documents imprimés, des pages Web, des courriels ou une combinaison des deux. Une fois que vous écrivez dans un format, il est facile de le transférer dans un autre. Certaines personnes sont plus à l'aise pour lire un document imprimé qu'elles peuvent conserver et archiver. D'autres peuvent préférer une URL ou un lien vers un document sur votre site Web.

Soyez organisé, clair et concis. Anticipez et expliquez non seulement ce que les utilisateurs du produit vont faire, mais aussi ce qu'il ne faut pas faire. Vous devez écrire avec un oeil vers les deux.

Commencez par le début en ne dévoilant que les informations nécessaires de manière logique. Ecrire à voix active, pas passive. Gardez votre copie mince, en éliminant les mots superflus. Restez simple et méthodique.

Casser le texte avec des photos, des illustrations ou des diagrammes autant que possible. Faire en sorte que les lecteurs parcourent un texte sans fin avec des paragraphes monstrueux est un moyen sûr de les perdre. Les paragraphes et les pages longs et complexes conviennent aux manuels techniques mais pas aux simples guides d'utilisation. Gardez-le court et doux.

Avertissez le lecteur de ce qu'il ne faut pas faire à divers intervalles. Cela aide à minimiser les frustrations lors de l’apprentissage d’un nouveau produit ou d’une nouvelle application.

Fournissez aux lecteurs d’autres ressources qu’ils peuvent utiliser pour compléter votre guide.

Conseils

  • Écrivez en termes très simples. Ne supposez aucun niveau de connaissance. Ce qui vous semble facile et compétent ne l’est peut-être pas pour vos lecteurs. Utilisez des graphiques, des images clipart et des photos de haute qualité pour améliorer l'apparence de votre document et améliorer sa lisibilité. Gardez les paragraphes et les descriptions courts.

Attention

Ne supposez jamais que le lecteur est familiarisé avec le produit. Écris chaque guide comme s'il n'en avait jamais vu auparavant.