Combien de fois avez-vous passé une éternité à chercher dans un fichier d’aide quelque chose que vous saviez être là, mais que vous ne pouviez pas trouver? La documentation d’aide est généralement le premier endroit où nous cherchons lorsque nous ne savons pas comment quelque chose est censé fonctionner. Si les informations contenues dans le fichier d’aide ne sont pas claires, ou même pire trompeuses, alors nous finirons par être simplement frustrés et peut-être même rejetterons-nous le produit pour lui préférer quelque chose de plus facile à comprendre.

Lire la suite →

La création de la documentation d’aide d’un produit, présente de nombreuses similitudes avec un projet étudiant typique. Un projet étudiant devra souvent:

• Discuter d’un sujet en profondeur, en couvrant minutieusement chaque aspect du sujet
• Diviser un sujet en sections clairement identifiables
• Inclure des références détaillées appuyant la conclusion du projet
• Fournir un index complet couvrant le sujet discuté

Toutes ces tâches peuvent être bien mieux gérées dans un logiciel de création d’aide que dans une suite de traitement de texte classique. Si vous rédigez un projet étudiant dans Microsoft Word, vous avez peu d’autre choix que de commencer au début du sujet et de taper le tout au fur et à mesure. Cette approche rend l’écriture du projet difficile et très longue.

Lire la suite →

Rédiger une documentation d’aide est un travail pénible, un rédacteur technique doit expliquer clairement chaque fonction du produit et la documentation doit être écrite pour un large panel d’utilisateurs du produit, dont tous n’approcherons pas le produit avec les mêmes attentes ou le même niveau d’expertise technique.
Malgré ces considérations, dans de nombreux cas les auteurs techniques découvrent qu’écrire la documentation d’aide n’est que la partie la plus facile du processus. Une fois qu’ils ont rédigé tout ce qu’ils ont à dire pour couvrir le sujet correctement, ils doivent ensuite le formater pour qu’il soit accessible et facile à lire dans une variété de formats. Les formats qui peuvent être requis incluent PDF, Word, online HTML, éventuellement HLP ou encore CHM. Le processus de formatage peut être très long quand que ce que veulent vraiment la plupart des auteurs techniques, c’est se concentrer sur le fait de rédiger une très bonne documentation d’aide et non pas passer une éternité à s’inquiéter de savoir comment leurs pages vont s’afficher sur différents appareils.
Lorsque la documentation est enfin terminée, ce n’est bien souvent pas encore la fin du processus, car chaque fois que le produit est révisé, la documentation doit être modifiée pour refléter les caractéristiques nouvelles ou mises à jour.

Lire la suite →