朱子纯 / erp-workflow-plugin

SKILL.md 3.75 KB

name: db-design-gen description: A3 DB 设计 + REQ 回填——基于 docs/01 REQ 卡片正向设计 docs/03 并回填 REQ 卡片与模块头的 TBD 占位。 user-invocable: false

allowed-tools: Read Write Edit Grep Glob AskUserQuestion

所有输出必须使用中文。

db-design-gen

每步骤完成后用 Edit 在 docs/08-模块任务管理.md § 一 勾选对应子项。

执行步骤

A. 读取设计输入

读：

  • docs/04-技术规范.md
  • docs/01-需求清单/index.md 模块索引
  • docs/01-需求清单/*/REQ-*.md 所有 REQ 卡片

B. 推导 schema

基于步骤 A 读到的 REQ + 命名规范，正向推导业务实体 → 表 + 字段 + 索引 + 外键。要求：

  1. 严格套用 docs/04 命名规范 + 匈牙利列前缀（i=int / s=varchar / t=datetime）
  2. 主键：标准列 iIncrement int 主键。REQ 明确要求不同主键（复合主键 / UUID / 业务主键）时按 REQ，并在该表业务注记里注明偏离原因
  3. 外键：依据 REQ 中的引用关系（如「订单引用客户」），明确列出 ON DELETE / ON UPDATE 策略；不能确定时默认 RESTRICT
  4. 索引：根据 REQ 的查询模式推导业务索引；外键列默认建索引；租户隔离列 sBrandsId / sSubsidiaryId（标准列）按业务查询模式建组合索引
  5. 业务注记：对每张表用一两句话说明业务用途、关键约束、与其他表的关系

如果某 REQ 表述模糊以致无法推断关键 schema 细节（如：枚举值范围 / 字段长度上限 / 必填性），先按合理默认推导并在该字段「业务含义」列加 【人工填写：需用户审阅】 标注，待步骤 E 用户审阅时调整；不打断本次推导。

C. 渲染 docs/03

  1. 读取 ${CLAUDE_SKILL_DIR}/templates/docs-03-header-template.md，填充 schema_name（从 config-vars.yaml 读 database.schema，无则填 【人工填写：database.schema】）、er_overview（纯文本 ER 概览）。「项目标准列约定」是固定 5 列，无占位、原样保留。
  2. 渲染「表清单」：对每张表读取并填充 ${CLAUDE_SKILL_DIR}/templates/docs-03-table-template.md——标准列 5 行已内置原样输出，只需填业务字段（{{#each columns}}）/ 索引 / 外键 / 业务注记。
  3. 写入 docs/03-数据库设计文档.md。

勾选：- [ ] docs/03-数据库设计文档.md 已生成

D. 回填模块头 + REQ 卡片的 TBD 字段

  1. 列出 docs/01-需求清单/*/_module.md（模块头）和 docs/01-需求清单/*/REQ-*.md（REQ 卡片）。
  2. 在这些文件中搜索 TBD(A3 自动补) 的并回填。 不动 TBD(A5 自动补)
  3. 打印回填统计：A3 回填 <M> 处模块"涉及表" + <N> 处 REQ"依赖表"。

勾选：- [ ] docs/01 各 REQ 卡片"依赖表" + 模块头"涉及表" 已回填

E. 勾选 A3 顶层 + 停下等人工审阅

  1. 勾选 A3 顶层（A3 两个子项已在 C / D 步骤分别勾选）：- [ ] A3 DB 设计 + REQ 回填 — db-design-gen

  2. 打印停下横幅并停下，不调用任何下游 skill：

   [db-design-gen] ✅ A3 DB 设计完成
   产出：docs/03-数据库设计文档.md + REQ 卡片依赖表/模块头涉及表已回填
   ⏸ 请审阅 docs/03（业务实体覆盖、字段类型/默认值、索引、外键策略、`【人工填写：需用户审阅】` 标注）。
   审阅完成后运行：/erp-workflow:plan-start

参考

  • ${CLAUDE_SKILL_DIR}/templates/docs-03-header-template.md
  • ${CLAUDE_SKILL_DIR}/templates/docs-03-table-template.md
  • docs/04-技术规范.md § 一+（命名规范输入）
  • docs/01-需求清单/<module>/_module.md（模块头：回填 涉及表）
  • docs/01-需求清单/<module>/REQ-*.md（REQ 输入 + 回填 依赖表）