SuperAPI AI 工具集

nightly-docs-and-changelog

写作与研究

查看项目

更新于 11-05 16:17

技能介绍

用途

该技能用于在已有仓库中按夜间的节奏自动维护文档与更新日志,防止它们随代码演进逐渐过期。它本身不提供循环机制,而是复用 loop-controller 的循环基础设施(原语选择、完整防护规则栈、状态外置),并补充针对“夜间保持文档与更新日志不过时”的三项内容:每晚的固定流程、机械性证明,以及人工介入(HITL)边界。

主要能力

  1. 夜间一次扫描:读取上次运行标记,执行 git diff <标记>..HEAD,该差异即当晚唯一的工作范围。尚无标记(首次运行)时,从最近的发布标签或合理的近期基线开始,而非整个历史。
  2. 撰写文档更新:针对变更部分,按 docs-agent 为该仓库定义的文档惯例自行撰写更新。docs-agent 是编排器构建阶段的文档角色,禁止模型自动调用,仅在契约优先的构建中由编排器调度;本技能复用其文档风格,而不复用其调度方式。
  3. 变更日志纪律:将每项变更分类为面向用户或内部。新增标志、行为变更、修复用户可见缺陷、破坏性变更属于面向用户,需写入 CHANGELOG.md;内部重构、仅测试变更、lint 修复、无用户可见影响的依赖升级不写入。分类标准与示例见 references/scheduling.md。
  4. 提交并开启一个 PR:提交文档与更新日志变更,通过 git-pr 开启一个以扫描日期命名的 PR,汇总本次变动,然后停止。绝不自动合并、绝不强制推送、绝不改写已发布的 CHANGELOG 条目。
  5. 无变更夜晚的记录:若自标记以来无差异,则记录一条明确的“无变更”记录,不开启 PR,以便区分跳过与遗漏。

使用方式

该技能为用户调度型,默认禁用模型自动调用,不会因白天代码变动而由 Claude 自行开始改写文档。用户一次性设置后(或输入 /nightly-docs-and-changelog 立即执行一次扫描)即可运行。夜间调度应使用云端 routine 或桌面计划任务(通过 /schedule)在真实 cron 上触发,独立于任何打开的会话,并能在机器关机后存活;不应使用 /loop,因为 /loop 是会话级的、约三天后过期且不会补跑错过的触发。完整的 /schedule 设置、cron 行以及 routine 提示词见 references/scheduling.md。

证明标准

默认 FAIL 立场:在依据上次运行以来的差异验证之前,假定文档已过期、更新日志不完整。证明需同时满足两个条件:变更部分的文档与当前实现一致;自标记以来每个用户相关变更均在 CHANGELOG.md 中有记录(安静夜晚有明确的无变更记录)。证明产物为文档/更新日志差异加所开启的 PR;空差异加无变更记录也是有效且常见的结果。

防护规则

继承 loop-controller 的完整防护栈,并额外设定:每晚迭代上限(默认约 10 次),达到后停止并开启部分 PR 并标记,而非草率处理文档;连续三晚同一变更部分仍在漂移(文档反复修改不收敛,或同一文件夜复一夜未被记录)则停止并上报,交由人工处理;预算上限,从 .claude/profile.yaml(若存在)读取 token/成本上限并终止扫描;人工介入是退出点而非循环中检查点——开 PR 后交给人,绝不合并。不得作弊:未开 PR 不得推进标记,不得为缩短更新日志而丢弃用户相关变更,未对照差异检查不得标记文档为“当前”。

适用场景

适用于已发布、持续演进、需要长期保持文档和变更日志与代码同步的项目;尤其适合希望每天早上审查一份小范围、可读的文档与更新日志变更 PR 的团队。

限制

复用 loop-controller 与 git-pr 的机制,需具备相应技能与环境;docs-agent 不可由用户调度,本技能仅复用其文档惯例;不自动合并,合并决策始终由人工做出;具体 cron 设置、标记机制及分类细则需参考其引用文件;资料未提供安装命令、平台支持范围、收费信息或实际效果评测。