Contenu

• Avancer d'un pas
• Partie 1 sur 4: Planification de votre manuel du propriétaire
• Partie 2 sur 4: Incorporer les informations essentielles
• Partie 3 sur 4: Description de la maintenance du produit
• Partie 4 sur 4: Rédiger un manuel lisible
• Conseils

Les logiciels, ordinateurs, jeux et appareils nécessitent des manuels d'utilisation; des guides expliquant comment utiliser le produit (et comment ne pas le faire). Un manuel d'utilisation est un document formel avec une structure spécifique et doit être rédigé par quelqu'un qui connaît le produit à fond, tel qu'un rédacteur technique ou le concepteur de produit. La rédaction d'un manuel d'utilisation efficace nécessite que vous sachiez qui utilisera le produit et que vous rédigiez le manuel en pensant à ces utilisateurs. Gardez votre écriture claire, précise et simple pour assurer une expérience utilisateur sans tracas.

Avancer d'un pas

Partie 1 sur 4: Planification de votre manuel du propriétaire

1. Faites une analyse utilisateur. Le manuel de l'utilisateur doit être rédigé pour les utilisateurs - ceux qui achèteront votre produit ou service et liront le manuel de l'utilisateur. Une analyse utilisateur vous indiquera qui sera votre public principal ou cible et vous guidera tout au long de la rédaction du texte.
   • Parlez aux personnes qui utiliseront votre appareil. Proposez aux utilisateurs de test des prototypes de l'appareil et rédigez un manuel d'utilisation dans des conditions contrôlées. Demandez à ces utilisateurs de test des commentaires sur les éléments qui ne sont pas clairs ou confus dans le guide de l'utilisateur et apportez des modifications à votre guide de l'utilisateur en fonction de ces commentaires.
   • Vous ne pouvez jamais satisfaire l'ensemble de votre public; rédiger le manuel adapté au public cible ou au public le plus large.
   • Tenez compte de l'âge, de la santé (ont-ils des maladies, des troubles d'apprentissage ou des handicaps?) Et le niveau d'éducation du public pour déterminer la meilleure approche pour rédiger le manuel d'utilisation.
2. Coordonnez la conception du manuel d'utilisation. Si vous faisiez partie de l'équipe qui a contribué à la conception et au développement de l'appareil ou du produit, il peut être difficile de jeter un regard objectif sur le produit pour expliquer son fonctionnement. Vous devriez donc demander l'avis d'un rédacteur (de préférence une personne ayant de l'expérience dans la rédaction d'instructions) et d'un graphiste pour vous aider à préparer le manuel d'utilisation. Vous pouvez choisir ces personnes par le biais d'un conseil externe ou de votre propre entreprise ou organisation.
3. Faites une analyse des tâches. L'analyse des tâches est le processus d'identification et d'organisation des étapes nécessaires à l'utilisation de l'appareil. Une analyse approfondie du travail identifie les matériaux et l'équipement (tels que les batteries, les médicaments ou d'autres produits fournis par l'utilisateur) requis pour chaque étape, ainsi que les actions, les erreurs et les conseils de dépannage que chaque étape peut nécessiter.
   • Si vous disposez d'un produit qui peut effectuer de nombreuses tâches ou sous-tâches différentes, vous devez effectuer une analyse des tâches pour chaque tâche. Par exemple: dans une voiture, vous pouvez klaxonner, vous attacher et allumer ou éteindre vos phares. Faites une analyse de poste pour chacun de ces éléments, si nécessaire.
4. Assurez-vous que votre produit répond aux exigences d'étiquetage et d'autorisation de mise sur le marché. Ces exigences garantissent que les produits sont fabriqués en tenant compte de la sécurité de l'utilisateur et que l'exposition de l'utilisateur à des conditions dangereuses, telles que les radiations et l'électrocution, est limitée. Les publicités doivent indiquer clairement l'objectif et les directives de fonctionnement de base d'un produit, et vous devez utiliser ces ressources lors de la rédaction de votre manuel du propriétaire.
   • Pour que le manuel d'utilisation d'un produit soit efficace, il doit être rédigé conformément aux étiquettes apposées directement sur le produit.
   • Assurez-vous que votre appareil est officiellement autorisé à la vente avant d'écrire le manuel d'utilisation.
