Permalink
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
70 lines (54 sloc) 3.05 KB

Format structuré DITA XML

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 |techwriter|. 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.

Formats de documentation technique : degrés de structuration

L'information que le |techwriter| 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 |techwriter| 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| est une architecture XML de rédaction structurée destinée à la création de documents modulaires et à la réutilisation du contenu. À partir d'une base commune de modules d'information atomiques |dita|, le |techwriter| 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| 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 |techwriter| peut publier des documents différents à partir d'un ensemble de briques d'information standardisées.

.. toctree::
   :hidden:

   cas-concrets-utilisation-de-dita-xml.rst
   formats-structures-et-non-structures
   une-architecture-documentaire-trop-complexe
   du-document-a-la-base-documentaire-modulaire
   cas-concret-documentation-de-nufirewall