Qu’est-ce que la rédaction structurée ?

Qu'est-ce que la rédaction structurée ?

L’industrie technologique a longtemps été un moteur de changement, et ces dernières années, la manière dont nous fournissons des solutions à nos clients a changé de manière spectaculaire, passant des méthodologies traditionnelles “waterfall” en cascade à une approche agile.

Au cours des vingt dernières années, la façon dont les rédacteurs techniques créent, gèrent et publient le contenu a considérablement évolué. Auparavant, la plupart des documents étaient créés à l’aide de logiciels de traitement de texte, comme Microsoft Word.

Aujourd’hui, les rédacteurs techniques utilisent davantage des outils de création de contenu structuré, tels que des éditeurs XML associés à un CCMS comme celui proposé par Componize Software.

Qu’est-ce que le contenu structuré ?

C’est une manière plus efficace et plus performante de créer, gérer et publier du contenu. Elle permet aux rédacteurs de le réutiliser, d’automatiser les procédures de publication et de collaborer plus efficacement avec d’autres rédacteurs et experts du domaine (les SME). Cette approche combine deux concepts distincts :

  • Le single-source : permet aux rédacteurs de créer un fragment de contenu unique et de l’utiliser pour plusieurs formats.
  • l’application de framework dédiés : comme DITA XML, qui facilite la réutilisation du contenu.

Grâce à ces deux concepts, le contenu structuré est un outil bien plus puissant que ses prédécesseurs.

En rédaction technique et structurée, chaque topic, paragraphe, phrase, élément de liste ou entrée de tableau a une fonction bien précise.

Le contenu est organisé de manière très spécifique. Il se compose d’éléments hiérarchisés qui peuvent être réutilisés de plusieurs façons. À l’opposé du contenu non structuré, qui n’est pas sujet à une organisation spécifique. Le contenu non structuré est généralement utilisé pour des documents de traitement de texte, des PDF et des présentations PowerPoint.

Il est également différent du contenu semi-structuré, qui n’est que partiellement organisé. Ce type de contenu est souvent utilisé pour des documents de traitement de texte qui ont été formatés avec des titres et des sous-titres, par exemple.

La rédaction structurée est conçue pour résoudre les difficultés fréquemment rencontrées lors de la documentation de systèmes et de produits complexes. Elle offre une structure et un cadre, afin :

  • que les utilisateurs se familiarisent rapidement à la présentation des informations dans les manuels d’une même organisation ;
  • d’offrir aux utilisateurs une expérience transparente et concise ; 
  • de garantir une documentation exacte et complète ;
  • et bien d’autres choses encore.

Quels sont les défis liés à l’adoption de la rédaction structuré ?

La courbe d’apprentissage

Apprendre de nouveaux procédés, outils, et méthodologies, était une chose intéressante et facile lors de la formation initiale du rédacteur technique. Avec le temps, les habitudes s’installent. L’apprentissage de nouveaux langages de balises, de méthodologies telles que le minimalisme et DITA, peut être décourageant.

Les coûts

Il y a un certain nombre de coûts à prendre en compte. Les principaux domaines dans lesquels vous devrez investir :

Les outils

  • Le CCMS : Qu’il s’agisse d’une solution hébergée en interne ou d’une solution SaaS, le coût est généralement calculé par utilisateur.
  • L’éditeur XML : Tout comme le CCMS, les coûts sont généralement liés au nombre d’utilisateurs.

La formation

La formation de l’ensemble de l’équipe de rédaction technique aux différentes architectures de rédaction (DITA, Docbook) représente un coût.  Ces coûts incluent à la fois les dépenses liées à la formation et les temps d’arrêt pour l’équipe, car il est généralement nécessaire de suspendre ou de réduire la production pendant la période de formation.

La migration

Il s’agit de la conversion du contenu existant. Le passage d’un langage de balises à un autre entraînera des coûts de conversion. Plus les règles de structure des documents à convertir sont importantes, plus la création d’une matrice de conversion sera rapide et peu coûteuse, même si vous faites appel à une entreprise qui assure la conversion des données.

