UnityAI/modules/模块文档模板.md

# 模块名称

## 目的

TODO：一句话说明模块解决的问题。

## 主要路径

| 类型 | 路径 | 说明 |
|---|---|---|
| 源码 | `Assets/...` | TODO |
| 生成代码 | `Assets/...` | 没有则删除本行 |
| 资源/配置 | `Assets/...` | TODO |

## 边界

- 本模块负责：TODO
- 本模块不负责：TODO
- 源码与生成结果：TODO

## 数据流

```text
TODO：入口 -> 处理 -> 输出
```

## 关键类与接口

| 类/方法 | 用途 |
|---|---|
| `ClassName` | TODO |

## 使用规则

- TODO

## 验证

- TODO：编译、Unity、运行时或目标平台验证方式。

## 当前状态

- 已识别 / 初步梳理 / 待验证 / 已完成 / 未发现实现

## 文档关联

| 文档 | 关联原因 |
|---|---|
| [模块索引](模块索引.md) | 模块入口和状态 |
| [模块登记规则](../rules/30-模块登记规则.md) | 文档分类和结构 |
| [架构说明](../rules/10-架构说明.md) | 代码分层和依赖方向 |

## 文档结构

- 轻量模块只保留 README。
- 公共 API 较多时增加 `使用指南.md` 或 `开发指南.md`，具体判断标准见 [模块登记规则](../rules/30-模块登记规则.md)。
- 特殊限制较多时增加 `注意事项.md`；一次性任务文档规则见 [工作流清单](../rules/40-工作流清单.md)。

### README 与使用指南的分工

| 文档 | 内容 |
|---|---|
| `README.md` | 模块定位、核心组成、使用规则、边界、导航链接 |
| `使用指南.md` | 详细 API、调用示例、数据流、架构图、最佳实践、边界场景 |