Rédiger une documentation technique orientée marketing éditorial

Étiquettes : ,

La documentation technique est-elle condamnée à rester ardue, ennuyeuse et surtout à ne pas être lue? Non! Vous pouvez la rendre plus séduisante.

La documentation technique et la rédaction web ne semblent pas appartenir au même monde. La première a une mission d’exhaustivité, de description détaillée des fonctionnalités et des mécanismes de fonctionnement d’un produit ou d’un service. La deuxième a pour objectif principal de donner envie de lire un texte. Pourtant ces deux mondes peuvent se rejoindre pour le plus grand bonheur des internautes et des rédacteurs techniques.

Mettez une couche de marketing éditorial sur votre documentation technique

S’il existe, le produit pour lequel vous rédigez une documentation technique a forcément des qualités qui le rendent unique – son Unique Value Proposition (UVP) – et que vous pouvez décliner en arguments de vente – les Unique Selling Proposition(USP). Donner une couche de marketing éditorial à votre documentation technique consistera d’abord à partir de ces UVP et USP pour concevoir le plan de votre documentation. Elle s’articulera ainsi autour des points forts de votre produit et sera plus attirante pour le lecteur.

La documentation technique et la rédaction web ne semblent pas appartenir au même monde. 

La rédaction web au service de la rédaction technique

Quand vous passez de la conception de votre plan à la rédaction elle-même, vous pouvez aussi appliquer les règles de la rédaction web. Elles rendront votre documentation technique plus intéressante et plus lisible:

  • Des titres courts, explicites et accrocheurs.
  • De courtes introductions résumant chaque chapitre. Commencez toujours par l’essentiel avant de détailler vos explications.
  • Un texte découpé en paragraphes courts pour laisser respirer le lecteur.
  • Des intertitres et des encadrés pour maintenir l’attention du lecteur.
  • Des phrases courtes et simples, au langage adapté à celui du public cible de votre documentation.
  • Des listes à puces pour les énumérations.

En suivant ces quelques règles, bien des documentations deviendraient plus lisibles, plus attirantes et enfin plus lues.

Et vous, comment rédigez-vous vos documentations techniques? 

Addendum

Il va de soi qu’il n’est pas question de confondre, de faire l’amalgame entre le marketing éditorial et la rédaction technique, ni de sous-estimer la spécificité de la documentation technique et la complexité du métier de rédacteur technique. Ces deux métiers sont profondément différents et la rédaction technique a ses propres outils et méthodes, élaborés et perfectionnés depuis des dizaines d’années. L’un et l’autre peuvent cependant être complémentaires, l’un axé sur l’éducation et la formation, l’autre sur la promotion. Tel était le projet de cet article, un projet difficile, inabouti jusqu’à présent, qui sera poursuivi dans une publication ultérieure.

 


