SuperAPI AI 工具集

project-discover-modules-contracts

编程与开发

查看项目

更新于 10-16 08:46

技能介绍

用途:把选中的模块(优先 P0)整理成单页模块 SSOT,位于 .aidlc/project/components/{module}.md,同页建立 API/Data 契约的权威入口、不变量摘要、证据入口与结构化缺口清单,满足 Discover 阶段的 DoD 门禁。使用前需宣布正在使用本技能。

主要能力与硬规则:模块页路径固定为 .aidlc/project/components/{module}.md;必须包含锚点标题 ## TL;DR、## API Contract、## Data Contract、## Evidence(证据入口)、## Evidence Gaps(缺口清单);契约不单独建目录,禁止 .aidlc/project/contracts/**;所有缺口只写入 Evidence Gaps,禁止散落“待补/未发现/TODO”;正文禁止占位句,缺证据或缺结论时只允许写入缺口清单。

Frontmatter 必填字段:module、priority(P0|P1|P2)、change_frequency(high|medium|low)、last_verified_at(YYYY-MM-DD)、source_files(关键源文件路径列表)。推荐结构含 TL;DR、模块定位(In/Out)、Owner、入口、协作场景、状态机与领域事件、API Contract、Data Contract、Evidence、Evidence Gaps。

API/Data 契约最小要求:权威入口需可定位(如 OpenAPI/Proto/Schema 源文件或生成物路径,含生成/校验命令或 CI job 入口);不变量摘要 3–7 条;证据入口最小粒度含关键 handler/router/controller、代表性测试入口、CI job/命令入口。Data 部分需写明数据主责(主写/只读/同步来源)、核心对象与主键、迁移/DDL/Schema/ORM 证据入口、不变量摘要与证据入口。

降级规则:P1 模块页必须存在,API 或 Data 允许缺失其一但需在 Evidence Gaps 写清缺口与影响;P2 默认不创建模块页,仅索引占位,需要时再升级。

限制与提醒:缺口须按结构化模板(缺口、期望补齐粒度、候选证据位置、影响)书写;若暂时无法给出 3–7 条不变量摘要,不得在正文写占位句,应在 Evidence Gaps 新增条目,且该模块不得在索引中打勾;索引只做导航,不重复模块页内容;证据入口应写“在哪里”而非操作步骤;一次性交付细节应下沉 spec 或外部 runbook。