Les documents d'aide sont désormais plus faciles à rédiger

Help documents are easier to write

Rédiger un manuel d'aide peut souvent s'avérer être un processus très pénible. Tout le monde sait que l'objectif est de créer un manuel qui permette aux utilisateurs de comprendre toutes les fonctions de vos produits et de résoudre les problèmes qu'ils rencontrent. La difficulté réside dans le fait de savoir comment y parvenir. La plupart des auteurs font un jour ou l'autre l'expérience de la page blanche (ou de l'écran blanc), se demandant comment commencer leur dernier livre ou article. Quand on rédige une documentation d'aide, le principal problème est de savoir comment aborder le sujet.

Identifiez les fonctions de votre produit

La manière la plus simple de commencer est d'identifier toutes les fonctions distinctes du produit puis d'écrire alors à propos de chacune d'entres-elles.
Il est utile d'expliquer quel est l'objet de chaque fonction au début de chaque section, et non pas de fournir simplement un guide étape par étape. Tous les utilisateurs ne seront pas aussi familiers que vous l'êtes avec votre produit et ils peuvent ne pas apprécier tout ce qu'ils peuvent faire avec le produit. Nous avons tous été dans la situation d'avoir acheté un produit pour faire une chose et de découvrir par la suite qu'il était aussi possible de l'utiliser d'une autre façon, ou de faire quelque chose d'autre avec à laquelle nous n'avions même pas pensé lorsque nous l'avons acheté.

Les avantages de l'utilisation d'un OCA

L'une des façons les plus faciles pour écrire votre document d'aide est d'utiliser un OCA ou Outil de création d'aide. Vous pouvez ainsi rédiger votre manuel en utilisant le processeur word intégré comme vous le feriez sur un document word indépendant, mais vous avez aussi la possibilité de tirer avantage des nombreuses fonctionnalités supplémentaires incluses dans le logiciel.
Utiliser ces fonctionnalités vous permettra de construire votre manuel d'aide plus vite et vous laissera la possibilité de le mettre à jour facilement dés que vous devez prendre en compte une nouvelle version du produit.

Ces fonctionnalités comprennent:

  • Un éditeur de chapitre - Vous pouvez revoir facilement tous les chapitres sur lesquels vous avez écrit et vous assurer que chaque sujet a été minutieusement traité et d'une manière facile à comprendre pour l'utilisateur.
  • Une bibliothèque médias - Être en mesure d'ajouter des éléments médias, comme des photos et des vidéos, à votre document, peut vous épargner beaucoup de travail d'écriture et expliquer certaines fonctionnalités très simplement.
  • Génération de formats multiples - Créez des documents d'aide dans un large éventail de formats afin que vos utilisateurs puissent accéder à l'information qu'ils cherchent de la manière qui soit la plus pratique pour eux. Vous n'avez à rédiger le document qu'une seule fois et il est déjà formaté pour tous les types de document dont vous avez besoin. Parmi les formats on trouve PDF, ePub, HTML, etc.
  • Génération Conditionnelle de Contenu - Si vous souhaitez créer des documents d'aide légèrement différents, par exemple pour différentes versions du produit ou pour que les documents soient produits en différents formats, vous pouvez le faire très facilement grâce à la génération conditionnelle de contenu.

Les Outils de Création d'Aide sont le meilleur moyen de rédiger vos documents d'aide rapidement, et de fournir aux utilisateurs de votre produit le niveau de service le plus élevé afin qu'ils puissent vite trouver les réponses dont ils ont besoin.