Comment créer un guide de l'utilisateur : 12 étapes (avec photos)

Table des matières:

Comment créer un guide de l'utilisateur : 12 étapes (avec photos)
Comment créer un guide de l'utilisateur : 12 étapes (avec photos)

Vidéo: Comment créer un guide de l'utilisateur : 12 étapes (avec photos)

Vidéo: Comment créer un guide de l'utilisateur : 12 étapes (avec photos)
Vidéo: Karaté - cours 3 : techniques de poing (tsuki waza) 2024, Novembre
Anonim

Un guide de l'utilisateur est un manuel au format papier ou électronique (PDF ou XPS) qui fournit des instructions sur une procédure ou l'utilisation de quelque chose. Bien que les « manuels d'utilisation » soient souvent associés aux guides d'applications informatiques, les guides d'utilisation sont également fournis 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, les lecteurs MP3 et les équipements ménagers et de jardin. Un bon guide de l'utilisateur informe les utilisateurs sur les fonctionnalités du produit tout en leur apprenant à utiliser ces fonctionnalités efficacement. Le guide de l'utilisateur est structuré de manière à être facile à lire et à consulter. Voici quelques étapes que vous devez prendre en compte lors de l'élaboration d'un contenu efficace et de la conception de la mise en page du guide de l'utilisateur.

Étape

Partie 1 sur 3: Création d'un guide de l'utilisateur approprié

Créer un manuel d'utilisation Étape 1
Créer un manuel d'utilisation Étape 1

Étape 1. Décidez qui utilisera le guide

Pour rédiger un bon guide d'utilisation, vous devez développer un profil d'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 l'utilisateur. De tels profils sont utiles lorsque vous faites partie d'une équipe de rédaction de guides d'utilisation et lorsque vous travaillez sur le produit prévu, du concept à la forme finale. Tenez compte des facteurs suivants lors de la création d'un profil utilisateur:

  • L'emplacement de l'utilisateur utilisera le guide, par exemple à la maison, au bureau, sur un lieu de travail distant, ou dans la voiture. Ce facteur détermine non seulement le contenu, mais aussi le style d'écriture que le guide adoptera.
  • Comment l'utilisateur utilisera le guide. S'ils l'utilisent rarement ou n'en ont besoin que pour trouver des informations, il est préférable que le guide soit réalisé sous la forme d'un document de référence. En revanche, si l'utilisateur l'utilise régulièrement au début, la section de référence doit être accompagnée d'une section « Comment démarrer » et d'instructions sur les fonctions les plus courantes que le produit exécutera.
  • Quelle est l'expérience de l'utilisateur avec le produit ou un article similaire. Si le produit est nouveau ou très différent de produits similaires, vous devez inclure une explication de la façon dont il diffère des autres et des instructions sur la façon de l'utiliser. Si le produit traite de quelque chose que les utilisateurs trouvent souvent difficile, comme une application informatique, vous devez fournir des informations et des détails appropriés de manière compréhensible.
Créer un manuel d'utilisation Étape 2
Créer un manuel d'utilisation Étape 2

Étape 2. Créez un guide qui correspond aux besoins de l'utilisateur d'une manière qu'il puisse comprendre

Si les utilisateurs ne sont pas des gens avertis techniquement, il est probablement préférable d'éviter un langage très technique et de fournir des explications claires et simples. Le texte doit également être organisé d'une manière qui ressemble à la façon dont l'utilisateur pense. Répertorier les fonctionnalités du produit regroupées par fonction est souvent plus logique que par les fonctionnalités les plus fréquemment utilisées.

Parfois, l'utilisation de termes techniques est inévitable, par exemple pour les applications graphiques qui incluent des graphiques de Fibonacci ainsi que des camemberts et les graphiques à barres les plus courants. Dans un cas comme celui-ci, il serait préférable que vous définissiez les termes et fournissiez des informations, par exemple une explication de ce qu'est le graphique de Fibonacci et de son utilisation dans l'analyse financière

