KjerrDes exemples de changelog
qui méritent d’être copiés.
Les bons exemples de changelog ont trois points communs : un titre qui dit ce qui a changé, une phrase sur ce que l’utilisateur peut désormais faire, et un mot honnête sur la suite. Voici quatre billets, un par type de changement, puis la différence entre changelog et notes de version, et une check-list.
Quatre exemples de changelog, par catégorie
Chacun de ces exemples est écrit pour un produit fictif, dans les quatre catégories de la section Annonces de Kjerr. Copiez la forme, pas les mots.
Nouvelle fonctionnalité
La double authentification est là
Vous pouvez désormais protéger votre compte par une seconde étape à la connexion. Ouvrez Réglages, puis Sécurité, scannez le QR code avec l’application d’authentification de votre choix et conservez vos codes de secours. Le propriétaire d’un espace de travail peut l’imposer à tous les membres. C’était l’une des idées les plus demandées sur notre tableau.
Pourquoi ça marche : Commence par ce que l’utilisateur peut faire, dit où le trouver et rend hommage à la demande.
Amélioration
Les rapports se chargent jusqu’à trois fois plus vite
Nous avons refait le calcul des rapports. La synthèse mensuelle, qui mettait six secondes à s’ouvrir sur les gros comptes, s’ouvre maintenant en moins de deux, et les périodes de plus d’un an n’expirent plus. Les chiffres, eux, ne changent pas.
Pourquoi ça marche : Donne un chiffre que le lecteur ressent, et répond à la crainte que les données aient changé.
Correctif
Corrigé : l’export CSV perdait la dernière ligne
Les exports de plus de 10 000 lignes perdaient leur dernière ligne. C’est corrigé, et les exports réalisés à partir d’aujourd’hui sont complets. Si vous avez exporté un gros rapport pendant la première quinzaine d’août, relancez-le.
Pourquoi ça marche : Dit ce qui n’allait pas, qui était touché et quoi faire. Sans euphémisme.
Annonce
Ce que nous construisons cet automne
Un coup d’œil sur les prochains mois, d’après vos votes. Les notifications Slack sont en cours de développement. Le mode sombre viendra ensuite ; c’est l’idée la plus votée du tableau, et le design a commencé. Nous publierons ici à chaque livraison.
Pourquoi ça marche : Fixe les attentes sans dates intenables, et renvoie aux votes.
Anatomie d’un billet de changelog qui fonctionne
- Le titre : le changement, pas la version. « Les rapports se chargent jusqu’à trois fois plus vite » dit au lecteur si cela le concerne. « v4.12.1 » ne lui dit rien.
- La catégorie. Nouvelle fonctionnalité, Amélioration, Correctif ou Annonce. Elle permet de survoler et de filtrer.
- Ce que vous pouvez faire désormais. Une ou deux phrases, écrites du côté de l’utilisateur.
- Où le trouver. Le chemin dans les menus, ou un lien.
- La suite. Souvent rien. Quand un correctif impose de relancer un export ou de changer un réglage, dites-le sans détour.
- Rendez hommage à la demande. Si des utilisateurs l’avaient demandé, mettez le lien vers la demande. C’est la preuve la moins chère que le feedback est lu.
Changelog ou notes de version (release notes)
Un changelog est le registre continu de tous les changements notables ; des notes de version, ou release notes, sont le compte rendu d’une seule version. Le changelog est une liste que l’on parcourt : des billets courts, le plus récent en tête, un par changement. Les notes de version sont un document que l’on lit : elles regroupent les changements d’une version, expliquent les plus importants avec des captures d’écran et donnent les étapes de mise à jour ou de migration.
Les petites équipes n’ont en général besoin que du changelog, avec un billet plus long quand une version le mérite. Les produits qui s’installent par versions ou qui exposent une API publient souvent aussi des notes de version, vers lesquelles renvoie chaque billet du changelog.
Une check-list avant de publier
Relisez le billet comme un utilisateur qui n’a jamais vu votre roadmap.
- Le titre se comprend-il sans le texte ?
- La première phrase parle-t-elle de l’utilisateur, et non de l’équipe ?
- Y a-t-il un chiffre, un chemin ou une capture d’écran là où cela aiderait ?
- Si quelque chose a cassé, dit-on qui était touché et quoi faire ?
- Les demandes auxquelles le billet répond sont-elles en lien ?
- Ceux qui avaient demandé seront-ils prévenus, et pas seulement ceux qui passeront par là ?
Publier ces billets dans Kjerr
La section Annonces de Kjerr est un changelog doté des quatre catégories ci-dessus. Les billets acceptent titres, listes, liens et images, citent les idées auxquelles ils répondent et peuvent prévenir les abonnés par e-mail à la publication.
- Catégories, recherche par texte et par date, réactions emoji et commentaires.
- Un abonnement par e-mail à adresse vérifiée.
- Les idées liées s’affichent sous le billet ; leur passage à Shipped envoie un e-mail à leurs votants.
- Un widget pour votre propre site affiche les mêmes annonces dans un panneau latéral, avec le nombre de billets non lus sur le lanceur.
Des questions, des réponses franches.
Qu’est-ce qu’un changelog ?
Un changelog est la liste datée de ce qui a changé dans un produit, du plus récent au plus ancien, écrite pour les personnes qui l’utilisent. Chaque billet dit ce qui a changé, qui est concerné et ce qu’il y a à faire, s’il y a quelque chose à faire.
Quelle différence entre un changelog et des notes de version ?
Un changelog est le registre continu de tous les changements notables ; des notes de version (release notes) sont le compte rendu d’une seule version. Un billet de changelog tient en quelques phrases. Des notes de version peuvent occuper une page, avec captures d’écran et étapes de mise à jour. Beaucoup de produits publient les deux au même endroit.
Que doit contenir un billet de changelog ?
Un titre qui énonce le changement, une catégorie, une ou deux phrases sur ce que l’utilisateur peut désormais faire, l’endroit où le trouver et, le cas échéant, ce qu’il doit faire. Si le changement répond à une demande, dites-le et mettez le lien.
À quelle fréquence mettre à jour un changelog ?
Chaque fois que vous livrez quelque chose que les utilisateurs peuvent remarquer. Un billet court toutes les semaines ou tous les quinze jours inspire plus confiance qu’un long billet par trimestre.
Où publier un changelog ?
Sur une page publique qui a sa propre adresse, pour qu’on puisse y renvoyer, y chercher et l’indexer, et par e-mail pour les abonnés. Kjerr le place sur le même tableau que les demandes de fonctionnalités.
À lire aussi
Donnez une réponse à vos utilisateurs.
Kjerr est gratuit pendant l’accès anticipé : toutes les fonctionnalités, sans carte bancaire. Quand les offres payantes arriveront, elles seront facturées par espace de travail, jamais par siège administrateur.