Le guide de rédaction de documents d'aide et de manuels pour les idiots

Write help documents and manuals

Si vous n'avez jamais rédigé de documentation d'aide jusqu'ici, cela peut vous paraître un peu effrayant. Les utilisateurs finaux de votre produit comptent sur ​​vous pour les aider à comprendre toutes les fonctions du produit, et leur utilisation continue du produit repose sur la façon dont vous réussissez à répondre à leurs questions. Voici notre "guide pour les idiots" pour la rédaction de manuels et de documents d'aide. Ces conseils vous aideront à rédiger des documents d'aide qui couvrent tous les détails que vous devez inclure et qui puissent être facilement compris par vos utilisateurs finaux.

Comprendre vos utilisateurs-produit

C'est le point le plus fondamental quand on rédige une documentation d'aide. Si ce que vous rédigez est destiné à être utile à ceux qui essayent de comprendre le produit, il faut aborder les sujets qui les préoccupent. Il est inutile de rédiger un manuel d'aide joliment présenté s'il n'aide personne à utiliser le produit, ou s'il répond à des questions que personne ne se pose réellement sur le produit.
Commencez par parler à ceux qui utilisent le produit. Découvrez comment ils l'utilisent, pourquoi ils l'utilisent? Quelles fonctions sont le plus couramment utilisées? Parlez avec le service d'assistance ou le support client, sachez quelles sont les questions que les utilisateurs posent le plus fréquemment.
Une fois que vous avez une véritable compréhension de la façon dont les clients utilisent votre produit, vous aurez alors une idée beaucoup plus claire des fonctions du produit qui nécessitent que vous preniez le temps de les expliquer.Vous saurez aussi quels sont les domaines sur lesquels vous pouvez passer brièvement.

Planifiez soigneusement votre table des matières

Il est important d'inclure toutes les fonctions de votre produit, mais il est encore plus important de s'assurer que le guide soit structuré de manière logique. Les utilisateurs doivent être en mesure de trouver ce qu'ils cherchent. Un guide d'aide n'est pas une chose que les gens ont envie de lire du début à la fin. La plupart des gens n'ouvrent le guide d'aide que lorsqu'ils se posent une question précise et ils veulent aller directement au point qui traite du sujet qui les concerne dans la documentation d'aide.
Essayez de penser à chaque façon dont votre produit sera utilisé et listez les étapes dans l'ordre où elles devront être réalisées pour accomplir la tâche requise, cela permet aux lecteurs de trouver facilement l'information dont ils ont besoin.

Écrire pour le bon public

Rédigez la documentation ou le manuel d'aide à un niveau qui soit approprié pour les utilisateurs de votre produit. Pensez aux personnes qui utiliseront votre produit et au niveau d'expertise technique qu'ils sont susceptibles de posséder. Une bonne documentation d'aide évitera de supposer des connaissances que les utilisateurs n'ont pas, mais elle évitera aussi de prendre les utilisateurs de haut et de tout leur expliquer avec tellement de détails qu'ils auront l'impression d'être considérés comme une classe de maternelle.

Simplifier la création de vos documents d'aide

Utilisez un logiciel de création d'aide pour vous guider lorsque vous créez votre manuel. La meilleure façon d'écrire une bonne documentation d'aide est d'utiliser un logiciel spécialement conçu pour rédiger ce type de matériel. Un progiciel de création d'aide peut rendre le travail de mise en page de votre documentation beaucoup plus simple. Avec un éditeur de chapitre, la capacité de créer des modèles et une bibliothèque de médias polyvalente, concevoir une documentation d'aide est simple, et le manuel achevé peut ensuite être exporté dans divers formats sans devoir reformater le manuel à chaque fois.