Créer un guide

Les manuels d`utilisation sont des documents papier ou électroniques (PDF ou XPS) contenant des instructions sur la façon de faire ou d`utiliser quelque chose. Bien que les manuels d`utilisation soient souvent considérés comme des manuels de logiciels, ils sont également très souvent inclus avec les ordinateurs et autres appareils électroniques tels que les téléviseurs, les chaînes stéréo, les systèmes téléphoniques et les lecteurs MP3, ainsi que les appareils électroménagers et les équipements de jardin. De bons manuels d`utilisation informent les utilisateurs sur les fonctionnalités d`un produit et sur la façon d`utiliser ces fonctionnalités efficacement, et sont organisés pour être faciles à lire et à consulter. Voici quelques éléments à prendre en compte lors de la création de contenu efficace et de la conception de la mise en page d`un guide de l`utilisateur.

Pas

Partie1 sur 3: Création d`une documentation utilisateur utile

Image intitulée Créer un manuel d`utilisation Étape 1
1. Définir l`utilisateur. Pour rédiger un guide d`utilisation réussi, vous devez développer un profil de votre utilisateur, soit de manière formelle en créant un profil écrit, soit de manière informelle, en prenant le temps de formuler des hypothèses raisonnables sur les caractéristiques de votre utilisateur. Un tel profil est utile lorsque vous faites partie d`une équipe qui rédige la documentation utilisateur, et il peut également être utile lors du développement du produit du concept à la forme finale. Les éléments à prendre en compte lors du développement d`un profil d`utilisateur incluent :
  • Où l`utilisateur utilisera le manuel, par exemple à la maison, au bureau, sur un chantier de construction éloigné ou dans la voiture. Cela peut déterminer non seulement le contenu, mais aussi le style du manuel d`utilisation.
  • Comment les utilisateurs utiliseront le manuel. Si le manuel ne sera consulté que rarement ou s`il n`est destiné qu`à des fins d`information, il devra principalement prendre la forme d`un document de référence. S`il s`agit d`un élément auquel les utilisateurs se réfèrent souvent au début, la section de référence doit être accompagnée d`un "Au boulot"-section et des instructions sur les tâches les plus courantes pour lesquelles le produit sera utilisé.
  • Combien d`utilisateurs ont une expérience avec le produit ou ce que les autres aiment à ce sujet. Si votre produit est nouveau ou très différent de produits similaires, vous devez inclure une explication de sa différence par rapport aux autres produits ainsi que des instructions sur la façon de commencer. Si le produit présente des fonctionnalités avec lesquelles d`autres utilisateurs ont souvent du mal, telles que diverses applications informatiques, vous devez fournir les informations et les détails appropriés de manière compréhensible.
