用途:把原始技术变更(工单、变更日志、git 日志、PRD)转写为清晰、以用户收益为导向的发布说明,让每次发布向合适受众以合适语气传递价值。采用五步法:收集输入、将每项变更归入五类之一、按用户收益改写、按受众调整语气、组装成文。
主要能力:五类分类(新功能、改进、Bug 修复、破坏性变更、弃用),各有明确归类规则;用户收益改写,先讲结果、用平实语言、1-3 句,并识别开发者视角措辞;受众语气指导,覆盖 B2B/企业、消费者、开发者/API、内部;自动生成脚本 release_notes_generator.py,可分组条目、输出 markdown/JSON,并标记需改写的技术性语言。
使用方式:运行 python scripts/release_notes_generator.py --input changes.json --product-name "Acme App" --version "2.5.0",或用 --demo 演示;只收录有条目的类别。生成前需确认三点:受众类型、源变更(工单/PR/变更日志)、破坏性变更与弃用(改了什么、需用户做什么、期限)。若用户说“直接起草”,则先列出假设再产出。
适用场景:产品发布公告、冲刺演示、变更日志维护、邮件与应用内及文档的客户沟通。
限制:不自动从 git 历史提取变更,不集成 Jira/Linear 拉取工单(需手工 JSON 输入),不维护跨版本变更日志(按单次发布生成),不分发到邮件、应用内或文档渠道。改写建议为基于模式的经验规则,无法判断描述是否真正传达用户收益;语义化版本对齐由用户自行负责;破坏性变更必须写明改了什么、用户需做什么、期限。分类仅据明确用途判定。