Lorsque l'aide et les manuels sont mauvais

help and manuals go wrong

Tout le monde ou presque a au moins une horrible histoire liée à un manuel d'aide à raconter. Qu'il s'agisse d'essayer de comprendre un produit quand le manuel d'aide est écrit dans un si mauvais Français qu'il est illisible, ou qu'un produit ait simplement été livré avec le manuel d'un autre modèle. Ou peut-être l'histoire concerne-t-elle l'un de ces manuels qui sont si détaillés qu'ils contiennent trop d'informations et qu'il est presque impossible de trouver la réponse dont vous avez rapidement besoin. Il existe beaucoup de raisons pour qu'un manuel d'aide soit mauvais, mais en général, elles peuvent être divisées en deux principales catégories:

  • Le manuel est obsolète ou contient la mauvaise information
  • Le manuel est mal écrit ou il est difficile à parcourir

Une grande partie de ces problèmes avec les manuels d'aide se produit parce que les auteurs de ces manuels sont débordés, et essayent d'en faire trop, trop vite. Souvent, les auteurs d'aide sont les mêmes personnes qui développent et commercialisent le produit, et le manuel est souvent la dernière chose à laquelle ils pensent. S'assurer que le produit est tout à fait terminé et testé est toujours prioritaire. Ensuite, il y a urgence à mettre le produit sur ​​le marché, et on ne dispose pas de beaucoup de temps pour rédiger le manuel.
Rédiger un bon manuel en partant de zéro peut prendre beaucoup de temps, surtout si le produit est assez complexe..

Quelle est la solution?

Il est peu probable que les rédacteurs techniques disposent de beaucoup de temps pour rédiger le manuel, or si un bon manuel ne peut être rédigé dans le délai imparti, allons-nous devoir toujours nous contenter pour autant de manuels de second ordre?
Non, car heureusement pour les auteurs d'aides, il existe une solution simple. Si vous utilisez un Outil de Création d'Aide (OCA) pour rédiger votre documentation d'aide, vous pouvez produire un manuel de haute qualité rapidement, sans vous soucier des problèmes de mise en forme ou de navigation dans le manuel.
HelpNDoc et d'autres logiciels de création fournissent aux auteurs un environnement de traitement de texte pleinement fonctionnel ainsi qu'une série d'outils destinés à faciliter la vie des auteurs. Vous pouvez ajouter des images et des vidéos à vos fichiers d'aide en quelques clics seulement et l'utilisation de l'éditeur de chapitre vous permet de vérifier que tous les chapitres importants que vous devez couvrir ont été inclus dans la documentation. Une fois que le document ressemble exactement à ce que vous vouliez, vous pouvez sortir le fichier en autant de formats que vous le souhaitez. Parmi ceux-ci PDF, HTML, ou même ePub, ou Kindle eBook pour que vos utilisateurs puissent lire le manuel sur leurs e-readers.
Ce sont toutes des fonctions utiles, mais pour la plupart des auteurs les réels avantages de l'utilisation d'un OCA se constatent lorsque les manuels ont besoin d'être mis à jour. Ces outils font tout le formatage pour vous et au lieu d'avoir à reformater le contenu après chaque changement, il vous suffit de modifier la section que vous devez mettre à jour, puis de sortir à nouveau le fichier. Si vous devez changer une image ou d'autres éléments médias, vous pouvez le faire en quelques clics. Un OCA rend la production des manuels plus rapide et plus facile que jamais.