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?
Asked
Active
Viewed 9,747 times
12
-
This looks like a duplicate of http://programmers.stackexchange.com/questions/66377/can-you-recommend-a-good-release-notes-template – Oct 05 '12 at 08:32
-
1don't forget features added – ratchet freak Oct 05 '12 at 08:33
2 Answers
21
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.
Robert Harvey
- 198,589
- 55
- 464
- 673
Md Mahbubur Rahman
- 4,747
- 5
- 32
- 38
-
1its also some times worth highlighting things the end user may want to change in their configurations or workflow – jk. Oct 05 '12 at 08:47
-
@jk. Yes, You are right. I have edited my answer as your good comment. – Md Mahbubur Rahman Oct 05 '12 at 08:51
-
Most end users don't care about the test result. They expect it to have high quality no matter what the release note says. – Henrik Oct 06 '12 at 09:10
-
@Henrik release notes may be useful for people other than end users though – jk. Oct 09 '12 at 19:56
5
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.
ddyer
- 4,060
- 15
- 18
-
4each line might lose 10% of casual, uninterested (or lazy) readers. Those readers are the ones your release notes are not written for. The ones who care about what you've done will read them all and thank you for each relevant line - you only have to be careful about including fluff that really needs to go into the documentation proper. – gbjbaanb Oct 05 '12 at 17:21