Changelog est l'anglicisme pour « journal des modifications ». Le changelog d'un logiciel répertorie les modifications effectuées lors de chaque nouvelle version. Consigner ces changements est essentiel pour guider le travail des développeurs. Les utilisateurs du logiciel peuvent également consulter le changelog, pour connaître les mises à jour : résolution de bugs et ajout de fonctionnalités, par exemple.

Téléchargement  >> Le guide et la check-list pour rester pertinent dans le web 3.0

 

À quoi sert un changelog ?

Un changelog sert à documenter, de manière durable et structurée, les mises à jour successives d'un produit ou d'un projet informatique. La documentation est utile au développeur, ou à l'équipe de développeurs dans le cadre d'un projet collaboratif ou open source.

  • Le développeur se réfère au changelog pour visualiser les correctifs effectués au fil du temps. Cela limite le risque de régression, à l'instar de la documentation des tests avec la méthode TDD. Accéder à l'historique des fonctionnalités supprimées, par exemple, évite de les rajouter.
  • Quand plusieurs développeurs collaborent sur un projet informatique, le changelog est d'autant plus important. Chacun travaille sur une partie différente, à un moment différent : le journal des modifications permet à tous de savoir ce qui a été fait entre deux versions.

Le journal des modifications ne sert pas qu'aux développeurs. Rendre public le changelog d'une application logicielle est également pertinent, à plusieurs égards :

  • Les utilisateurs du logiciel ont besoin de connaître les modifications effectuées à l'occasion de la nouvelle version. L'ajout ou la suppression d'une fonctionnalité, ou le changement d'interface, par exemple, impacte leur utilisation du logiciel. Diffuser le changelog prévient les utilisateurs et leur permet de bénéficier des dernières mises à jour.
  • Pour un logiciel ou une application métier, le changelog peut servir de support au service informatique dans le cadre de l'élaboration d'un plan de déploiement. Si les modifications de la nouvelle version sont majeures, en effet, le changement doit être conduit avec pédagogie.
  • Pour les éditeurs de logiciels, diffuser les changelogs est l'opportunité d'annoncer publiquement chaque sortie d'une nouvelle version. C'est un atout en termes d'image de marque : le public constate que l'entreprise de logiciels est attentive à la performance de ses produits. C'est également un argument efficace pour fidéliser les clients.

 

Comment rédiger un bon changelog ?

Il existe deux méthodes pour rédiger un changelog. Traditionnellement, les développeurs documentent les modifications dans un fichier, en respectant les codes rédactionnels du changelog. Des outils, par ailleurs, permettent d'automatiser la rédaction et la diffusion du journal des modifications, à partir de notes de version informelles.

 

Les éléments qui doivent figurer dans un changelog

Les changelogs ont tous une apparence similaire. Utiliser les codes de rédaction et de mise en forme facilite la lisibilité et la compréhension du document. Pour rédiger un bon changelog, il est essentiel de faire figurer dans le fichier les éléments suivants :

  • Le numéro de version. Par usage, le numéro de chaque version logicielle est composé de trois nombres séparés par des points : « 3.10.1 » par exemple. Pour déterminer le nombre à faire évoluer au moment d'une nouvelle version, il faut évaluer l'importance de la mise à jour. Une mise à jour très importante fait augmenter le premier nombre, les changements mineurs font augmenter le troisième nombre. Dans l'exemple, la correction d'un léger bug fait passer la version de « 3.10.1 » à « 3.10.2 ».
  • La date de sortie de la nouvelle version. D'un pays à l'autre, les dates ne s'écrivent ni ne se prononcent de la même manière. Pour s'assurer de comprendre uniformément la date de la mise à jour, une syntaxe standardisée dicte d'écrire la date en chiffres, au format : année-mois-jour.
  • La liste des modifications, par type. Par convention, il est recommandé d'utiliser les termes suivants : « added » pour l'ajout de fonctionnalités, « removed » pour la suppression de fonctionnalités, « changed » pour les modifications de fonctionnalités, « deprecated » pour les fonctionnalités susceptibles d'être supprimées, « fixed » pour les résolutions de bugs et « security » pour les risques de vulnérabilités détectés.
  • La description de chaque modification. Le changelog est rédigé en langage humain, pour des humains. Le descriptif doit être facilement compréhensible.
  • Des liens de redirection éventuels. Pour faciliter la navigation entre deux versions logicielles, ou pour développer le descriptif d'une modification, des liens peuvent être ajoutés dans le document aux emplacements pertinents. Un développeur en POO peut par exemple estimer judicieux d'écrire le code utilisé pour effectuer sa modification fonctionnelle.

 

