Comment créer une page de journal des modifications : entrées, étiquettes, RSS et « Nouveautés »

Une page de journal des modifications est une liste datée de ce qui a changé dans votre produit, les plus récents en premier, rédigée pour les personnes qui l'utilisent. Pour en créer une, il faut des entrées avec une date, un titre clair, une courte explication et une étiquette (Nouveau, Amélioré, Corrigé), une page qui les liste, une adresse distincte par entrée et, idéalement, un flux RSS et un moyen d'informer les utilisateurs qu'il y a du nouveau. C'est l'une des choses les plus simples à construire, et la principale décision porte sur l'endroit où vivent les entrées : sous forme de fichiers dans votre site, ou dans une base de données avec une page d'administration.

Pourquoi un journal des modifications en vaut la peine

Un journal des modifications montre aux clients et aux prospects que le produit est entretenu. Il donne au soutien et aux ventes un lien à envoyer lorsqu'on demande « est-ce que ça fait X maintenant? ». C'est aussi un moyen de boucler la boucle des commentaires : lorsqu'une fonctionnalité demandée est livrée, l'entrée du journal est ce vers quoi vous orientez les gens. Si vous gérez un portail de rétroaction des clients, reliez directement les demandes livrées à leurs entrées.

Un journal des modifications n'est pas votre historique interne de commits. « Refactorisation du service de facturation » ne signifie rien pour un utilisateur. « Les factures affichent maintenant le numéro de TVA de votre entreprise » oui.

Ce que la page doit contenir

Contenu de chaque entrée

Champ	Remarques
Titre	Ce qui a changé, du point de vue de l'utilisateur
Date	Date de publication, affichée sur la page
Étiquette	Nouveau, Amélioré, Corrigé (et peut-être Retiré ou Sécurité)
Corps	Quelques phrases ou puces; comment l'utiliser, qui en bénéficie
Image ou vidéo	Facultatif; une capture d'écran aide plus qu'un paragraphe
Slug	L'adresse de l'entrée, comme `/changelog/invoice-vat-numbers`
Statut	Brouillon ou publié, plus une date de publication planifiée au besoin

Extras dans l'app

Badge « Nouveautés » : un point sur un élément de menu lorsqu'il y a des entrées que l'utilisateur n'a pas vues. Enregistrez la date de la dernière entrée ouverte, par utilisateur ou dans le navigateur.
Infolettre récapitulative par courriel : un résumé envoyé aux utilisateurs qui y consentent. Cela nécessite un fournisseur d'envoi; voir comment envoyer des courriels depuis votre app.

La principale décision : fichiers ou base de données

Entrées sous forme de fichiers dans le site

Chaque entrée est un fichier Markdown dans le projet. Publier une entrée signifie ajouter un fichier et redéployer. C'est l'approche la plus simple et la plus robuste : pas de base de données, pas de connexion d'administrateur, rien à sécuriser, et les pages peuvent être pré-rendues pour se charger rapidement et être faciles à lire pour les moteurs de recherche.

Elle convient aux équipes où les personnes qui rédigent les entrées sont à l'aise de demander à un créateur IA ou de modifier un fichier.

Entrées dans une base de données avec une page d'administration

Les entrées vivent dans une table, et une page d'administration privée permet à n'importe qui dans l'équipe de rédiger, prévisualiser, planifier et publier. Cela convient aux équipes où le marketing ou le soutien rédige les mises à jour, ou lorsque vous voulez une publication planifiée ou des entrées par public (par exemple, n'afficher les fonctionnalités d'entreprise qu'aux clients entreprise).

Le coût est plus de construction et d'entretien : une connexion d'administrateur, le téléversement d'images, et la vérification que les pages publiques restent lisibles par les moteurs de recherche, ce qu'une page qui ne charge les entrées que dans le navigateur pourrait ne pas permettre.

	Fichiers	Base de données + administration
Qui peut publier	Quiconque modifie le projet	Toute personne ayant une connexion d'administrateur
Mise en place	Minimale	Connexion, stockage, interface d'administration
SEO	Facile (pages pré-rendues)	Demande de la rigueur pour que les pages soient rendues sur le serveur ou pré-rendues
Planification	Publication au déploiement	Planification par date possible
Coût d'hébergement	Statique	Nécessite une app et une base de données en fonctionnement

Rédiger des entrées que les gens lisent

Commencez par l'avantage. « Exporter les rapports vers Excel » vaut mieux que « Nouveau module d'exportation ».
Dites à qui cela s'adresse. Tous les forfaits, Pro seulement, déploiement progressif cette semaine.
Montrez-le. Une capture d'écran ou un court extrait.
Regroupez les petites corrections. Une entrée hebdomadaire « Corrections et améliorations » avec des puces évite d'inonder la page.
Soyez transparent sur les retraits. Si quelque chose disparaît, dites quand et par quoi le remplacer.

Un premier message qui fonctionne

