Collaboration et révision en temps réel pour la documentation technique

Componize propose une fonctionnalité de relecture collaborative qui permet de travailler à plusieurs, directement dans votre CCMS DITA.

• Vous cherchez un moyen pour effectuer vos relectures en un seul cycle ?
• Vous avez un gros volume de contenus à faire relire avant la publication ?
• Vous souhaitez planifier efficacement toutes vos relectures ?
• Tout cela, en passant d’un outil à un autre ?

Dans les secteurs réglementés, la gestion des modifications est un élément clé du système de management de la qualité (SMQ). Pour répondre à ces exigences, toutes les modifications apportées doivent être justifiées, faire l’objet d’un suivi et pouvoir être vérifiées.

Ces deux dernières années, Componize a développé une solution dédiée au processus de relecture au cours du cycle de vie de la documentation. Nous nous sommes interrogés, ainsi que nos clients, sur les causes de la lenteur et de l’inefficacité de ce processus. En raison des silos que de nombreuses entreprises créent involontairement au sein de leurs équipes produits, que peut-on faire pour réduire ces cycles et appliquer la même approche de collaboration sur le code logiciel pour la création de contenu en XML ?

Notre solution sera disponible dans le courant de l’année et permet de résoudre ces problématiques en proposant une approche unifiée de toutes les étapes du processus de livraison, tout en prêtant une attention particulière aux exigences strictes imposées aux fabricants dans les secteurs réglementés.

Le nouveau Componize permettra d’effectuer des relectures collaboratives et proposera :

• Une gestion des tâches 
• Une identification et une gestion automatiques des modifications
• Une aide aux cycles de vérification et de validation 
• Des signatures électroniques
• Et bien d’autres fonctionnalités.

Tous ces éléments sont conformes aux réglementations relatives à la gestion de la documentation électronique et aux signatures électroniques, telles que les dispositions du titre 21 CFR Part 11.

L’optimisation du processus de relecture permet de gagner énormément en productivité. Malheureusement, cet aspect n’est pas suffisamment pris en charge par les autres fournisseurs de CCMS.

L’impact des silos d’équipe sur la livraison Agile

L’approche classique des secteurs réglementés consiste à diviser les équipes en “silos” : ingénierie, système(s), logiciel(s), documentation technique, etc. Même en faisant preuve de flexibilité, l’équipe chargée de la documentation technique reste le dernier wagon d’un long train. Wagon, qui est toujours le dernier à arriver en gare.

La collaboration des équipes sur la documentation permet de réduire drastiquement la longueur de ce train, qui dispose désormais de deux étages. Plus de passagers arrivent en même temps sur le quai tout en réduisant la longueur du convoi. Même si tous les wagons n’arrivent pas en gare en même temps, plus de passagers/fonctionnalités sont livrés à quai.

Résultats du sondage du webinaire, résultats du sondage LinkedIn

Componize a organisé un webinaire le 10 mars 2022. Nous avons simulé un scénario dans lequel un rédacteur technique envoyait un chapitre à relire. Au cours du webinaire “Pain relief for convoluted review cycles”, nous avons effectué un rapide sondage :

• Sur 46 participants, seulement 3 % était en mesure d’effectuer les relectures en un seul cycle.
• Près de la moitié d’entre eux, 43 %, a besoin d’un minimum de quatre cycles.

En prenant l’exemple de ce sondage, imaginez ce scénario :

1. Un contenu est envoyé pour relecture et validation le lundi soir.
2. Dans le meilleur des cas, les premiers retours arrivent le mardi en fin de journée.
3. Les modifications sont effectuées le mercredi.
4. Le contenu est renvoyé le mercredi également.

43 % des interrogés effectuent ces étapes sur 4 cycles. Ce qui signifie que le contenu ne sera pas finalisé avant le lundi deux semaines après l’étape 1 !

Une réunion avec les experts en charge de la relecture le mercredi aurait permis de finaliser le contenu. Au cours de cette réunion, la lecture du contenu s’effectue en coordination et les modifications à apporter sont identifiées. De cette façon, l’expert ne perd pas son temps à repérer les modifications. Même avec un DiffDoc (un document surligné en rouge indiquant les modifications apportées), l’expert doit toujours parcourir la documentation. À l’issue de cette réunion, le contenu est finalisé et tous les commentaires ont été appliqués. Aucun email de questions ou de demande d’informations n’a été nécessaire. Je n’ai reçu aucune information contradictoire venant des autres équipes.

Les motifs d’une modification du contenu

Les motifs d’une modification peuvent provenir de diverses sources. Une nouvelle fonctionnalité, un défaut, un correctif, etc. Ces raisons doivent être documentées dans l’un des outils utilisés par le fabricant pour assurer le suivi des événements. 

Plutôt que de les lister dans un autre outil (les feuilles de calcul sont très répandues), elles peuvent être incluses dans les annotations, les commentaires et les boîtes de dialogue par topic. Le rapport généré à la fin du projet peut alors énumérer toutes les modifications apportées à un document, ainsi que les personnes qui les ont effectuées, celles qui les ont relues et approuvées dans le CCMS.

La traçabilité

