agent-entrypoints
创建、优化或审查项目及模块级 AGENTS.md / CLAUDE.md 等 Agent 入口文档时使用。根据项目事实精简规则、设置按需读取指针,支持模块两入口布局,并检查规则是否可执行、入口是否冲突。
盘点并维护项目测试资产,把需求、业务规则、风险、Bug 和跨端接口契约转成 TEST-ID 与可验证证据,生成或更新 TESTS.md。用于测试资产盘点、测试缺口分析、单元/集成/契约/E2E/冒烟分类、Bug 回归保护、前后端或多服务基于同一契约的消费者/提供者测试、测试必要性判断、测试清单维护与交付前测试证据审查。中文触发:测试盘点、测试清单、测试资产、测试缺口、测试必要性、Bug 转测试、契约测试、前后端接口测试、测试治理。English triggers: test inventory, test catalog, test gap
$ npx -y skills add qshanx/docs-governance --skill test-collaboration --agent claude-codeHow it fires
How this skill gets triggered: by you, by Claude, or both.
/test-collaborationContext preview
The summary Claude sees to decide when to auto-load this skill.
盘点并维护项目测试资产,把需求、业务规则、风险、Bug 和跨端接口契约转成 TEST-ID 与可验证证据,生成或更新 TESTS.md。用于测试资产盘点、测试缺口分析、单元/集成/契约/E2E/冒烟分类、Bug 回归保护、前后端或多服务基于同一契约的消费者/提供者测试、测试必要性判断、测试清单维护与交付前测试证据审查。中文触发:测试盘点、测试清单、测试资产、测试缺口、测试必要性、Bug 转测试、契约测试、前后端接口测试、测试治理。English triggers: test inventory, test catalog, test gap
name: test-collaboration description: "盘点并维护项目测试资产,把需求、业务规则、风险、Bug 和跨端接口契约转成 TEST-ID 与可验证证据,生成或更新 TESTS.md。用于测试资产盘点、测试缺口分析、单元/集成/契约/E2E/冒烟分类、Bug 回归保护、前后端或多服务基于同一契约的消费者/提供者测试、测试必要性判断、测试清单维护与交付前测试证据审查。中文触发:测试盘点、测试清单、测试资产、测试缺口、测试必要性、Bug 转测试、契约测试、前后端接口测试、测试治理。English triggers: test inventory, test catalog, test gap analysis, bug-to-test, contract testing, consumer contract, provider verification, test governance."
用项目根目录的 `TESTS.md` 管理两类信息:
1. **现有测试资产地图**:项目已经有哪些测试、从哪里运行、保护什么。 2. **必要测试点清单**:哪些需求、规则、风险和 Bug 必须被测试保护,当前证据是否足够。
清单管理的是“为什么测、测什么、证据在哪”,测试代码仍然是可执行事实。不要把 `TESTS.md` 写成每个测试函数的镜像。
| 资产 | 唯一职责 | |---|---| | `TESTS.md` | 测试资产、必要测试点、缺口、状态和证据 | | 测试代码 | 可执行输入、断言、fixture/fake 和边界模拟 | | `REGRESSION.md` | 模块下游、回归命令和改动后的重跑规则;只引用 TEST-ID | | Spec/Issue | 成功标准、问题现象、影响、优先级、任务状态和排期的唯一来源 | | `PROJECT_LOG.md` | 只追加测试状态变化和交付结论,不复制整个清单 |
v1 由当前会话直接执行本 skill,不新增专用 agent、slash command 或强制脚本。
按存在性读取,不要求项目拥有全部文件:
1. `TESTS.md` 与 `templates/TESTS.example.md`。 2. 项目规则和地图,如 `CLAUDE.md`、`AGENTS.md`、`CLAUDE_MAP.md`。 3. 测试目录、测试配置、CI 配置、标准测试入口和专用测试任务。 4. Spec、Bug、Issue、审计、事故或回归清单;成功标准只引用,不复制进 `TESTS.md`。 5. `REGRESSION.md`,用于对齐模块回归命令与 TEST-ID。 6. 跨端接口的机器可读契约及生成/校验入口,例如 OpenAPI、JSON Schema、GraphQL schema 或 protobuf。
先识别仓库已有的测试框架和命名习惯,不强迫项目改成统一目录结构。
首次采用时做一次全量盘点,之后按事件增量维护:
1. 找到标准测试入口,例如 `pytest`、`npm test`、`make test` 或项目脚本。 2. 扫描测试目录、配置和 CI;可以使用 collect/list 模式,但不要为了盘点执行高风险外部操作。 3. 按模块、测试套件或关键流程聚合,禁止手抄每个测试函数。 4. 标注层级、用途、为什么存在/保护什么风险、执行组、外部依赖、位置和当前判断。 5. 将资产判断为:必要、疑似重复、缺失或疑似废弃。盘点阶段只报告,不擅自删除或重写测试。
重新盘点由事件触发,不按日历机械执行:
每个必要测试点使用稳定 ID,例如 `TEST-ORDER-001`。至少记录:
纯模板、教程或历史方案中的示例编号不属于项目测试台账。确定性审计需要扫描这些文档时,可在文档顶部加 `<!-- test-id-audit: examples-only -->` 显式声明“本文件只有示例”;活动 Spec、Issue、Bug、评审或交付证据不得用该标记逃避登记。
来源必须链接回 Spec/Issue 中的原始成功标准。`TESTS.md` 只回答“哪条证据验证它”,不得另写一份可独立漂移的业务标准。成功标准含糊时,回到需求澄清能力或请项目负责人确认,不由测试 Skill 猜测。
受控层级:`单元`、`集成`、`契约`、`E2E`、`冒烟`。
受控用途:`规则保护`、`关键链路`、`回归保护`、`专项保护`。需要多个用途时用逗号分隔,不能临时发明新值。
`不适用` 必须写理由,例如风险由 schema、类型系统或 lint 更合适地机械拦截。不能用“不好测”作为理由。
修复 Bug 时,必须二选一:
1. 新增或关联一个 TEST-ID;或 2. 明确记录为什么只能人工验收,以及人工验收步骤和证据。
TEST-ID 应复现真实失败形状,而不是换成更容易通过的相似输入。记录修复前失败、修复后通过的证据;如果无法先运行旧代码,至少说明复现依据和未实测项。
没有 TEST-ID 或明确的人工出口,不得宣称 Bug 已完整闭环。
前端与后端或多个服务分开开发时,把接口契约作为测试共同输入,不让各端分别手写一份接口事实:
1. 找到仓库已有的机器可读契约,记录路径及可核验的版本、commit 或 hash;不把字段表复制进 `TESTS.md`。 2. 用同一个 TEST-ID 串起四层证据:
3. 每层记录实际命令、退出码和证据位置。生成类型或 mock 未重新生成、与契约不一致时,不得标为 `已覆盖`。 4. 接口需要变化时先更新唯一契约源,再重新生成消费方资产并重跑提供方与联调测试。 5. 仓库没有机器可验证契约时,标为 `待补` 或 `不可验证`,说明当前只能依赖什么证据;不能把双方各自测试为绿写成“兼容性已验证”。
契约测试证明双方是否遵守同一接口边界;E2E 继续证明真实业务路径能否工作。两者不能互相替代。
将状态标为 `已覆盖` 前,逐项确认:
1. 测试文件真实存在。 2. 断言验证业务行为,不只是“函数被调用”或“状态码是 200”。 3. 命令可执行且退出码为 0。 4. 测试进入标准 runner,或登记为命名清楚的专用执行组。 5. 证据能对应 TEST-ID 的输入、预期和边界。
只看到测试文件、测试数量或绿色 CI,不足以证明必要规则已覆盖。
交付闭环还要确认:活跃 Spec/Issue 有明确成功标准;关键标准已关联 TEST-ID 或可复核的人工出口;证据确实验证预期行为;标准变化和本次重要结果已按活文档规则记入 `PROJECT_LOG.md`。
创建或更新 `TESTS.md` 时使用 `templates/TESTS.example.md` 的结构,并在回复中给出:
1. 标准测试入口和测试资产概况。 2. 必要、缺失、疑似重复、疑似废弃的数量。 3. 本轮新增或变更的 TEST-ID。 4. 已实际运行的命令、退出码和未实测项。 5. 下一步只列最重要的补测动作。
盘点任务默认只修改测试治理文档。除非用户另行授权,不修改生产代码、不删除测试,也不替贡献者偷偷补实现。
A knowledge, decision, and verification governance system for long-running AI-assisted projects. It turns a strong agent's one-off work into shared project capability that future agents can inherit, verify, and evolve.
创建、优化或审查项目及模块级 AGENTS.md / CLAUDE.md 等 Agent 入口文档时使用。根据项目事实精简规则、设置按需读取指针,支持模块两入口布局,并检查规则是否可执行、入口是否冲突。
用户要求整体检查项目治理规则的承载位置、精简常驻约束,或判断散落资料能否沉淀为 Skill、脚本或 Hook 时使用。只读识别主源、重复工作流与自动化缺口,给出证据和最小建议;单项文档维护直接使用已有专项 Skill。
判断项目是否需要架构文档,或生成、完善、审查 ARCHITECTURE.md 及已有架构说明。用于模块分工、状态归属、依赖关系或核心流程需要梳理时;依据项目证据记录结构,区分当前实现与已确认设计。
兼容旧 context-and-decisions 调用;领域术语与 ADR 的形成和修改统一转交随插件提供的 domain-modeling。
只读审计现有项目文档,检查资料散乱、入口难找、断链、内容过时、重复主源及当前与历史混用。用于用户要求“审计文档”“检查文档是否过时”“看看文档哪里乱”,或阶段交接前检查文档体系时。
作为面向长期 AI 协作项目的知识、决策与验证治理总入口,把优秀 Agent 的一次性工作沉淀为可继承、可验证、可持续演进的项目集体能力;根据用户意图把任务路由到活文档、领域上下文与…