Aller au contenu

Rédaction technique : un processus industriel

Concept

Découvrez le processus complet de rédaction technique : définition du projet, collecte d'information, création de contenu, validation, traduction et livraison.

3 min de lecture

Voir en Markdown

Ce processus repose sur une méthodologie rigoureuse et une chaîne de production fiable.

Processus de rédaction techniqueSchéma montrant la piste méthodologie, définition du projet, collecte de l'information, création du contenu, validation d'où part la traduction, et livraison, reliée à la piste chaîne de production, format source, référentiel et format cible, la création du contenu alimentant le format source et le format cible alimentant la livraison.Définition du projet(méthodologie)Collecte del'information(méthodologie)Création du contenu(méthodologie)Validation(méthodologie)Livraison (méthodologie)Traduction(méthodologie)Format source (chaîne deproduction)Référentiel (chaîne deproduction)Format cible (chaîne deproduction)

Processus de rédaction technique

Pour créer et valoriser un contenu à forte valeur ajoutée pour l’entreprise, le rédacteur technique dialogue constamment non seulement avec tous les acteurs internes de la société, mais aussi avec son écosystème : partenaires, journalistes, utilisateurs, etc. Il fournit ainsi aux différents publics l’information dont ils ont besoin. Ceci renforce l’image de marque de la société, améliore la satisfaction client et facilite la perception des avantages produit par les prospects.

Chaque étape fait l’objet d’un article.

  1. Définition du projet. Comme pour les projets de R&D ou de marketing, la définition du projet permet d’en estimer le budget et les retombées : public cible, périmètre, livrables et critères de succès.
  2. Collecte d’information. Le rédacteur technique collecte l’information auprès de différentes sources, internes et externes à l’entreprise : spécifications du produit, tickets, interview du service R&D, prise en main du produit.
  3. Test des produits. Premier représentant des utilisateurs, le rédacteur technique teste les produits dans des conditions proches des leurs, plutôt que de mettre en forme des informations glanées auprès des différents acteurs de la société.
  4. Création de contenu. Le rédacteur technique crée le contenu dans un dialogue constant avec les services R&D, marketing et les autres acteurs de la société, en tenant compte des contraintes liées au cycle de vie des supports.
  5. Validation et contrôle qualité. Le contenu est validé avant livraison, et chaque demande de modification est tracée, via un workflow CMS (Content Management System)Un outil qui ajoute workflow et verrouillage des fichiers à la gestion de contenu, au prix de compromis de fiabilité par rapport à une gestion de versions simple.Voir dans le glossaire → ou un système de tickets.
  6. Traduction. La traduction a des implications autant sur le style rédactionnel que sur l’organisation du RéférentielL'endroit où une équipe documentaire conserve ses sources : répertoires partagés, base de données d'un CMS ou système de gestion de versions comme Git, qui conserve en outre l'historique complet de chaque fichier. Un référentiel Git est aussi appelé dépôt.Voir dans le glossaire → : elle doit être prise en compte en amont.
  7. Livraison. Le contenu validé atteint ses cibles via le format et le canal définis lors de la définition du projet.

Les étapes se succèdent, mais ne forment pas un simple relais :

  • La validation accompagne la rédaction. Idéalement, la phase de validation se déroule en parallèle de la phase de création : plus les modifications interviennent tôt, moins elles sont coûteuses.
  • La traduction part de la validation, mais se prépare dès le départ. Si la documentation repose sur un ensemble de modules, la traduction peut se faire en parallèle de la rédaction.
  • Le test vérifie ce que la collecte rassemble. Les avis des acteurs de l’entreprise sont partiels ; tester le produit comble les lacunes.
  • La livraison honore la définition du projet. Le format et le canal des livrables sont choisis à la première étape et livrés à la dernière.

Le rédacteur technique s’appuie sur une chaîne de production aussi automatisée que possible. En mettant en place un processus industriel et reproductible, il diminue les coûts de production et fournit un niveau de qualité constant, adapté aux buts de l’entreprise.

La création de contenu alimente la chaîne, et la chaîne alimente la livraison :

Avec une approche docs-as-code, cette chaîne de production devient très concrète : les sources sont des fichiers texte dans un dépôt Git, chaque modification est relue sous forme de Pull requestDemande d'intégration des modifications d'une branche dans la ligne principale, présentée sous forme de différences à relire : les relecteurs commentent, les contrôles automatisés s'exécutent et l'approbation est tracée avant la publication. GitLab parle de merge request.Voir dans le glossaire →, des contrôles automatisés (génération, liens, métadonnées) s’exécutent avant toute fusion, et un pipeline CI/CD (intégration continue et livraison continue)Automatisation qui vérifie chaque modification dès qu'elle est proposée (intégration continue), puis publie le résultat une fois les contrôles réussis (livraison continue). En docs-as-code, un pipeline CI/CD compile la documentation, exécute des tests, comme la vérification des liens et des schémas, et déploie le site.Voir dans le glossaire → publie le résultat. Les étapes ci-dessus restent les mêmes ; ce qui change, c’est la part du suivi que la machine peut prendre en charge. La rédaction assistée par IA s’insère dans la même chaîne : c’est une contribution de plus, soumise à la même relecture et à la même validation que les autres.

Pour suivre une modification unique tout au long de cette chaîne, voir l’exemple de workflow docs-as-code.