web-dev-qa-db-fra.com

Quelle est la différence entre les notes de publication et le journal des modifications?

Les packages logiciels sont souvent livrés avec changelog et/ou release notes. Quelle est la différence entre eux? Doivent-ils tous deux être inclus avec la sortie d'une nouvelle version?

9
rubick

Pour répondre directement à votre question, vous pouvez inclure les deux dans votre version logicielle.

Notes de mise à jour sont un ensemble de documents livrés aux clients dans le but de fournir une description détaillée de la sortie d'une nouvelle version d'un produit ou service. Ces artefacts sont généralement créés par une équipe marketing ou un propriétaire de produit et contiennent des résumés de fonctionnalités, des corrections de bogues, des cas d'utilisation et d'autres supports. Les notes de publication sont utilisées comme un guide rapide de ce qui a changé en dehors de la documentation utilisateur.

Inversement, changelogs sont des listes complètes des nouvelles fonctionnalités, améliorations, bogues et autres changements dans l'ordre chronologique inverse. Les journaux des modifications sont généralement liés à des problèmes spécifiques ou à des demandes de fonctionnalités dans un système de gestion des modifications et peuvent également inclure des liens vers le développeur qui a fourni la modification.

2
dthagard

Oui, je pense que vous pouvez inclure les deux dans une nouvelle version.

Pour moi, la principale différence est que dans une note de version, vous pouvez expliquer ce qui est nouveau ou ce qui a changé dans un langage plus complet.

Dans le cas d'un journal des modifications, vous devez ajouter plus de détails techniques sur les modifications, par exemple avec des messages de validation avec lien vers le diff ou des RP avec des liens vers la discussion technique.

0
wolmi