Solutions automatiques

Frill, Beamer ou encore ReleaseNotes : des outils existent pour faciliter le travail de rédaction et de diffusion des changelogs. Ils proposent une manière moins formelle et plus ludique d'annoncer des changements opérés lors d'une mise à jour logicielle. Parmi les fonctionnalités de ces solutions automatiques :

  • La rédaction automatique des annonces de montée en version à partir de notes informelles.
  • La possibilité d'afficher le changelog sous forme de widget sur le site web, le logiciel SaaS ou l'application, ou de diffuser l'annonce sur une page web autonome optimisée pour le référencement.
  • Des modèles d'annonces personnalisables, pour accélérer le travail de mise en forme. Les outils permettent d'ajouter des captures d'écran ou encore des extraits de vidéos, pour agrémenter la publication du changement.
  • Des fonctions de traduction automatique pour générer le texte du changelog en différentes langues, en fonction du public cible.
  • Des zones de commentaires, pour permettre aux utilisateurs du logiciel mis à jour de réagir à l'annonce et de commenter les modifications.
  • La possibilité de paramétrer un système de notification des utilisateurs du logiciel à chaque mise à jour du produit.
  • Des statistiques pour analyser l'engagement des utilisateurs.

 

métavers, blockchain, intelligence artificielle : comment rester pertinent dans le web 3.0 ?

téléchargez le guide gratuit et découvrez les pratiques pour adapter votre stratégie aux tendances du web 3.0.

 

3 bons exemples de changelogs

 

Le système d'exploitation iOS

changelog d'ios

 

Le changelog de la version 17 du logiciel Apple s'adresse aux développeurs d'applications dans l'environnement iOS. La liste des mises à jour successives du système d'exploitation permet aux développeurs de mettre à leur tour à jour leurs applications, pour améliorer les performances globales des appareils Apple, au bénéfice des utilisateurs.

L'apparence de cette documentation officielle est relativement austère, et ne reprend pas exactement les codes rédactionnels académiques. Le changelog toutefois est compréhensible, et la navigation est facilitée par le système de liens internes.

 

La bibliothèque JavaScript React

journal des modifications react sur github

 

React est une bibliothèque JavaScript open source, qui compte un grand nombre de contributeurs. Les modifications substantielles sont documentées dans le changelog React accessible librement sur la plateforme de développement GitHub.

En tant que projet collaboratif, la bibliothèque React est modifiée par de multiples développeurs, régulièrement. Tenir à jour le journal des modifications est important pour que tous s'y retrouvent. Les développeurs en outre se mentionnent les uns les autres pour notifier les informations nécessaires aux personnes concernées.

 

L'application de gestion de tâches TickTick

changelog de l'application ticktick

 

Le changelog du logiciel TickTick s'adresse aux utilisateurs de cette application de gestion de tâches. Les annonces des changements sont d'autant plus compréhensibles, et la mise en page est plus ludique.

Pour aller plus loin, découvrez les opportunités d'affaires liées aux évolutions du web en téléchargeant le guide et la checklist du web 3.0, ou découvrez le logiciel marketing de HubSpot.

New call-to-action

Publication originale le 25 septembre 2023, mise à jour le 13 février 2024

Sujet(s):

Monitoring web