Souvent remplis de jargon, d'acronymes et d'instructions qui nécessitent un doctorat pour être compris, les manuels d'utilisation des logiciels sont parfois écrits du point de vue d'un développeur plutôt que d'un utilisateur. En conséquence, le guide peut émettre des hypothèses sur le niveau de compétence du lecteur qui sont souvent incorrectes. La première étape pour rédiger un bon manuel d’utilisateur est d’obtenir le processus d’écriture le plus loin possible des ingénieurs.
Le développeur de logiciel sait mieux que quiconque ce qui fait fonctionner le logiciel, mais cela ne veut pas dire que le développeur doit rédiger le guide. Au contraire, c'est un désavantage distinct. Il est plus important que de bien comprendre le fonctionnement interne du logiciel, mais aussi de comprendre qui sera l'utilisateur final, quel est son niveau de formation et comment cet utilisateur utilisera le logiciel. Dans la plupart des cas, les utilisateurs finaux n'ont pas besoin de connaître les aspects les plus fins de la programmation et du fonctionnement final du logiciel. Ils ont simplement besoin de savoir comment l'utiliser pour faciliter leur travail.
Test utilisateur
Le manuel d'utilisation devrait être en grande partie axé sur les tâches, plutôt que fortement descriptif. Le manuel étant conçu pour aider les utilisateurs à comprendre comment exécuter des tâches spécifiques, le rédacteur doit également les comprendre. Par conséquent, chaque étape distincte de chaque fonction est absolument essentielle. Il n’est pas nécessaire que le rédacteur sache nécessairement comment le programme a été créé du point de vue de la conception ou du développement, mais il est essentiel d’avoir une solide connaissance pratique de toutes ses fonctionnalités. Pendant l'exécution de chaque tâche, prenez le temps de noter chaque étape, y compris les clics, les menus déroulants et d'autres actions.
Le processus d'entrevue
Bien que le développeur ne soit pas le rédacteur du manuel, il restera néanmoins une ressource précieuse pour le rédacteur. Avant de commencer à rédiger, planifiez une réunion de lancement entre le rédacteur, le développeur, les ingénieurs et les utilisateurs finaux potentiels pour aider à informer le l'écrivain depuis le début. Les entretiens avec des experts en la matière et des ingénieurs doivent être enregistrés, avec des transcriptions rédigées pour référence ultérieure.
Imagerie
Un manuel d'utilisation ne doit pas être trop chargé en texte. Intégrez plutôt une utilisation libérale des graphiques et des clips d’écran. La description d'une action est beaucoup plus claire avec des instructions textuelles accompagnées d'un clip d'écran illustrant clairement cette direction. Incluez les vues avant et après, pour montrer à quoi ressemble l'écran avant d'effectuer chaque action et ce qui se produit une fois l'action effectuée. Un simple utilitaire de capture d’écran, tel que l’outil de capture inclus dans Microsoft Windows, fonctionne bien pour capturer ces images. Veillez à numéroter chaque image et à inclure une légende qui la décrit brièvement. Centrez-le immédiatement sous le paragraphe qui introduit le concept décrit dans l'image.
Mise en forme
Pour communiquer clairement dans un document technique, il est nécessaire de planifier et de respecter scrupuleusement les normes tout au long du guide. Les normes de présentation, de langue et de nomenclature aident à éviter toute confusion. Des modèles sont disponibles et peuvent constituer un bon point de départ pour l'uniformité, même s'ils peuvent certainement être adaptés à chaque situation. L'utilisation d'une marge d'un pouce avec une seule colonne convient mieux à la nécessité d'ajouter des graphiques. un paramètre à deux colonnes peut sembler trop encombré et peut compliquer le placement des images.
Gestion des versions et suivi
Plus que tout autre type de document, un guide de l'utilisateur d'un logiciel passera probablement par plusieurs itérations avant d'être terminé et par un processus de révision par plusieurs parties prenantes. L'utilisation de la fonctionnalité Suivi des modifications sous Microsoft Word constitue un moyen simple de suivre les commentaires et les modifications de chaque personne. La création de plusieurs versions après chaque cycle de révision, chacune avec un nom de fichier différent, facilite également le processus et garantit que toutes les parties prenantes sont satisfaites du résultat final.