Créer un manuel d'utilisation Étape 3
Créer un manuel d'utilisation Étape 3

Étape 3. Décrivez le problème que l'utilisateur essaie de résoudre, puis fournissez une solution à ce problème

Offrir des fonctionnalités comme solutions à des problèmes courants est très bien lors de la publicité d'un produit, mais une fois qu'un client possède le produit, il doit comprendre comment l'utiliser. Identifiez le problème que l'utilisateur rencontrera, décrivez-le dans le guide de l'utilisateur, suivi des instructions pour le résoudre.

Si le problème est complexe, divisez-le en plus petits morceaux. Écrivez chaque section avec des instructions sur la façon de le résoudre ou de le traiter, puis suivez les uns les autres dans l'ordre. La décomposition des informations de cette manière est connue sous le nom de méthode de regroupement ou de division

Partie 2 sur 3: Composants du guide de l'utilisateur

Créer un manuel d'utilisation Étape 4
Créer un manuel d'utilisation Étape 4

Étape 1. Créez une couverture et une page de titre appropriées

Vous aurez besoin d'une couverture pour tout guide de l'utilisateur qui est plus qu'une carte de référence et d'une page de titre pour un guide qui comprend plus qu'une feuille de papier pliée (4 pages ou plus).

  • Si le guide est protégé par le droit d'auteur, l'avis de droit d'auteur doit être inclus sur les couvertures avant et arrière, ainsi que sur la page de titre.
  • S'il existe des conditions d'utilisation du guide et des produits qui y sont associés, veuillez les inclure à l'intérieur de la couverture avant.
Créer un manuel d'utilisation Étape 5
Créer un manuel d'utilisation Étape 5

Étape 2. Mettez une référence au document connexe dans l'introduction

S'il existe plus d'un guide de l'utilisateur, veuillez faire référence à un autre document, y compris le numéro de version correct, ici. L'avant-propos est également un endroit pour mettre la section « Comment utiliser ce guide » s'il y en a une.

Créer un manuel d'utilisation Étape 6
Créer un manuel d'utilisation Étape 6

Étape 3. Incluez une table des matières si le guide fait plus de 10 pages

Créer un manuel d'utilisation Étape 7
Créer un manuel d'utilisation Étape 7

Étape 4. Placez les instructions/procédures et les documents de référence sur le corps du guide

Dans la plupart des cas, la procédure et le matériel de référence devraient avoir chacun leur propre section. Cependant, vous pouvez demander aux utilisateurs de se référer à un contenu spécifique dans une section et de le différencier des autres sections. De cette façon, l'utilisateur peut trouver rapidement l'information qu'il recherche.

  • Les procédures doivent être écrites dans une structure cohérente tout au long des instructions du manuel. Commencez par un aperçu des fonctionnalités du produit, puis expliquez ce que l'utilisateur doit faire et quels résultats il obtiendra ou verra. Les étapes doivent être numérotées et commencer par un verbe d'action, tout comme les étapes sont écrites dans chaque section de cet article.
  • Le matériel de référence peut inclure des listes de contrôle, des conseils de dépannage et des questions fréquemment posées. Un glossaire et un index peuvent être ajoutés à la fin du guide, bien qu'un glossaire des termes fréquemment utilisés puisse être fourni au début. L'index peut être omis si le guide compte moins de 20 pages.
Créer un manuel d'utilisation Étape 8
Créer un manuel d'utilisation Étape 8

Étape 5. Utilisez des images graphiques au besoin pour prendre en charge le texte

