SuperAPI AI 工具集

project-discover-modules-contracts

通用与其它

查看项目

更新于 10-16 01:28

技能介绍

用途:为选中模块(优先 P0)建立单页权威入口,让 AI 或人快速判断模块边界与不变量,并沿证据链定位代码、契约、测试、CI 与运维信息,满足 Discover 的 DoD 门禁。

主要能力:模块页路径固定为 .aisdlc/project/components/{module}.md;要求锚点标题 ## TL;DR、## API Contract、## Data Contract、## Evidence(证据入口)、## Evidence Gaps(缺口清单);契约不单独建目录,禁止 .aisdlc/project/contracts/**;缺口只写入 Evidence Gaps,正文禁止“待补齐后填写/待确认/未发现/以后再补”等占位句。模块页需含 frontmatter 字段:module、priority(P0|P1|P2)、change_frequency(high|medium|low)、last_verified_at、source_files。

使用方式:API Contract 与 Data Contract 各自写明权威入口(可定位)、3–7 条不变量摘要、最小粒度证据入口;证据入口覆盖 Code、Tests、CI、Ops。缺口按结构写:缺口、期望补齐到的粒度、候选证据位置、影响。若暂时给不出不变量摘要,不在正文写“待补”,而是在 Evidence Gaps 新增条目,且该模块此时不得在索引中打勾。

适用场景:Discover 阶段整理模块边界、契约入口与证据链,优先处理 P0 模块。

限制:P0 必须满足全部硬规则;P1 模块页必须存在,API 或 Data 允许缺失其一,但须在 Evidence Gaps 写清缺口与影响;P2 默认不创建模块页,只在索引占位。契约段落避免写成字段大全,证据入口写“在哪里”而非“怎么做”,一次性交付细节应下沉到 spec 或外部 runbook。