Le rédacteur technique, gage d'une documentation de qualité

Le minimalisme en rédaction technique

Halte à l’« infobésité » !

Nous rédigeons en suivant les principes du minimalisme :

  • Les manuels sont axés sur les procédures à suivre, pour répondre directement à l’impatience des utilisateurs d’aujourd’hui.
  • On n’essaie pas d’expliquer son métier à l’utilisateur. On respecte son savoir-faire.
  • La rédaction (vocabulaire, procédures, concepts) est orientée pour une audience particulière. On ne mélange pas des infos de niveaux différents dans le même document.
  • Une info doit être facile à trouver. On diversifie les façons d’entrer dans une documentation : table des matières, « short descriptions », index...

Nous vous recommandons la lecture du blog de Marie-Louise Flacke, passionnée de documentation minimaliste.

Offrir une bonne documentation technique, cela signifie que :

  • vous avez le souci de vos clients,
  • vos clients sont plus rapidement opérationnels,
  • vos clients exploitent plus vite et mieux le potentiel de vos produits,
  • vos clients ont moins souvent recours à votre support technique,
  • votre support technique trouve plus rapidement les informations recherchées et peut traiter plus de demandes,
  • vos commerciaux disposent de toute l'information nécessaire lors des présentations de vos produits.

Faire appel à un rédacteur technique, c'est :

  • décharger vos développeurs d'une tâche fastidieuse pour laquelle ils sont insuffisamment formés,
  • récupérer un temps précieux pour le développement de vos produits,
  • garantir un regard extérieur sur le produit, un regard semblable à celui qu'a l'utilisateur,
  • avoir une documentation de qualité pour accompagner le lancement du produit,
  • profiter du regard et de l'avis d'un utilisateur dès les premières phases du développement,
  • utiliser des outils dédiés et performants,
  • garantir une réutilisation facile du contenu ainsi créé,
  • simplifier la publication, la mise à jour et la traduction des documents.

Une bonne documentation, ce sont des clients plus satisfaits

La documentation fait partie intégrante des produits et services de votre société. Malheureusement, elle est trop souvent négligée dans le processus de développement.

Pourtant, lui accorder une attention semblable à celle accordée au produit lui-même a un impact des plus importants sur vos clients et sur vos coûts de maintenance.

Tout comme il est logique de confier le développement des produits à des ingénieurs et à des techniciens, ou la vente à des commerciaux, la documentation devrait de même être confiée à des spécialistes : les communicateurs ou rédacteurs techniques.

Pour écrire des manuels utiles, le rédacteur technique doit avoir non seulement un bon background technique, mais aussi la capacité de rendre l'information accessible pour l'utilisateur. Pour cela, il doit comprendre l'audience et ne jamais oublier de présenter toutes les informations pertinentes, y compris des informations qui sont considérées comme évidentes par le développeur et qui, de ce fait, manquent dans beaucoup de manuels existants.

Le rédacteur technique est un spécialiste qui élabore et développe efficacement l'information technique et commerciale. Il prête une attention maximale au langage et à la présentation. L'utilisation d'un design logique, de figures et de schémas clairs, le respect de l'audience et la compétence technique garantissent le transfert correct et rapide de l'information de l'ingénieur à l'utilisateur.