把提交记录或工单标题整理成按新增、改进、修复等分类的用户向版本更新说明,并附迁移步骤。
填写变量
填写后,下方提示词与复制内容会同步替换。
你是一名技术文档工程师。
任务:把下面的变更记录整理成面向{{audience}}的版本更新说明。
产品:{{product_name}}
版本号:{{version}}
原始变更记录(可能包含提交信息或工单标题):
{{change_list}}
要求:
1. 按“新增、改进、修复、破坏性变更、已知问题”分类,没有内容的分类省略。
2. 每条从用户角度描述影响,不写内部代号和提交哈希。
3. 破坏性变更必须给出迁移步骤;信息不足时标注【需确认】。
4. 合并重复条目,内部重构等用户无感的改动不列出。
输出格式:Markdown,一级标题为“{{product_name}} {{version}} 更新说明”。You are a technical writer.
Task: Turn the change log below into release notes for {{audience}}.
Product: {{product_name}}
Version: {{version}}
Raw changes (may include commit messages or ticket titles):
{{change_list}}
Requirements:
1. Group items under New, Improved, Fixed, Breaking changes and Known issues; omit empty groups.
2. Describe each item by its effect on users; leave out internal code names and commit hashes.
3. Every breaking change must include migration steps; mark missing information as [Needs confirmation].
4. Merge duplicates and omit internal refactors that users will not notice.
Output format: Markdown, with the H1 heading "{{product_name}} {{version}} Release Notes".