SuperAPI AI 工具集

release-notes

写作与研究

查看项目

更新于 10-25 10:23

技能介绍

用途

该技能用于撰写面向现有用户的发布说明或变更日志条目。目标是告诉用户更新后会注意到什么,以及他们是否需要做任何事。大多数用户只读第一行,部分读下一节,很少继续往下读,因此内容需要按重要性组织。

主要能力

  • 收集自上次发布以来的变更,例如使用 git log --oneline <last tag>..HEAD,并阅读相关的 PR 和 issue。
  • 当提交标题不能清楚说明用户体验时,阅读变更的 diff,只描述能追溯到变更的效果。
  • 查找项目的更新步骤和发布平台,参考发布文档、README 和上次发布的说明。
  • 按固定结构组织内容:一行最显著效果、标题变更的图片(如有)、用户会注意到的条目、更新步骤、底层细节。
  • 用户会注意到的条目以粗体句子开头说明用户看到或做什么,必要时用一句话说明之前的情况。
  • 仅影响部分应用或平台时注明名称;应用无变化时明确说明。
  • 将用户必须执行的操作放在对应条目内,影响整个发布的操作放在更新部分。
  • 使用屏幕上用户看到的名称(按钮标签、选项卡名称、消息),精确引用;用平实词语命名位置。
  • 按用户遇到频率排序,移除功能或破坏工作流的变更放最前,并说明替代方案。
  • 底层细节每行一个变更,链接 issue 或 PR 并感谢报告者;不发布的内容(如视频、计划、无效果重构)不包含。
  • 发布前让没有上下文的读者仅阅读说明,询问更新后会注意到什么、是否必须做什么,答案错误则重写。

使用方式

该技能以指导文档形式提供,描述撰写发布说明的流程和规范。使用时按照收集、组织、检查的步骤操作,并遵循项目发布文档的发布时机和方式。撰写说明并不授权发布;发布命令示例:gh release create <tag> --notes-file <file> 或 gh release edit <tag> --notes-file <file>,之后用 gh release view <tag> --json body 重新阅读已发布内容。

适用场景

适用于软件项目发布新版本时,需要向现有用户传达更新内容。特别适合有多个应用或平台、需要区分用户可见变化和技术细节的项目。

限制

该技能不提供自动发布功能,需遵循项目发布文档。资料中未提供具体的安装命令或平台支持信息。