5. Décidez de la mise en page de votre manuel. Il existe plusieurs façons importantes de rationaliser votre manuel. Vous devez mettre un titre en gras au début de chaque section avec chaque mot en majuscules. Par exemple, «Configurer votre appareil», «Utiliser votre appareil» et «Dépanner» peuvent tous être des en-têtes de section en gras.
   • Une autre façon de rationaliser votre guide consiste à utiliser deux colonnes, l'une à droite avec du texte et l'autre juste à gauche du texte, avec des puces, des chiffres ou de petites icônes, telles que des marques d'avertissement ou des points d'exclamation rouges.
   • Le manuel peut être constitué principalement d'images avec du texte sous chaque image pour expliquer l'appareil, ou il peut s'agir principalement de texte avec seulement quelques images d'accompagnement. Vous pouvez également utiliser un organigramme pour guider l'utilisateur. Pensez à votre produit et comment chaque méthode peut vous aider à rédiger votre manuel. Cependant, évitez de mélanger différentes mises en page dans un seul manuel. Choisissez en un et gardez le.

Partie 2 sur 4: Incorporer les informations essentielles

1. Organisez le manuel de manière logique. Le manuel doit être structuré de manière à ce que l'utilisateur en tire le meilleur parti. Divisez le manuel en chapitres ou sections qui ont un sens pour l'utilisation du produit et incluez une table des matières au début du manuel afin que chaque section puisse être trouvée rapidement.
   • Une table des matières est particulièrement nécessaire pour les manuels plus longs.
   • Un glossaire ou un index est nécessaire s'il existe de nombreux termes pour expliquer que votre public n'est peut-être pas familier. Cependant, un glossaire n'est pas recommandé; le meilleur choix est d'expliquer les termes confus dans le texte du manuel lui-même. Si vous choisissez d'inclure un glossaire, placez-le au début du manuel, juste après la table des matières.
   • Une liste de tableaux ou de figures n'est nécessaire que s'il y a plus de quelques tableaux ou figures dans le manuel.
   • Une annexe est nécessaire pour les choses qui doivent être expliquées mais qui ne peuvent être expliquées ailleurs dans le manuel, car cela perturberait le flux et la concentration.
2. Incluez les avertissements nécessaires. Les avertissements généraux ou les informations de précaution doivent fournir des informations sur les dangers potentiels causés par une mauvaise utilisation du produit, y compris la mort ou des blessures graves. Ces avertissements doivent être placés tout au début du manuel, après la première page, afin que l'utilisateur les voie en premier. Des avertissements spécifiques doivent également être inclus dans le texte du manuel juste après ou juste avant qu'une étape potentiellement dangereuse ne soit suggérée.
   • Par exemple, un avertissement général pour un appareil électrique pourrait être de ne pas l'utiliser lorsqu'il pleut.
   • Une instruction spécifique peut être de vous assurer que vos mains et l'appareil sont secs avant de brancher l'appareil sur la prise de courant.
   • Fournissez des images (comme un crâne et des os croisés) ou du texte d'une couleur différente (comme du texte rouge) pour distinguer l'avertissement du reste des instructions de la notice d'utilisation et attirer l'attention des utilisateurs sur celui-ci.
3. Décrivez l'appareil. Votre description doit inclure à la fois une explication écrite de l'objectif de l'appareil et une petite représentation graphique de ce à quoi ressemble l'appareil. La figure doit étiqueter et nommer tous les commutateurs, boutons et pièces amovibles contenus dans l'appareil.
4. Fournissez les instructions d'installation. La section d'installation doit contenir des informations de base sur la préparation à l'utilisation du produit ou de l'appareil. Si l'appareil ne peut pas être construit ou installé par un utilisateur domestique, indiquez-le clairement dans un titre en gras en haut de la section d'installation. Vous devez également inclure les éléments suivants:
   • Une liste de pièces
   • Instructions de déballage
   • Avertissements d'installation
   • Conséquences d'une mauvaise installation
   • Qui appeler en cas de difficultés lors de l'installation
5. Fournissez des informations sur l'opération. Cette section est la partie la plus importante du manuel d'utilisation et doit fournir des informations concrètes et détaillées sur la façon d'utiliser l'appareil. Commencez par les préparatifs de base pour l'utilisation de l'appareil, par exemple en branchant le cordon d'alimentation ou en vous lavant les mains. Continuez avec des étapes logiques et numérotées décrivant comment utiliser le périphérique, ainsi que tout commentaire (par exemple, "Vous entendrez un clic ...") auquel l'utilisateur peut s'attendre lorsqu'il utilise correctement le périphérique.
   • À la fin de ce chapitre, les utilisateurs doivent être renvoyés au chapitre de dépannage pour résoudre les problèmes qui ne peuvent pas être expliqués rapidement.
   • Placez les images là où c'est nécessaire. Certaines étapes sont mieux expliquées avec des images et des mots. Pensez à utiliser des photos ou des illustrations dans votre manuel.
   • Dans cette section, comme dans n'importe quelle section, vous devez inclure des avertissements de sécurité pertinents concernant une utilisation ou une opération incorrecte. Par exemple, vous pouvez avertir les utilisateurs de tronçonneuse de ne pas boire d'alcool ou d'utiliser la tronçonneuse lorsqu'ils prennent certains médicaments.
   • Si vous pensez que les utilisateurs en bénéficieront, pensez à inclure des liens vers des vidéos en ligne démontrant l'utilisation et le fonctionnement corrects de l'appareil. Vous pouvez enregistrer ces vidéos soit au début de cette section, soit (dans le cas de vidéos qui illustrent une seule étape) à la fin de chaque étape.