Encore une fois, vous devez prendre en compte le temps nécessaire à la conversion, à son nettoyage, à sa vérification, puis à la validation du contenu. D’autant plus si vous travaillez dans des secteurs réglementés, où le temps et les efforts peuvent s’avérer plus longs ou plus conséquents.

Afin de réduire le temps et les efforts, interrogez les équipes chargées de la qualité et de la réglementation sur le choix des outils. Incluez-les également dans la validation du processus de conversion.

La traduction

Oui, l’un des principaux arguments de vente du contenu structuré et de la réutilisation, est la réduction du coût de traduction. Cependant, les économies ne se feront sentir qu’après avoir traduit une nouvelle fois le contenu converti, à partir de la version n+1. Pourquoi ?

Quelle que soit la qualité de votre prestataire de traduction et des mémoires de traduction (MT) que vous avez alimentées au fil des ans, les MT fonctionnent en identifiant des segments d’information. Un segment peut désigner un mot, une expression, une phrase ou même un paragraphe entier. 

Le contenu structuré et la conversion en XML modifient les segments en ajoutant des éléments/balises. Une simple phrase, considérée comme un seul segment, devient au minimum 5 segments :

“Le renard brun et rapide saute par-dessus le chien paresseux“

<p>Le renard <b>brun</b><i>et rapide </i>saute par-dessus <u>le chien paresseux</u></p>

Les alternatives à la rédaction structurée

Bien qu’il existe de nombreuses alternatives à la rédaction structurée, elles dépendent de la finalité du contenu.

  • Confluence ou les plateformes wiki : plateforme collaborative de type wiki qui aide les équipes à collaborer et à partager rapidement les connaissances. Permet aussi de documenter les spécifications d’un projet, d’assigner des tâches aux utilisateurs et de proposer un modèle de collaboration.
  • La publication assistée par ordinateur (PAO) : Adobe FrameMaker (lorsqu’il est utilisé dans un format non structuré), InDesign, et d’autres outils qui permettent un flux libre de création de contenu, avec des paramètres de publication améliorés par rapport à un simple document Word.
  • MS Word, Google Docs et tout autre logiciel de traitement de texte : Bien qu’ils soient faciles à utiliser et accessibles, voire gratuits. Les problèmes liés aux erreurs de copier/coller, au formatage des pages et à la longueur de la publication démontrent les limites de ce type d’outil.

Les avantages de la rédaction structurée

Contenu réutilisable

Le principal avantage du contenu structuré est qu’il peut être réutilisé de différentes manières. Un élément de contenu structuré peut être utilisé pour produire plusieurs formats (tels que HTML, PDF et EPUB). Le format multiple permet également de diffuser le contenu sur plusieurs supports, notamment papier, en ligne, mais aussi sur des tablettes et des smartphones.

Étant donné que le contenu structuré est décomposé en fragments d’information totalement indépendants qui peuvent être interprétés en dehors de leur contexte, au lieu de copier/coller la même information dans plusieurs documents, il suffit de faire une référence au contenu à inclure.

Cette approche signifie que lorsqu’une modification est nécessaire pour ce fragment de contenu, le rédacteur n’a qu’à le modifier une fois et le republier sur tous les supports différents d’un simple clic pour que les mises à jour soient appliquées à toutes les publications concernées.

L’approche de source unique (single-source)

Cette approche “single-source” permet également de réaliser des économies dans la gestion des traductions. Le contenu réutilisé et traduit n’a pas besoin d’être traduit une nouvelle fois lorsqu’il est utilisé dans une autre publication.

Publishing

Enfin, le contenu structuré est plus facile à publier que le contenu non structuré. Grâce aux CCMS et aux normes d’architecture d’information comme DITA, l’aspect et la présentation de la documentation sont gérés de manière centralisée et sont uniformes à travers tous les documents. Le rédacteur n’a plus à se préoccuper des paramètres de publication.

NEWSLETTER

Table of contents