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.[pullquote]La documentation technique et la rédaction web ne semblent pas appartenir au même monde. [/pullquote]
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.