Writing release notes

Tips

Categorise - Break the notes into New, Improved and Fixes.

Plain english - Write the notes in a way that a non-technical user will understand.

Example

Release 10 - Jan 15, 2018

New

• Added the Immunisation topic.

Improvements

• Date published is being stored in a more flexible format, meaning it can be used for sorting and filtering.
• Clearer guidance for content authors on how to correctly enter the duration of a video.
• Pages should load around 70% faster on slower connections and older devices.

Fixes

• News items are now appearing in the correct date order on home and topic pages.
• Audio and App or tool are now correctly using revisions and workflow.
• Fixed the issue when the 'In this section' would appear on mobile with nothing in it.