Évolution : de la documentation classique à la nouvelle ingénierie documentaire
Auparavant, la documentation était un manuel fourni obligatoirement à la livraison de l’équipement. Mais aujourd’hui, son format évolue. L’ingénierie documentaire est pensée principalement de manière électronique. Elle devient, de ce fait, accessible sur Internet et permet de s’adapter facilement aux différents supports sur lesquels on souhaite la diffuser. L’ingénierie documentaire garantie aujourd’hui 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. On peut désormais affirmer que demain, la documentation intégrera de nouvelles technologies comme le machine learning ou la réalité virtuelle. Ainsi, les services après-vente des entreprises doivent déjà anticiper et s’adapter à ces évolutions. Il devient donc essentiel de repenser chaque processus de production documentaire afin de mettre en avant une nouvelle ingénierie permettant d’améliorer sa qualité, de faciliter son usage et d’envisager l’apport de nouveaux formats de contenus comme la 3D ou la vidéo.
Ingénierie documentaire, un contexte structuré
Le processus de création documentaire est encadré par un ensemble de règles, appelées « spécification ». Cette spécification est déterminée en amont par un service interne à l’entreprise ou par 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. L’ingénierie documentaire régissant ces normes permet de fournir, à minima, une structure pour la documentation de l’entreprise. Mais elle apporte aussi des règles de rédaction, d’échange ainsi qu’un cadre adapté de mise en page.
Pour les contenus textuels, il est toujours conseillé de privilégier le format XML. La structure est fournie sous forme de fichier de type Doctype (DTD) ou XML Schema (XSD). Tandis que pour les autres formats, comme la vidéo ou les images, la spécification de l’ingénierie documentaire impose les règles à suivre.
Outre la structure, l’ingénierie documentaire et sa spécification permettent également de contrôler la façon dont le fond documentaire est rédigé.
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 le nombre d’étapes dans une procédure de démontage d’un bien industriel (par exemple).
Une autre norme appelée ASD-STE100 (Simplified Technical English) contrôle l’usage du lexique anglais dans la rédaction des procédures techniques. Ainsi, cette norme interdira l’usage du verbe « place » au profit du verbe « put » afin d’assurer l’homogénéité et la bonne logique du contenu.
L’ingénierie documentaire permet aussi de développer des normes destinées à contraindre le contenu des graphiques afin d’en garantir leur bon fonctionnement dans les outils de visualisation. C’est, par exemple, le cas de la norme WebCGM , co-produite par les groupes W3C et OASIS. Cette règle permet de restreindre 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 de leur ingénierie documentaire. Au final, lorsqu’un industriel livre un matériel pour un client, il reste toujours libre de choisir la norme qu’il souhaite suivre et qui convient le mieux à son activité. En revanche, un équipementier, qui doit livrer plusieurs industriels sera contraint de livrer sa documentation technique dans le respect de la norme choisie par ses clients.
Grâce à l’ingénierie documentaire, chaque industriel peut définir les règles qui lui correspondent avant de passer à la production de sa 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 du processus d’ingénierie documentaire 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 cette modification.
Cette étape permet de planifier la rédaction de la documentation technique, de définir les dates de livraison et d’attribuer les tâches aux personnes en charge de rédiger les contenus. Par exemple, le système de gestion de contenu dédié à l’ingénierie documentaire de 4D Concept appelé ADAM Manager permet de créer de manière optimale une liste de documents vides et de les assigner à un rédacteur spécifique.
La rédaction
Afin de faciliter le travail de la rédaction, cette dernière doit se faire, de préférence, dans un environnement contraint. À cet égard, un bon outil permet d’intégrer des contrôles techniques ou métier. Si le rédacteur ne bénéficie pas d’un bon environnement et d’un cadre, il doit alors se référer à un guide de rédaction. De cette façon, les risques d’erreur sont nécessairement augmentés.
Il est donc toujours préférable d’utiliser un bon outil de rédaction. Celui-ci doit être facile à utiliser et doit guider le rédacteur dans son travail, sans pour autant 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 pourra ensuite s’appuyer sur ces maquettes afin de concevoir les graphiques dans un outil de dessin technique (2D ou 3D), respectant les normes du projet initial, et compléter ainsi la documentation finale de façon optimale.
Dans la production de contenus et de normes techniques, toute modification effectuée sur un document existant doit être tracée. Ce processus d’ingénierie documentaire assure ainsi la possibilité de revenir en arrière, de connaître les modifications passées et les auteurs de ces modifications. De même, si le rédacteur écrit des parties communes à différents matériels, il doit être en mesure d’attribuer les contenus aux équipements concernés depuis son outil d’édition. Le but est toujours d’éviter la redondance de l’information et de réduire les risques d’incohérence lorsque la documentation est distribuée aux différents utilisateurs.
La preview
Avant la validation finale de la documentation technique, une vérification, aussi appelée « 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. Grâce à la suite ADAM, cette étape de preview du processus d’ingénierie documentaire se réalise rapidement et facilement et peut être lancée par le rédacteur à n’importe quel moment de la rédaction depuis l’outil ADAM Author.
La validation
Une fois l’étape de preview effectuée, la validation de la production documentaire s’effectue en plusieurs étapes afin de toujours 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 grâce à l’outil 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 alors publiée puis livrée au client final.
Au moment de cette étape, il devient obligatoire de tracer précisément le contenu livré au client.
Par exemple, il faudra, à cette étape de processus d’ingénierie documentaire, lister les documents envoyés et répertorier les différences apportées à chaque nouvelle version d’un document.
Une fois livré, un document ne peut plus être modifié. Dans le cas contraire, 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 production documentaire 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.
Ingénierie documentaire : 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 un processus d’ingénierie 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 toujours avec cette volonté et dans cet esprit que 4D Concept développe la suite ADAM , spécialisée dans la gestion de contenu et l’ingénierie documentaire, afin d’accompagner au mieux le processus de production documentaire à chaque étape de sa création et de sa validation.
