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, structure incohérente, charabia technique incompréhensible, souvent tout semble mis en place pour faire fuir le lecteur. Pourtant, il suffit de suivre quelques règles simples pour faire en sorte que votre documentation technique soit utilisée.

La solution? Penser au lecteur

Les besoins d’abord

Lorsque vous travaillez sur la structure et le contenu de votre documentation technique, gardez en tête les besoins des différents lecteurs. Si vous concevez un guide d’utilisation, par exemple, laissez tomber l’idée de présenter toutes les fonctionnalités et caractéristiques de votre produit. Expliquez plutôt aux lecteurs comment utiliser votre produit tâche par tâche.

Des titres qui parlent

Il n’y a rien de plus décourageant que de consulter une table des matières sans y trouver ce que l’on cherche. Utilisez des titres évocateurs qui décrivent précisément le contenu. Essayez aussi de penser à ce que le lecteur pourrait chercher comme information.

Par exemple, une section qui explique comment régler un appareil photo devrait avoir pour titre Ajuster les paramètres de l’appareil photo et non Paramètres de l’appareil photo.

Moins c’est mieux

Ne surchargez pas vos pages. Écrivez des paragraphes clairs et concis : votre texte sera accessible à tous les types de lecteurs et l’information, plus facile à trouver. Utilisez aussi des outils de présentation comme des tableaux, des listes numérotées ou des listes à puces qui aideront à rendre plus lisibles par exemple, des données techniques, des instructions par étapes et des longues énumérations.

Une image vaut mille mots

Lorsque c’est possible, ajoutez des photos et des illustrations. Cela aidera le lecteur à visualiser le produit et les tâches à accomplir et rendra votre documentation plus attrayante.

Mission accomplie

Malgré tout, votre documentation technique ne remplacera pas la lecture de chevet de vos clients. Mais s’ils ont envie de la consulter et de l’utiliser, vous pourrez vous dire : Mission accomplie!