SuperAPI AI 工具集

diff-driven-docs

写作与研究

查看项目

更新于 10-16 08:08

技能介绍

用途:diff-driven-docs 用于在 BUILD 阶段完成、暂存提交或即将创建 PR 时,确保代码 diff 已反映到文档中。它把文档当作每次构建的交付物,而非事后补充。

主要能力:内置 Impact Classifier 表,按 diff 特征决定业务层、技术层、审计层是 SKIP、CHECK 还是 CREATE。业务层写用户指南、管理文档、功能与权限说明;技术层写 hooks、组件目录、API、数据库 schema、环境变量与架构说明;审计层写决策记录,含 What Changed、Why、Alternatives Considered、Impact 四段。若三层全为 SKIP,则设 IMPACT_LEVEL: none 并直接输出 SKIPPED 契约。

使用方式:由 doc-syncer 代理在 BUILD 链中加载,在 integration-verifier 通过后、Memory Update 前运行。流程为:取 diff(如 git diff --cached --stat && git diff --cached,或 git diff HEAD~1 --stat && git diff HEAD~1);分类影响;按 CLAUDE.md 的 Doc Targets 或通用启发式映射文档目标;先读后写,做最小编辑;自检后输出 Router Contract YAML。审计文档命名参考 docs/YYYY-MM-DD-{topic}-decision.md。可在 CLAUDE.md 的 Session Settings 加 DIFF_DRIVEN_DOCS: skip 关闭。

适用场景:新增页面或路由、导出 API 签名变化、架构模式或技术选型、破坏性变更、权限与安全合规影响等。

限制:资料未提供具体安装命令、收费与平台信息;文档目标映射依赖项目自身约定,缺失时使用通用启发式。