Chaque action effectuée sur les topics est enregistrée dans une base de données au sein du CCMS. Les utilisateurs disposent d’identifiants uniques pour se connecter au CCMS afin que toute modification soit enregistrée sous leur nom. Les entreprises qui utilisent le SSO (Single Sign-On) pour les connexions à leurs outils ont la garantie que les utilisateurs sont uniques et que les signatures ne peuvent pas être contrefaites.

Appliquée correctement, l’authentification SSO qui répond aux exigences du 21 CFR Part 11 permet de s’assurer que tous les rapports générés dans le cadre d’un tel système sont prêts pour l’audit et que leur authenticité est vérifiée.

Les audits réglementaires

Les fabricants soumis à un audit réglementaire sont souvent les plus lents à adopter des changements dans leur approche “traditionnelle”, consistant à convertir les processus papier en processus numériques. Le motif avancé pour continuer à imprimer des documents en vue d’une signature analogique pour approbation, est fondé sur un vieux concept selon lequel les PDF ne sont pas modifiables. 

Cela était vrai au début des années 2000. Mais la profusion d’outils d’édition PDF gratuits vient contredire cet argument en 2022. Par ailleurs, les CCMS et autres systèmes de gestion de contenu sont désormais plus performants. La possibilité de suivre toutes les modifications apportées à un document, de créer des captures d’écran des données sources et de reproduire exactement le même contenu, signifie que les fabricants doivent désormais utiliser toutes les fonctionnalités de leurs systèmes. Ces fabricants ont investi beaucoup de temps et de ressources dans la qualification de leurs systèmes et les intègrent dans leur stratégie de gestion de la qualité.

Le reporting

Afin d’obtenir un certificat de bonne santé, l’examinateur doit obtenir des résultats fiables lorsqu’il examine l’historique de la conception d’un appareil. Un audit réussi dépend des compétences de l’auditeur et de la qualité des registres de l’entreprise, ainsi que de la transparence de ses rapports opérationnels. Dans le cas de publications destinées à un usage ou à une maintenance, l’entreprise doit pouvoir fournir un historique précis et détaillé des modifications apportées aux publications, avec des liens directs vers les motifs de ces modifications.

La participation des experts du domaine au processus de relecture 

Chez Componize, notre objectif est d’améliorer continuellement nos outils afin de fluidifier les cycles de vie de la création de contenu. Comme solution intermédiaire à notre nouveau produit, Componize CCMS intègre oXygen Web Author avec une fonction de rédaction collaborative. Ce plugin est un pas de plus vers la création d’un système de gestion de contenu collaboratif qui permet la traçabilité et l’auditabilité.

Grâce à cette fonctionnalité, les rédacteurs peuvent organiser des réunions pour travailler en temps réel avec leurs experts, afin de finaliser la documentation. Les experts du domaine peuvent modifier le document avec le rédacteur, chacun pouvant ajouter des annotations ou modifier le contenu source.

Avec Componize et ses flux de travail entièrement personnalisables, vous pouvez organiser la production de votre contenu. L’outil dispose également d’un système de relecture intégré, qui s’effectue en un seul cycle. Le CCMS aide les industries réglementées à se conformer aux réglementations en leur offrant un moyen simple de suivre les modifications apportées au contenu, ainsi que les collaborateurs qui les ont effectuées.

Les balises XML peuvent être supprimées de l’interface de relecture, pour que les relecteurs aient un aperçu de la version finale des topics. La barre d’outils est simplifiée et ne laisse apparaître que les fonctionnalités nécessaires pour la relecture, ce qui facilite grandement la prise en main du CCMS.

Pour un client, Componize a mis en place un cycle de relecture complet, comprenant notre fonctionnalité collaborative et des flux de travail personnalisés. Les retours ont été excellents. Puisque la fonctionnalité est encore récente, nous n’avons pas encore mené d’enquête sur les améliorations apportées. Cependant, les rédacteurs techniques et les chefs de projet nous ont fait part de leur grande satisfaction :

• Moins de brouillons inutiles
• Moins de mails de relance pour terminer la relecture d’un topic
• Moins d’étapes à suivre pour l’approbation d’un document avant sa publication

Description d’un processus optimisé

Avec Componize :

1. Créez votre/vos flux de travail avec Componize pour :
   – Définir le statut du document (prêt à être révisé, révisé, révisé, approuvé…)
   – Déplacer des documents tout au long du cycle de vie
   – Définir des autorisations pour les différents rôles (read only, edit allowed by role x, full access …) 
2. Déployer le plug-in Concurrent Editing et le configurer selon vos flux de travail
3. Déployer le plugin de signature électronique si vous souhaitez inclure les signatures électroniques grâce au SSO (Single Sign-On)
4. Lancer des relectures sur des cycles plus courts

Cliquez ici pour en savoir plus sur les flux de travail de Componize.

Résultats

• Un flux de travail fluide et personnalisable qui guide les contributeurs tout au long du cycle de vie des documents.
• Une interface simplifiée permettant aux experts du domaine d’effectuer des relectures plus efficacement.
• Un suivi de toutes les modifications apportées au document.
• Des rapports de traçabilité indiquant qui a fait quoi, quand et pourquoi.
• Le tout soutenu par une base de données conforme aux exigences réglementaires et capable de fournir des rapports d’audit.