Software packages are often shipped with changelog and/or release notes. What's the difference between them? Should they be both included with release of a new version?
Asked
Active
Viewed 1.5k times
2 Answers
30
To directly answer your question, you can include both in your software release.
Release notes are a set of documents delivered to customers with the intent to provide a verbose description of the release of a new version of a product or service. These artifacts are generally created by a marketing team or product owner and contain feature summaries, bug fixes, use cases, and other support material. The release notes are used as a quick guide to what changed outside of the user documentation.
Conversely, changelogs are comprehensive lists of the new features, enhancements, bugs, and other changes in reverse chronological order. Changelogs usually link to specific issues or feature requests within a change management system and also may include links to the developer who supplied the change.
dthagard
- 823
- 7
- 23
6
Yes I think you can include both on a new release.
For me the main difference is that in a release note you can explain what is new or what have changed in a more comprehensive language.
In the case of a changelog you have to add more technical details of the changes, for example with commit messages with link to the diff or PRs with links to the technical discussion.
wolmi
- 1,659
- 12
- 25