6. Incluez un résumé du produit à la fin. Le résumé doit apparaître à la fin du manuel, juste avant l'index, pour fournir les étapes de fonctionnement de base. Il doit s'agir d'une version simplifiée et allégée des informations opérationnelles et ne doit pas dépasser une page. Résumez la manière dont l'appareil ou le produit doit être utilisé. Incluez des alertes de base, des étapes numérotées expliquant comment utiliser le produit et des numéros de téléphone ou des adresses e-mail qui invitent les utilisateurs à vous aider.
   • Si vous vous attendez à ce que l'utilisateur retire ou se réfère souvent à la feuille récapitulative, vous pouvez l'imprimer sur une carte plastifiée amovible ou un carton épais pour faciliter le transport et la référence par l'utilisateur.
   • Vous pouvez également appliquer un résumé directement au produit pour une référence rapide et facile par l'utilisateur.

Partie 3 sur 4: Description de la maintenance du produit

1. Expliquez comment nettoyer l'appareil. Si votre appareil ou produit doit être nettoyé, expliquez comment procéder. Énumérez les agents de nettoyage requis. Dites au lecteur à quelle fréquence nettoyer. Ensuite, comme dans toute autre partie du manuel, incluez des instructions numérotées étape par étape sur la façon de le nettoyer.
   • Si le nettoyage nécessite le démontage du produit ou le retrait d'une ou plusieurs pièces particulières, indiquez comment le produit doit être démonté.
   • Fournit un avertissement sur les résultats de l'échec du nettoyage de l'appareil. Par exemple, vous pourriez dire: "Si le périphérique n'est pas nettoyé, les performances seront moins qu'optimales".
2. Comptez l'utilisateur comment effectuer la maintenance de base. Si le produit ou le périphérique peut être réparé par l'utilisateur pour corriger les problèmes de performances, fournissez des instructions numérotées sur la façon de procéder pour l'utilisateur. Par exemple, si les piles doivent être remplacées toutes les 300 heures d'utilisation, fournissez des instructions sur la façon de vérifier si les piles doivent être remplacées, comment retirer les piles épuisées et comment installer les nouvelles.
   • Si certaines tâches de maintenance ne peuvent être effectuées que par un technicien certifié, divisez la partie maintenance du manuel en deux parties.
3. Discutez des options de stockage. Si nécessaire, le manuel doit expliquer comment stocker correctement le produit ou l'appareil. vous devez également inclure des informations sur les raisons pour lesquelles le stockage est nécessaire et les conséquences d'un stockage inapproprié. Par exemple: vous pourriez écrire:
   • Stockez le produit dans un endroit frais et sec. Un stockage inapproprié peut raccourcir la durée de vie de votre produit en raison de l'accumulation d'humidité. "
   • "N'exposez pas le produit à la chaleur et ne le stockez pas à des températures supérieures à 50 degrés Celsius.Si vous le faites, cela peut entraîner une combustion. "
4. Fournissez des informations de dépannage. Vous pouvez organiser cette section sous la forme d'une liste de problèmes courants et de leurs solutions. Regroupez les problèmes similaires sous une rubrique logique. De cette manière, les utilisateurs peuvent rapidement trouver des problèmes spécifiques.
   • Par exemple, s'il y a plusieurs problèmes avec l'ordinateur affichant un écran bleu, regroupez-les sous un sous-titre, tel que "Problèmes d'écran courants".
   • Vous devez également inclure un numéro de téléphone et / ou une adresse e-mail pour le service client dans cette section.

Partie 4 sur 4: Rédiger un manuel lisible

1. Lisez les autres guides de l'utilisateur. Avant d'écrire un manuel pour votre propre produit, consultez d'autres guides d'utilisation efficaces. Faites attention à la structure, au choix des mots et à la structure des phrases. Les grandes marques telles qu'Apple, Google et Microsoft produisent des guides de l'utilisateur solides et efficaces qui peuvent vous aider à produire un guide de l'utilisateur rédigé de manière plus réfléchie.
   • Ne vous contentez pas de lire tout manuels d'utilisation. Lisez les manuels des produits similaires que vous vendez. Par exemple, si vous vendez des produits pour bébé, lisez des manuels pour bébé, pas des manuels techniques.
