Oui. Activez Afficher les numéros de version dans les paramètres du journal des modifications, puis ajoutez une version telle que v2.14.0 à chaque entrée. Elle s’affiche sous forme de badge à côté de la date dans le centre d’aide et le widget.
Publier un journal des modifications
Publiez des notes de version datées que vos utilisateurs peuvent consulter dans votre centre d’aide, suivre via RSS et voir dans le widget. Un journal des modifications se trouve dans votre centre d’aide, à côté de votre documentation, et chaque entrée est rédigée et publiée comme un article.
Les propriétaires et les administrateurs peuvent créer un journal des modifications.
Créer un journal des modifications
Dans le Centre d’aide, ouvrez le menu d’ajout d’une section et choisissez Créer un journal des modifications. Un journal des modifications se trouve au premier niveau d’une section. Il ne peut pas être placé dans une collection ni contenir ses propres collections. Pour regrouper les mises à jour produit dans leur propre onglet, créez d’abord une section dédiée.
Rédiger et publier des entrées
Ajoutez une entrée depuis le journal des modifications et rédigez-la comme n’importe quel article. La date de l’entrée détermine son emplacement : les entrées sont affichées de la plus récente à la plus ancienne, et vous pouvez modifier leur ordre en changeant leurs dates. Attribuez jusqu’à huit tags à une entrée, parmi Nouveau, Amélioré, Corrigé et Changements majeurs, ou utilisez vos propres termes.
Lors de la première publication d’une entrée, choisissez si vous souhaitez l’annoncer :
Oui, l’annoncer : les utilisateurs connectés du widget qui ne l’ont pas encore vue reçoivent un message « Quoi de neuf ? ».
Non, publier discrètement : l’entrée apparaît uniquement dans le journal des modifications et son flux.
Vous pouvez modifier ce choix plus tard avec Annoncer dans le widget dans les paramètres de l’entrée. Les visiteurs anonymes ne reçoivent jamais ce message. Un développeur peut également choisir quand il s’affiche ou désactiver les annonces dans le code de votre widget. Consultez le SDK du widget.
Chaque journal des modifications public dispose d’un flux RSS à son adresse, suivi de /rss.xml. Les lecteurs peuvent réagir aux entrées avec des émojis. Un centre d’aide privé ne propose aucun flux.
Annuler une modification
Dépublier l’entrée la retire immédiatement du journal des modifications et du widget. Elle reste sous forme de brouillon.
Une entrée supprimée est placée dans Éléments supprimés récemment, où vous pouvez la restaurer pendant 30 jours.
La suppression du journal des modifications entier supprime également ses entrées. Vous pouvez restaurer les entrées depuis Éléments supprimés récemment, mais elles redeviennent des articles ordinaires, sans leurs dates, tags ni versions, et le journal des modifications lui-même ne peut pas être restauré.
Questions fréquentes
Puis-je afficher les numéros de version ?
Puis-je antidater une entrée ou en programmer une ?
Vous pouvez antidater une entrée en modifiant sa date ; la liste est triée en fonction de celle-ci. La publication programmée n’est pas possible : une entrée est publiée dès que vous la publiez.
Fern peut-elle rédiger des entrées du journal des modifications ?
Oui. Demandez à Fern de rédiger une entrée comme vous lui demanderiez de rédiger un article. Rien n’est publié tant que vous ne l’avez pas publié. Consultez Demander à Fern de rédiger ou de mettre à jour des articles.