Lorsqu’il s’agit de gérer le cycle de vie des documentations techniques, les suites bureautiques traditionnelles se révèlent peu satisfaisantes, à moins que l’on s’impose une discipline stricte et chronophage. Il existe pourtant une autre manière de produire de la documentation technique, et que l’on pratique au sein d’IGDoc : la rédaction structurée.

Un regard nouveau sur la production documentaire

“La production documentaire est fondamentalement différente de la rédaction par traitement de texte, outil servant avant tout à la mise en page de l’information. En écriture structurée, la signification de l’information et la sémantique occupent une place centrale. C’est pour cette raison qu’on parle davantage de structure que de mise en page : […] le rédacteur se concentre sur la signification des informations qu’il écrit (un titre, un avertissement, une étape de procédure etc.) plutôt que sur leur mise en page (police, couleur, taille, etc.)“

NeoDoc, partenaire d’IGDoc

“D’un point de vue plus technique, la rédaction structurée est une approche méthodologique normalisée de création de contenu, incluant des types d’information, l’utilisation systématique des métadonnées, le balisage sémantique basé sur le XML, une architecture modulaire d’information basée sur des rubriques, un environnement de rédaction avec des contraintes et des règles appliquées par le logiciel, la réutilisation de contenu, et enfin la séparation du contenu et de la forme.”

Ixiasoft, partenaire d’IGDoc

Le choix de l’efficacité et de la flexibilité

A court, moyen et long terme, la rédaction structurée présente de nombreux avantages :

• L’optimisation documentaire grâce au contenu source, permettant un gain de temps dans les mises à jour, une réduction des erreurs humaines et une optimisation des données de publication (filtrage des contenus).

• La diminution et la meilleure répartition du contenu source.

• L’ ”industrialisation” de la rédaction de documents techniques et la réduction significative de mise à disposition desdits documents (time to market), dus à l’identification claire de chaque contenu réutilisable, l’automatisation de la mise en page, la focalisation du rédacteur seulement sur les contenus.

• La diminution des coûts de production et de traduction, notamment grâce aux mémoires de traduction.

• L’amélioration de la qualité de la documentation, ainsi que la gestion documentaire (ex. : conformité réglementaire).

La nécessité d’une migration méthodique

Passer d’un contenu non structuré à un contenu structuré requiert la présence d’une ressource qualifiée pour superviser la bonne structuration des contenus, afin d’éviter toute perte ou redondance inutile de données.
Dans cette nouvelle architecture structurée, le rédacteur technique découpe l’information en briques autonomes, uniques, standardisées et génériques, pour pouvoir l’assembler à la demande et selon les besoins de l’entreprise. Il doit donc utiliser des modules structurés de manière homogène qui peuvent facilement s’articuler grâce à des solutions locales ou dématérialisées.

Des outils permettant de gagner en productivité

La rédaction structurée propose des outils proches de ceux des CAO ou des PLM. Parmi les plus connus : MadCap Flare, Calenco ou encore Author-It. L’interface de travail de ces logiciels se veut ergonomique pour le rédacteur technique, qui peut ainsi se consacrer pleinement à la production ainsi qu’à la gestion de sa documentation.

Notre partenaire NeoDoc propose les fonctionnalités suivantes dans sa solution Calenco :

• un éditeur web personnalisable,
• une publication multiformat,
• une diffusion automatique et sécurisée,
• un éditeur d’image en ligne pour intégrer les légendes des illustrations à la gestion des traductions,
• un système de tags pour retrouver plus facilement ses contenus,
• une bibliothèque de source unique pour les contenus réutilisables,
• un système de filtrage pour personnaliser les contenus et conditionner en fonction d’un profil ou d’un contexte,
• une plateforme de traduction intégrée.

Sources :

• https://www.ixiasoft.com/documentation/DITA_Style_Guide/fr/Artefact/Authoring_Concepts/c_What_is_Structured_Authoring.html
• https://www.calenco.com/fr/Quoi-de-neuf/Actualites/La-redaction-structuree-Vs-traitement-de-texte.html
• https://redaction-technique.org/format-structure-dita-xml.html
• https://www.calenco.com/fr/L-offre/Fonctionnalites-Calenco.html

Voir aussi : 9 outils indispensables pour un rédacteur technique

Depuis 2016, IGDoc accompagne ses clients dans leurs projets documentaires : rédaction technique et mise en qualité de documents, mise en place d’outils de rédaction structurée, illustrations techniques ou encore gestion documentaire.