Ai-je besoin d’un rédacteur technique pour ma doc? 3 raisons de répondre OUI!

Dans de nombreux secteurs d’activité et entreprises, la documentation technique n’est pas rédigée par un service de rédaction ou un rédacteur technique dédié.

Faute de ressource, le « fardeau » est réparti… Les ingénieurs du bureau d’études se chargent du mode d’emploi, le responsable du support technique aux clients va créer et mettre à jour une FAQ ou un troubleshooting guide (guide de résolution de problème), le webmaster va créer une aide en ligne. Chacun fait de son mieux, en fonction de son expertise dans le domaine concerné par le document et/ou sa maîtrise du moyen de diffusion (texte imprimable, mise en ligne…), et surtout du temps qu’il lui reste quand il a terminé ses tâches principales.

Cette stratégie est-elle payante?

Désolé de tuer le suspens, mais je pense que non, et je me propose de vous exposer pourquoi en 3 points :

Raison n°1 : Une documentation technique de meilleure qualité

Un rédacteur technique convenablement formé utilise des méthodes, des standards et des outils qui vous garantissent une documentation technique de meilleure qualité.

Une documentation adaptée à l’utilisateur

Tout projet de rédaction technique commence par là. Il faut identifier l’utilisateur, se mettre à sa place et anticiper ses problèmes. Car non, l’utilisateur ne va pas lire la doc pour le plaisir, il la consulte parce qu’il à un problème à régler.

Il faut que le texte soit adapté au niveau d’expertise de l’utilisateur : trop je jargon ou pas assez de détails, et le document devient inefficace. Au contraire, si l’information intéressante et cachée au milieu d’innombrables lapalissades et évidences, le lecteur a l’impression qu’on le prend pour un idiot. Le document lui tombe des mains : échec.

Cela peut représenter une difficulté pour un programmeur ou un ingénieur qui vient de concevoir un produit : S’il rédige lui-même la documentation, sera-t-il capable de se mettre au niveau de l’utilisateur, de comprendre ses problèmes?

L’information utile plus facile à trouver

On en a parlé plus haut, l’utilisateur de la documentation a un problème à régler : changer une pièce endommagée sur une machine, installer une base de donnée, ou connecter son grille-pain au Cloud… Mais ce problème, il veut le régler maintenant! Pas le temps, pas envie, de lire 100 pages d’un super manuel hyper complet. Il veut trouver en quelques secondes le paragraphe précis qui le concerne.

Organiser, structurer le document pour guider l’utilisateur vers l’information qui l’intéresse, voilà ce que peut apporter un rédacteur. Il saura découper l’information en modules digestes pour l’utilisateur, créer des titres parlants et clairs, et créer un index et une table des matières efficaces.

Une documentation cohérente

Le manque de cohérence de la documentation est un écueil difficile à éviter si, faute d’un rédacteur dédié ou d’un service structuré, la rédaction est répartie entre les autres membres de l’équipe.

D’un produit à l’autre, d’une version à l’autre, d’une partie d’un document à l’autre, on a de fortes chances de se retrouver avec des différences importantes :

  • Niveau de détails
  • Terminologie
  • Mise en page

Et dans le pire des cas, on va créer des doublons, voir des contradictions.
Cela nuit à la compréhension de l’information, et à l’image de l’entreprise et de son produit. Pour y remédier il faut une démarche de rédaction basée sur des procédures, une constance dans l’application des bonnes pratiques de rédaction, et un regard global sur l’ensemble de la documentation de l’entreprise.

La maîtrise d’outils permettant la diffusion multi-support

A partir d’une source unique, un rédacteur technique pourrait bien vous permettre la diffusion de votre documentation sur une multitude de supports :

  • Manuel papier/PDF
  • Aide en ligne/Wiki/Tutoriels
  • Aide contextuelle intégrée au produit
  • Documentation adaptée aux écrans mobiles : tablettes, smartphone, Google Glass

Raison n°2 : Documentation moins chère

Réutilisation de contenu

Le moment est venu de parler du super pouvoir du rédacteur technique : la réutilisation de contenu!

