SuperAPI AI 工具集

changelog-writing

写作与研究

查看项目

更新于 10-16 08:45

技能介绍

用途:把提交、已合并的拉取请求、issue 和工单等原始记录,整理成开发者能在十五秒内扫完、判断“这次发布是否让我额外干活”的发布说明。它不生成简单列表,而是做生成器不做的编辑层:保留什么、对读者意味着什么、什么会破坏兼容。

主要能力:先做范围确认,把版本号提升、打标签、发布制品交给发布自动化工具;需要前后代码对比、弃用时间线和 codemod 时转交 version-migration-guide;需要叙事型博客转交 engineering-blog-post;渠道规划转交 devrel-content-calendar。通过访谈确认发布面(仓库 CHANGELOG.md、git 托管发布正文、托管更新页、产品内“新功能”、应用商店列表、企业通告等)、读者(集成方或终端用户)、版本范围、是否已有变更日志规范、提交约定、是否含破坏性变更、可读取的原始材料、是否翻译及字符上限、发布时间与资源上限。工作流包括收集原始材料(可运行 ./scripts/collect-release-material.sh)、归并净差异、按消费者可观察性筛选、分级发布、分类、按影响优先撰写条目、处理破坏性变更与弃用、按各发布面模板组装、执行验证门禁并交接。

使用方式:按项目规范与发布面模板撰写;破坏性条目采用三部分:什么会破坏、影响谁、该怎么做。版本号保持诚实:主版本表示破坏性,次版本表示新增,补丁表示修复。

适用场景:开发者工具与消费产品的发布说明、集成方与终端用户两种受众变体、历史记录混乱(无提交约定)的仓库。

限制:不负责版本提升、打标签、制品发布、迁移指南撰写、博客叙事和渠道规划;性能数字、缺失的迁移指南、需要 CVE 引用的安全条目仍需人工确认;具体收费、价格、平台支持等信息暂未提供。