Décrivez l'effet, pas seulement l'activité
La mise à jour de l'ensemble de données indique très peu au lecteur. Une entrée utile identifie le champ ou le groupe d'enregistrement touché et explique si le changement corrige une erreur, ajoute des preuves, modifie une étiquette ou modifie la structure du fichier.
Gardez l'identificateur de libération stable et donnez à la modification sa date enregistrée. Une date de sortie de l'ensemble de données est distincte des dates des événements ou des sources décrits à l'intérieur. La publication d'un historique corrigé aujourd'hui ne fait pas de son événement sous-jacent un événement nouveau.
Utiliser des catégories qui mènent à une décision
Un lien source ajouté, une étiquette d'hôte corrigée, un duplicata fusionné et un nom de colonne modifié ont des conséquences différentes. Quelqu'un réutilisant le fichier doit savoir s'il faut revoir une interprétation, modifier un identifiant ou adapter un importateur.
| Modifier le type | L'étape suivante probable du lecteur |
|---|---|
| Valeur corrigée | Revérifier les calculs en utilisant cette valeur |
| Autres éléments de preuve | Lire son champ d'application avant d'étendre une conclusion |
| Identité fusionnée | Suivez la cartographie de l'identificateur ancien à courant |
| Colonne rebaptisée | Mettre à jour la cartographie des importations |
| Dossier retraité | Vérifier la raison et la destination retenue |
Évitez de combiner tous ces sous un seul compte de nouveaux articles. Un meilleur comptage distingue les nouveaux lecteurs des alias, des réparations et des modifications de métadonnées.
Un exemple de sortie fictif
La version R-12 contient deux rubriques qui, par la suite, font référence au même rapport de laboratoire. R-13 conserve un enregistrement courant et cartographie le deuxième identifiant. Le journal de changement doit nommer les deux identificateurs, expliquer la recherche en double et indiquer si un décompte sommaire a changé.
L'ancienne libération reste intacte. Un utilisateur reproduisant R-12 peut toujours obtenir son fichier original, tandis qu'un utilisateur migrant vers R-13 a une cartographie explicite. Supprimer l'identifiant plus ancien sans trace rendrait les liens et les calculs publiés antérieurement difficiles à interpréter.
Connectez la prose aux changements lisibles par machine
Pour chaque correction importante, conservez des valeurs anciennes et nouvelles ou un diff de niveau d'enregistrement limité. Utilisez des identifiants stables plutôt que des numéros de lignes, qui peuvent changer après tri. Un résumé humain peut regrouper les changements connexes pendant que le fichier détaillé fournit les enregistrements exacts.
Si un changement a été déclenché par une nouvelle source, identifiez la source et l'énoncé qu'elle affecte. Une nouvelle notice bibliographique n'exige pas nécessairement de modifier une conclusion clinique. Expliquez le lien plutôt que de traiter tous les ajouts de citation comme des mises à jour scientifiques.
Vérifier la libération que vous décrivez
Comparez les fichiers finals réels avec la version précédente. Vérifiez le nombre d'enregistrements, les identifiants dupliqués, les redirections et les hachages de fichiers. Écrire le journal de changement à partir de cette comparaison et les décisions éditoriales documentées, pas à partir de la mémoire de ce qui était prévu.
Lorsqu'une correction modifie une déclaration publique, rendre la page actuelle et les données téléchargeables d'accord. Un changement de journal qui explique une correction tout en laissant l'ancienne valeur dans le téléchargement actuel crée une autre incohérence.
Combien de détails suffisent ?
Inclure suffisamment pour que quelqu'un puisse localiser le matériel touché et en comprendre les conséquences. Tenir les discussions privées et les détails opérationnels hors de l'entrée publique à moins qu'ils ne soient nécessaires et approuvés à cette fin.
Suivez laguide de conservationpour les fichiers et leréférence du changement d'histoirepour le lien entre les révisions d'articles et les diffusions de données.
Écrire une entrée à partir de l'action suivante de l'utilisateur
Une entrée utile peut être brève: identifier le matériel touché, décrire le changement et indiquer les conséquences. Pour une unité corrigée, la conséquence peut être de répéter les calculs en utilisant ce champ. Pour une fusion d'identité, il peut s'agir de suivre une cartographie publiée. Pour une réparation de l'orthographe, aucune interprétation ou changement d'importateur ne peut être nécessaire. La désignation de cette différence aide les utilisateurs à orienter leur attention.
Dans une seconde sortie fictive, une colonne anciennement appelée "date" devient "Event start date" sans changer ses valeurs. Le nom plus clair affecte toujours un importateur qui s'attend à l'ancien en-tête. Le journal de changement enregistre le changement de structure et toute aide à la migration, tout en préservant explicitement le sens et la précision des dates sous-jacentes. Il ne devrait pas compter chaque cellule renommée comme nouvelle preuve scientifique.
Séparer les numéros agrégés d'une version des documents détaillés touchés. Dix liens corrigés peuvent concerner trois articles, et trois alias peuvent indiquer une identité conservée. Expliquez ce que le dénombrement mesure pour que les lecteurs n'inféreront pas dix nouveaux articles ou trois nouvelles maladies.
Foire aux questions
Une nouvelle citation rend-elle un ancien événement actuel?
Conserver les dates d'ajout, de publication et d'événement distinctes. Expliquez si la nouvelle source a changé d'interprétation ou simplement amélioré la provenance. Une version actuelle peut encore décrire du matériel historique.
Un disque retiré devrait-il disparaître complètement?
Préserver la raison, le statut et toute destination conservée appropriée au système de publication. Les utilisateurs doivent comprendre ce qui est arrivé à un identificateur mentionné précédemment. Évitez une suppression silencieuse qui les laisse deviner si les données ont été déplacées ou n'ont jamais existé.
Comment vérifier le changelog?
Comparez les artefacts en cours de publication, résolvez les identificateurs énumérés et inspectez les changements dits anciens à nouveaux. Une liste de contrôle basée sur les modifications prévues ne peut pas prouver que le téléchargement final les contient. Si un changement a été retourné avant la publication, supprimer ou réviser l'entrée de sorte que l'historique public décrit les fichiers finaux.
Citer cette référence
Défense du bétail. Les lecteurs de changement peuvent utiliser pour les données de référence vétérinaires. Mise à jour 2026-11-03. https://livestockdefense.com/fr/guides/building-a-veterinary-data-release-changelog/
Ajoutez la date à laquelle vous avez accédé à la page. Cela identifie la référence actuelle; conserver une copie sauvegardée autorisée si votre travail dépend de sa formulation exacte. Une citation ne suffit pas à elle seule à étayer une réclamation.
Comment citer une page et sa révision