At the delivery of every version of software we have to write a release note.
For example, here are some of the terms I add when I write a release note:
- Release Date
- Bug Solved
Is that enough, or is there anything else?
2
I think followings will give a way to good practices
// Date Related
- Release Date
// Feature related
- Features Added
- Featured Removed
- Features Changed
// Bug related
- Solved Bugs
- Unsolved Bugs
// Dependency related
- List of dependency
// Testing related
- Unit Test results
- Acceptance Test results
// Version controlling related
- Tag Note
- Revision Number
Also some times worth highlighting things the end user may want to change in their configurations or workflow.
Most end users don’t care about the test result. They expect it to have high quality no matter what the release note says.
The most important thing about release notes is to be aware that every
additional sentence loses another 10% of the readers. So you must
strictly prioritize what your current users need to know about the
release.
4
The most important thing about release notes is to be aware that every additional sentence loses another 10% of the readers. So you must strictly prioritize what your current users need to know about the release.
1