Bonnes pratiques en matière de contrôle de version des documents

En bref

• Gardez le schéma de numérotation stable une fois choisi : la renumérotation brise chaque référence croisée citant l'ancien numéro.
• Imprimez la version, la date et l'approbateur au même endroit fixe sur chaque page, pas seulement dans le nom ou les propriétés du fichier.
• Ne laissez jamais deux personnes modifier la version « actuelle » en parallèle sans convention de verrouillage ou d’extraction.
• Décidez dès le départ, par écrit, de ce qui rend un changement majeur ou mineur.
• Traitez « aucun changement nécessaire » comme un résultat d'examen enregistré, et non comme un silence.
• QueryChart remplace la convention d'extraction par un graphique canonique en direct : voir /features/version-control.

Un programme n’est valable que pendant sa deuxième année

Un système de numérotation échoue rarement au cours de son premier mois. Il échoue au cours de sa deuxième année, lorsque la personne qui fixait les « nombres entiers pour les copies délivrées » a quitté son poste, un nouveau contrôleur de documents invente une règle légèrement différente pour traiter un cas urgent, et deux conventions commencent à fonctionner simultanément dans le même registre. Cette page suppose que la décision de base est déjà prise : le choix d'un système en premier lieu est abordé dans /fr/guides/comment-controler-la-version-d-un-document et concerne la poignée d'habitudes qui permettent au système choisi de fonctionner une fois que le volume réel, le chiffre d'affaires et l'urgence l'atteignent.

Quatre problèmes se produisent une fois le projet choisi, et aucun d’entre eux ne concerne le projet lui-même. La renumérotation d'une bibliothèque existante pour corriger une faille perçue brise toutes les références croisées, les enregistrements de formation et les citations d'audit antérieures qui nommaient les anciens numéros, cela coûte donc généralement plus cher que de vivre avec la faille. Un numéro de version qui figure uniquement dans un nom de fichier ou un panneau de propriétés disparaît dès que quelqu'un imprime une page ou transfère une capture d'écran, il a donc besoin d'une position fixe et imprimée à la place. Deux auteurs éditant le même fichier « actuel » le même après-midi ne constituent pas du tout un problème de numérotation : il s'agit d'une convention de verrouillage ou d'extraction manquante, et aucun schéma ne survit sans une telle convention. Et un examen périodique qui ne trouve rien d’anormal doit encore laisser des traces, sinon il est impossible de le distinguer un an plus tard d’un examen qui n’a jamais eu lieu. Rien de tout cela ne représente le cycle de vie complet du document (la demande jusqu'au retrait est entièrement parcourue sur /fr/templates/organigramme-du-processus-de-controle-des-documents) ; c'est la couche de numérotation à l'intérieur de ce cycle de vie, bien faite plutôt que simplement faite.

QueryChart supprime l'un de ces modes de défaillance de manière structurelle plutôt que par stratégie. Il existe un graphique canonique en direct par document plutôt qu'un ensemble de fichiers que quelqu'un doit se rappeler de verrouiller, chaque sauvegarde est automatiquement capturée en tant que nouvelle entrée dans le journal des modifications avec l'acteur et le champ exact qui a changé, et Comparer les versions met deux révisions côte à côte. Deux personnes ne peuvent pas créer silencieusement la copie "actuelle", car il n'y en a qu'une, et tout son historique est une requête plutôt qu'un test de mémoire. Voir /features/version-control.

Comment cela fonctionne

1. Geler le schéma de numérotation une fois que de vrais documents en dépendent

   Traitez une modification du système lui-même (passer des nombres entiers à la version sémantique, ou redéfinir la signification d'une décimale) comme un projet et non comme un ajustement : cela invalide toutes les références croisées, dossiers de formation et citations d'audit antérieurs existants. Si une faille apparaît, documentez l'exception à l'avenir plutôt que de renuméroter la bibliothèque.

2. Placez la version, la date et l'approbateur à un endroit fixe sur chaque modèle

   Choisissez une seule position (en-tête ou pied de page) et intégrez-la au modèle de document afin que chaque auteur l'utilise sans décider. Un numéro de version dans un nom de fichier ou dans les propriétés d'un document ne survit pas à une impression, une capture d'écran ou un transfert d'e-mail ; celui imprimé sur la page le fait.

3. Donnez à la version "actuelle" une convention de verrouillage ou d'extraction

   Décidez qui peut ouvrir immédiatement la version actuelle pour l'éditer et comment un deuxième auteur découvre que quelqu'un le fait déjà : un indicateur d'extraction dans le registre, un fichier verrouillé ou une seule copie dynamique canonique où une seule sauvegarde peut gagner à la fois. Sans cela, deux modifications approuvées atterrissant sur la même version ne sont pas hypothétiques.

4. Écrivez la règle majeure contre mineure avant que le premier document n'en ait besoin

   Précisez, dans le même document qui définit le schéma de numérotation, exactement ce qui déclenche une étape de nombre entier : approbation formelle seule, ou approbation plus une réécriture substantielle. Une équipe qui décide de cette question au cas par cas se retrouve avec deux documents différents appelés tous deux version 2.0.

5. Enregistrez chaque examen périodique, y compris ceux qui ne changent rien

   Donnez à l'étape de révision une forme de décision avec une sortie étiquetée « aucun changement » qui écrit une entrée datée dans le registre, de la manière « Modification demandée après publication ? atteint "La version actuelle reste en vigueur" au lieu de simplement ne rien faire. Une entrée manquante devrait signifier que l’examen n’a pas eu lieu, et non que rien ne s’est produit pendant celui-ci.

6. Laissez une copie dynamique canonique supprimer complètement le problème de verrouillage

   Ouvrez le document sous forme de graphique QueryChart au lieu d'un ensemble de fichiers transmis par courrier électronique, et il n'y a qu'une seule version actuelle à modifier : chaque sauvegarde est automatiquement capturée en tant que nouvelle entrée dans le journal des modifications, de sorte qu'une convention d'extraction n'a plus rien à appliquer. Voir /features/version-control.

Erreurs à éviter

• Renuméroter pour corriger une erreur

  Découvrir que le système présente un défaut deux ans plus tard et renuméroter l'ensemble du registre pour le corriger brise toutes les citations qui nommaient les anciens numéros : audits, dossiers de formation, références croisées dans d'autres documents. Documentez plutôt l'exception à l'avenir ; vivre avec le défaut de ce qui est déjà publié.

• Le numéro de version qui ne figure que dans le nom du fichier

  "Policy_v3_FINAL.docx" ne dit rien à personne une fois imprimé, transmis ou copié sans son nom. Mettez la version, la date et l’approbateur à l’intérieur du document lui-même, au même endroit fixe à chaque fois.

• Deux exemplaires « courants » édités dans la même après-midi

  Une copie sur lecteur partagé et une copie envoyée par courrier électronique sont toutes deux modifiées comme si chacune était le maître, et les deux ensembles de modifications s'écrasent ou se forment silencieusement. Corrigez cela avec une convention d'extraction ou, mieux, une copie dynamique canonique : voir /features/version-control.

• Une revue qui ne laisse aucune trace quand rien n’a changé

  Un document examiné et jugé toujours exact, sans aucune mention faite nulle part, est impossible à distinguer un an plus tard d'un document que personne n'a examiné du tout. Donnez à "aucun changement nécessaire" sa propre ligne datée dans le registre, de la même manière que la branche Non d'une ligne de décision atteint toujours un résultat nommé.

Questions fréquentes

Quelle est la plus grosse erreur de contrôle de version de document à éviter ?

Traiter le schéma comme fixe uniquement jusqu'à ce que quelqu'un trouve une raison de le modifier. La renumérotation d’une bibliothèque existante (même pour corriger un véritable défaut) détruit toutes les références croisées, les dossiers de formation et les citations d’audit qui nommaient les anciens numéros, et ce coût dépasse presque toujours le coût de la vie avec un système imparfait. Résolvez les problèmes à l’avenir avec une exception documentée, et non en touchant à ce qui est déjà émis.

Comment puis-je empêcher deux personnes de modifier simultanément la même version « actuelle » ?

Soit ajoutez une convention d'extraction explicite (un indicateur dans le registre indiquant qui a le document ouvert, afin qu'un deuxième auteur sache attendre), soit supprimez structurellement la possibilité en conservant exactement une copie dynamique canonique au lieu des fichiers transmis par courrier électronique ou par un lecteur partagé. QueryChart fait la seconde : chaque document est un graphique en direct, chaque version est automatiquement enregistrée et il n'y a pas de deuxième copie à créer. Voir /features/version-control.

Qu’est-ce qui devrait être considéré comme une version majeure par rapport à une version mineure ?

Il n’existe pas de règle universelle, c’est exactement pourquoi elle doit être écrite avant que le premier document n’en ait besoin plutôt que d’être jugée au cas par cas. Une convention commune lie l'étape majeure, celle du nombre entier, à la seule approbation formelle (chaque projet de révision intermédiaire, aussi substantiel soit-il, reste une décimale), de sorte que "quelle était l'ampleur du changement" n'a jamais à être discuté au moment où un numéro de version est attribué.

Dois-je enregistrer un examen périodique qui n’a révélé aucune modification nécessaire ?

Oui : un avis non enregistré ne peut pas être distingué d'un avis qui n'a jamais eu lieu. Donnez à l'étape de révision de votre processus une forme de décision avec une sortie étiquetée « aucun changement nécessaire » qui écrit toujours une entrée datée dans le registre, de la même manière que la ligne de décision d'un graphique enregistre chaque branche qu'elle prend, pas seulement celles qui mènent à un nouvel endroit.