Les images graphiques, ou captures d'écran, peuvent mieux illustrer certains points d'un guide que le texte, en particulier dans les procédures complexes où les utilisateurs ont besoin d'une confirmation visuelle pour s'assurer qu'ils suivent correctement les étapes. Les dessins graphiques peuvent être créés à l'aide d'applications de dessin assisté par ordinateur (CAO) ou d'édition graphique, d'appareils photo numériques et d'applications de traitement de photos, ou si vous souhaitez utiliser des captures d'écran, utilisez les fonctionnalités de capture d'écran intégrées à votre ordinateur ou un programme graphique doté de capacités de capture d'écran.

  • Une fois que vous avez créé une image graphique, enregistrez-la dans un format compressé afin de pouvoir l'utiliser dans une application de traitement de texte ou de PAO. Vous devez également réduire la taille de l'image pour mieux l'adapter à la page, tout en fournissant des détails complets à l'utilisateur. (Si nécessaire, vous pouvez recadrer l'image d'origine en sections et afficher les sections pertinentes avec le texte à l'appui).
  • Si vous utilisez plusieurs images graphiques dans la procédure, assurez-vous que les images sont créées à une taille cohérente, soit dans les mêmes dimensions de longueur et de largeur, soit proportionnellement à la taille de l'image d'origine. De cette façon, l'image sera plus attrayante pour les utilisateurs. La même chose est vraie lorsque vous prenez des captures d'écran à partir d'un ordinateur; assurez-vous que l'ordinateur affiche le schéma de couleurs standard lors de la prise de photos, sinon l'assistant affichera une capture d'écran en couleur.
  • Alors que les applications de retouche d'images comme Photoshop et Paint Shop Pro ont de bonnes capacités de capture d'images, les programmes dédiés à la prise de captures d'écran comme Snagit offrent également la possibilité de modifier, cataloguer et annoter facilement des captures d'écran.

Partie 3 sur 3: Concevoir un guide de l'utilisateur facile à utiliser

Créer un manuel d'utilisation Étape 9
Créer un manuel d'utilisation Étape 9

Étape 1. Choisissez des polices faciles à lire

Bien qu'un ordinateur puisse prendre en charge un certain nombre de polices, le but de la création d'un guide de l'utilisateur est facile à lire. La sélection de plusieurs polices correspondantes est le meilleur moyen d'atteindre cet objectif. Les polices peuvent être regroupées en deux types: serif et sans serif.

  • Les polices Serif ont de petites lignes décoratives aux extrémités des lignes principales qui composent les lettres. Les polices serif incluent Times New Roman, Baskerville et Book Antiqua. Les polices Serif sont parfaites pour la plupart des textes affichés dans les tailles 10-12 dans le corps principal pour les guides d'impression.
  • Les polices sans empattement ne comportent que les lignes qui composent les lettres, sans embellissements. Les polices appartenant au groupe sans empattement incluent Arial, Calibri et Century Gothic. Les polices sans empattement peuvent être utilisées pour la plupart des tailles de texte 8 à 10 dans les fichiers PDF ou les guides en ligne, bien qu'étant sans fioritures, les phrases affichées dans les polices 12 ou plus soient plus difficiles à lire. Cependant, les polices peuvent être utilisées efficacement dans des tailles plus grandes pour afficher des titres et des titres, et dans des tailles plus petites, elles sont parfaites pour les notes de bas de page et les nombres dans les colonnes et les tableaux.
  • En général, il est préférable de choisir une police simple comme Arial ou Times New Roman pour votre guide, bien que vous puissiez utiliser une police décorative pour les citations ou les titres si vous écrivez un guide pour un jeu vidéo se déroulant dans un cadre fantastique ou de science-fiction.. (Dans le cas des citations, vous pouvez souvent utiliser une police simple et afficher la citation complète en italique).
  • Après avoir choisi les polices à utiliser, créez des exemples de pages pour vérifier qu'elles sont belles sur le papier. Vous devez également montrer cet exemple de page à la personne responsable de l'approbation de l'affichage du guide avant de procéder au processus de rédaction.
Créer un manuel d'utilisation Étape 10
Créer un manuel d'utilisation Étape 10

Étape 2. Pensez à la mise en page

Une fois que vous avez sélectionné une police pour le guide, vous devrez décider comment structurer le contenu en haut de la page.

  • En général, vous devriez probablement placer le titre du document ou le titre du chapitre dans l'en-tête ou le pied de page, peut-être en utilisant les en-têtes de guide à gauche de la page et les en-têtes de chapitre à droite de la page. Vous devez placer le numéro de page dans l'en-tête ou le pied de page, soit à l'extérieur (en-tête ou pied de page), soit au centre (uniquement dans le pied de page). Vous devrez peut-être également distinguer la première page de chaque section ou chapitre des autres pages en plaçant le numéro de page au milieu du pied de page et la page suivante dans le coin extérieur de l'en-tête.
  • Vous devrez peut-être insérer le texte dans une zone de couleur ou une zone de bloc pour le différencier du reste du texte. Assurez-vous de choisir une couleur ou un niveau de blocage afin que cela ne rende pas le texte difficile à lire.
  • Laissez une marge assez large sur tous les côtés, avec un espace supplémentaire sur les bords à relier.
Créer un manuel d'utilisation Étape 11
Créer un manuel d'utilisation Étape 11

Étape 3. Considérez le type de volume pour le guide de l'utilisateur

Si le guide fait plus de 4 pages, les pages doivent être reliées d'une certaine manière. Bien que les documents internes puissent être agrafés avec une agrafeuse dans le coin de la page, le guide de l'utilisateur externe fourni avec le produit est généralement agrafé par l'une des 3 méthodes suivantes:

  • La méthode d'agrafage latéral (serré sur les côtés de la page avec une agrafeuse) pour les guides imprimés sur du papier plié 21 x 27,5 cm, 21 x 35 cm ou 27,5 x 42,5 cm. La plupart des guides bon marché de 48 pages ou moins sont reliés de cette façon.
  • La méthode de piqûre à cheval (cousue sur le côté de la page) est plus souvent utilisée pour les guides de référence tiers que pour les guides inclus avec des produits autres que les voitures, bien que certains guides plus longs soient reliés de cette manière. (Le guide Paint Shop Pro comprenait à l'origine un guide de piqûre à cheval tout en étant toujours produit par JASC Software).
  • La reliure à spirale convient mieux aux guides utilisés dans des environnements plus difficiles, comme à l'extérieur (auquel cas les méthodes d'agrafage latéral et de piqûre à cheval ne sont pas assez solides pour faire glisser les pages). Certains guides à reliure spirale peuvent également avoir des pages laminées avec du plastique pour éviter qu'elles ne soient endommagées lorsqu'elles sont mouillées ou exposées à la boue.
Créer un manuel d'utilisation Étape 12
Créer un manuel d'utilisation Étape 12

Étape 4. Créez un modèle de document pour vous guider

De nombreuses applications de traitement de texte et de PAO offrent la possibilité de créer des modèles de documents pour les guides d'utilisation. Ainsi, au fur et à mesure que vous tapez, le texte apparaîtra automatiquement avec la police que vous avez sélectionnée pour la partie de l'assistant sur laquelle vous travaillez. (En fait, cet article a été écrit à l'origine à l'aide d'un modèle Microsoft Word). La plupart de ces programmes incluent également un ensemble standard de modèles que vous pouvez modifier selon vos besoins afin que vous n'ayez pas à créer le vôtre à partir de zéro.

Les applications de traitement de texte et de PAO offrent également la possibilité de créer des « styles », des tailles de police prédéfinies pour l'en-tête, le pied de page, l'en-tête et le corps du texte. Vous pouvez choisir l'un des noms de style prédéfinis (par exemple, Titre, Normal, Citation) ou créer votre propre style avec votre propre nom. Dans la mesure du possible, suivez la convention de création de noms de style si vous avez plusieurs styles pour le même type de texte. (Par exemple, les noms de style que Microsoft Word adopte pour les titres sont Titre1, Titre2, et ainsi de suite pour les titres principaux jusqu'à plusieurs niveaux de sous-titre). Essayez de créer tous les styles dont vous aurez besoin à l'avance afin de ne pas avoir à vous arrêter et à les créer au milieu du processus de saisie

Conseillé: