5 erreurs à éviter lors de la rédaction d'une documentation d'aide

Mistakes to Avoid When Writing Help Documentation

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.

Ne pas commencer par rédiger la table des matières

Si vous écrivez une documentation d'aide elle doit expliquer en détail tous les aspects de votre produit. Il est important de n'oublier aucune des fonctionnalités que votre utilisateur final peut avoir besoin de connaître. La meilleure façon de vous assurer de tout couvrir correctement est de commencer avec un plan. Écrivez votre table des matières dès le début et faites la liste de tous les chapitres à propos desquels vous devez écrire. De cette façon, vous pouvez être sûr que rien n'est laissé de côté.

Supposer une connaissance que l'utilisateur n'a pas

Un des problèmes avec beaucoup de documentations d'aide est qu'elles supposent que tout le monde aborde le produit avec le même niveau de connaissance. Souvent la documentation est rédigée avec un type particulier de client à l'esprit quand en réalité il existe de nombreux types de personnes qui utilisent le produit, toutes avec différents niveaux de connaissances. La meilleure documentation d'aide explique toutes les procédures clairement depuis le début et ne s'appuie pas sur le fait que les utilisateurs sauraient déjà quoi que ce soit.

Ne pas mettre à jour les documents d'aide

Une documentation d'aide qui n'est pas mise à jour lorsque le produit change est souvent pire qu'inutile. Il n'y a rien de pire que d'essayer de suivre des instructions, pour se faire dire d'appuyer sur un bouton qui n'existe plus. Utiliser un bon logiciel de création d'aide permet de gagner beaucoup de temps dans cette situation. HelpNDoc, et des programmes similaires, rendent facile l'édition de l'index de votre fichier d'aide et la réécriture ou les déplacements dans les sections de votre texte, sans avoir à concevoir à nouveau l'ensemble du document chaque fois que vous apportez des modifications.

Ne pas avoir un index adéquat

Quand un utilisateur arrive sur votre document d'aide avec un problème, quel est le premier endroit où il va chercher? Dans de nombreux cas, il ne va pas commencer au début du document et se frayer un chemin jusqu'à la fin. Il va commencer par l'index et voir ce qui est dit au sujet de son problème. L'index est un outil vital dans tous les documents d'aide, assurez-vous qu'il est aussi complet que possible. Inclure les synonymes dans l'index est une excellente idée, il y a souvent plus d'un mot qui puisse être utilisé pour décrire un chapitre, alors assurez-vous qu'il soit facile de trouver ce que l'utilisateur veut savoir.

Ne pas laisser quelqu'un d'autre vérifier ou modifier votre travail

Même si vous pensez pouvoir produire la meilleure documentation d'aide au monde, il est toujours utile de la faire lire à quelqu'un d'autre et de laisser cette personne suggérer des changements. Chacun a différentes façons d'aborder un sujet et il est probable qu'une nouvelle paire d'yeux sera capable de relever des passages qui pourraient être améliorés et rendus plus clairs.

Éviter ces cinq erreurs courantes vous permettra d'améliorer la qualité de votre documentation d'aide et d'améliorer l'expérience des utilisateurs de vos produits. Rédiger une bonne documentation d'aide rend plus probable que les utilisateurs persévèrent avec votre produit et construit finalement une clientèle plus solide et plus fidèle à vos produits.