Comment écrire un manuel d`utilisation pour le logiciel

Contenu

Test de l`utilisateur
Le processus d`entrevue
Imagerie
Formatage
Versioning et le suivi
les références
ressources

div itemprop="description" class="intro marginTop" data-module="article-intro">

Souvent rempli de jargon, les acronymes et les directions qui exigent un doctorat pour comprendre, manuels d`utilisation du logiciel sont parfois écrites du point de vue d`un développeur plutôt que d`un utilisateur. En conséquence, le guide peut faire des hypothèses sur le niveau de compétence du lecteur qui sont souvent incorrectes. La première étape dans l`écriture d`un bon mode d`emploi est d`obtenir le processus d`écriture réelle loin des ingénieurs que possible.

Le développeur de logiciel sait plus que quiconque ce qui rend le travail du logiciel, mais cela ne signifie pas que le développeur doit écrire le guide. Au contraire, il est un net désavantage. Plus important que une compréhension profonde du fonctionnement interne du logiciel est une compréhension de qui est l`utilisateur final sera, ce que son niveau d`éducation, et comment cet utilisateur final utilisera le logiciel. Dans la plupart des cas, les utilisateurs finaux ne pas besoin de connaître les subtilités de la programmation et le fonctionnement de back-end du logiciel - ils ont juste besoin de savoir comment l`utiliser pour rendre leur travail plus facile.

Test de l`utilisateur
Le manuel d`utilisation doit être en grande partie centrée sur la tâche, plutôt que fortement descriptive. Parce que le manuel est écrit pour aider les utilisateurs à comprendre comment exécuter des tâches spécifiques, l`écrivain a besoin d`avoir une compréhension de ces tâches ainsi, et par conséquent, en passant par chaque étape distincte de chaque caractéristique est absolument essentiel. Il est pas nécessaire pour l`écrivain de connaître nécessairement la façon dont le programme a été créé à partir d`un point de vue de la conception ou de développement, mais il est essentiel d`avoir une bonne connaissance pratique de toutes ses fonctions. Pendant l`exécution de chaque tâche, prenez le temps d`écrire chaque étape, y compris les clics, les menus déroulants, et d`autres actions.

Le processus d`entrevue

Bien que le développeur ne devrait pas être le seul à écrire le manuel, elle sera toujours une ressource précieuse pour l`écrivain, et avant le début de l`écriture, planifier une réunion de lancement entre l`écrivain, développeur et ingénieurs, et les utilisateurs finaux potentiels pour aider à informer le le travail de l`écrivain depuis le début. Entrevues avec des experts et des ingénieurs Matière devraient être enregistrées, avec les transcriptions faites pour référence ultérieure.

Imagerie

Un manuel d`utilisation ne doit pas être trop lourd texte. Au contraire, intégrer l`utilisation libérale des graphiques et des clips écran. Description d`une action est beaucoup plus claire avec les directions à base de texte accompagnée d`un clip d`écran qui illustre clairement cette direction. Inclure à la fois avant et après des vues, pour montrer ce que l`écran ressemble avant de prendre chaque action, et ce qui se passe après que l`action a été prise. Un utilitaire de capture d`écran simple tel que l`outil Snipping inclus dans Microsoft Windows fonctionne bien pour capturer ces images. Assurez-vous de numéroter chaque image, et inclure une légende qui décrit brièvement ce. Centrer immédiatement au-dessous du paragraphe qui introduit d`abord le concept représenté sur l`image.

formatage

Communiquer clairement dans un document technique nécessite une planification et un respect rigoureux des normes tout au long du guide. Normes de présentation à la fois, la langue, et la nomenclature aide éviter toute confusion. Les modèles sont disponibles et peuvent être un bon point de départ pour l`uniformité, bien que ceux-ci peuvent certainement être adaptées à chaque situation. L`utilisation d`une marge d`un pouce avec une seule colonne convient le mieux à la nécessité d`ajouter un paramètre Graphics-deux colonnes peut apparaître trop de monde, et peut rendre le placement des images confuses.

Versioning et le suivi

Plus que tout autre type de document, un utilisateur du logiciel guide est susceptible de passer par plusieurs itérations avant qu`il ne soit terminé, et il est susceptible de passer par un processus d`examen par les multiples parties prenantes. Utilisation de la fonctionnalité Suivi des modifications sur Microsoft Word est un moyen facile de garder une trace des commentaires et des modifications de chaque individu. La création de plusieurs versions après chaque cycle d`examen, chacun avec un nom de fichier différent, aide également le processus long et fait que tous les intervenants sont satisfaits du résultat final.