Formats de Documentation

Formats de documentation générés par des outils ou logiciels de création d'aide.

Pourquoi devriez-vous créer des versions ePub et Kindle de vos fichiers d'aide?

Tout le monde comprend l'importance d'une documentation d'aide précise et mise à jour. La seule manière de tirer le meilleur parti de n'importe quel produit, c'est d'en lire le manuel et d'y trouver comment utiliser correctement chaque fonction. La difficulté à laquelle font face les développeurs de nombreux produits, est de savoir quels formats choisir pour produire leur documentation d'aide. Autrefois, un manuel imprimé était considéré comme suffisant pour la plupart des produits. Au cours des dernières années, le manuel imprimé a souvent été remplacé soit par un PDF, soit par une version en ligne. Mais s'agit-il vraiment des meilleures options disponibles?

Qu'est-ce qu'un outil de création d'aide ?

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.