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

Help Authoring Tool

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.

Comment un outil d'aide à la création aide-t-il?

De nombreux auteurs techniques ont découvert que la façon la plus simple pour réduire le travail fastidieux consistant à rédiger une documentation d'aide, est d'utiliser un outil de création d'aide.

Un Outil de Création d'Aide ou OCA est un logiciel utilisé par les rédacteurs techniques pour créer des systèmes d'aide en ligne.

Les outils de création d'aide simplifient le processus de rédaction et permettent aux auteurs de se concentrer sur les aspects les plus importants de la rédaction de la documentation d'aide - la rendre facile à lire, exacte, détaillée et de manière générale, utile pour le lecteur final.
Il existe plusieurs outils de création d'aide différents, qui sont disponibles pour faciliter la vie des auteurs techniques. L'un des outils de création d'aide le plus populaire est HelpNDoc, il comprend d'excellentes fonctionnalités pour réduire le temps nécessaire à l'écriture d'une documentation d'aide.
Quelques-unes des fonctionnalités les plus utiles d'HelpNDoc comprennent:

  • Un environnement de création simple, facile à utiliser et complet
  • La capacité de générer de multiples formats d'aide depuis une unique source
  • La souplesse pour personnaliser l'apparence et l'impression dégagée par la documentation d'aide
  • HelpNDoc est gratuit pour un usage personnel, et à des fins d'évaluation.

Jetons un oeil à chacune des caractéristiques d'un bon outil de création d'aide et voyons comment ces caractéristiques peuvent vous aider à rédiger une meilleure documentation d'aide, vous faire gagner du temps pour toutes vos tâches d'écriture et créer des documents uniques et de grande qualité, qui permettent à l'utilisateur final de trouver facilement et rapidement l'information dont il a besoin.

Un environnement de création complet

Il est possible d'écrire une documentation d'aide en utilisant Microsoft Word ou un autre traitement de texte de base, mais ce n'est pas une solution très pratique car un traitement de texte n'a pas la fonctionnalité dédiée d'un outil de création d'aide.
La beauté d'un outil de création d'aide, c'est que vous avez un excellent traitement de texte associé à de nombreux autres outils supplémentaires qui simplifient la création de votre documentation.
Ces outils comprennent souvent un éditeur de table des matières, un éditeur de mots-clés, un éditeur de chapitre et une bibliothèque d'éléments médias, qui jouent tous un rôle pour vous aider à construire une documentation d'aide de grande qualité sans les tracas que vous avez peut-être connu par le passé.

La création de multiples formats d'aide à partir d'une source unique

La création de multiples formats est probablement le plus grand avantage qu'un outil de création d'aide puisse fournir. Il est important pour n'importe quel produit, que la documentation d'aide soit disponible dans au moins quelques formats différents. Si vous concevez votre document d'aide dans Microsoft Word, vous devrez alors passer du temps à le formater pour un affichage en ligne, ou pour le faire fonctionner en tant que fichier .CHM, ou peut-être voudrez vous qu'il soit lu comme un livre EPUB. Chacun de ces formats comporte des règles différentes et concevoir votre document de manière à pouvoir s'afficher correctement dans chaque format prend du temps. Un bon outil de création d'aide peut supprimer tout le travail fastidieux de ce processus. En tant qu'auteur technique tout ce que vous avez à faire c'est d'écrire votre document dans l'environnement de création et il sera ensuite automatiquement converti en autant de formats différents que vous le souhaitez.

Une apparence et une impression personnalisées pour vos documents

Une des raisons les plus courantes donnée par les auteurs pour ne pas utiliser d'outil de création d'aide standard, c'est que tous les documents finalisés se ressemblent et qu'il n'y a aucun moyen de personnaliser le document pour lui donner un aspect qui soit unique. Cet argument ne tient certainement pas pour la plupart des outils de création d'aide. Ces outils permettent une liberté complète pour concevoir la documentation d'aide comme vous le souhaitez.
Un bon outil de création d'aide devrait toujours donner accès au code source complet de tous ses modèles de design. Avoir accès au code source vous permettra de personnaliser complètement les modèles et de générer une documentation en ligne, ou même un site iPhone, qui ressemblera exactement à ce que vous voulez.
Une bibliothèque d'éléments médias stocke toutes les images, les vidéos et autres variables utilisées dans votre document. Vous pouvez inclure ces éléments tout au long du document selon vos besoins. Ce système basé sur l'usage d'une bibliothèque présente un avantage supplémentaire lorsque vous souhaitez mettre à jour l'une des images de votre document. Si, par exemple, votre logo d'entreprise change et que vous l'avez inclus en de nombreux endroits dans votre document, il n'est pas nécessaire de travailler à travers tout le document pour modifier chaque instance de l'image. Il suffit de modifier le fichier dans la bibliothèque et chaque copie de la photo ou de la vidéo sera automatiquement mise à jour pour refléter le changement dans le document. Cette capacité à faire des modifications rapides sur tout document d'aide définit l'outil de création d'aide dédié, contrairement à toute autre moyen pour créer un document d'aide.

Un logiciel qui soit gratuit

Vous pourriez penser qu'un logiciel qui est utile et qui permet de gagner autant de temps est forcément cher à l'achat. Au moins dans le cas d'HelpNDoc, ce n'est pas le cas. Cet outil de création d'aide est gratuit à utiliser à des fins personnelles et d'évaluation. La version gratuite est complète et contient toutes les fonctionnalités. Tous les auteurs ont donc accès à tout ce dont ils ont besoin pour créer de très belles documentations d'aide, sans se soucier du coût.

Lorsqu'on considère ces avantages, on comprend clairement pourquoi tant d'auteurs techniques choisissent d'utiliser un outil de création d'aide pour écrire la totalité de leurs documentations d'aide, leurs manuels et autres documents techniques dont ils peuvent avoir besoin. Un outil de création d'aide est le bon choix pour simplifier toutes les tâches de rédaction technique.