bell notificationshomepageloginNewPostedit profile

Topic : Re: How can we make compiling release notes less chaotic? Each of our software releases is accompanied by a set of release notes, which include short descriptions of the following: new features, - selfpublishingguru.com

10% popularity

Compiling release notes is NOT the job of a single author. It's ideally part and parcel of your source control and project management system. Your developers would have a set of automated tests for all reported bugs and documented features, and any necessary changes would require a change in said test, which could automatically note a change for the release notes.

New Features would mean new tests, which happily could have supporting documentation. New Test -> New feature added to release notes.
Changes to existing features mean some old tests stopped working. Change a test -> note that "action X and Y no longer does Z."
Bugs, after being recorded internally and having a test written to demonstate the error, can be identified and marked as closed once a "known-bad" test no longer breaks.

Consider, btw, how two games do their release notes.

Eve Online does release notes in mammoth lists, introduced by blog posts for major new features and a discussion forum where changes are suggested. Notably, bug fixes are NOT detailed, as there's no public bug repository.
Minecraft, on the other hand, has a public bug list and includes links to their actual bug database for resolved fixes.


Load Full (0)

Login to follow topic

More posts by @LarsenBagley300

0 Comments

Sorted by latest first Latest Oldest Best

Back to top