Les notes de version constituent un petit pont entre un déploiement et les personnes utilisant le produit. Traduisez les détails de l’implémentation en changements qu’un lecteur peut remarquer et distinguez une nouvelle fonctionnalité d’un correctif ou d’une action requise.
Répondez aux questions du lecteur
- Qu'est-ce qui a changé dans le produit ou le flux de travail ?
- Qui peut utiliser le changement, et est-il déjà disponible partout ?
- Le lecteur doit-il mettre à jour, migrer des données ou modifier un paramètre ?
Soyez précis sur la disponibilité
Utilisez un langage simple et évitez de promettre une date de déploiement ou un résultat qui n’a pas été confirmé. Mentionnez les limitations qui affectent la façon dont quelqu'un peut utiliser la fonctionnalité.
Demandez à un coéquipier extérieur à l'implémentation de réviser les notes. S'ils ne peuvent pas dire ce qui a changé ou quoi faire ensuite, révisez l'explication avant de la publier.