Trucs & Astuces


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

Comment créer des documentations conviviales avec un Anglais Technique Simplifié

Comment créer des documentations conviviales avec un Anglais Technique Simplifié [Featured]

L’Anglais est l'une des langues les plus utilisées dans la rédaction technique. Mais la langue anglaise est complexe - riche en idiomes, phrases verbales, figures de styles, synonymes, mots et termes ambigus pouvant embrouiller les locuteurs secondaires, et même natifs. C’est une des raisons pour lesquelles les utilisateurs ne lisent pas vos manuels.
En documentant, la plupart des rédacteurs techniques estiment ardue la tâche consistant à communiquer les termes techniques complexes en des mots, phrases et instructions très simples et faciles à comprendre. Dans la plupart des cas, l’effort du rédacteur technique est mesuré aux avis des utilisateurs.
Ainsi, pour rendre les documentations techniques comme les manuels d’utilisation, fichiers d’aide, guides de sécurité, etc. plus faciles à comprendre et faciles à utiliser, l’Association des industries aérospatiales et de défense de l’Europe (ASD) a développé l’Anglais Technique Simplifié (STE), également connu sous l’appellation ASD- STE100 ou la technique Thumbs-up.

Lire la suite →

Analyse d’audience en rédaction technique : Comment Obtenir les Données Adéquates

Analyse d'audience en rédaction technique : Comment Obtenir les Données Adéquates [Featured]

L’efficacité de toute la documentation technique dépend de la manière dont le rédacteur technique a adapté son contenu pour plaire au public cible. Mais dans de nombreux cas, adapter le contenu pour le public cible n’est pas le défi.
Le principal défi est comment identifier et analyser son public. Il n’est donc pas étrange de voir des rédacteurs techniques demander “Comment adapter son contenu à un public spécifique quand on ne le connait même pas ?” C’est une des raisons pour lesquelles les utilisateurs ne lisent pas vos manuels.
L’analyse d’audience est peut-être l’aspect le plus important de la rédaction technique. Si vous le faites correctement, votre service clientèle en sera soulagé et vous pouvez réduire vos coûts d’assistance à la clientèle.
Mais qu’arrive-t’il quand vous ne tapez pas dans le mille ? Vous dépenserez plus en assistance à la clientèle. Peut-être, en créant un nouveau manuel, et imaginer la mauvaise image que ça pourrait donner à votre produit comme marque, surtout quand vos concurrents le font bien. Maintenant, vous pouvez éviter un tel scénario simplement en analysant votre public.

Lire la suite →

Pourquoi les Utilisateurs ne Lisent Pas Vos Manuels et Comment les y Pousser

Pourquoi les Utilisateurs ne Lisent Pas Vos Manuels et Comment les y Pousser [Featured]

Vous avez créé un produit presque parfait ou conçu un excellent logiciel. Et vous avez embauché ensuite certains des meilleurs rédacteurs techniques pour rédiger un manuel d’aide convivial pour résoudre les problèmes de convivialité. Vous voulez que les utilisateurs de vos produits pour en profitent dès la première minute. Les rédacteurs techniques ont fait un excellent travail, confirmé par votre équipe d’expérience utilisateur.
Mais après le lancement de votre produit ou la publication d’une mise à jour, vous dépensez beaucoup plus en assistance clientèle. Dans de nombreux cas, les réponses que les utilisateurs cherchent figurent dans le manuel de l’utilisateur. Alors vous vous posez désormais la même question que de nombreux fabricants et développeurs. Les utilisateurs du produit lisent-ils vraiment les manuels d’aide?

Lire la suite →

5 Compétences Essentielles Pour Devenir Un Excellent Rédacteur Technique

images/essential-skills-technical-writer.jpg

Quelle est la différence entre un grand rédacteur technique et un grand écrivain?
Ils sont tous les deux de grands écrivains. Mais l’un a la maitrise de compétences essentielles nécessaires pour que presque tout le monde comprenne et utilise tous les produits nécessitant certaines connaissances techniques indépendamment de leur savoir-faire technologique.
Si vous êtes rédacteur technique ou peut-être êtes intéressé à le devenir, il est important de maitriser ces compétences requises également. Donc, pour vous faciliter la rédaction technique, nous avons compilé 5 des compétences les plus importantes à maitriser pour un rédacteur technique professionnel.

Lire la suite →

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

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

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 [Featured]

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 [Featured]

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 [Featured]

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 [Featured]

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 [Featured]

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 →