Short description of this PR, postable to Twitter, < 140 char (You never know, we might)
The tragic backstory. The troubles the townfolk (users) had to face.
If there is a JIRA link, include it and just explain in short to save yourself the trouble.
JIRA link:
How you, the hero, came in and saved the day.
How the town looked before and after your undertaking.
Your time to shine. If they are simply too good, go ahead and put them in the intro itself ;)
So the townfolk know how they can now live at ease.
User-facing. If there are multiple Examples, let us know them all.
All the river blocks you opened or neighbouring houses you destroyed on the way.
Anything that might be affected, so we know where to put all the blame, er I mean, praise in future.
May not always apply, depending on the scope of your adventure
For anyone who questions if the menace truly is vanquished.
No no, we do trust you. We always will :)
So the folk can tell and retell this story to everyone.
Basically whatever you said in Solution and Usage, on docs.haptik.ai.
Be sure to add the Town elders (Reviewers) who have trodden this path before you.
Fear not. Not all of this will always apply, simply write Not Applicable with reason in that case.