2. Sélectionnez vos normes. La normalisation de l'orthographe, du choix des mots et du libellé rendra le manuel d'utilisation plus convivial. Le Chicago Manual of Style et le Microsoft Manual of Style peuvent également être des guides de style utiles lors de la rédaction de votre manuel du propriétaire; vérifiez les deux pour voir si l'un d'eux convient à votre manuel.
   • Par exemple, au lieu d'utiliser à la fois «interrupteur d'alimentation» et «bouton d'alimentation» dans votre manuel, choisissez l'un des deux termes et respectez-le.
3. Utilisez la voix active. La voix active est une manière d'écrire qui explique les choses du point de vue de l'utilisateur. Elle est plus facile à comprendre que l'alternative, la voix passive, dans laquelle le sujet est indéfini.
   • Essayez l'application Hemingway (www.hemmingwayapp.com) pour identifier les passages passifs de votre écriture.
   • Étudiez ces deux exemples de phrases - le premier est actif et le second est passif:
     • Vous devez ouvrir le paquet lentement et soigneusement.
     • L'emballage doit être ouvert lentement et soigneusement.
4. Écrivez des instructions numérotées. Les instructions ordonnées numériquement aident le lecteur à mieux se concentrer sur le processus d'utilisation, de connexion ou de construction du produit en question. Au lieu d'écrire un long paragraphe détaillé ou une série de paragraphes non numérotés, rédigez votre guide de l'utilisateur avec des étapes simples et explicites, chacune clairement numérotée.
5. Commencez chaque étape par un impératif. Un impératif est un verbe orienté vers l'action. En commençant chaque étape par un verbe, vous donnez au lecteur un indice sur l'action requise pour terminer l'étape. Par exemple, selon le produit sur lequel vous écrivez, vous pouvez commencer vos étapes avec une commande comme «Connecter», «Confirmer» ou «Faire glisser». Cependant, ne commencez pas vos étapes avec une réponse du système.
   • Par exemple, si l'écran devient bleu et commence à clignoter, ne démarrez pas l'étape avec: "L'écran clignotera et deviendra bleu." Essayez: "Appuyez sur la touche d'accueil et maintenez-la enfoncée. L'écran clignotera et deviendra bleu. "
6. Déterminez le vocabulaire que vous utiliserez. Si vous écrivez un manuel yo-yo, votre public sera principalement composé de jeunes enfants. Utilisez des mots et du vocabulaire simples pour expliquer le fonctionnement du yo-yo. Lorsque vous écrivez un manuel de microscope électronique à balayage, votre public est composé de scientifiques hautement qualifiés qui peuvent comprendre des informations très détaillées, alors n'hésitez pas à utiliser un vocabulaire spécialisé ou des explications nuancées.
   • En général, vous essayez d'éviter le jargon et le langage technique.
   • Pour être efficace pour la base d'utilisateurs la plus large possible, essayez d'écrire à un niveau allant de la sixième à la septième année de l'école primaire.
7. Lorsque vous expédiez un produit à l'étranger, assurez-vous que vos traductions sont exactes. Engagez un traducteur pour traduire votre manuel d'utilisation dans la langue maternelle du pays dans lequel vous expédiez votre produit. Vous pouvez également utiliser un programme de traduction en ligne, mais demandez à un locuteur natif de lire la traduction et de vérifier les erreurs.
   • Si plusieurs groupes linguistiques sont représentés dans votre audience, veuillez inclure les traductions du manuel d'utilisation dans chaque langue pertinente.
   • Le traducteur doit être familiarisé avec le produit car il peut y avoir différents mots dans la langue cible pour des termes spécifiques qui ne sont pas des traductions mot à mot.
8. Écrivez en phrases courtes. Au lieu de quelques longs paragraphes, vous utilisez beaucoup de courts paragraphes. Recherchez des coupures logiques dans chaque section et assimilez les informations utiles en morceaux d'une ou deux phrases. La même chose est vraie au niveau de la phrase. Gardez vos phrases courtes et simples, plutôt que longues et verbeuses.
   • Si une étape devient trop longue, divisez-la en étapes plus petites. Cela ne réduira pas le nombre de mots, mais les sauts de ligne faciliteront la lecture.
9. Consultez le manuel pour les erreurs. Un manuel peut perdre sa crédibilité en raison d'erreurs de grammaire et d'orthographe. Demandez à un collègue ou à un rédacteur technique de réviser et de relire également le manuel. En plus de l'orthographe et de la grammaire, un relecteur doit prêter attention aux points suivants:
   • Voix passive
   • Langage peu clair ou déroutant
   • Structure de la phrase enveloppée
   • Paragraphes trop longs

Conseils

• Les gens apprennent de différentes manières; Si possible et approprié, incluez des aides visuelles ou des liens vers des vidéos en ligne dans le manuel pour accueillir les lecteurs visuellement orientés.