Format structuré DITA XML
Réduisez les coûts et délais en rédaction technique en choisissant le bon format d'authoring structuré et en optimisant la réutilisation du contenu documentaire.
Diminuer les coûts de production et de traduction, réduire les délais de mise sur le marché (ou time to market) et améliorer la qualité de la documentation. Voilà les défis que doit relever aujourd’hui le rédacteur technique. L’un des meilleurs moyens d’y parvenir consiste à réduire le volume source de la documentation et à mieux gérer le contenu d’entreprise.
Degrés de structuration
Section intitulée « Degrés de structuration »Les formats de documentation diffèrent par leur degré de structuration, de reStructuredTextLangage de balisage en texte brut issu de l'écosystème Python, plus riche que Markdown (directives, rôles, renvois) et format source natif du générateur de documentation Sphinx.Voir dans le glossaire → à 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 → :
Formats de documentation technique : degrés de structuration
La redondance : utile aux lecteurs, coûteuse dans les sources
Section intitulée « La redondance : utile aux lecteurs, coûteuse dans les sources »L’information que le rédacteur technique fournit au public doit être redondante : l’entreprise doit présenter à chacun de ses publics toute l’information dont il a besoin, sur le support qui lui est adapté. Pour prendre l’exemple le plus simple, chaque support d’information doit mentionner les coordonnées de la société. Mais jusqu’à 50 % de l’information disséminée par l’entreprise est répétée.
En revanche, la redondance de l’information en interne engendre des coûts supplémentaires, allonge les cycles de production et entraîne une baisse de l’homogénéité, et donc de la qualité, du contenu. Il est donc primordial de diminuer et de mieux partager le contenu source et d’en diminuer le volume. Le rédacteur technique doit diviser l’information en briques autonomes uniques, standardisées et génériques, pour pouvoir l’assembler à la demande. Il doit donc utiliser des modules structurés de manière homogène qui peuvent être facilement manipulés par des applications.
Les sources de la documentation doivent être moins volumineuses que les livrables.
DITA XML : des briques standardisées
Section intitulée « DITA XML : des briques standardisées »DITA XML est une architecture XML de Rédaction structuréeRédiger un contenu dont le balisage encode le sens (ceci est un avertissement, ceci est une étape) plutôt que la seule apparence visuelle — permettant un traitement automatisé, une réutilisation et des contrôles de cohérence que les formats non structurés ne permettent pas.Voir dans le glossaire → destinée à la création de documents modulaires et à la Réutilisation du contenu (réutilisation de contenu)Rédiger une information une seule fois et l'employer à plusieurs endroits ou dans plusieurs livrables plutôt que de la recopier : une correction faite une fois s'applique partout. Les conrefs, le texte conditionnel et le single-sourcing sont autant de moyens d'y parvenir.Voir dans le glossaire →. À partir d’une base commune de modules d’information atomiques DITA XML, le rédacteur technique peut fournir en temps réel toute l’information dont chaque utilisateur a besoin, sur tout type de média, du support d’e-learning au document PDF ou papier, en passant par le site Web.
DITA XML applique le principe de non-redondance des informations propre aux bases de données normalisées. Cette architecture transpose à la documentation technique la révolution introduite dans l’industrie par la standardisation : si l’on peut construire des automobiles de modèles différents à partir d’un ensemble de pièces identiques, de même, le rédacteur technique peut publier des documents différents à partir d’un ensemble de briques d’information standardisées.