SuperAPI AI 工具集

write-changelog

写作与研究

查看项目

更新于 11-09 16:49

技能介绍

用途

该技能用于从 Git 提交(commit)和冲刺(Sprint)数据中生成更新日志,支持两种受众:内部团队版和面向玩家的公开版。它属于游戏开发工作流中的发布文档生成工具。

主要能力

  • 历史归属校验:在生成日志前,读取最近的提交主题,将其分类为「游戏改动」(机制、内容、平衡、美术、音频、UI 或相关缺陷)、「框架/维护」或「不明确」。只有存在至少一条「游戏改动」提交时才继续;若为零条,则判定历史不属于本游戏并停止,避免把框架维护提交误写成玩家可见更新。
  • 参数解析:接受版本号或冲刺编号。版本号对应 Git 标签,冲刺编号对应日期范围。会检查是否为 Git 仓库,无历史则停止并提示。
  • 数据收集:读取自上一标签或发布以来的 Git 日志;无标签时以 git log --oneline -n 100 为范围。读取 production/sprints/ 下的冲刺报告和 design/gdd/ 下的设计文档(按标题分段读取)。
  • 变更分类:将每项变更归入新功能、改进、Bug 修复、平衡性调整、技术债/重构、已知问题、其他。技术债/重构仅出现在内部日志。统计缺少任务引用的提交数量。
  • 生成内部日志:按固定模板输出版本、日期、冲刺、提交范围,以及各分类条目(含提交哈希、负责人、设计文档链接)、已知问题和指标(提交总数、文件变更、增删行数、无任务引用提交数)。
  • 生成玩家版日志:用玩家可理解的语言描述新功能、改进、Bug 修复、平衡性调整和已知问题,不暴露内部代码引用、文件路径或开发者姓名,并附带反馈链接。
  • 可选写入文件:询问用户是否写入 docs/CHANGELOG.md,可选追加(推荐,最新条目置顶)、覆盖或手动复制。

使用方式

该技能以斜杠命令形式在 Claude Code 环境中调用(如 /write-changelog),可传入版本号或冲刺编号。运行前会自动解析自动化模式配置(collaborative/guided/autonomous),不同模式决定是否每次询问或直接执行。生成后会建议使用 /patch-notes 生成公开版本,并用 /release-checklist 做发布前检查。

适用场景

  • 游戏项目在版本发布或冲刺结束时整理更新日志。
  • 需要同时产出内部技术日志和面向玩家的公告文案。
  • 希望从提交历史中自动归类变更并核对任务引用完整性。

限制

  • 依赖 Git 仓库和提交历史;非 Git 仓库或无提交时无法生成。
  • 若最近提交中没有本游戏的改动,会直接停止。
  • 需要项目具备 production/sprints/、design/gdd/ 等目录结构以获取上下文,缺失时相关内容暂未提供。
  • 提交信息模糊时需借助关联文件或冲刺数据推断,仍无法判断的归入「其他」。
  • 自动化模式的具体配置文件与行为细节以项目内 .claude/docs/automation-modes.md 为准,该文档内容在此资料中暂未提供。