Mode d'emploi - User guide

Un guide d'utilisation , également communément appelé manuel d'utilisation , est destiné à aider les utilisateurs à utiliser un produit, un service ou une application particulier. Il est généralement rédigé par un technicien, un développeur de produits ou le personnel du service client d'une entreprise.

Des guides d'utilisation sont souvent inclus avec l'achat d'appareils électroménagers. Mais désormais c'est courant dans les deux services, logiciels, applications... Il est publié en version papier, ou en version électronique (document ou application).

La plupart des guides d'utilisation contiennent à la fois un guide écrit et des images associées. Dans le cas des applications informatiques, il est habituel d'inclure des captures d' écran de l'interface ou des interfaces homme-machine, et les manuels du matériel incluent souvent des schémas clairs et simplifiés . Le langage utilisé est adapté au public visé , avec un jargon réduit au minimum ou bien expliqué.

Contenu d'un manuel d'utilisation

Les sections d'un manuel d'utilisation comprennent souvent :

  • Une page de garde
  • Une page de titre et une page de copyright
  • Une préface, contenant des détails sur les documents connexes et des informations sur la façon de naviguer dans le guide de l'utilisateur
  • Une page de sommaire
  • Une section Objectif. Cela devrait être une vue d'ensemble plutôt que de détailler l'objectif du document
  • Une section Public pour indiquer explicitement qui est le public visé qui doit lire, y compris les options facultatives
  • Une section Champ d'application est cruciale car elle sert également de clause de non-responsabilité, indiquant ce qui est hors champ ainsi que ce qui est couvert
  • Un guide sur la façon d'utiliser au moins la fonction principale du système
  • Une section de dépannage détaillant les erreurs ou problèmes possibles qui peuvent survenir, ainsi que la façon de les résoudre
  • Une FAQ (Foire Aux Questions)
  • Où trouver de l'aide supplémentaire et coordonnées
  • Un glossaire et, pour les documents plus volumineux, un index

Histoire

Image
Le mode d'emploi gravé dans une maquette du Mécanisme d'Anticythère.

Des guides d'utilisation ont été trouvés avec des appareils anciens. Un exemple est le mécanisme d'Anticythère , un ordinateur analogique grec vieux de 2 000 ans qui a été trouvé au large des côtes de l'île grecque d' Anticythère en 1900. Sur la couverture de cet appareil se trouvent des passages de texte qui décrivent les caractéristiques et le fonctionnement du mécanisme.

Alors que l'industrie du logiciel se développait, la question de savoir comment documenter au mieux les programmes logiciels était indécise. Il s'agissait d'un problème unique pour les développeurs de logiciels, car les utilisateurs étaient souvent frustrés par les documents d'aide actuels. Voici quelques considérations pour la rédaction d'un guide de l'utilisateur développé à ce moment :

  • l'utilisation d' un langage simple
  • longueur et difficulté de lecture
  • le rôle des guides d'utilisation imprimés pour les programmes numériques
  • conception centrée sur l'utilisateur

Manuels et guides de logiciels informatiques

Les manuels d'utilisation et les guides d'utilisation de la plupart des applications logicielles non triviales sont des documents de type livre dont le contenu est similaire à la liste ci-dessus. Ils peuvent être distribués sous forme imprimée ou électronique. Certains documents ont une structure plus fluide avec de nombreux liens internes. Le Guide de l'utilisateur de Google Earth est un exemple de ce format. Le terme guide est souvent appliqué à un document qui traite d'un aspect spécifique d'un produit logiciel. Certains usages sont Installation Guide , Guide de démarrage , et divers Comment guides. Le Guide de démarrage Picasa en est un exemple .

Dans certaines applications logicielles d'entreprise , où des groupes d'utilisateurs n'ont accès qu'à un sous-ensemble des fonctionnalités complètes de l'application, un guide de l'utilisateur peut être préparé pour chaque groupe. Un exemple de cette approche est le document d' aide d' Autodesk Topobase 2010 , qui contient des guides de l' administrateur , des guides de l' utilisateur et un guide du développeur distincts .

Voir également

Les références