Use when 你需要把选中的模块(优先 P0)做成 `.aisdlc/project/components/{module}.md` 的单页模块 SSOT,并在同一页内建立 API/Data 契约的权威入口、不变量摘要、证据入口与结构化缺口(Evidence Gaps),以满足 Discover 的 DoD 门禁。
From sdlc-dev-skillsnpx claudepluginhub zixun-github/aisdlcThis skill uses the workspace's default tool permissions.
模块页是 Discover 的“权威入口”。它的目标不是写全细节,而是让 AI/人能在需要时 快速判断边界与不变量,并且能沿着证据链定位到代码/契约/测试/CI/ops。
开始时宣布:「我正在使用 project-discover-modules-contracts 技能为模块建立单页 SSOT(含契约段落与证据链)。」
.aisdlc/project/components/{module}.md## TL;DR## API Contract## Data Contract## Evidence(证据入口)## Evidence Gaps(缺口清单).aisdlc/project/contracts/**## Evidence Gaps(缺口清单)(不允许散落“待补/未发现/TODO”)API Contract / Data Contract / Evidence 等正文里,禁止写“待补齐后填写/待确认/未发现/以后再补”等占位句。## Evidence Gaps(缺口清单),并保持正文段落简短、可追溯。---
module: <module-short-name>
priority: P0|P1|P2
change_frequency: high|medium|low
last_verified_at: <YYYY-MM-DD>
source_files:
- <path/to/key/file1>
- <path/to/key/file2>
---
提示:
change_frequency可用 git log 的经验判断或简单统计;source_files只选“最能代表模块边界/契约/状态机”的关键源文件。
# <模块中文名>(<module>)
## TL;DR
<3–5 句话:做什么、边界、关键不变量、最关键的证据入口>
## 模块定位
- In:
- Out:
## Owner
- 团队/负责人/值班入口:
## 入口
- 代码入口:
- 运行入口(如有):../ops/...
## 协作场景(1–2 个)
- 谁调用谁 + 关键边界(细节时序下沉到 spec)
## State Machines & Domain Events
- 状态机摘要:
- 领域事件摘要:
## API Contract
- 权威入口(必须可定位):
- 不变量摘要(3–7 条):
- 证据入口(最小粒度):
## Data Contract
- 数据主责(Ownership):
- 核心对象与主键:
- 权威入口(必须可定位):
- 不变量摘要(3–7 条):
- 证据入口(最小粒度):
## Evidence(证据入口)
- Code:
- Tests:
- CI:
- Ops:
## Evidence Gaps(缺口清单)
- 缺口:
- 期望补齐到的粒度:
- 候选证据位置:
- 影响:
## API Contract 最小要求(P0)## Data Contract 最小要求(P0)任何“找不到/不确定/待补”都必须按这个结构写,避免缺口散落导致永远补不齐。
特别提醒: 如果你暂时无法给出“3–7 条不变量摘要”,不要在正文里写“待补齐后填写”。 正确做法:在 Evidence Gaps 里新增缺口条目(例如“缺口:未提取 API 不变量摘要”),并写清候选证据位置与影响。 该模块此时不得在索引中打勾。
## Evidence Gaps(缺口清单)
- 缺口:未发现 OpenAPI/Proto 权威入口(无法确认接口字段与错误码族)
- 期望补齐到的粒度:定位到具体 schema 文件路径或生成 job 名
- 候选证据位置:`docs/`、`api/`、`openapi/`、CI workflow 中的 build-docs job
- 影响:需求设计与实现阶段会猜接口契约,容易破坏兼容性与回归成本高