Articles

19/012015

À la rencontre de son public cible pour une documentation technique qui fait mouche

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

09/122014

Mythe 5 : La documentation technique ne sert à rien

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ù […]

25/112014

Mythe 4 : La documentation technique devrait être faite à l’interne

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

11/112014

Mythe 3 : La documentation technique, c’est plate

Pour plusieurs, la documentation technique est forcément ennuyante parce qu’elle fournit une multitude de renseignements techniques sans intérêt. Réalité C’est vrai que l’information à transmettre avec la documentation technique est rarement palpitante : on y trouve peu d’action et assurément pas de suspense. Mais, même s’il peut être difficile de rendre la lecture de votre […]

28/102014

Mythe 2 : La documentation technique, ça coûte cher

Les légendes racontent que la documentation technique coûte cher et qu’elle peut engloutir votre budget d’une bouchée. Elles prétendent aussi que nombreux sont les projets de documentation technique qui ont occasionné des dépenses inavouables qui viennent hanter les entreprises, comme autant de squelettes dans le placard. Réalité Même si les analyses de coût-avantage de la […]

14/102014

Mythe 1 : Personne ne lit la documentation technique

Vos clients ne semblent pas lire la documentation technique que vous leur fournissez? Vous-même vous préférez vous débrouiller tout seul, quitte à faire des erreurs et à perdre du temps, plutôt que d’ouvrir un guide d’utilisation? Réalité Si elle n’est pas bien faite, la documentation technique peut décourager le lecteur le mieux intentionné. Information introuvable, […]