SuperAPI AI 工具集

docs-and-changelogs

写作与研究

查看项目

更新于 10-15 22:14

技能介绍

用途:围绕项目文档做自动生成与维护,涵盖变更日志、架构决策记录(ADR)与产品需求文档(PRD)。

主要能力:解析符合 Conventional Commits 的 git 提交历史,按类型(feat、fix、docs 等)归类,按 git tag 分组版本,按 Keep a Changelog 规范格式化,并写入或追加到 CHANGELOG.md;生成并顺序编号 ADR(含 Context、Decision、Consequences、Alternatives);搭建 PRD 模板(含问题陈述、目标与非目标、用户故事、需求、成功指标等);按语义化版本(MAJOR.MINOR.PATCH)管理版本,并可从变更日志生成发布说明。

使用方式:

  • 生成变更日志:python scripts/generate_changelog.py --since v1.0.0,可用 --output CHANGELOG.md 指定输出。
  • 新建 ADR:python scripts/create_adr.py "use postgresql for entity storage"。
  • 新建 PRD:python scripts/create_prd.py "timeline visualization feature"。
  • 版本更新:scripts/bump_version.py;发布说明:scripts/generate_release_notes.py。
  • 可接入 GitHub Actions 发布流程或 commit-msg 预提交钩子自动校验与更新文档。

适用场景:需要规范化提交信息、持续维护变更日志与文档的中长期项目。

限制:依赖提交遵循 Conventional Commits,否则无法正确归类;需用语义化版本号打 git tag;模板与文档格式为脚本约定,其他细节暂未提供。