Trucs & Astuces

Conseils, suggestions et idées pour développer et améliorer l'écriture et la production d'aides et manuels.

Lorsque l'aide et les manuels sont mauvais

Tout le monde ou presque a au moins une horrible histoire liée à un manuel d'aide à raconter. Qu'il s'agisse d'essayer de comprendre un produit quand le manuel d'aide est écrit dans un si mauvais Français qu'il est illisible, ou qu'un produit ait simplement été livré avec le manuel d'un autre modèle. Ou peut-être l'histoire concerne-t-elle l'un de ces manuels qui sont si détaillés qu'ils contiennent trop d'informations et qu'il est presque impossible de trouver la réponse dont vous avez rapidement besoin. Il existe beaucoup de raisons pour qu'un manuel d'aide soit mauvais, mais en général, elles peuvent être divisées en deux principales catégories...

Les meilleures pratiques en matière de rédaction de documents et de manuels d'aide

Rédiger une documentation d'aide peut s'avérer un processus délicat. Vous devez apprendre à penser comme l'utilisateur d'un produit et non comme un développeur. En tant que responsable de la rédaction de la documentation d'aide, vous connaissez surement votre produit depuis longtemps et vous êtes sans doute très familiarisé avec la manière dont il fonctionne. C'est utile lorsque vous rédigez la documentation d'aide mais cela peut aussi être un désavantage, puisque vous abordez le produit d'une manière différente de ceux qui le découvrent pour la première fois. Ce qui vous paraît peut-être évident, peut s'avérer être un mystère absolu pour quelqu'un qui n'a pas votre expérience du produit ou votre connaissance du processus de conception.

Pourquoi rédiger un manuel d'aide de qualité peut être le meilleur investissement que votre entreprise puisse faire

Lancer un nouveau produit coûte à la fois du temps et de l'argent et quelle que soit l'entreprise, les deux manquent généralement. Il existe toujours des pressions pour réduire les coûts et avoir le plus tôt possible un produit terminé et prêt pour la vente.
Parfois, lorsqu'on recherche des moyens de réduire les coûts au minimum, il est tentant de considérer le manuel d'aide comme une dépense accessoire et de le produire au moindre coût possible. C'est une croyance commune de considérer que la plupart des gens découvriront par eux-mêmes comment utiliser le produit et que s'ils ont des difficultés, ils pourront toujours appeler votre service d'assistance.
Cette manière de penser pourrait bien être l'une des plus grandes erreurs faites par les entreprises aujourd'hui. Personne ne peut nier que la production d'une documentation d'aide appropriée implique un certain coût, mais considérer le coût sans voir les économies réalisées grâce à votre manuel d'aide, c'est voir seulement la moitié du tableau.

Rédiger de meilleurs documents d'aide en moitié moins de temps

Rédiger une documentation d'aide peut être un processus très long. Si vous avez un produit compliqué à expliquer, il n'est pas rare qu'il puisse nécessiter plusieurs centaines de pages d'aide, et même un produit assez simple peut avoir besoin d'un manuel de 50 ou 100 chapitres.
Ce n'est pas seulement la longueur des documents d'aide qui peuvent les rendre compliqués à rédiger. Si vous voulez que votre manuel soit utile à vos lecteurs, vous devez vous assurer que toutes les fonctions du produit sont incluses dans la documentation et que chaque aspect du produit soit décrit avec précision et d'une manière qui soit vraiment utile à votre utilisateur final.
Avec autant d'information à inclure; organiser votre documentation d'aide et la compléter au moment opportun, peut représenter un sérieux défi pour n'importe quel rédacteur technique. Heureusement, il existe une façon de rédiger des documents d'aide plus rapidement, d'y inclure tout ce que vous devez couvrir et de créer quand même un document professionnel de haute qualité qui peut être produit dans une variété de formats.

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?

Le guide de rédaction de documents d'aide et de manuels pour les idiots

Si vous n'avez jamais rédigé de documentation d'aide jusqu'ici, cela peut vous paraître un peu effrayant. Les utilisateurs finaux de votre produit comptent sur ​​vous pour les aider à comprendre toutes les fonctions du produit, et leur utilisation continue du produit repose sur la façon dont vous réussissez à répondre à leurs questions. Voici notre "guide pour les idiots" pour la rédaction de manuels et de documents d'aide. Ces conseils vous aideront à rédiger des documents d'aide qui couvrent tous les détails que vous devez inclure et qui puissent être facilement compris par vos utilisateurs finaux.

Utilisez un outil de création d'aide et réduisez radicalement vos coûts de support client

Quels sont les principaux coûts liés aux produits de votre entreprise? Tout le monde sait que la création d'un nouveau produit coûte de l'argent. Il y a des coûts impliqués par la conception, les tests, la fabrication du produit et la promotion et la mise à disposition du produit pour les clients. Toutes ces étapes sont incontournables si vous voulez créer un produit qui puisse être vendu et produire un revenu qui permettra à l'entreprise de prospérer.

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

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.