Build Notes Template

---

Context

The provision of comprehensive build notes is essential to continued fruitful communication on any software project. A key consideration should always be that of expectation management, e.g. what can someone expect to see, and what can they expect won't be functional/visible/implemented. Being clear up front about any known issues also prevents disappointment from stakeholders and awkward conversations asking where a particular item is that they were hoping to see, or detailed bug reports on items that you already know are broken. Ideally, good build notes will push stakeholders towards the newly implemented/fixed items and away from the known issues.

Key considerations for solid build notes:

• Provides clarity as to what the current status of the project is without needing to hunt for changes within the build.
• Indicates which areas are worth focussing on to elicit more valuable feedback.
• Clearly outlines any known issues or missing items from the deliverable.

Below is an example framework that can be applied across most projects as it outlines the key areas within which to provide information for all stakeholders. There is a fully fleshed out build notes example here.

[ApplicationName]

[Logo]

Build Notes

• vX.XX
• Date

Platforms

• [iOS, Android, etc]

General notes

• [purpose for the build, main areas of focus, etc]

What is included in this build

• [List of all additions to the build since the last deliverable]
• [Add areas of particular interest for feedback]

What is not included in this build

• [Keep expectations in check by clearly outlining which features are not yet available/included]

Known issues

• [List all known issues/bugs/temporary items]

---