Write Release Notes for Internal Users
Added 2026-10-31
Organise by what users must do, not by feature list.
We shipped a change to an internal tool. I will give what changed. Write an internal notice under 200 words: 1) one line on the direct impact; 2) what users must do — say plainly if nothing; 3) which habits change; 4) who to contact if it breaks; 5) when the old way stops working. No technical detail or version numbers.
Site original
Chinese original
How to use
内部通知先回答「我要不要改做法」。
Try tweaking it
- Ask for three openings in different tones, then pick one.
- Replace "make it better" with concrete limits: length, reader, facts to keep.
What you should get
- A publishable draft, not an outline
- A short changelog: what changed and why
Common mistakes
- Letting it guess the facts, so plausible-looking sources get invented.
- Dumping the whole text with just "polish it" — the result still has no point.
How to check the output
- The conclusion comes first; deleting the opening paragraph does not break it.
- Every fact, number and quote traces back to the source text.
Where it works
- Good for: turning a rambling draft into a conclusion-first, shorter version.
- Watch out: keep sources and figures verbatim — do not let it invent citations.