Improvements worth highlighting
Start with the benefit to the reader, rather than a list of engineering tasks. Each update should answer three questions:
- What was difficult before?
- How has the experience changed?
- Does the user need to take any action?
Describe a fix clearly
A useful description explains the situation, the previous behavior, and the expected result:
“When you did A under condition B, C used to happen. After this update, you will see D.”
Internal ticket numbers, stack traces, and variable names do not belong in a user-facing release note.
Link to related information
Link to the Conative Support introduction, add a screenshot with descriptive alternative text, or refer to a published guide.
Use the documentation to learn the basics, or read Using Conative Support for help finding guides and updates.