You are viewing a plain text version of this content. The canonical link for it is here.

Posted to derby-commits@db.apache.org by Apache Wiki <wi...@apache.org> on 2006/06/14 03:47:04 UTC

[Db-derby Wiki] Update of "ReleaseNoteFormat" by BryanPendleton

Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Db-derby Wiki" for change notification.

The following page has been changed by BryanPendleton:
http://wiki.apache.org/db-derby/ReleaseNoteFormat

The comment on the change is:
Proposing a release note format

New page:
A good release note takes some effort to write, but the results are extremely helpful to users of Derby. One way to help ensure that you write a good release note is to use the following outline:

 * PROBLEM: a short description of the problem that is being fixed.

 * SYMPTOM: a description of the erroneous behavior. How does the user know that they've hit this problem?

 * CAUSE: the underlying defect which causes the symptom

 * SOLUTION: how the problem has been fixed

 * WORKAROUND: techniques that can be used to avoid the problem, to minimize its symptoms, or to repair damage which has occurred.

For a good example of a release note in this style, see [http://issues.apache.org/jira/browse/DERBY-1327?page=comments#action_12416072 DERBY-1327]