Comment rédiger un manuel d'utilisation pour le logiciel

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. Entretiens avec des experts et des ingénieurs Matière devraient être enregistrées, avec les transcriptions faites pour référence ultérieure.

Images

• 
  

  
  

  Un manuel d'utilisation ne doit pas être trop texte-lourd. Plutôt, intégrer l'utilisation libérale de 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 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 comme l'outil Capture inclus dans Microsoft Windows fonctionne bien pour la capture de ces images. Assurez-vous de numéroter chaque image, et inclure une légende qui décrit brièvement. Centrer immédiatement au-dessous du premier paragraphe qui introduit le concept représenté sur l'image.

Formatage

• 
  
  

  Communiquer clairement dans un document technique nécessite une planification et respect scrupuleux des normes à travers le guide. Normes de présentation à la fois, de la langue, et la nomenclature d'éviter la confusion. Les modèles sont disponibles et peuvent être un bon point de départ pour l'uniformité, même si ceux-ci peuvent certainement être adaptées à chaque situation. En utilisant une marge d'un pouce avec une seule colonne convient le mieux à la nécessité d'ajouter un cadre Graphics-deux colonnes peut sembler trop de monde, et peut rendre le placement des images confuses.

Des versions et suivi

• Plus que tout autre type de document, un utilisateur du logiciel guide est susceptible de passer par de multiples itérations avant qu'il ne soit terminé, et il est susceptible de passer par un processus d'examen par de multiples parties prenantes. Utilisation de la fonction de suivi des modifications sur Microsoft Word est un moyen facile de garder une trace des commentaires et des modifications de chaque individu. 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 veille à toutes les parties prenantes sont satisfaits du résultat final.