zentao-flow/.agents/skills/docmap/references/module_template.md

{模块名称}

1. 模块定位

1.1 模块目标

1.2 解决问题

---

2. 功能清单

功能名称	功能描述	输入	输出	依赖模块
功能1	描述1	输入1	输出1	模块A
功能2	描述2	输入2	输出2	模块B

---

3. 核心逻辑

3.1 业务规则

1. 规则1: 规则描述
2. 规则2: 规则描述

3.2 校验逻辑

校验项	校验规则	错误提示
校验1	规则描述	错误信息
校验2	规则描述	错误信息

3.3 状态流转

stateDiagram-v2
    [*] --> 初始状态
    初始状态 --> 状态A: 事件1
    状态A --> 状态B: 事件2
    状态B --> [*]: 结束
    状态A --> 异常状态: 异常事件

---

4. 数据结构

4.1 涉及数据表

表名	描述	关键字段
表A	描述A	字段1, 字段2
表B	描述B	字段3, 字段4

4.2 字段说明

表A

字段名	类型	说明	约束
id	bigint	主键	自增
name	varchar	名称	非空

4.3 数据关联

---

5. 对外接口

5.1 API 列表

接口	方法	路径	描述
接口1	GET	/api/xxx	描述1
接口2	POST	/api/yyy	描述2

5.2 事件机制

事件名称	触发时机	消费者
事件1	时机1	消费者A

5.3 回调机制

---

6. 异常与边界处理

6.1 异常情况

异常场景	处理方式	返回信息
场景1	处理方式1	信息1
场景2	处理方式2	信息2

6.2 边界条件

边界条件	处理逻辑
条件1	逻辑1
条件2	逻辑2

6.3 性能考虑