Les meilleures pratiques en matière de rédaction de documents et de manuels d'aide

Writing Help Documents

Rédiger une documentation d'aide peut s'avérer un processus délicat. Vous devez apprendre à penser comme l'utilisateur d'un produit et non comme un développeur. En tant que responsable de la rédaction de la documentation d'aide, vous connaissez surement votre produit depuis longtemps et vous êtes sans doute très familiarisé avec la manière dont il fonctionne. C'est utile lorsque vous rédigez la documentation d'aide mais cela peut aussi être un désavantage, puisque vous abordez le produit d'une manière différente de ceux qui le découvrent pour la première fois. Ce qui vous paraît peut-être évident, peut s'avérer être un mystère absolu pour quelqu'un qui n'a pas votre expérience du produit ou votre connaissance du processus de conception.

Quelles sont les meilleures pratiques en matière de rédaction de documents d'aide?

Très peu de gens ouvrent un document d'aide en commençant par le début pour le lire jusqu'à la fin. La plupart des gens ouvrent la documentation d'aide lorsqu'ils cherchent à connaître une chose en particulier. Souvent il y a une fonction ou un outil qu'ils souhaitent utiliser et qu'ils ne peuvent comprendre sans une information précise. Il veulent pouvoir ouvrir le manuel d'aide et trouver rapidement l'information dont ils ont besoin, puis retourner à leur travail aussi vite que possible.

Il y a des choses spécifiques que nous pouvons dire sur la façon dont la documentation d'aide doit être organisée:

  • La documentation d'aide doit être organisée de manière logique
  • La documentation d'aide doit être conçue pour être facile à consulter
  • La documentation d'aide doit comprendre un index des chapitres

Organiser le document d'aide de manière logique

Les meilleures pratiques en matière de rédaction de documents d'aide consistent à organiser les documents en chapitres. Les utilisateurs comprennent généralement la plupart des choses qu'ils doivent connaître pour faire fonctionner votre produit, mais il y aura quelques domaines pour lesquels ils auront besoin d'aide. En tant que rédacteur technique c'est votre travail de rédiger la documentation de manière à ce qu'ils puissent trouver facilement ces points qu'ils ont besoin qu'on les aide à comprendre.

Concevoir la documentation d'aide pour qu'elle puisse être consultée rapidement

La meilleure documentation d'aide est toujours facile à consulter. Les utilisateurs doivent pouvoir trouver la section sur la page qui contient l'information dont ils ont besoin. Ils ne veulent pas lire un chapitre entier d'un texte difficile à lire, qui leur donne des informations qu'ils connaissent déjà. Fragmentez le texte en paragraphes courts et faciles à lire et faites en sorte qu'on sache clairement ce que contient chaque section.

Pensez à inclure un bon index

L'index est probablement la partie la plus importante de toute documentation d'aide. Contrairement à un livre conventionnel, beaucoup de lecteurs vont aller à l'index avant de lire tout autre partie du livret. L'index doit être aussi complet que possible et doit lister chaque sujet que vos lecteurs sont susceptibles de chercher. C'est aussi une excellente idée d'y inclure des synonymes des sujets.

Comment pouvez-vous suivre ces bonnes pratiques en matière de rédaction de documents d'aide?

Rédiger des documents d'aide ainsi peut sembler un travail difficile, mais il existe des outils de création disponibles pour vous aider à rendre ce processus très simple. HelpNDoc est un exemple de logiciel gratuit qui fait tout le travail difficile pour vous. Il comprend un éditeur de mot-clé et un éditeur de chapitre pour simplifier l'organisation de votre travail, et quand vous avez terminé toute la partie rédaction, votre document est automatiquement converti en différents formats sans travail supplémentaire.