Comment rédiger des instructions informatiques efficaces

Laura est rédactrice technique. Elle aime jouer du piano, voyager, faire des beaux-arts et fabriquer des bijoux.

Mettez-vous à la place du lecteur

Pour rédiger de meilleures instructions ou procédures informatiques, vous devez d’abord vous mettre à la place du lecteur ou de l’utilisateur.

L’utilisateur ne sait rien de votre site Web ou de votre logiciel et ne prendra pas (et ne devrait pas avoir besoin de) le temps de lire l’ensemble des instructions avant de commencer son travail. L’utilisateur utilise simplement votre produit pour atteindre un de ses objectifs (effectuer un achat, rechercher des informations, etc.).

Ce que vous devez comprendre à propos de vos lecteurs

Tout d’abord. Vous devez accepter le fait que vos lecteurs ne voudront probablement pas lire ce que vous avez écrit. Cela signifie que pour rédiger des instructions efficaces et utiles, vous devez d’abord accepter toutes les vérités suivantes :

• Vos lecteurs/utilisateurs ne veulent pas apprendre à utiliser votre produit/service ; ils veulent accomplir une tâche ou un objectif qui leur sont propres.
• Ils n’ont lu la documentation qu’en désespoir de cause après l’échec de ce qu’ils ont essayé de faire.
• Ils sont maintenant frustrés.
• Ils ne savent pas comment procéder pour accomplir leur objectif/tâche.

Vos lecteurs sont déjà frustrés

En tant que rédacteur d’instructions, vous commencez dans une mauvaise situation car les utilisateurs (que vous ne connaissez probablement pas et que vous ne rencontrerez jamais) sont déjà frustrés par votre produit/service au moment où ils se tournent vers les instructions que vous avez écrites. comment accomplir chaque tâche. Alors, soyez bienveillant avec eux et donnez-leur des instructions claires, concises, définitives, précises qui les remettent sur le chemin de l’atteinte de leur objectif le plus rapidement possible : C’est une forme de bon service client !

Le modèle devient assez simple et s’applique à la plupart des types d’instructions pas à pas, pas seulement aux instructions informatiques.

Une note avant de commencer à rédiger des instructions

Avant de commencer à écrire des instructions, vous devez savoir dans quel style elles doivent être écrites.

Demandez autour de vous un « guide de style maison » (le service marketing est un bon point de départ) et obtenez la dernière copie du Microsoft Manual of Style for Technical Publications. Mais qu’en est-il des utilisateurs d’Apple Macintosh ? Soit ils sont déjà familiarisés avec le style d’écriture de Microsoft, soit ils ne seront pas déroutés car vous mettrez en œuvre le style d’écriture de manière cohérente tout au long du manuel d’instructions.

Un dictionnaire et un thésaurus ne font jamais de mal non plus, bien que ceux-ci puissent également être trouvés sur Internet, et lesquels utiliser doivent être spécifiés dans le House Style Guide. En cas de doute, utilisez Merriam Webster, le « gold standard » des dictionnaires.

La formule magique pour écrire des instructions

La formule magique : la nouvelle méthode

Vous connaissez maintenant l’une des bases de la communication technique, que vous soyez ou non un rédacteur professionnel. Elle est également connue sous le nom de méthode donnée-nouvelle parce que vous commencez par dire au lecteur quelque chose qu’il sait déjà, une « donnée », puis vous lui donnez quelque chose de « nouveau ». Des titres/en-têtes clairs sont les clés du succès ici.

Notez que cette méthode aide le lecteur/utilisateur déjà frustré à comprendre rapidement si votre procédure particulière s’applique à sa situation parce que vous lui avez donné un titre clair, s’il est au bon point de départ (parce que vous lui avez dit par où commencer), quoi faire à ce moment-là, et à quoi devraient ressembler les résultats.

Vous êtes maintenant prêt à écrire de bonnes instructions

Maintenant que vous connaissez les règles d’écriture, vous pouvez commencer à écrire les instructions en gardant toujours à l’esprit le point de vue de l’utilisateur.

Faites défiler pour continuer

Vous intitulez les instructions « Comment faire la tâche ABC », en vous assurant que les instructions sous ce titre ont toutes à voir avec l’accomplissement de la tâche ABC (et rien d’autre). Vous êtes maintenant prêt à écrire les instructions elles-mêmes.

La première chose à faire est d’orienter les utilisateurs : leur dire où ils se trouvent et ce qu’ils doivent voir sur leur écran, comme le nom de la fenêtre qu’ils doivent regarder. Ensuite, dites-leur quel(s) bouton(s) appuyer sur la fenêtre actuelle et/ou quel texte ils doivent taper dans quel(s) champ(s). Ensuite, dites-leur comment se rendre à l’étape/au lieu suivant et décrivez ce qu’ils doivent voir à l’écran lorsqu’ils entreprennent cette action.

Par exemple:

1. du Fenêtre principale, sélectionnez toutes les options que vous souhaitez activer. Cliquez sur D’ACCORD. la Deuxième fenêtre apparaît, indiquant l’état actuel des options que vous avez sélectionnées.
2. sur le Deuxième fenêtrevérifiez que toutes les options sélectionnées sont correctes.

• Si toutes les options sont correctes, cliquez sur Activer les options. la Troisième fenêtre apparaît.
• Si les options ne sont pas toutes correctes, cliquez sur retour pour revenir à la Fenêtre principale et sélectionnez différentes options.

Nettoyage final

Lorsque vous avez terminé d’écrire, exécutez le vérificateur d’orthographe et de grammaire, puis demandez à un ou plusieurs experts en la matière (PME) – des personnes qui connaissent le produit – de réviser le document. Apportez des modifications, relancez le vérificateur d’orthographe et de grammaire et demandez à quelqu’un de relire/modifier le document.

Une fois que vous avez entré les modifications apportées par l’éditeur, vous avez généralement terminé (sauf si votre entreprise dispose d’un processus formel de publication de documents, que vous devez suivre).

Notez que les modifications apportées par les experts en la matière et l’éditeur (l’exportation de la matière sur le libellé et le style exacts) doivent être acceptées presque sans aucun doute : il est leur emploi pour connaître leur domaine d’expertise. Si vous fortement n’êtes pas d’accord avec une modification, portez-la ensuite à l’attention de la PME ou de l’éditeur, selon le cas. Sinon, effectuez les modifications suggérées.

Testez la convivialité de vos instructions

Une fois que vous avez un très bon brouillon, recrutez plusieurs personnes pour tester vos instructions – pour les parcourir du début à la fin et noter (et vous permettre de noter) tous les domaines dans lesquels elles se perdent ou sont confuses ou où les instructions sont erronées.

Idéalement, les testeurs d’utilisabilité devraient être les vrais clients/utilisateurs du produit/site Web que vous avez documenté. Cependant, à la rigueur, recruter quelques personnes du bureau qui ne connaissent pas ce que vous avez écrit et les faire tester le document est mieux que rien. Dans ce cas, notez que les testeurs sont les utilisateurs experts en la matière, de sorte que leurs modifications sont tout aussi précieuses que celles de votre produit PME et éditeur (PME).

Les tests d’utilisabilité eux-mêmes sont une discipline entière qui est trop vaste pour être couverte dans cet article.

Cependant, une fois que vous avez apporté des modifications aux tests d’utilisabilité, exécutez les modifications au-delà de l’éditeur et, le cas échéant, de vos PME de produits/services : peut-être qu’un petit changement dans le produit/service, maintenant ou dans une version future, ferait une énorme différence. aux utilisateurs.

Conclusions et généralisations

Nous pouvons tirer les conclusions et généralisations suivantes sur l’écriture d’instructions logicielles :

• Les lecteurs sont frustrés lorsqu’ils lisent votre travail.
• Vous devez mettre le lecteur à l’aise en lui disant où il se trouve, quoi faire et où il finira.
• Vous devez demander à des experts d’examiner votre document pour l’exactitude du produit ainsi que l’exactitude de l’écriture.
• Vous devez accepter les modifications apportées par vos experts, sauf si vous important pas d’accord, auquel cas parlez-en à l’expert en question.
• Les tests d’utilisabilité sont le meilleur moyen de s’assurer que votre document répondra avec succès aux besoins des utilisateurs/lecteurs. Cela peut même conduire à des améliorations du produit !

Cet article est exact et fidèle au meilleur de la connaissance de l’auteur. Le contenu est uniquement à des fins d’information ou de divertissement et ne remplace pas un conseil personnel ou un conseil professionnel en matière commerciale, financière, juridique ou technique.

© 2009 Laura Schneider

Laura Schneider (auteur) du Minnesota, États-Unis, le 13 juillet 2012 :

Alison, je ne vois pas de problème de précision avec cette phrase. Pourriez-vous s’il vous plaît expliquer ce que vous voyez que je ne suis pas?

alison le 12 juillet 2012 :

…cliquez sur Activer les options et la troisième fenêtre apparaît, sinon cliquez sur Retour…

Vérifiez la phrase ci-dessus pour l’exactitude.

Laura Schneider (auteur) du Minnesota, États-Unis, le 28 novembre 2009 :

Comte–

Excellent point ! Je suis d’accord de tout coeur.

Avoir des utilisateurs de votre public cible (utilisateurs prévus) et des personnes désemparées au hasard « dans la rue » (quelqu’un d’un autre département, un étudiant stagiaire, etc.) testent tous les instructions et donnent leur avis est la meilleure façon de procéder.

Et, bien sûr, si vous avez un éditeur professionnel parmi le personnel, n’oubliez pas de demander à l’éditeur de revoir vos instructions.

à votre santé!

–Laura

Comte Hemminger le 27 novembre 2009 :

Vous avez laissé de côté la nécessité de faire tester vos étapes par plusieurs utilisateurs. Peu importe à quel point vous faites vos instructions à l’épreuve des idiots, quelqu’un est un meilleur idiot et trouvera un moyen de casser vos instructions.