Comment Écrire un Excellent Manuel d'Aide

Lorsque vous écrivez un excellent manuel d’aide, vous faites deux choses – vous aidez les clients à trouver et utiliser facilement les solutions appropriées et vous réduisez significativement vos couts d’assistance clientèle.
Bien plus encore, les clients seront ravis de recommander votre produit, et les décideurs dans votre branche commerciale recommanderont facilement votre marque aux autres experts et à leurs clients. Voici pourquoi la rédaction d’un manuel d’aide de qualité peut être le meilleur investissement dans votre entreprise.
Mais comment justement écrire un excellent manuel d’aide ?

Comment Écrire un Excellent Manuel d’Aide en 8 Étapes Simples

1. Définir pour qui vous écrivez

Connaissez-vous bien les utilisateurs de votre produit? Avant de commencer à écrire, définissez votre public cible, faites des recherches sur leur choix de mots et leur niveau de connaissance technique. Si vous ciblez des experts techniques, votre choix de mots et de termes techniques devrait être différent de ce que vous utiliseriez pour de nouveaux utilisateurs du produits avec peu ou pas de connaissances techniques.

2. Inclure toutes les sections pertinentes

Les bons manuels d’aide ont plusieurs sections clés différentes. Ces sections principales incluent la page de couverture, table de matières, liste de graphiques et de tableaux, introduction, chapitres, annexe, glossaire, index et couverture arrière… Toutes ces sections peuvent ne pas être pertinentes dans votre manuel d’aide, vous devrez donc choisir avec soin celles qui rendent vos manuels d’aide plus accessibles.
Ces sections principales ne devraient jamais compliquer la tâche dans le manuel, mais la simplifier. Pour ce faire, utilisez un format harmonisé pour chaque section et introduisez chaque section avec un très court résumé de la tâche à effectuer.

3. Rendre le contenu facile à lire

Tout d’abord, vous devez séparer les instructions ou procédures à partir des références. Il sera ainsi plus facile aux utilisateurs de naviguer dans le manuel rapidement. Chaque instruction doit être écrite pour aider les utilisateurs à effectuer des tâches spécifiques.
Commencez par identifier les principales tâches à accomplir et ensuite divisez chaque tâche majeure en sous-tâches. Utilisez de courtes phrases et des mots que les utilisateurs comprendront, écrivez une série d’étapes qui indiquent aux utilisateurs comment facilement réaliser chaque sous-tâche.
Informez l’utilisateur sur les fonctions du produit et la façon de les utiliser. Indiquez l’importance ou l’accent via des contrastes, des couleurs ou des nuances. Ne pas supposer que les utilisateurs comprennent tous les termes techniques simplifiés mentionnés : créez un glossaire de termes techniques expliquant la signification de chacun tel qu’employé dans le manuel.

4. Parler directement aux utilisateurs

Votre manuel d’aide ne doit pas être ennuyeux; il faut donc toujours utiliser la forme active lors de l’écriture et utiliser la deuxième personne – “Vous”, “Vôtre” et “Vos”. Lorsque vous demandez aux utilisateurs d’effectuer une action, utilisez la forme impérative du verbe le plus pertinent. Par exemple: " choisissez la deuxième option dans le menu déroulant et appuyez sur Entrée “.

5. Segmenter vos textes

Selon les connaissances techniques de votre public cible, il se peut que vous ayez à diviser de gros fragments d’information en plus petits via un processus appelé regroupement en blocs. C’est très différent de la création de sous-tâches. Si une sous-tâche a un gros fragment d’information qui peut poser un défi pour les utilisateurs, vous pouvez le diviser en une liste de “blocs”. Voici les meilleures pratiques dans la rédaction de manuels et documents d’aide.

6. Utiliser les images et illustrations de lanière adéquate

Parfois, vous avez juste besoin d’une ou deux illustrations pour simplifier l’exécution d’une tâche par les utilisateurs. L’une des raisons pour lesquelles certains utilisateurs ne lisent jamais les manuels d’aide est la longue série de textes ennuyeux qu’ils contiennent. Vous pouvez rendre votre manuel d’utilisation facile à lire et comprendre en vous servant d’images et d’illustrations adéquatement pour expliquer des tâches complexes.

7. Corriger le manuel

Une simple faute d’orthographe ou de grammaire suffit pour détruire complètement une instruction dans un manuel d’aide. Une fois la rédaction terminée, relisez le manuel et ayez au moins deux personnes possédant une connaissance approfondie du produit pour relire le manuel également.

8. Choisir soigneusement le bon format d’édition

La solution est simple. Vous devrez choisir des formats de documents qui rendront le manuel facilement accessible aux utilisateurs lorsque nécessaire et exactement tel qu’ils en ont besoin.
Mais que se passe-t-il si vos utilisateurs ont accès à plusieurs formats de documents différents. Avez-vous vraiment à souffrir dans la création de plusieurs manuels pour les différents formats ? La solution est très simple. Vous pouvez profiter de HelpNDoc, un outil de création de manuel d’aide qui génère différents formats de documentation à partir d’une unique source. Tout ce que vous avez à faire, c’est créer un seul fichier de manuel d’aide ; HelpNDoc va convertir ce fichier dans tout autre format souhaité.

La rédaction d’un excellent manuel d’aide nécessite précision et minutie. Bien que cela puisse sembler lent au début, vous pouvez tirer parti des outils de création de manuel d’aide pour écrire de meilleurs manuels en peu de temps.

Voir aussi...

Analyse d'audience en rédaction technique : Comment Obtenir les Données Adéquates [Featured]

Tags: Formats de Documentation Trucs & Astuces

Comment Écrire un Excellent Manuel d’Aide