Search Contact

L’ingénierie documentaire : De quoi parle t-on vraiment ?

Évolution de la documentation

Auparavant, la documentation était un manuel fourni obligatoirement à la livraison de l’équipement. Aujourd’hui, son format est principalement électronique. Elle devient, de ce fait, accessible sur internet et permet une plus grande interactivité avec le client final. L’utilisateur du produit accède plus facilement à l’information par des requêtes et des filtres dynamiques. Demain, la documentation intègrera de nouvelles technologies comme le machine learning et la réalité virtuelle. Afin de s’adapter et d’anticiper ces évolutions, les services après-vente des entreprises repensent leur documentation pour en améliorer la qualité, faciliter leur usage et l’enrichir de nouveaux formats de contenus (3D, vidéos..).  

Le contexte structuré

Le processus de création documentaire est cadré par un ensemble de règles, appelé spécification. Cette spécification émane d’un service interne de l’entreprise ou d’un organisme international. Dans le domaine aéronautique par exemple, certaines normes sont très répandues telles que l'ATA, la S1000D ou encore la DITA.  Elles fournissent à minima une structure pour la documentation, mais aussi des règles de rédaction, d’échange, et de mise en page. Pour les contenus « texte », le format XML est privilégié. La structure est fournie sous forme de fichier de type Doctype (DTD) ou XML Schema (XSD). Tandis que pour les autres formats (vidéos, images...), la spécification impose les règles à suivre. Outre la structure, la spécification contrôle aussi la façon de rédiger les documents. Par exemple, la norme S1000D fournit un format d’échange pour ces règles appelé le BREX (Business Rules Exchange). Ces règles de rédaction vont permettre de rationaliser certains processus comme par exemple, le nombre d’étapes dans une procédure de démontage d’un bien industriel. Une autre norme appelée ASD-STE100 (Simplified Technical English) contrôle l’usage du lexique anglais pour les procédures. Par exemple, cette norme interdira l’usage du verbe « place » au profit du verbe « put » afin d’avoir des phrases homogènes. Des normes existent aussi pour contraindre le contenu des graphiques afin d’en garantir leur bon fonctionnement dans les outils de visualisation. C’est le cas de la norme WebCGM , co-produite par les groupes W3C et OASIS, qui restreint l’usage des graphiques au format CGM. Ce dernier étant un format modifiable librement et gratuitement, il est indispensable de limiter l’usage de ces contenus. Malgré cet arsenal de normes, les industriels ajoutent souvent leurs propres règles pour renforcer le contrôle du processus documentaire. Au final, lorsqu’un industriel livre un matériel pour un client final, il est assez libre de choisir la norme qu’il souhaite suivre. En revanche, un équipementier, qui doit livrer plusieurs industriels sera contraint de livrer sa documentation dans le respect de la norme choisie par ses clients. Une fois les règles définies, il est temps de produire la documentation technique.  

Le processus de production documentaire

Le déclencheur

Plusieurs événements peuvent déclencher le processus. Il peut s’agir de créer une documentation pour un nouvel équipement ou d’intégrer une modification émanant d’un organisme tiers (bureau d’étude, chaîne de montage, autorité …) dans une documentation existante. La collecte des données sources et l’analyse d’impact La première étape consiste à récupérer l’ensemble des documents associés à la modification (plan, données 3D, analyse logistique, gamme de montage, photos..) et d’analyser quels sont les éléments de la documentation impactés par la modification. Cette étape permet de planifier la rédaction, de définir les dates de livraison et les personnes en charge de rédiger. Par exemple dans ADAM Manager (le système de gestion de contenu dédié à l'ingénierie documentaire de 4D Concept), il est possible de créer une liste de documents vides et de les assigner à un rédacteur.  

La rédaction

Pour faciliter le travail de la rédaction, elle doit se faire dans un environnement contraint. À cet égard, un bon outil intègre des contrôles techniques ou métier. Dans le cas contraire, le rédacteur se réfère à un guide de rédaction, ce qui va augmenter les risques d’erreur. Un bon outil de rédaction doit être facile à utiliser et doit guider le rédacteur dans son travail, sans le bloquer ou modifier le contenu à sa place. Si le besoin s’en fait ressentir, le rédacteur peut aussi préparer des maquettes d’illustration. Un illustrateur s’appuie ensuite dessus pour concevoir les graphiques dans un outil de dessin technique (2D ou 3D), respectant les normes du projet. Dans la production de normes techniques, toute modification effectuée sur un document existant doit être tracée, afin de pouvoir revenir en arrière, de connaître les modifications passées et leurs auteurs. Si le rédacteur écrit des parties communes à différents matériels, il doit pouvoir attribuer quels sont les équipements concernés depuis l’outil d’édition. Le but est d’éviter la redondance de l’information et de réduire les risques d’incohérence.  

La preview

Avant la validation finale, une vérification (appelée la preview) est effectuée pour s’assurer que le rendu corresponde bien aux contenus rédigés précédemment. Le document rédigé est ainsi traité en passant par les mêmes étapes que celles effectuées lors de la publication finale. Dans la suite ADAM, cette étape de preview peut être lancée par le rédacteur à n’importe quel moment de la rédaction depuis l’outil ADAM Author.  

La validation

La validation s’effectue en plusieurs étapes pour s’assurer que chaque document respecte la procédure en place.
  • Une étape de relecture est nécessaire pour détecter d’éventuelles erreurs dans la première version du document.
  • Une étape de validation automatisée, réalisable dans ADAM Data Checker, réduit les risques de non-qualité en intégrant des contrôles informatiques.
  • Enfin, pour certaines procédures, une validation en conditions réelles sur l’équipement doit être effectuée.
 

La publication

Une fois la documentation validée, elle sera publiée puis livrée au client. Lors de cette étape, tracer précisément le contenu livré au client est obligatoire. Par exemple, il est nécessaire de lister les documents envoyés et de répertorier les différences apportées à chaque nouvelle version d’un document. Une fois livré, un document ne peut plus être modifié. Chaque modification nécessite de livrer une nouvelle version, ce qui déclenche un nouveau cycle de création documentaire, encadré par la spécification en vigueur. La documentation peut être livrée au format de documentation papier (PDF) ou électronique (Visualiseur). Le client peut aussi demander les fichiers bruts (graphiques et textuels), s’il souhaite les intégrer dans une nouvelle chaîne de traitement.  

La nécessité de s’outiller

La volonté de produire une documentation plus interactive, avec toujours plus de service, pousse les producteurs de documentation technique vers une information plus structurée, plus modulaire, mais aussi plus complexe. De ce fait, il est quasiment impossible de gérer la production documentaire sans :
  • un atelier de rédaction guidée ;
  • un gestionnaire de contenu (CMS) avec un suivi des flux de publication ;
  • un outil de contrôle des documents ;
  • un outil de publication doté de fonction de filtrage.
C’est dans cet esprit que 4D Concept développe la suite ADAM afin d’accompagner le processus d’ingénierie documentaire à chaque étape.
Vous autorisez 4D Concept à vous envoyer des newsletters