DITA et single-source publishing, pour une documentation technique « low maintenance »

La création d’un guide d’utilisation fait partie intégrante du processus de développement d’un produit ou service, afin notamment de guider les utilisateurs dans la prise en main et la compréhension du fonctionnement de celui-ci. Trop souvent, cette tâche est confiée au développeur du produit, qui décrira avec précision l’ensemble des fonctionnalités qu’il a imaginées, sans se mettre à la place de l’utilisateur.

« Un utilisateur d’un outil informatique ne veut pas lire ; il veut trouver immédiatement la solution à son problème. »

Source: minimalist-doc.blogspot.fr

En résulte un décalage avec les attentes de ce dernier, qui souhaite de son côté trouver dans la documentation des réponses claires aux questions « comment réaliser telle action ? » ou « que faire dans telle situation ? ».

Comment alors assurer une bonne expérience utilisateur, tout en minimisant les ressources dédiées à la rédaction et la création d’un manuel, qui ne sera que peu lu ?

 

Les attentes de l’utilisateur

  • Accéder à une aide contextuelle, qui soit pertinente par rapport à la fonctionnalité qu’ils sont en train d’utiliser ;
  • Trouver la juste information, qui leur indiquera clairement comment procéder en quelques étapes ;
  • Obtenir une information formulée en fonction de leur profil : expert vs. novice, client vs. back office, français vs. anglais, etc.

 

La réponse : penser rédaction modulaire

Pour être pertinente aux yeux de l’utilisateur, l’information devra pouvoir être filtrée : selon le contexte, l’audience (le profil), la version du logiciel utilisé, la langue,… et diffusée de telle sorte que celui-ci ne voit que les informations qui le concerne et lui sont directement utiles.

Grâce à la rédaction en modules, un même contenu pourra être publié à la volée sur différents supports :

  • Manuel au format PDF,
  • Aide en ligne/page HTML,
  • Aide embarquée dans une application, etc.

Selon le principe du « single source publishing », ayant pour effet immédiat de réduire les ressources nécessaires pour produire ces différents livrables.

 

La solution et ses avantages

Il existe un langage de rédaction structurée destiné à la création de documents modulaires et à la réutilisation du contenu : DITA, pour Darwin Information Typing Architecture. Ce format de rédaction basé sur XML, initié par IBM en 2000, devient une norme en 2005 et, est aujourd’hui massivement utilisé par les producteurs d’information technique tels que les éditeurs de logiciels, fabricants de machines-outils, constructeur de véhicules, etc.

 

1. Les informations sont catégorisées ; on distingue :

  • Ce qui relève d’une procédure – comment faire telle action ?
  • D’un concept – en quoi consiste telle fonctionnalité ?
  • D’une référence – quelles sont les caractéristiques de tel équipement ?

 

2. Chaque information est encapsulée dans un bloc de texte autonome appelé « topic », traitant d’un seul sujet.

On peut lui associer des variables :

  • Audience,
  • Version,
  • Langue, etc.

 

3. Les topics sont associés à l’aide d’une « map », et pourront être réutilisés dans différents contextes :

Par exemple, une procédure peut être identique dans plusieurs softwares. La mise à jour du contenu s’effectue directement sur le topic et est répercutée automatiquement dans tous les supports.

 

4. Les contenus ainsi assemblés sont ensuite appliqués à une feuille de style, le fond et la forme étant traités séparément et associés uniquement au lancement de la publication.

Résultats

  • – 25% sur les coûts de rédaction technique,
  • – 30% de temps passé au formatage de documents (sauts de page, polices…),
  • – 20% de coûts de traduction,
  • – 30% de contenu à produire.

 

Laisser un commentaire

Optimization WordPress Plugins & Solutions by W3 EDGE