Une documentation d'aide n'a pas à être ennuyeuse

Help documentation doesn't have to be boring

Reconnaissons-le, la documentation d'aide a aujourd'hui une terrible image. Presque tout ceux à qui vous parlez à ce sujet ont une mauvaise image des manuels d'aide. Il y a de nombreuses raisons à cela, les plus courantes étant:

  • Elles ne répondent pas aux questions que vous vous posez
  • Vous ne pouvez pas trouver la réponse, même si vous savez qu'elle est là quelque part
  • Il est difficile de naviguer dans le manuel
  • La documentation est obsolète
  • La documentation n'existe pas encore

Avec des problèmes de ce genre, il n'est pas surprenant que beaucoup de gens ne prennent pas la peine de lire les documents d'aide, ils préfèrent essayer de trouver la réponse par eux-mêmes ou ils cherchent tout simplement un produit qui est plus facile à comprendre. Personne ne veut passer son temps à travailler avec un manuel long et ennuyeux, qui de toute façon ne répondra probablement pas aux questions qui se posent.
Ce n'est pourtant pas une fatalité! Il est tout à fait possible d'avoir une documentation d'aide au sein de laquelle il soit facile de naviguer et qui réponde rapidement et correctement aux questions des utilisateurs finaux.

Comprendre les besoins de vos clients

Pour quiconque rédige des documentations d'aide, les problèmes commencent généralement parce qu'ils n'approchent pas le document de la bonne façon. Souvent, ceux qui sont en charge de produire la documentation, sont les mêmes qui ont passé des mois à développer le produit. La tentation est grande de supposer que tout ceux qui utilisent votre produit ont le même niveau de connaissance que vous et qu'il désirent utiliser le produit de la manière à laquelle vous vous attendez.
Il est nécessaire d'accepter le fait que ce ne soit pas le cas. Chacun des utilisateurs de votre produit l'abordera avec un niveau de connaissance différent et probablement avec des attentes un peu différentes de ce que votre produit peut faire, et de comment ils veulent l'utiliser. Votre documentation d'aide doit accompagner chacune de ces personnes là où ils en sont, à travers chacune des fonctions de votre produit. Au moment où ils atteignent la fin de la documentation, ils devraient être en mesure de bien comprendre toutes les fonctions du produit qu'ils ont besoin d'utiliser, sans avoir eu à se battre avec des pages d'informations sur des fonctions qu'ils n'utiliseront jamais.

L'organisation est la clé

Une des plus grosse difficultés pour tous ceux qui envisagent de rédiger un manuel d'aide, est de savoir comment organiser les ressources. Ils peuvent savoir tout ce qui est possible sur le produit, à moins de savoir comment organiser ce matériel de manière utile, cela ne bénéficie à personne. Un logiciel qui peut s'avérer très utile est l'outil de création d'aide. Un OCA peut vous assister pour organiser et mettre en forme le matériel de votre aide et de vos manuels. Utiliser des fonctions comme l'éditeur de chapitre et la bibliothèque de médias peut vous aider à vous assurer que chaque chapitre sur lequel vous devez écrire est couvert en profondeur et que toutes les images et autres éléments multimédias que vous devez utiliser sont en place afin de rendre le manuel facile à comprendre.

Utiliser un outil de création d'aide est particulièrement utile lorsqu'il est temps de mettre à jour la documentation d'aide. Au lieu d'avoir à réécrire des sections du manuel, puis de reformater minutieusement l'ensemble du document pour refléter les changements, il vous suffit de cliquer sur quelques boutons et le manuel est mis à jour et il peut être sorti dans un large éventail de formats, y compris PDF, ePub ou Qt Help. Il est même possible de générer une version HTML complète de votre documentation d'aide, qui peut être utilisée comme fichier d'aide en ligne.
Créer une documentation d'aide qui soit bien organisée, qui soit belle et qui réponde vraiment aux questions de vos clients, est un excellent moyen pour que plus personne ne trouve jamais vos manuels d'aide ennuyeux.