En structurant la documentation, et ayant une vision globale sur l’ensemble de la documentation de l’entreprise, le rédacteur peut réutiliser un maximum de contenu.

Grâce à DITA, des sections ou paragraphes peuvent être utilisés dans plusieurs documents (par exemple dans les modes d’emploi de plusieurs produits), et sur plusieurs supports de diffusion (par exemple dans un mode d’emploi PDF, et une aide contextuelle intégrée à l’interface d’un logiciel). Je ne parle pas d’un « copier/coller » qu’il faudrait répéter dans chacun des documents, mais d’une solution permettant de mettre à jour en un clic le paragraphe dans l’ensemble des documents où il apparait : moins de temps pour créer la documentation, cohérence entre les documents, mise à jour sans oubli!

Pour des traductions moins coûteuses

La traduction de la documentation : Voilà un poste qui peut peser très lourd dans le coût de la documentation d’un produit vendu à l’export.

Il est pourtant possible de réduire son coût : par la réutilisation de contenu, par la constante dans la terminologie et de la construction des phrases, par la capacité à rédiger des instructions concises.

Les bonnes pratiques du rédacteur technique facilitent la tâche du traducteur.

A la chasse aux coûts cachés de la documentation

Une documentation bien rédigée, bien construite, disponible sur un format qui convient à l’utilisateur renvoie une image positive du produit et de l’entreprise. Mais cela permet aussi de limiter :

  • les demandes des clients à l’assistance téléphonique
  • les demandes d’intervention de votre service SAV
  • l’endommagement de matériel induit par une mauvaise utilisation

Le coût de la non-qualité de la documentation n’est jamais calculé, mais il existe!

Raison n°3 : Libérer les « non-rédacteurs » de ce fardeau

Les programmeurs, pour prendre un exemple, ont été formés pour programmer. C’est pour cela qu’ils sont le plus efficace, c’est pour cela qu’on les paient. Ils peuvent être frustrés de passer du temps à rédiger la documentation du logiciel qu’ils sont en train de créer : ils préfèreraient peaufiner le produit, voir commencer à travailler sur le suivant. Ils sont aussi moins à l’aise pour rédiger la documentation du logiciel, car ils n’ont pas été formé pour cela.

En confiant la documentation à un rédacteur ou une équipe de rédaction dédiée, vous libérez vos équipes de conception ou de support, ils se concentrent sur ce qu’ils font le mieux, sur ce qui leur permet de s’épanouir.

Ok, je voudrais bien confier la doc à un rédacteur technique, mais j’ai pas le sous moi…

J’entends d’ici les :

« on est trop petits pour embaucher un rédacteur technique à plein temps ou créer un service documentation ».

Ayant moi-même travaillé dans de petites structures avant de devenir rédacteur technique, je comprend cet argument massue. Mais je pense que cela ne doit pas empêcher d’avoir une stratégie pour sortir du « répartissons le fardeau et chacun fait comme il peut »:

  • Mettre en place des procédures de rédaction et des documents types pour guider les personnes chargées de la rédaction, et permettre une cohérence de la documentation de l’entreprise.
  • Vérifier que les outils nécessaires pour sont disponibles pour produire une documentation professionnelle : logiciels (c’est le moment de s’assurer que Word est vraiment adapté…), système de gestion des versions et de validation, page web dédiée pour diffusion…
  • Désigner clairement les personnes chargées de la rédaction, de la validation, de la diffusion, et de la mise à jour de chaque document. Cela devrait être fait au début de chaque projet. Bien-sûr il faut prévoir de dégager du temps pour cela aux responsables désignés.
  • Former son équipe sur les bonnes pratiques de la rédaction technique pour lui permettre d’être plus efficace.

Et pourquoi ne pas sous-traiter tout ou partie de votre documentation, ou vous faire accompagner pour améliorer votre process de rédaction?

La documentation est-elle confiée à des rédacteurs techniques dédiés dans votre entreprise? Comment cela se passe-t-il? N’hésitez pas à partager votre expérience et vos réflexions dans les commentaires.

Laisser un commentaire

Votre adresse de messagerie ne sera pas publiée. Les champs obligatoires sont indiqués avec *