SuperAPI AI 工具集

writing-release-notes

写作与研究

查看项目

更新于 10-16 03:13

技能介绍

用途:撰写面向使用者的发布说明,包括 CHANGELOG、GitHub Release 描述和版本公告。核心原则是每条都说明对读者的影响,而非代码改动;读者只关心两件事——是否该升级、升级后什么会坏。

主要能力:区分三类文档——CHANGELOG(简洁累积、按类型分组、最新版本在前)、Release notes(先亮点后完整列表)、Upgrade guide(仅破坏性变更,含前后对比与步骤)。按固定顺序分类:Breaking、Added、Changed、Deprecated、Removed、Fixed、Security,空分类省略,破坏性变更始终置顶,安全条目单独成节并注明严重程度与是否需操作。

使用方式:先用 git log --oneline v1.4.0..HEAD、grep BREAKING/deprecat、git diff --stat 等命令收集候选,再逐条翻译为读者可见效果。条目写法:先说效果而非机制,量化性能(如 90s→22s),修复按用户看到的症状描述,需操作时明确标注,细节用链接而非内联,过去时主动语态、无营销语。破坏性变更必须给出迁移步骤,最好是命令或 diff。日期用 ISO 格式、版本用方括号,便于工具解析。

适用场景:库或应用的版本发布、GitHub Release、升级公告。

限制:资料未提供具体安装命令、收费或平台信息;配套技能 writing-internal-comms、coauthoring-docs、evolving-apis-and-schemas 仅作引用,未展开细节。