Commentaires

  1. Bonjour,
    Vous indiquez « La documentation technique et la rédaction web ne semblent pas appartenir au même monde » En effet, même si nous retrouvons des démarches similaires, l’un ne doit jamais remplacer/absorberl’autre.

    (a) « La première a une mission d’exhaustivité, de description détaillée des fonctionnalités et des mécanismes de fonctionnement d’un produit ou d’un service. » Erreur de base et approche très datée. Un véritable rédacteur technique ne DECRIT JAMAIS les fonctionnalités d’un produit, et encore moins les mécanismes de fonctionnement. Tout cela n’intéresse pas l’utilisateur final. La rédaction technique est « task-oriented » pour répondre aux besoins de l’utilisateur. Il n’est pas question d’exhaustivité : décrire tous les boutons d’une application est une absurdité profonde. L’utilisateur n’est pas un baschibouzouk débile : il sait que le bouton « Imprimer » sert à imprimer un document. Pas la peine de le lui décrire.

    (b) « Donner une couche de marketing éditorial à votre documentation technique consistera d’abord à partir de ces UVP et USP pour concevoir le plan de votre documentation. Elle s’articulera ainsi autour des points forts de votre produit et sera plus attirante pour le lecteur. »
    La véritable doc technique n’est pas un argument de vente (Unique Selling Point) : la doc marketing intervient au moment de l’avant-vente (pour attirer le client). La doc technique intervient APRES, au moment où l’utilisateur est confronté à la réalité : comment atteindre mon objectif (imprimer une page A3) avec ce logiciel ?
    Si l’utilisateur n’a pas trouvé, dans les secondes qui suivent la consultation du manuel, la réponse à sa question, la doc technique a manqué son but ; elle est donc inutile. Le bla-bla marketing n’y ajoutera rien.

    1. Avatar Pierre-Alain Le Cheviller dit :

      Bonjour,

      Merci pour votre point de vue et pour toutes ces informations très intéressantes. Le but de l’article n’était évidemment pas de sous-estimer la spécificité de la documentation technique et la complexité du métier de rédacteur technique.

  2. (c)  » concevoir le plan de votre documentation.  » avec l’USP : j’ose espérer que c’est une bonne blague 😉

    (d) « Quand vous passez de la conception de votre plan à la rédaction elle-même, vous pouvez aussi appliquer les règles de la rédaction web. Elles rendront votre documentation technique plus intéressante et plus lisible » Ceci dénote un grand potentiel d’humour ! Les principes de rédaction Web devraient être appliqués à la rédaction technique ! Des milliers de rédacteurs techniques (dûment formés) se roulent par terre. Donc, message pour la génération Y : bien avant l’avènement du WWW, les spécialistes d’ergonomie avaient fixé les règles de la conception de documentation technique (doc structurée, user-oriented, usability testing, etc.). Voir les ouvrages de JoAnn Hackos et Ginny Redish, par ex. Au 21e siècle, nous en sommes maintenant au TBSA (Topic-Based Structured Authoring) et à DITA.

    Donc, ce sont les règles de la doc structurée qui ont été transposées dans la conception de sites Web et absolument pas l’inverse.

    Depuis quelques années, on devient encore plus « chics » : on parle de Content Strategy, Information Design, Intelligent Content, etc. C’est ni plus ni moins que le « re-branding » des notions de base de la bonne redaction technique.

    Last, but not least… quelques exemples :

    – Est-ce que Giorgio, perché sur son poteau, a besoin de doc marketing ? http://minimalist-doc.blogspot.fr/2014/06/minimalisme-principe-n-2-loutil-integre.html

    – 150 pages à lire pour arrêter la centrale nucléaire de Three-Mile Island : est-ce suffisant ou doit-on ajouter 5 petites pages marketing ? http://minimalist-doc.blogspot.fr/2014/03/booster-lefficacite-de-votre.html

    – L’utilisateur ne lit pas le manuel : il y cherche l’information, la solution à son problème(voir Dany Boon et son excellent sketch sur le rédacteur technique qui veut inclure autre chose que de la doc marketing pour attirer le lecteur dans certains chapitres…)
    http://minimalist-doc.blogspot.fr/2014/02/le-minimalisme-explique-par-un-chti.html

    – Ajouter du contenu marketing dans une documentation médicale ? Est-ce vraiment une bonne idée ? Les sur-irradiés d’Epinal ont peut-être une opinion là-dessus :
    http://minimalist-doc.blogspot.fr/2013/10/documentation-medicalelinfobesity-ca-se.html

    – Est-ce que le capitaine Sullenberger du vol 1549 qui a amerri dans la Baie d’Hudson avait besoin de documentation marketing pour sauver la vie de 250 passagers ?
    http://minimalist-doc.blogspot.fr/2013/10/aeronautique-documentation-minimaliste.html

    Pour tout ce qui est tendance Web et relation client, IMHO, on peut suivre l’excellentissime Gerry McGovern. Ses twitts et ses webinaires sont tout simplement de véritables défis !

    Les professionnels de la rédaction technique ne se focalisent plus sur la conception de doc papier. Ils ont su prendre le train des nouvelles technologies -en collant au plus près aux besoins des utilisateurs- et commencent maintenant à fournir les procédures d’utilisation du produit par l’intermédiaire de Google Glass 😉
    Chez Nokia, on a déjà tout compris : on répond aux demandes d’aide des utilisateurs sur Twitter (3 x 140 caractères pour donner la solution : un vrai travail de pro !)

    A l’écoute de vos commentaires,

  3. Pour compléter cette information, voici le profil du rédacteur technique (fomation universitaire)
    http://www.sites.univ-rennes2.fr/lea/cfttr/sites/default/files/fiche_redacteur_technique.pdf

Laisser un commentaire

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

Devenez chroniqueur

Vous souhaitez devenir chroniqueur ou nous soumettre un article? Rien de plus simple.

Ça m'intéresse

#EPW sur Twitter

#EPW sur Facebook

À propos

Votre blog Écrire pour le web en chiffres
  • Plus de 25.000 sessions par mois
  • Plus de 35.000 pages vue chaque mois
  • 1500 abonnés à la newsletter
  • Créé en 2006
  • 1e position dans Google sur des expressions métier
En savoir plus