Write Changelogs for Users
Added 2026-10
Write Changelogs for Users — Chinese original prompt
这是本次版本的 [提交记录或内部变更清单]。请改写成面向用户的变更日志:按新增、改进、修复分组,每条说清影响了哪个功能、用户需要做什么、有没有行为变化需要注意。输出:改写后的条目、需要补截图或文档链接的位置、以及可以合并或省略的内部改动。
Site original
Chinese original
Example
Sample input
这次版本的提交记录在下面,大多是内部重构,帮我改写成用户能看懂的变更日志。
The output should include
- 按新增改进修复三类分组写
- 每条说清影响哪个功能与要做什么
- 标出可合并省略的内部改动
Replace these placeholders 1
Swap the bracketed parts for your own details before sending.
[提交记录或内部变更清单]
How to use
破坏性变更单独成段并给迁移指引,藏在一堆条目里等于没告知。
Try tweaking it
- Have it restate requirements and constraints before writing code.
- Ask for the smallest change plus a rollback path, not a full-file rewrite.
What you should get
- A minimal, runnable change with copy-ready code
- Impact list: which files and call sites must follow
Common mistakes
- Asking it to touch ten files at once, then losing track of what broke what.
- Pasting only the error, with no code or version, and getting an unfixable answer.
How to check the output
- The change runs, can be rolled back, and touches nothing unrelated.
- Edge cases (empty, oversized, concurrent) are covered or explained.
Where it works
- Good for: having it restate requirements and constraints, then propose the smallest runnable change.
- Watch out: include versions and a minimal reproduction with the error, or the fix may look plausible but not fit.