Aller au contenu

Le typage de l’information en documentation technique

Comprendre les principes fondamentaux de la rédaction structurée modulaire et la séparation entre tâches, concepts et références.

Voir le YAML
Conceptinformation-typing-concepts

Comprendre les principes fondamentaux de la rédaction structurée modulaire et la séparation entre tâches, concepts et références.

Le typage de l’information consiste à organiser les contenus techniques selon leur intention de communication plutôt que par chapitre linéaire ou support de diffusion. Issu de la méthode Information Mapping de Robert Horn et formalisé dans la norme OASIS DITA, ce principe répond aux besoins cognitifs distincts des lecteurs en situation de travail.

Les trois archétypes documentaires fondamentaux

Au lieu de mélanger des descriptions théoriques, des modes d’emploi et des listes de paramètres dans un texte monolithique, la rédaction structurée isole chaque finalité :

  • Tâches (procédurales) : Répondent à la question Comment faire ? par des instructions séquentielles concrètes menant à un résultat vérifiable.
  • Concepts (explicatifs) : Répondent aux questions Qu’est-ce que c’est ? et Pourquoi cela fonctionne-t-il ainsi ? pour bâtir un modèle mental clair.
  • Références (factuelles) : Répondent à la question Quels sont les paramètres ? en proposant des données structurées et tabulées propices à la recherche rapide.

Bénéfices d’une typologie sémantique stricte

L’application de contrats structurels rigoureux améliore directement la qualité documentaire :

Efficacité de lecture et charge cognitive

L’utilisateur qui effectue une maintenance mécanique a besoin d’instructions directes sans digression théorique. Inversement, l’architecte système a besoin d’explications conceptuelles claires sans liste de boutons à cliquer.

Réutilisation et modularité du contenu

Chaque sujet forme une unité autonome pouvant être assemblée dans différents livrables (sites web, manuels PDF, aide contextuelle) sans dupliquer les sources.

Validation automatisée et régularité

Des schémas de validation garantissent que chaque tâche contient des étapes exploitables, chaque concept aborde les principes de fond et chaque page de référence fournit des caractéristiques tabulées.

Mettre en œuvre DITA en YAML sans XML

Le standard DITA d’origine repose sur des grammaires XML (DTD, XSD) et la chaîne DITA-OT, souvent jugées lourdes par les équipes de développement. En transposant la sémantique DITA (cmd, info, substeps, stepresult, prereq, context) dans des fichiers YAML lisibles :

  • Les rédacteurs travaillent sur des fichiers simples dont les révisions se visualisent parfaitement dans Git.
  • Les générateurs de sites modernes tels qu’Astro produisent un code HTML sémantique et accessible sans pipeline XSLT.
  • Des validateurs de schémas (comme Zod) contrôlent la structure et l’intégrité référentielle dès la compilation.

Exemple d’application

Dans notre exemple d’entretien de tondeuse, la tâche replace-lawnmower-blade fournit la marche à suivre mécanique, la référence lawnmower-blade-reference regroupe les couples de serrage et tolérances d’usure, et ce concept explicite la logique d’organisation.