Search code examples
deploymentlanguage-agnosticrelease-notes

How should release notes be written?

Is there any sort of guidelines or best practices on how release notes should be written? I guess I am trying to find the proper balance between making the point without being too specific. Also, do developer usually provide a much more release notes for QA team compare to the one submitted for public view?

Solution

  • Public release notes should contain at least:

    • release, buildnumber
    • all fixed public bugs
    • all added public features

    QA release notes should contain at least:

    • release, buildnumber
    • all fixed bugs including bug number
    • all added features including links to design docs

    Consider your audience and try to think what they need.

    An other thing to add is new or discontinued support for certain platforms. (For example we quit support for Win3.1 and added Vista 64 bit).