Permalink
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
68 lines (44 sloc) 2.34 KB

Les trois niveaux de la documentation technique

Si l'on compare la |doc| à un jardin, on peut la classifier selon les niveaux suivants :

Friche
  • Pas d'utilisation de processus documentaire.
  • Création de la documentation par des équipes non dédiées.
  • Utilisation de formats non adaptés ou utilisation incohérente de formats adaptés.
Jardin à l'anglaise
  • Utilisation de processus documentaires fiables.
  • Création de la documentation par des équipes dédiées.
  • Utilisation cohérente de formats adaptés, mais non structurés.
Jardin à la française
  • Utilisation de processus documentaires fiables.
  • Création de la documentation par des équipes dédiées.
  • Utilisation cohérente de formats structurés.

Les formats non adaptés à la |techwriting| sont par exemple les formats de traitement de texte, qui ne dissocient pas suffisamment la mise en page du contenu.

Les formats adaptés sont les formats de type |fm|, qui dissocient (relativement) la mise en page du contenu, mais ne sont pas sémantiques.

Les formats structurés sont les formats sémantiques de type |db| ou |dita|.

Le stade du jardin à l'anglaise est déjà très satisfaisant et garantit qu'une information de qualité est fournie à l'utilisateur. Celui du jardin à la française permet en outre à l'entreprise de mieux maîtriser son contenu et de réduire les coûts de production.

À elle seule, la présence d'une des trois composantes (processus, équipe dédiée et format adapté) ne peut garantir un résultat satisfaisant. Confiez par exemple des outils permettant de générer du contenu au format |dita| à des collaborateurs dont la |comtech| n'est pas le métier ou sans mettre en place de processus de gestion du cycle de vie de la documentation technique, et vous obtiendrez des résultats décevants. Seule la présence conjointe de ces trois éléments fournira un résultat optimal.

.. toctree::
   :hidden:

   un-index-est-il-utile-dans-un-pdf