SuperAPI AI 工具集

changelog-generator

写作与研究

查看项目

更新于 10-15 08:33

技能介绍

Changelog Generator 是一个把技术性 Git 提交转化为清晰、面向用户的更新日志的技能,目标是让客户和用户能够理解并感受到产品变化。

一、用途 该技能适合在需要对外传达产品变化的场景中使用,包括:为某个新版本准备发布说明;创建每周或每月的产品更新摘要;为客户记录变化;为应用商店提交撰写更新日志条目;生成更新通知;创建内部发布文档;维护公开的更新日志或产品更新页面。

二、主要能力

  1. 扫描 Git 历史:分析特定时间段或版本之间的提交记录。
  2. 分类变更:把提交按逻辑类别分组,例如功能、改进、缺陷修复、破坏性变更、安全等。
  3. 技术语言转用户语言:将开发者提交转换为客户可读的表述。
  4. 专业格式化:生成干净、结构化的更新日志条目。
  5. 过滤噪音:排除重构、测试等内部提交。
  6. 遵循最佳实践:应用更新日志撰写规范以及你的品牌语气。

三、使用方式 基础用法示例(在项目仓库中执行):

  • 创建自上次发布以来的更新日志
  • 生成过去一周所有提交的更新日志
  • 创建 2.5.0 版本的发布说明

指定日期范围示例:

  • 创建 3 月 1 日至 3 月 15 日之间所有提交的更新日志

使用自定义规范示例:

  • 创建自 v2.4.0 以来的更新日志,并使用我在 CHANGELOG_STYLE.md 中的更新日志规范

示例输入与输出: 用户输入“Create a changelog for commits from the past 7 days”。输出示例为一份按“新功能 / 改进 / 修复”分段的更新日志,例如“本周更新 - 2024 年 3 月 10 日”,其中新功能包含团队工作区、键盘快捷键;改进包含更快的同步、更好的搜索;修复包含大图上传问题、定时发布时区混淆、通知角标计数等。

四、适用场景 该技能可用于创建 GitHub 发布说明、撰写应用商店更新描述、生成面向用户的邮件更新、制作社交媒体公告帖子。

五、限制与注意事项 资料未提供该技能的收费、价格、平台支持或效果保证等信息,这些方面暂未提供。使用提示包括:从 Git 仓库根目录运行;指定日期范围以获得更聚焦的更新日志;使用 CHANGELOG_STYLE.md 保持格式一致;发布前审阅并调整生成的更新日志;可直接将输出保存到 CHANGELOG.md。