Trucs & Astuces


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

Manuel Imprimé contre Manuel Numérique - Duquel Avez-vous Besoin?

Manuel Imprimé contre Manuel Numérique - Duquel Avez-vous Besoin?

Choisir le bon format de publication pour vos fichiers d’aide peut être difficile, surtout si vous créez votre premier manuel et souhaitez éviter les énormes erreurs faites par les auteurs de manuel d’aide à leurs débuts. Le bon format détermine si vos utilisateurs ont accès à vos fichiers d’aide exactement quand et tel qu’ils le souhaitent.
Si vous utilisez un outil de création de manuel d’aide (et vous devriez parce qu’il facilite la rédaction des meilleurs documents d’aide en peu de temps), la publication dans différents formats peut se faire sans aucune difficulté.
La grande question à laquelle nous répondrons aujourd’hui est, devez-vous publier un manuel imprimé (copie papier) ou une édition numérique (PDF, CHM, HTML Web, format eBook…).

Lire la suite →

Comment Écrire un Excellent Manuel d’Aide

Comment Écrire un Excellent Manuel d'Aide

Lorsque vous écrivez un excellent manuel d’aide, vous faites deux choses – vous aidez les clients à trouver et utiliser facilement les solutions appropriées et vous réduisez significativement vos couts d’assistance clientèle.
Bien plus encore, les clients seront ravis de recommander votre produit, et les décideurs dans votre branche commerciale recommanderont facilement votre marque aux autres experts et à leurs clients. Voici pourquoi la rédaction d’un manuel d’aide de qualité peut être le meilleur investissement dans votre entreprise.
Mais comment justement écrire un excellent manuel d’aide ?

Lire la suite →

Les Plus Grosses Erreurs Commises par les Auteurs de Manuel d’Aide Débutants

Biggest Mistakes First Time Help Manual Authors Make

Quelle est la pire erreur que vous puissiez faire en tant qu' auteur de manuel d’aide débutant?

Un bon manuel d’aide se doit d’être pratique et contenir des instructions claires que les utilisateurs puissent trouver et utiliser facilement. Mais si vous êtes un auteur débutant, la création d’un bon manuel d’aide peut s’avérer une tâche difficile, surtout s’il s’agit de votre premier projet de rédaction technique.
Il est intéressant de savoir que tout bon rédacteur de manuel d’aide a débuté un jour et qu’il a lui aussi fait plusieurs erreurs lors de sa première tentative. Nous avons donc compilé ces erreurs afin que vous puissiez ne pas les reproduire. C’est une chance de pouvoir ainsi apprendre de ces erreurs et créer un manuel d’aide remarquable dès votre première tentative.

Lire la suite →

Une documentation d’aide n’a pas à être ennuyeuse

Help documentation doesn't have to be boring

Reconnaissons-le, la documentation d’aide a aujourd’hui une terrible image. Presque tout ceux à qui vous parlez à ce sujet ont une mauvaise image des manuels d’aide. Il y a de nombreuses raisons à cela, les plus courantes étant:

  • Elles ne répondent pas aux questions que vous vous posez
  • Vous ne pouvez pas trouver la réponse, même si vous savez qu’elle est là quelque part
  • Il est difficile de naviguer dans le manuel
  • La documentation est obsolète
  • La documentation n’existe pas encore

Lire la suite →

Lorsque l’aide et les manuels sont mauvais

help and manuals go wrong

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:

  • Le manuel est obsolète ou contient la mauvaise information
  • Le manuel est mal écrit ou il est difficile à parcourir

Lire la suite →

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

Writing Help Documents

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.

Lire la suite →

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

Customer Support

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.

Lire la suite →

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

Documents in half the time

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.

Lire la suite →

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

Kindle device

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?

Lire la suite →

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

Write help documents and manuals

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.

Lire la suite →