Générateur de notes de version gratuit

Qu'est-ce que des notes de version ?

Les notes de version sont un court résumé des changements apportés à une nouvelle version d'un produit : nouvelles fonctionnalités, améliorations et correctifs, rédigées pour que le lecteur sache ce qu'il peut faire désormais. Un générateur de notes de version transforme la liste brute dont dispose déjà votre équipe, comme les commits ou les tickets, en ce résumé, afin que les notes accompagnent la sortie au lieu d'arriver une semaine plus tard.

De bonnes notes de version expliquent aux clients pourquoi une mise à jour est importante pour eux. Les messages de commit indiquent aux développeurs quel code a changé. Le travail consiste à traduire l'un en l'autre.

Notes de version ou changelog ?

Les termes sont souvent utilisés de manière interchangeable. Une distinction utile :

Cet outil fonctionne aussi comme un générateur de changelog : générez les notes pour chaque version et ajoutez-les en haut de votre page de changelog.

Que faut-il inclure dans les notes de version

• Titre avec produit et version : « Notes de version Acme Analytics 3.2 ».
• Un résumé en une ligne : le ou les deux changements qui intéressent le plus les lecteurs.
• Nouveautés, Améliorations, Correctifs : dans cet ordre, en omettant les sections vides.
• Puces axées sur les avantages : ce que l'utilisateur peut faire maintenant, pas ce que fait le code.
• Changements cassants : ce que l'utilisateur doit faire exactement, clairement indiqué.
• Liens : vers l'article d'aide ou la vidéo pour tout ce qui nécessite des explications.

Un court exemple de notes de version

Trois commits, « feat: export reports to CSV », « fix: dashboard timezone off by one hour » et « chore: bump dependencies », pourraient devenir :

Acme Analytics 3.2
Vous pouvez désormais emporter vos rapports partout, et les tableaux de bord affichent les bonnes heures.

Nouveautés

• Export CSV : téléchargez n'importe quel rapport sous forme de fichier CSV pour l'ouvrir dans Excel ou Google Sheets.

Correctifs

• Heures du tableau de bord : les graphiques utilisent désormais correctement votre fuseau horaire.

La mise à jour des dépendances est omise de la version client, car les utilisateurs ne le remarqueront pas. La version interne la conserve.

Comment préparer vos changements pour le générateur

Vous n'avez pas besoin de nettoyer votre liste au préalable, mais quelques habitudes permettent d'obtenir de meilleures notes. Collez un changement par ligne, qu'il s'agisse d'un message de commit, d'un titre de ticket ou d'une phrase. Gardez les préfixes conventionnels comme « feat: » et « fix: » si vous les utilisez ; ils aident à classer les changements en nouveautés et correctifs. Ajoutez un mot de contexte aux éléments cryptiques, par exemple « fix: export (CSV was empty for large reports) ». Remplissez le nom du produit et la version pour que le titre soit prêt à être publié. Ensuite, exécutez l'outil deux fois si vous avez besoin des deux versions : une pour les clients, une pour l'équipe interne.

Bonnes pratiques pour les notes de version

Écrivez pour la personne qui utilise le produit

« Les rapports se chargent plus vite » est préférable à « Optimisation du planificateur de requêtes ». Nommez la fonctionnalité telle qu'elle apparaît dans l'interface.

Mettez en avant ce qui compte le plus

Placez le changement que la plupart des gens remarqueront en premier. Les petits correctifs peuvent être listés en une ligne chacun à la fin.

Montrez la nouvelle fonctionnalité

Une capture d'écran ou une courte vidéo d'une nouvelle fonctionnalité vaut mieux qu'un long paragraphe. Liez l'article d'aide qui l'explique.

Publiez selon un calendrier que les gens peuvent suivre

Gardez chaque version sur une seule page de changelog, de la plus récente à la plus ancienne, afin que les clients et votre équipe de support sachent toujours où regarder.

Erreurs courantes dans les notes de version

• Coller le journal des commits tel quel, avec des numéros de ticket et du jargon.
• Cacher un changement cassant au milieu d'une liste.
• Lister chaque changement interne dans les notes destinées aux clients.
• Promettre des dates ou des fonctionnalités qui ne sont pas dans la version.

Le générateur n'inclut que les changements de votre liste et n'ajoutera pas de dates que vous n'avez pas fournies, mais vérifiez chaque élément avant de publier.