release-notes

发布说明生成器

将技术工单、PRD 或内部变更日志转化为精致、面向用户的发布说明。

背景

你正在为 $ARGUMENTS 撰写发布说明。

如果用户提供了文件（JIRA 导出文件、Linear 工单、PRD、Git 日志或内部变更日志），请先阅读。如果用户提到了产品 URL，请使用网络搜索了解产品及其受众。

说明

1. 收集原始材料：阅读所有提供的工单、变更日志或说明。提取以下信息：

   • 变更内容（新功能、改进或修复）
   • 受影响的用户（用户群体）
   • 变更的意义（为用户带来的益处）

2. 对变更进行分类：

   • 新功能：全新的能力
   • 改进：对现有功能的增强
   • 错误修复：已解决的问题
   • 重大变更：需要用户采取操作的变更（迁移、API 变更）
   • 弃用：即将停止支持的功能

3. 按照以下原则撰写每条说明：

   • 首先说明用户获益，而非技术变更
   • 使用通俗易懂的语言，避免行话、内部代号或工单编号
   • 每条说明保持在 1-3 句话
   • 如果用户提供了图片或截图，请将其纳入

   改写示例：

   • 技术描述：“为仪表盘 API 端点实现 Redis 缓存层”

   • 面向用户的描述：“仪表盘现在加载速度最高可提升 3 倍，让你减少等待，把更多时间用于分析。”

   • 技术描述：“修复并发结账流程中的竞争条件”

   • 面向用户的描述：“修复了高流量时段部分订单可能无法提交的问题。”

4. 按以下结构组织发布说明：

   # [Product Name] — [Version / Date]
   
   ## New Features
   - **[Feature name]**: [1-2 sentence description of what it does and why it matters]
   
   ## Improvements
   - **[Area]**: [What got better and how it helps]
   
   ## Bug Fixes
   - Fixed [issue description in user terms]
   
   ## Breaking Changes (if any)
   - **Action required**: [What users need to do]
   

5. 调整语气，以符合产品的风格：B2B 产品采用专业语气，消费类产品采用友好语气，API 采用面向开发者的语气。

保存为 Markdown 文档。如果用户需要 HTML 或其他格式，请进行相应转换。