Ça y est, vous êtes rendu là? Vous vous dites que, en termes de documentation technique, vous devriez faire mieux? Que de demander à vos ressources techniques de rédiger des guides d’utilisation, c’est bien mal utiliser leurs compétences? Vous êtes décidé à engager un professionnel pour produire de la documentation technique à la hauteur de […]
Si on pense que personne ne lit la documentation technique, on en vient rapidement à se demander : « À quoi ça sert d’investir temps et argent pour de la documentation technique? ». Et si on ne se posait pas la bonne question? On ne fait pas de la documentation technique pour qu’elle soit lue Comme le […]
Année après année, vous mettez beaucoup d’effort à aller chercher de nouveaux clients… avec qui vous n’arrivez pas toujours à construire une relation durable. Laissez-nous vous montrer en quelques statistiques pourquoi ça vaut la peine d’investir dans la fidélisation de sa clientèle et surtout comment vous pourriez utiliser la documentation technique pour le faire. Fidéliser […]
Tout rédacteur de guide touristique sait qu’il doit guider ses lecteurs, leur proposer des itinéraires pour qu’ils profitent au maximum de leur voyage. La même chose s’applique pour le rédacteur technique qui utilise la méthode par sujet. Il doit organiser les différents sujets, faire l’organisation de l’information, de façon à guider les lecteurs. Après tout, […]
Dans la méthode par sujet, chaque sujet répond à un objectif et correspond donc généralement à un seul type d’information. Dans l’article précédent, La méthode par sujet, on comparait la documentation à un archipel où chaque sujet serait une île. En y regardant de plus près, on pourrait voir que chaque île de cet archipel a une […]
Dans le domaine de la documentation technique, on ne peut pas passer à côté de la méthode par sujet. Et ça consiste en quoi exactement? Sujet autonome Dans la méthode par sujet, chaque sujet doit être autonome. Ça signifie que, quand on développe un sujet, on doit en faire le tour de façon à répondre […]
Une documentation axée sur les objectifs des utilisateurs est une documentation efficace. Dans cet article, nous verrons comment découvrir quels sont les objectifs de vos utilisateurs et comment créer du contenu qui leur permettra de les atteindre. Allez-y, demandez-leur! Pour savoir de quelle information les utilisateurs ont besoin et ce qu’ils recherchent dans votre documentation, […]
Avant de commencer la rédaction de vos documents, avant même de penser au contenu, au format et aux aspects plus techniques, vous devez identifier votre public. Vos utilisateurs types Évidemment, vous ne pouvez pas connaître précisément chaque lecteur qui se procurera votre documentation ou qui consultera votre page de dépannage en ligne. Vous pouvez tout […]
Il suffit d’utiliser le produit. Appuyer sur un ou deux boutons. Secouer un peu. Frapper dessus même! Bon, ça ne fonctionne toujours pas… Quelques coups de fils devraient régler le problème. Vous finirez bien par comprendre, non? Eh bien, en fait, un guide d’utilisation serait bien utile en ce moment. Réalité Rappelez-vous la fois où […]
Plusieurs employeurs croient que, puisque leurs employés connaissent leurs produits par coeur, ils sont les mieux placés pour produire leur documentation! Réalité Contrairement à ce que l’on pourrait penser, connaître les produits n’est qu’une partie de ce que ça prend pour créer de la documentation de qualité. Même si votre personnel connaît les moindres détails […]