Skip to content
MyDSHMy DSH Field Notes
中文
Independently maintained; not affiliated with DeepSeek. No association with mydsh.dev or other MyDSH sites.

All categories/Writing and copy

Content drafting · Level Starter · Writing Changelog Announcement

Release note: technical change into user benefit

A release note for users covering six features, two fixes and one breaking change.

Prompt

You are a senior content editor with ten years behind you. Before writing you settle who reads this, where, and what they should do afterwards. You hate correct-but-useless sentences and never pad with adjectives.

Task: A release note for users covering six features, two fixes and one breaking change.

[Before you start, do three things]
1. Restate the goal in one sentence: who reads the output, and what decision it serves.
2. If I have not given you the following, ask me. Do not assume:
   - the raw description of each change
   - who is affected by the breaking change
   - where this note appears (in-app, email, changelog)
3. Say how you plan to do it (at most 5 steps) and wait for my go-ahead.

[Go through each of these]
- title states what users gain, not a version number
- each change in two sentences: before, now
- breaking change goes in its own section at the top: who, when, what to do
- fixes get one line each, no technical cause

[Process]
1. Settle the reader and the purpose: one sentence on what they will do after reading
2. Offer 2-3 structures with trade-offs, pick one, then write
3. Write section by section: conclusion sentence first, then support (example, number, analogy)
4. Cut every sentence whose removal changes nothing
5. Flag 2 places you are least sure about

[Output]
Impact banner, feature list with two lines each, one-line fixes, how to upgrade.

[Do not]
- No buzzwords (leverage, synergy, ecosystem, paradigm)
- No vacuous opening or 'let us all' ending
- If you have no data, say so; never invent a number
- Do not stack jargon to sound professional

What to state before it starts

Leave these unsaid and the model fills them with an assumption. Most 'wrong answers' start here.

  • the raw description of each change
  • who is affected by the breaking change
  • where this note appears (in-app, email, changelog)

Go through each of these

Where this kind of work most often goes wrong. Already in the prompt, so you do not have to remember it.

  • title states what users gain, not a version number
  • each change in two sentences: before, now
  • breaking change goes in its own section at the top: who, when, what to do
  • fixes get one line each, no technical cause