Les CMS : le workflow en prime, mais une fiabilité à tester
Un CMS comme SharePoint ou Alfresco apporte workflow et verrouillage des fichiers à la rédaction technique, et certains (DocZone, Componize) gèrent même DITA XML - mais leur fiabilité pour archiver les sources reste à tester, adossée à une sauvegarde éprouvée.
Définition
Section intitulée « Définition »Les CMS, ainsi dénommés pour des raisons purement marketing, mais dont la fonction se comprend mieux avec l’acronyme GED, apportent des notions de workflow et de gestion des liens qui s’avèrent précieuses lorsque l’on gère des documents modulaires.
Principes clés
Section intitulée « Principes clés »S’ils utilisent des formats monolithiques tels que FrameMaker, les rédacteurs techniques peuvent utiliser des 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 → tels que SharePoint, Alfresco ou consorts pour :
- télécharger sur leur disque dur une copie locale des fichiers partagés,
- effectuer leurs modifications sur la copie locale,
- déposer la copie modifiée sur le dépôt central.
Cette solution est plus satisfaisante que le partage sur un simple serveur de fichiers, ne serait-ce que parce que la fréquence à laquelle les fichiers transitent sur le réseau est bien moindre. Il est cependant toujours nécessaire de verrouiller les fichiers en cours de modification, ce dont se charge le CMS.
Originellement destinés aux documents monolithiques, de nombreux CMS prennent aujourd’hui en compte la modularisation des documentations techniques. Des solutions telles que DocZone ou Componize, cette dernière bâtie sur Alfresco, sont par exemple explicitement destinées à gérer des documentations modulaires basées sur l’architecture XML DITA XMLUne architecture de rédaction structurée et modulaire, construite autour de la typologie concept/tâche/référence et de la réutilisation de contenu via conrefs et ditamaps.Voir dans le glossaire →.
Compromis
Section intitulée « Compromis »Mais comment croire que ces solutions, qui sont fréquemment disponibles sous de nouvelles versions, marketing oblige, sont toutes d’une fiabilité optimale ?
J’aurais quelques scrupules, et quelques inquiétudes, sur le fait de leur confier entièrement la gestion et l’archivage des fichiers sources de la documentation. Une sélection rigoureuse de la solution s’impose, associée à une procédure de sauvegarde et de restauration éprouvée.
L’alternative docs-as-code
Section intitulée « L’alternative docs-as-code »Avec des formats source texte, un système de Gestion de versionsEnregistrement de chaque modification d'un ensemble de fichiers, qui permet de restaurer n'importe quel état antérieur, de comparer les changements et de travailler à plusieurs en parallèle. Git est le logiciel de gestion de versions le plus répandu ; en docs-as-code, la documentation est placée sous gestion de versions à côté du code du produit.Voir dans le glossaire → apporte l’essentiel de ce que l’on attend d’un workflow de CMS, sans verrouillage de fichiers :
| Ce que l’on attend d’un workflow de CMS | Ce qu’apporte la gestion de versions |
|---|---|
| Travail en parallèle | Les branches permettent à plusieurs rédacteurs de travailler en parallèle |
| Relecture et approbation | Les pull requests portent les étapes de relecture et d’approbation |
| Traçabilité | L’historique enregistre qui a modifié quoi et quand |
| Archivage | Chaque clone d’un dépôt Git contient tout son historique, ce qui répond en partie à la question de l’archivage |
Voir intégrer la documentation aux processus de développement et l’exemple de workflow de revue.
Un CMS reste pertinent lorsque les contributeurs ne peuvent pas travailler avec des fichiers texte et un gestionnaire de versions, ou lorsque l’organisation l’utilise déjà pour d’autres contenus.