Les Plus Grosses Erreurs Commises par les Auteurs de Manuel d'Aide Débutants

Biggest Mistakes First Time Help Manual Authors Make

Quelle est la pire erreur que vous puissiez faire en tant qu' auteur de manuel d'aide débutant?

Un bon manuel d'aide se doit d'être pratique et contenir des instructions claires que les utilisateurs puissent trouver et utiliser facilement. Mais si vous êtes un auteur débutant, la création d'un bon manuel d'aide peut s'avérer une tâche difficile, surtout s'il s'agit de votre premier projet de rédaction technique.
Il est intéressant de savoir que tout bon rédacteur de manuel d'aide a débuté un jour et qu'il a lui aussi fait plusieurs erreurs lors de sa première tentative. Nous avons donc compilé ces erreurs afin que vous puissiez ne pas les reproduire. C'est une chance de pouvoir ainsi apprendre de ces erreurs et créer un manuel d'aide remarquable dès votre première tentative.

Voici donc le top 5 des plus grandes erreurs que font les rédacteurs de manuel d'aide débutants:

1. Une mauvaise structure

La rédaction technique requiert une structure simple et claire, qui est différente de toute autre forme d'écriture. La structure est la manière dont est agencée l'information contenue dans un manuel d'aide. De nombreux auteurs de manuel d'aide débutants font l'erreur d'écrire sans avoir une structure simple et claire. Lorsque la structure est mauvaise, il est difficile pour les utilisateurs de naviguer ou de trouver des réponses facilement et le manuel devient ennuyeux.
Mais votre manuel d'aide n'est pas condamné à être ennuyeux, tout ce que vous avez à faire est de créer une structure simple. Voici comment:

  • Utilisez des phrases courtes et faciles à comprendre. Chaque phrase doit contenir une information.
  • Assurez-vous que l'information la plus importante arrive en premier. Placez celles dont tous les utilisateurs ont besoin avant celles dont seuls quelques utilisateurs auront besoin.
  • Placez les informations les plus fréquemment requises avant les informations qui ne sont utiles que de temps en temps.
  • Groupez en un seul endroit les différents points ou informations qui sont liés.
  • Assurez-vous qu'il soit facile d'accéder à chaque élément d'information séparément.

2. Écrire à la voix passive

Vous pouvez soit écrire à la voix active soit à la voix passive. Comme les manuels d' aide sont toujours éducatifs, écrire à la voix active facilite la compréhension des informations contenues aux utilisateurs. De nombreux manuels d'aide demandent souvent aux utilisateurs d'effectuer une ou plusieurs actions et l'écrire à la voix active aide les utilisateurs à exécuter la bonne action plus facilement.

Écrire à la voix passive peut rendre votre manuel d'aide ennuyeux, ambigu ou même trompeur. C'est pourquoi vous auriez tout intérêt à suivre ces meilleures pratiques dans la rédaction de documents et manuels d'aide.

3. Rédiger un contenu Vague

L' une des principales raisons pour lesquelles les gens lisent des manuels d' aide est de trouver des réponses. Si les informations de votre manuel d'aide sont techniquement creuses et dénuées de sens, vous avez réussi à créer un manuel d'aide vague. Pour éviter cela, vous devez:

  • Présenter l'information dans un étape par étape.
  • Dire aux utilisateurs du produit quelles sont les fonctionnalités disponibles, et à quoi sert chacune d'entre elles, ne vous contentez pas de dire comment les utiliser.
  • Utilisez des images, des diagrammes et des terminologies avec lesquels les utilisateurs du produit sont familiers.
  • N'écrivez pas pour impressionner les utilisateurs, écrivez pour exprimer des solutions et des réponses.
  • Sachez exactement pourquoi vous écrivez et pour qui vous écrivez.

4. Une mauvaise Mise en page

Si la mise en page de votre manuel d'aide est non-professionnelle et dysfonctionnelle, les utilisateurs peuvent avoir une mauvaise impression de votre marque et vous aurez à dépenser plus en matière de support à la clientèle. Mais qu'est ce qu'est exactement la mise en page d'un manuel utilisateur? C'est la façon dont les textes et les images sont présentés sur chaque page de votre manuel.
Si votre mise en page est trop colorée et trop chargée, elle peut distraire les utilisateurs de la véritable information. Pour éviter cela, utilisez des couleurs contrastées, ombrées ou en gras pour en souligner l'importance. Assurez-vous que les images soient claires et faciles à comprendre.

Si vous créez un manuel d'utilisateur "online", assurez-vous d'utiliser des polices qui soient les mieux adaptées pour la lecture à l'écran. Les polices sans-serif fonctionnent mieux pour la lecture sur un écran. Assurez-vous que les utilisateurs puissent facilement identifier ce qui est cliquable et ce qui ne l'est pas. Avec autant de "smart devices" qui nous entourent, il y a beaucoup de mises en page et de modèles que vous devez prendre en considération. Ne limitez pas votre manuel d'aide à un seul type de fichier ou de version. Voilà pourquoi vous devez créer des versions ePub et Kindle de vos manuels d'aide.

5. Un Mauvais Processus de Création

Beaucoup d'auteurs de manuel d'aide débutants créent leur premier manuel sans outil de création d'aide (OCA). Ils utilisent habituellement Microsoft Word, puisqu'ils l'utilisent déjà pour créer des documents. J'adore Microsoft Word, c'est un excellent logiciel! Mais ce n'est pas le bon outil pour la création de manuels d'aide.

La meilleure façon de rédiger un bon manuel d'aide est d'utiliser un outil de création d'aide. Avec un OCA, vous pouvez mettre à jour et reproduire le manuel d'aide sans aucun effort. L'outil permet à partir d'une source unique de générer différents formats (PDF, CHM, HTML, Word, iPhone, eBooks, ePubs ...) de votre manuel. En outre, vous pouvez facilement personnaliser la mise en page et la présentation de vos manuels.

Vous pouvez commencer par profiter du logiciel de création d'aide HelpNDoc. Vous pouvez le télécharger pour une utilisation personnelle et son évaluation - et il est complétement gratuit!

La clé pour créer un manuel d'aide convivial est de supposer que les utilisateurs du produit n'ont absolument aucune idée de comment utiliser le produit - et bien souvent, c'est la vérité. Cela dit, vous devrez simplifier votre contenupour les utilisateurs sans le rendre ennuyeux ou trop technique.