Aller au contenu

Une architecture documentaire trop complexe ?

DITA XML permet des gains de productivité en réduisant le volume source que le rédacteur technique crée, traduit et maintient, au prix d'une plus grande complexité.

, 1 min de lecture

Voir en Markdown

DITA XMLUne architecture de rédaction structurée et modulaire, construite autour de la typologie concept/tâche/référence et de la réutilisation de contenu via conrefs et ditamaps.Voir dans le glossaire → permet des gains de productivité importants par la réduction du volume source que le rédacteur technique crée, traduit et maintient. Ce gain de productivité se fait au prix d’une plus grande complexité.

Si les projets DITA XML sont plus complexes, ils sont cependant moins compliqués que des projets reposant sur des formats plus traditionnels de type FrameMaker. En effet, DITA XML est une architecture rationnelle. Le rédacteur technique se trouve donc face à un comportement prédictible des outils qu’il utilise, loin des trucs et astuces destinés à contourner les bugs ou les fonctionnements erratiques des outils plus lourds.

DITA XML est complexe mais prévisible, les formats traditionnels sont compliqués et erratiquesDiagramme du cadre Cynefin plaçant DITA XML dans le domaine complexe, car son comportement est rationnel et prévisible malgré sa complexité, et les formats traditionnels comme FrameMaker dans le domaine compliqué, en raison de leur comportement erratique nécessitant contournements et astuces.ComplexeDITA XMLCompliquéFrameMaker et formatstraditionnels

DITA XML est complexe mais prévisible ; les formats traditionnels sont compliqués et erratiques.

La présentation suivante expose les différents niveaux de complexité induits par DITA XML et les solutions qui permettent au rédacteur technique de les maîtriser plus facilement :

Syntaxe DITA XML

Solution : IDE tel que XMetaL ou nXML

Gestion des relations entre des briques d'information atomiques

Solution : CMS dédié tel que Componize ou DocZone

Syntaxe de la feuille de style XSLT

Solution : Logiciel graphique de création de feuilles de style

Pour une petite équipe de rédaction technique, l’écueil principal sera la nécessité de mettre en œuvre la charte graphique de l’entreprise. Les autres aspects peuvent être gérés sans outil spécialisé, avec une bonne communication et une série de bonnes pratiques.