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 documentation enlevante, vous pouvez au moins la rendre intéressante. Pour cela, vous n’avez besoin ni de revirements inattendus, ni d’effets spéciaux.

De l’information pertinente avant tout

Votre lecteur doit avoir une bonne raison de lire votre documentation technique. Assurez-vous donc que l’information qu’il y trouve est pertinente pour lui et qu’elle répond à ses besoins et aux questions qu’il peut se poser en tant qu’utilisateur de vos produits. Si vous avez plus d’un type d’utilisateurs, assurez-vous aussi de répondre à tous leurs besoins.

Sortir des sentiers battus

Osez trahir votre imprimante. Les guides en format papier ne sont pas toujours le meilleur médium pour votre documentation technique ou pour vos lecteurs. Envisagez des formats alternatifs : aides ou formations en ligne, vidéos, animations multimédia, etc. Par exemple, si vous lancez la dernière version d’un produit, une présentation par vidéo pourrait vous permettre de décrire les nouvelles fonctionnalités de façon efficace et intéressante. Vous verrez que faire preuve d’originalité et bien choisir son médium peuvent être payant!

Garder le meilleur… pour le début

La structure doit répondre aux attentes de l’utilisateur plutôt qu’à la logique du produit. Commencez toujours par l’information la plus importante, celle qui risque d’être cherchée le plus souvent, jusqu’à l’information la plus pointue, qui s’adresse aux utilisateurs expérimentés. Cela signifie aussi que les tâches seront généralement placées en début de paragraphe, plutôt qu’à la fin.

Choisir les bons mots

Utilisez des mots simples, le langage propre à votre lecteur, tout en restant précis (les termes exacts du produit sont toujours les meilleurs!), et ajoutez des clarifications pour mettre le lecteur en contexte au besoin. Les termes compliqués, comme le jargon technique, peuvent rendre vos textes pénibles à lire et difficiles à comprendre. Pensez aussi à ajouter des exemples concrets qui se rapprochent de la réalité des utilisateurs. Enfin, évitez les synonymes. En documentation technique, chaque mot doit correspondre à une idée précise.

Foncer droit au but

Rappelez-vous que la clé du succès pour rendre votre documentation technique intéressante est d’offrir du contenu utile. Pensez à l’annuaire téléphonique : personne n’a jamais eu envie de le lire, mais pendant des années, tout le monde le consultait.

Pour recevoir un avis lors de la publication de notre prochain article, inscrivez-vous à notre liste d’envoi.