Image intitulée Créer un manuel d`utilisation Étape 2
2. Lorsque vous écrivez, concentrez-vous sur le besoin de l`utilisateur, d`une manière qu`il puisse comprendre. À moins que l`utilisateur n`ait une formation technique, il est probablement préférable d`éviter un langage hautement technique et d`opter pour une explication claire et simple. Le texte doit également être organisé de manière à imiter l`état d`esprit de l`utilisateur ; faire une liste des fonctionnalités du produit regroupées par fonctionnalité est souvent plus logique que de regrouper les fonctionnalités les plus utilisées.
  • Parfois, vous ne pouvez pas vous empêcher d`utiliser des termes techniques, comme pour une application logicielle de génération de graphiques avec des graphiques de Fibonacci et les graphiques à secteurs et à barres les plus courants. Dans un tel cas, il est utile de définir le terme et de fournir des informations générales telles qu`une explication de ce que sont les graphiques de Fibonacci et de leur utilisation dans l`analyse financière.
  • Image intitulée Créer un manuel d`utilisation Étape 3
    3. Expliquez le problème que l`utilisateur essaie de résoudre, puis présentez la solution. Offrir une fonction comme solution à un problème courant fonctionne très bien avec un produit commercial, mais une fois que l`utilisateur a le produit, il veut savoir comment l`utiliser. Indiquez les problèmes spécifiques que l`utilisateur peut rencontrer, indiquez-les dans le manuel d`utilisation et suivez les instructions pour les résoudre.
  • Si le problème est complexe, décomposez-le en petits morceaux. Dressez la liste de chaque partie avec des instructions sur la façon de la réparer ou de la gérer, et traitez-les l`une après l`autre. La séparation des informations de cette manière s`appelle « chunking ».
  • Partie2 sur 3: Parties d`un manuel d`utilisation

    Image intitulée Créer un manuel d`utilisation Étape 4
    1. Ajoutez-y les pages de garde et de titre appropriées. Vous aurez besoin d`une page de couverture pour tout manuel qui est plus qu`une carte de référence, et d`une page de titre pour un manuel qui contient plus d`informations qu`une feuille de papier pliée (quatre pages ou plus).
    • Si le manuel est protégé par des droits d`auteur, placez un avis de droit d`auteur sur la couverture et la page de titre.
    • S`il y a des conditions attachées à l`utilisation du manuel et du produit correspondant, veuillez les mettre à l`intérieur de la couverture avant.
    Image intitulée Créer un manuel d`utilisation Étape 5
    2. Mettre des références à des documents connexes dans la préface. Si la documentation utilisateur se compose de plusieurs manuels, veuillez vous référer aux autres documents ici, avec les numéros de version corrects. La préface est aussi le lieu où une éventuelle section "Comment utiliser ce guide" vient.
    Image intitulée Créer un manuel d`utilisation Étape 6
    3. Inclure une table des matières si le manuel fait plus de 10 pages.
    Image intitulée Créer un manuel d`utilisation Étape 7
    4. Placer les instructions/procédures et le matériel de référence au cœur du manuel. Dans la plupart des cas, toutes les procédures et documents de référence ont leurs propres sections, mais vous pouvez renvoyer l`utilisateur à un contenu spécifique d`une section à l`autre. De cette façon, l`utilisateur peut trouver les informations qu`il recherche plus rapidement.
  • Les procédures doivent être écrites dans une structure cohérente dans les instructions du manuel. Commencez par un aperçu de la tâche, puis décrivez ce que l`utilisateur doit faire et ce qu`il doit percevoir en conséquence. Les étapes doivent être numérotées et introduites avec des verbes d`action, car les étapes sont écrites dans chaque section de cet article.
  • Les documents de référence peuvent inclure des listes d`options, des conseils, des solutions et des questions fréquemment posées. Des glossaires et des index peuvent être inclus approximativement à la fin du manuel, bien qu`une liste de termes couramment utilisés puisse être fournie sur la couverture avant. L`index peut être omis si le manuel fait moins de 20 pages.
  • Image intitulée Créer un manuel d`utilisation Étape 8
    5. Si nécessaire, utilisez des images pour soutenir le texte. Les graphiques ou les captures d`écran peuvent mieux illustrer certains points du manuel que le texte, en particulier dans les procédures complexes où l`utilisateur a besoin d`une confirmation visuelle que les étapes ont été effectuées correctement. Les graphiques peuvent être produits à l`aide d`un logiciel de conception ou d`un logiciel graphique, d`appareils photo numériques et d`un logiciel de retouche photo, ou dans le cas de captures d`écran, capturés à l`aide de la capacité de capture d`écran de votre PC ou d`un programme graphique.
  • Une fois que vous avez créé une image graphique, vous pouvez l`enregistrer dans un format compressé adapté à votre programme de traitement de texte ou de PAO. Vous voudrez également réduire la taille physique de l`image pour la rendre un peu plus facile à ajuster sur la page, sans sacrifier les détails. (Si nécessaire, vous pouvez diviser l`image originale en morceaux et afficher les parties pertinentes, ainsi que le texte de support.)
  • Si vous utilisez plusieurs graphiques dans les procédures, faites-en une taille cohérente, avec les mêmes mesures pour la longueur et la largeur ou réduits de la même manière. Cela rendra les images plus attrayantes pour l`utilisateur. De plus, lorsque vous prenez des captures d`écran, assurez-vous que l`ordinateur utilise un schéma de couleurs standard lors de la capture d`images, si le manuel d`utilisation affiche des captures d`écran en couleur.
  • Alors que les programmes d`édition graphique tels que Photoshop et Paint Shop Pro offrent la possibilité de prendre une capture d`écran, des programmes spécifiques tels que SnagIt vous permettent de modifier, de cataloguer et de sous-titrer facilement des images.
  • Partie3 sur 3: Concevoir un guide d`utilisation lisible

    Image intitulée Créer un manuel d`utilisation Étape 9
    1. Choisissez des polices lisibles. Alors que les ordinateurs peuvent prendre en charge un certain nombre de polices différentes, le but d`un guide de l`utilisateur est d`être facile à lire. Choisir seulement un petit nombre de polices qui vont bien ensemble est le meilleur moyen d`atteindre cet objectif. Les polices peuvent être divisées en 2 types : serif (serif) et sans serif (sans serif).
    • Les polices Serif comportent de petits embellissements aux extrémités des lignes principales qui composent la lettre. Les polices Serif incluent des polices telles que Times New Roman, Baskerville et Book Antiqua. Les polices Serif conviennent mieux aux gros morceaux de texte d`une taille de police comprise entre 10 et 12 dans le corps principal d`un manuel imprimé.
    • Les polices sans empattement n`affichent que les lignes qui composent les lettres, sans embellissement. Les polices sans empattement incluent des polices telles que Arial, Calibri et Century Gothic. Les polices sans empattement peuvent être utilisées pour de gros morceaux de texte de 8 à 10 points dans un manuel PDF ou en ligne, bien que le manque de sans empattement affiché en 12 points ou plus rend la lecture plus difficile. Cependant, ils peuvent être efficaces dans une taille plus grande pour afficher les titres et les en-têtes, et ils sont également parfaits dans des tailles plus petites pour les notes de bas de page et les nombres dans les colonnes et les tableaux.
    • En général, utilisez des polices régulières comme Arial ou Times New Roman pour votre manuel d`utilisation, bien que vous puissiez utiliser une police décorative pour les citations ou les titres importants, lors de la rédaction d`un manuel pour un jeu de fantasy ou de SF. (Dans le cas des citations accrocheuses, vous pouvez souvent utiliser l`une des polices simples et la citation accrocheuse est en italique.)
    • Une fois que vous avez choisi certaines polices à utiliser, créez un exemple de page sur papier pour vérifier si les polices correspondent bien. Vous voudrez également montrer cet exemple à quiconque doit approuver le manuel avant de continuer à l`écrire.
    Image intitulée Créer un manuel d`utilisation Étape 10
    2. Attention à la mise en page. Une fois que vous avez choisi l`une des polices du manuel, vous devrez décider où tout mettre sur les pages.
  • En général, vous placez le titre ou le titre du chapitre dans l`en-tête ou le pied de page, éventuellement avec le titre sur la page de gauche et le titre du chapitre sur la page de droite. Placez également les numéros de page dans l`en-tête ou le pied de page, soit près du bord (en-tête ou pied de page) soit au centre (dans le pied de page uniquement). Vous pouvez faire en sorte que chaque première page d`une section ou d`un chapitre diffère des autres pages en plaçant le numéro de page correspondant en bas au centre de la page et les autres pages dans le coin supérieur de la page.
  • Vous pouvez indiquer le texte explicatif dans des cases colorées ou ombrées pour le distinguer du reste du texte. Choisissez une couleur ou un niveau d`ombrage sans compromettre la lisibilité.
  • Optez pour des marges assez larges sur tous les côtés, avec un espace supplémentaire sur les bords qui seront liés entre eux.
  • Image intitulée Créer un manuel d`utilisation Étape 11
    3. Pensez au type de reliure pour le manuel d`utilisation. Si votre guide de l`utilisateur compte plus de 4 pages, les pages doivent être liées ensemble d`une manière ou d`une autre. Alors qu`une agrafe dans le coin peut suffire pour les documents internes, les guides d`utilisation externes qui accompagnent un produit sont généralement reliés de 3 manières :
  • L`agrafage convient aux manuels composés de feuilles de papier pliées : 21 x 27,5 cm, 21 x 35 cm ou 27,5 x 42,5 cm. Les manuels produits à bas prix de 48 pages ou moins sont regroupés de cette manière.
  • Le point à cheval est plus couramment utilisé pour les guides de référence tiers que pour les manuels du propriétaire inclus avec les produits non automobiles, bien que certains manuels du propriétaire plus complets soient liés de cette manière. (Paint Shop Pro était à l`origine livré avec un manuel d`utilisation relié par piqûre à cheval lorsqu`il a été publié par JASC Software.)
  • La reliure à spirale convient aux manuels du propriétaire conçus pour être utilisés dans des environnements plus difficiles, tels que l`extérieur, où les manuels agrafés ou cousus à cheval s`effondreraient. Certains manuels à reliure spirale ont des pages plastifiées pour éviter qu`elles ne se cassent si le manuel est mouillé ou boueux.
  • Image intitulée Créer un manuel d`utilisation Étape 12
    4. Créer un modèle de document pour votre manuel. De nombreux programmes de traitement de texte et de publication assistée par ordinateur vous permettent de créer un modèle de document pour votre manuel d`utilisation afin qu`au fur et à mesure que vous tapez, le texte apparaisse automatiquement dans la police que vous avez sélectionnée pour la partie du manuel sur laquelle vous travaillez. (En fait, cet article a été initialement écrit à l`aide d`un modèle Microsoft Word.) La plupart de ces programmes incluent également une collection de modèles prédéfinis que vous pouvez personnaliser en fonction de vos besoins, plutôt que de créer le modèle à partir de zéro.
  • Les traitements de texte et les programmes de PAO offrent également la possibilité de créer des « styles », des polices prédéfinies et des formats pour les en-têtes, les pieds de page, les en-têtes et le texte brut. Vous pouvez choisir l`un des noms de styles prédéfinis (par exemple, « Tête1 », « Normal », « Citation »), ou créer un style personnalisé avec son propre nom. Essayez de suivre autant que possible les conventions des noms de style existants, si vous utilisez plusieurs styles pour la même classe de texte. (Par exemple, Microsoft Word étiquette les styles de texte d`en-tête comme « Titre1 », « En-tête 2 », etc., du titre principal aux différents niveaux de sous-titres.) Essayez de pré-créer tous les styles afin de ne pas avoir à interrompre le processus d`écriture pour les recréer.
  • Des astuces

    • Dans la mesure du possible, utilisez des codes de champ ou des variables de texte. Vous pouvez attribuer des valeurs aux codes de champs, comme le nom d`un produit, le manuel ou le titre d`un chapitre, et les placer au sein de votre document, à la place du texte à mentionner. Lorsque vous prévisualisez ou imprimez le manuel, la variable est remplacée par le texte. Si le nom du produit est modifié ou si vous modifiez le nom du manuel ou d`un chapitre, il est plus facile de modifier les informations en ajustant la valeur de la variable texte qu`en recherchant et en remplaçant.

    Nécessités

    • Traitement de texte ou programme dtp
    • Logiciel graphique ou programme d`enregistrement d`écran

    Оцените, пожалуйста статью