SuperAPI AI 工具集

sync-release-docs

写作与研究

查看项目

更新于 10-16 01:35

技能介绍

用途:在代码发版或 PR 合并后,让项目文档与已交付变更保持一致,保证可发现性与跨文档一致性。

主要能力:检测基准分支(从 CLAUDE.md、.ai-cortex/config.yaml 或 gh 推断);用 git diff/git log 分析变更并按新功能、行为变更、移除、基础设施分类;逐文件审计 README、ARCHITECTURE、CONTRIBUTING、CLAUDE.md 等 .md 文件,把更新分为 Auto-update(事实性、diff 明确)与 Ask user(叙述性、大面积重写、安全模型、歧义);对明确事实性内容直接修改,风险项经用户确认后应用;仅润色 CHANGELOG 既有条目措辞,不改写、不删除、不重排;检查跨文档版本号与能力列表一致性及 README/CLAUDE 链接可发现性;清理 TODOS.md 已完成项;提交并输出 doc health summary(含 files_updated、files_skipped、todos_resolved、commit_hash)。

使用方式:在 feature branch 上运行;前置读取配置或用 gh pr view --json baseRefName -q .baseRefName、gh repo view --json defaultBranchRef -q .defaultBranchRef.name 推断 base branch,均失败则用 main。有修改时执行 git add <files>、git commit -m "docs: sync documentation for release"。

限制:不在 base branch 运行;不重写、不替换、不删除 CHANGELOG 条目,不用 Write 覆盖 CHANGELOG;不擅自 bump VERSION,需经用户确认(推荐 Skip);不建立文档规范、不做文档健康评估或从零引导文档结构,这些分别由 discover-docs-norms、assess-docs、bootstrap-docs 处理;本技能不提交代码变更,仅更新文档并 commit。