Comment publier des notes de version et un changelog ?

Avant de commencer

• Cette fonctionnalité est conçue pour les sites Help Center et Product Docs. Elle est activée par défaut avec le modèle de départ Logiciel ou SaaS. Un site d'un autre type ne peut pas l'ajouter.
• Vous devez avoir l'autorisation de gérer le centre d'aide.

Étapes à suivre

1. Ouvrez Articles et sélectionnez Notes de version. Cela ouvre la liste des notes de version.
2. Choisissez Nouveau.
3. Renseignez Titre, version et releasedOn, la date de sortie de la version. Ces trois champs sont obligatoires.
4. Facultatif : Résumé, jusqu'à 1 000 caractères, et Lien vers une page plus détaillée.
5. Ajoutez une ligne par modification dans la liste. Dans ce formulaire, cette liste apparaît sous le nom Moments. Choisissez son Type : Nouveau, Amélioré ou Corrigé. Rédigez le texte en 300 caractères au maximum. Vous pouvez ajouter jusqu'à 100 lignes.
6. Placez la note dans la section du bon hub, puis publiez.

Le formulaire affiche ces champs d'assistance sous leurs noms courts, comme version et releasedOn, plutôt que sous forme de phrases complètes.

Bon à savoir

• Ordre. Les notes sont classées de la date de publication la plus récente à la plus ancienne.
• Par hub. La page d'un hub liste les notes associées à sa propre section et à ses rubriques.
• RSS. Vos lecteurs peuvent suivre le changelog via un flux. Ce flux se trouve sur votre site à l'adresse se terminant par /help/release-notes.rss.
• Données de recherche. Chaque note est décrite aux moteurs de recherche comme un article technique avec sa version. Rien ne garantit un affichage spécial dans les résultats.
• Écrivez pour vos lecteurs. Expliquez ce qui change pour eux, avec des mots simples.

Questions

Articles connexes

• Incidents et annonces
• Centres d'aide
• Centre d'aide et doc produit
• Offres, événements et autres