Demandez une démo

La documentation technique – l’indispensable

Gestion d'entreprise
Julien Costerg Par Julien Costerg
 Akuiteo SAS

Article republié le 19 janvier 2016 avec plus de détails et de conseils

La documentation technique c'est… Une notice technique, guide d’installation, manuel utilisateur, aide en ligne, etc. Elle doit être fournie avec tout produit. Or, cela n’est pas forcément le cas de nos jours...

Par ailleurs, cette information est parfois difficilement accessible, qu'elle soit introuvable, noyée dans une masse d’information ou trop « compliquée » à appréhender… C'est souvent décourageant !

Enfin, la documentation technique nécessite du temps. Du temps pour trouver l'information, du temps pour la lire, pour la comprendre et enfin pour la mettre en pratique. Ce temps est rarement disponible - ou on ne juge pas utile de le prendre. Mais, lorsqu’on se retrouve bloqué par notre outil en plein travail, le problème à résoudre est souvent urgent et se pencher dans la documentation semble long contraignant et complexe. L’utilisateur veut avant tout trouver une réponse rapidement à la problématique qu'il rencontre.

La documentation technique aux mains des spécialistes 

Au départ, travail de forçat relégué aux techniciens ou ingénieurs lorsque ceux-ci avaient « du temps à perdre », on n’hésite plus aujourd’hui à faire appel à un spécialiste de la documentation.

Expert dans l’analyse de contenu, curieux et à l’écoute, il sait comment synthétiser l’information pour la rendre accessible au plus grand nombre.

documentation-technique-lindispensable-71226612.png

 

Le rédacteur technique ou le développeur de contenu

Comme ses confrères développeurs, le rédacteur technique doit « coder » , structurer l’information en utilisant des méthodes de travail1 adaptées et des outils techniques2 basés sur des langages informatiques3.

Avec un seul objectif en tête : répondre de manière claire et simple au besoin de l’utilisateur, qu’il soit client final ou en interne.

Pour cela, il doit se mettre à la place de l'utilisateur et se poser les bonnes questions :

  • Quel est son objectif ?
  • Quelles sont ses tâches à réaliser ?
  • Quelles procédures doit-il suivre exactement ?
  • Quels sont les impacts sur le reste de son activité ?
  • Quelles sont les précautions à prendre ?

Ensuite, il tient au rédacteur de présenter l’information de manière agréable, cohérente, succincte et, si besoin, illustrée tout en facilitant son accès, à travers des moteurs de recherche ou des sites web dédiés.

L’agilité du rédacteur technique

Des logiciels opérationnels plus qu’une documentation exhaustive - Manifeste pour le développement Agile de logiciels.

Malgré cette affirmation - très juste - qui pourrait faire penser que la documentation devient obsolète, le rédacteur technique se doit lui aussi d’être agile. En faisant partie intégrante du cycle de développement du produit, à travers des méthodes telles que Scrum, il est toujours au courant des évolutions de l’outil à documenter.

On n’est alors plus dans l’exhaustivité de la documentation, mais bien dans sa pertinence.

Tendances en matière de documentation technique

L’accès à l’information n’a jamais été aussi ouvert et élargi qu’aujourd’hui, et la simplification des objets connectés du quotidien (Smartphone, tablettes) nécessite l’utilisation d’outils de développement de plus en plus complexes… qu’il va bien falloir documenter.

Rédacteurs techniques, développeurs de contenu, spécialistes de la documentation et autres gestionnaires d’information, à vous de relever le défi !

------

[1] Task-Oriented Information Modelling (TIM)

[2] MadCap Flare http://www.madcapsoftware.com/products/flare/

[3] XML Extensible Markup Language http://www.w3.org/TR/xml/

Découvrez ERP et DAF : Histoire d'une transformation numérique réussie

Gestion d'entreprise

À propos de l'auteur

Julien Costerg Julien Costerg
Directeur marketing et commercial - Akuiteo SAS
Akuiteo

À propos d'Akuiteo

Akuiteo, c’est le logiciel ERP des sociétés de service heureuses ! Gestion commerciale, opérationnelle et financière : pilotez toutes les dimensions de votre business par affaire, projet ou mission.

En savoir +