Comment rédiger le manuel d'utilisation d'un programme

Étape 1

Rédigez un aperçu du manuel. Cela vous donnera un plan à suivre. Les points à inclure dans le schéma sont le processus d'installation, les applications du programme, les descriptions des menus, les tâches courantes, les fonctions avancées et la section de dépannage. Il inclut également des sous-sections dans votre conception pour des tâches spécifiques telles que la création d'un nouveau fichier, la sauvegarde et l'impression de fichiers.

Étape 2

Détaille le processus d'installation, y compris les exigences de l'ordinateur. Il fournit la configuration requise avant l’installation principale afin que les utilisateurs puissent préparer leur ordinateur. Décrivez même les étapes les plus élémentaires pour les débutants en informatique. Ces étapes peuvent être «double-cliquer sur le fichier d'installation» ou «insérer le CD dans le lecteur de CD-ROM». Les étapes typiques d’une installation consistent à expliquer les options d’installation, telles qu’une installation typique par opposition à une installation avancée, guidant l’utilisateur étape par étape à travers chaque écran IGU (interface graphique utilisateur) avec lequel il est trouvé, enregistrant le programme et entrez un code ou des numéros de série, et comment accéder au programme une fois installé pour vérifier que l'installation est correcte.

Étape 3

Faites une description détaillée des applications du programme. Il comprend ce pour quoi le programme est nécessaire et comment l’obtenir. Par exemple, si le programme traite de comptabilité, expliquez comment il facilite les tâches de comptabilité normales. Clarifie quelles sont les fonctions les plus importantes pour l'utilisateur final. Cela donnera à l'utilisateur une idée des fonctions qu'il tentera d'apprendre en premier. Par exemple, dans un programme de création musicale, indiquez à l'utilisateur le nombre de pistes qu'il peut enregistrer en même temps, tous les sons et rythmes qu'il possède et dans quels formats il peut enregistrer les fichiers. Il comprend une brève description des fonctionnalités avancées, ce qui en fait un programme différent de ceux proposés sur le marché. Par exemple, votre programme pourra peut-être générer plus de rapports ou prendre en charge plus de types de fichiers que tout autre programme disponible pour le moment.

Étape 4

Expliquez comment naviguer dans les menus. Expliquez chaque point des menus disponibles. Tout ce qui ne peut pas être expliqué en une ou deux phrases doit être inclus dans la section Tâches communes du manuel. Ces tâches peuvent inclure la modification des lettres et des couleurs, l'impression d'impressions de formats et de types de fichiers différents, ainsi que l'organisation des fichiers et des informations.

Étape 5

Rédigez une section séparée pour les fonctionnalités avancées et les fonctionnalités supplémentaires. C'est ici que vous devriez entrer dans les détails. Par exemple, un manuel d'utilisation pour Microsoft Excel inclurait des informations sur la création de rapports, de liens et de macros. Les fonctionnalités supplémentaires incluront des fonctionnalités auxquelles l'utilisateur ne peut s'attendre. Par exemple, un programme de création musicale peut intégrer un lecteur de musique intégré. Prenez le temps d'expliquer tout élément supplémentaire fourni avec votre programme ou ses applications uniques.

Étape 6

Il inclut des suggestions pour le dépannage. Expliquez le sens de chaque erreur que l'utilisateur peut trouver, comment résoudre le problème et comment l'éviter à l'avenir. C’est également à cet endroit que vous devez inclure des informations de contact et des informations de service client.

Des Articles Intéressants