Ingénierie documentaire

Documentation technique

Documentation technique - DITA DOCBOOK S1000D

La résultante logique de l’application de l’ingénierie documentaire est la documentation technique. Elle met en pratique les concepts de cette dernière.

La documentation technique consiste en un ensemble de documents pouvant être compris clairement et sans équivoque.

Les outils professionnels reposent sur un langage de balisage standardisé. Cela peut aller du XHTML utilisé de manière stricte aux grands standards établis tels quel DocBook ou DITA (S1000D pour l’aéronautique).

L’avantage de ces outils et formats est qu’ils sont performants et réutilisables.

Ils ont par contre l’inconvénient d’être très absconds au premier abord. Il est donc important de confier ces outils à des collaborateurs formés et spécialisé sans quoi le résultat final risque fort d’être contre-productif.

Généralement, la documentation technique est classée en trois niveaux :

Au jour le jour :

  • Aucune utilisation d’un processus documentaire
  • Création des contenus documentaires par une équipe non dédiée – collaborateurs chargés d’autres tâches
  • Utilisation d’outils et de formats non spécifiques ou de format spécifiques de manière inappropriée

Professionnel non structuré

  • Gestion via un processus documentaire adapté
  • Création des contenus documentaires par une équipe dédiée – collaborateurs / sous-traitants attachés essentiellement à la création de la documentation
  • Utilisation d’outils tel que traitements de texte ne séparant pas distinctement les contenus de la mise en forme

Professionnel structuré

  • Gestion via un processus documentaire adapté
  • Création des contenus documentaires par une équipe dédiée – collaborateurs / sous-traitants attachés essentiellement à la création de la documentation
  • Utilisation d’outils spécialisés et séparation claire entre contenus et mise en forme
Documentation technique - les outils

Et bien entendu des formes intermédiaires où le format est partiellement séparé par rapport au contenu. FrameMaker (non structuré) est un exemple d’outil professionnel relativement accessible qui permet par exemple la création d’un ouvrage de manière professionnelle sans apporter flexibilité et réutilisabilité.

Dans la pratique

Une gestion professionnelle non structurée est parfaitement adaptée dans nombre de cas. Elle garantit des contenus de qualité, une bonne traçabilité et une relative assurance que les documents pourront perdurer.

Une gestion professionnelle structurée assure, en plus des avantages mentionnés ci-dessus, une réduction significative des coûts de maintenance, de traduction et de publication. Mais comme nous l’avons indiqué un peu avant, les collaborateurs doivent être formés, sans quoi les bénéfices escomptés ne seront pas au rendez-vous.
Pour se prémunir de telles situations, il est possible de travailler avec des outils qui dissocient les formats (XML par exemple) de la présentation dans un éditeur. Cela rend la rédaction plus simple et la formation est drastiquement réduite.

En conclusion, seule la conjonction de processus dédiés, d’une équipe adaptée et d’un format séparant le contenu de la présentation garantissent un résultat optimal.

C’est le cas de tous les corps de métiers, la documentation technique n’y déroge pas.