Ajoute un journal des modifications public à notre site, à /changelog. Chaque entrée est un fichier Markdown avec un titre, une date, une étiquette (Nouveau, Amélioré ou Corrigé), une image de couverture facultative et un corps. La page d'index liste les entrées les plus récentes en premier, avec la date, l'étiquette et le premier paragraphe, propose des boutons de filtre par étiquette et affiche 10 entrées par page. Chaque entrée a sa propre page à /changelog/<slug>, avec un titre et une description de page appropriés pour les moteurs de recherche. Ajoute un flux RSS à /changelog/rss.xml. Crée trois entrées d'exemple. Respecte le design existant du site, reste lisible sur les téléphones et pré-rends les pages pour qu'elles se chargent rapidement.

Pour la version à base de données, remplacez la première phrase par « Enregistre les entrées dans une base de données avec un statut brouillon/publié et une date de publication, et ajoute une page d'administration protégée par mot de passe pour les rédiger, les prévisualiser et les publier. »

Étapes de construction

Décidez entre fichiers ou base de données à l'aide du tableau ci-dessus.
Construisez les pages d'index et d'entrée avec quelques entrées d'exemple.
Ajoutez les étiquettes et les filtres.
Ajoutez le flux RSS et liez-le depuis la page.
Ajoutez les titres de page, les descriptions et une entrée dans le plan du site pour chaque entrée. Notre guide sur le SEO pour les sites créés avec l'IA couvre les bases.
Page d'administration et connexion, si vous avez choisi la voie de la base de données.
Badge « Nouveautés » dans votre app.
Rédigez de vraies entrées pour les derniers mois, afin que la page ne soit pas vide au lancement.

Erreurs courantes

Copier les messages de commit. Écrivez pour les utilisateurs, pas pour les développeurs.
Une seule grande page sans adresses par entrée. Personne ne peut lier un changement précis, et les moteurs de recherche voient une page au lieu de plusieurs.
Les mises à jour s'arrêtent après un mois. Un journal dont la dernière mise à jour remonte à un an laisse croire à un produit abandonné. Fixez un rythme que vous pouvez tenir.
Charger les entrées uniquement dans le navigateur. Les moteurs de recherche et les aperçus de liens peuvent voir une page vide. Pré-rendez-la ou rendez-la sur le serveur.
Mélanger les incidents. Les pannes ont leur place sur une page d'état, pas dans le journal des modifications.

Quand un outil de journal hébergé est le meilleur choix

Il existe des outils hébergés de journal des modifications et de mises à jour de produit, et certains sont intégrés à des tableaux de rétroaction ou à des widgets dans l'app. Ils valent la peine si vous voulez une fenêtre contextuelle dans l'app, un ciblage du public et des analyses sans les construire vous-même, ou si votre équipe paie déjà un outil qui en inclut un. Votre logiciel de blogue ou de centre d'aide peut aussi avoir un format adapté.

Créer le vôtre a du sens lorsque vous voulez le journal sur votre propre domaine, avec votre propre design, et entièrement indexable, ce qui, pour une simple liste d'entrées datées, ne représente pas beaucoup de travail.

Créer l'app avec Mythex

Dans Mythex, vous pouvez demander à l'agent d'ajouter un journal des modifications à un projet existant ou de le construire comme petit site distinct, et de le voir dans l'aperçu en direct pendant sa construction. La version basée sur des fichiers n'a pas besoin de base de données. Si vous choisissez la version avec administration, l'agent ajoute une base de données Postgres dédiée lorsque les entrées doivent être enregistrées (ou tapez /database), et les captures d'écran vont dans le stockage de fichiers du projet. La connexion d'administrateur est quelque chose que vous ajoutez avec votre propre approche d'authentification (recette d'ajout de connexion).

Les nouvelles apps Mythex sont souvent des apps à page unique rendues côté client, ce que la recette SEO présente comme moins performantes pour la recherche; demandez donc des pages de journal statiques ou pré-rendues si vous voulez que les entrées soient trouvées dans la recherche. La même recette couvre les titres, les descriptions et les plans du site. Pour un point de départ avec un journal intégré, consultez le modèle centre de connaissances produit.

Questions

Que doit contenir une entrée de journal des modifications?

Une date, un court titre qui décrit ce qui a changé pour l'utilisateur, quelques phrases ou puces qui l'expliquent, une étiquette comme Nouveau, Amélioré ou Corrigé, et, facultativement, une capture d'écran et un lien vers plus de détails.

Un journal des modifications a-t-il besoin d'une base de données?

Pas nécessairement. Si une ou deux personnes publient les mises à jour, les entrées peuvent vivre sous forme de fichiers Markdown dans le site et être publiées à chaque déploiement. Utilisez une base de données lorsque des personnes non techniques doivent rédiger et planifier des entrées depuis une page d'administration.

À quelle fréquence devrais-je mettre à jour un journal des modifications?

Chaque fois qu'un changement que les utilisateurs remarqueraient a été apporté. Beaucoup de petits produits regroupent les changements chaque semaine ou toutes les deux semaines; l'important est un rythme régulier pour que la page paraisse vivante.

Un journal des modifications est-il bon pour le SEO?

Il peut aider un peu : chaque entrée est une page explorable sur une fonctionnalité, et une page régulièrement mise à jour signale un produit actif. Donnez à chaque entrée sa propre adresse et un titre descriptif.