Guideline to release notes ...

documentation how to write release notes

[12inch]

I have tried searching for documentation on how to write release notes.

I am currently working on a peronsal PHP project for myself and I'm not gonna release the whole project once, but in small releases.

But I cannot find anything on this topic.
Does anyone know where to find this?

[rogerd]

I'm sure there are a couple of developers here at WebmasterWorld who have some experience with writing realease notes, but I've never seen a style definition for them. Fortunately, there are thousands of free examples on the web - just about every software developer, large and small, publishes such notes for each of their products. I'd recommend reviewing a selection of these to find a few examples you are comfortable with and that seem appropriate to your product. These examples can then be the basis for your own style.

[mgream]

Release notes are easy: create a template and re-use it on each release. There should be many samples. From numerous past projects, this is what I can recall off the top of my head:

* identification of the release (name, date, version #)

* requirements (required third-party platforms / modules / packages / etc with version numbers / dates / etc)

* features and changes (new features, defects corrected, etc)

* outstanding issues (unresolved defects / features, work arounds, installation/operational issues, platform issues, etc)

* installation guide (how to obtain and install / notes / etc, with digital signatures as well)