84 lines
2.1 KiB
Markdown
84 lines
2.1 KiB
Markdown
|
# 模块名称
|
|||
|
|
|
|||
|
|
## 分类
|
|||
|
|
|
|||
|
|
- 项目功能 / 项目框架 / 编辑器工具
|
|||
|
|
|
|||
|
|
## 目的
|
|||
|
|
|
|||
|
|
TODO：一句话说明这个模块是做什么的，从玩家/产品/技术视角写。
|
|||
|
|
|
|||
|
|
## 主要路径
|
|||
|
|
|
|||
|
|
| 类型 | 路径 | 说明 |
|
|||
|
|
|---|---|---|
|
|||
|
|
| 逻辑代码 | `Assets/...` | TODO |
|
|||
|
|
| UI 代码 | `Assets/...` | TODO |
|
|||
|
|
| 资源 | `Assets/...` | TODO |
|
|||
|
|
| 配置 | `XLSX_SRC/...` 或 `GoogleProtobufNetwork/...` | TODO |
|
|||
|
|
|
|||
|
|
## 入口
|
|||
|
|
|
|||
|
|
- 运行入口：TODO
|
|||
|
|
- 编辑器入口：TODO
|
|||
|
|
- 资源入口：TODO
|
|||
|
|
|
|||
|
|
## 数据流
|
|||
|
|
|
|||
|
|
```text
|
|||
|
|
TODO：用箭头图描述关键流程
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
## 关键类 / API
|
|||
|
|
|
|||
|
|
| 类/方法 | 用途 |
|
|||
|
|
|---|---|
|
|||
|
|
| `ClassName` | TODO |
|
|||
|
|
|
|||
|
|
## 依赖
|
|||
|
|
|
|||
|
|
- 依赖的框架模块：TODO
|
|||
|
|
- 依赖的其他功能模块：TODO
|
|||
|
|
- 依赖的第三方插件：TODO
|
|||
|
|
|
|||
|
|
## 当前状态
|
|||
|
|
|
|||
|
|
- TODO
|
|||
|
|
|
|||
|
|
## 变更记录
|
|||
|
|
|
|||
|
|
| 日期 | 变更内容 | 关联 spec/change | 影响范围 |
|
|||
|
|
|---|---|---|---|
|
|||
|
|
| YYYY-MM-DD | 简要描述 | `[<change-name>]`（对应 `specs/openspec/<change-name>/业务参考总入口.md`） | 相关模块/文件 |
|
|||
|
|
|
|||
|
|
## 文档关联
|
|||
|
|
|
|||
|
|
本模块发生变更时，以下文档必须同步更新：
|
|||
|
|
|
|||
|
|
- [模块索引](模块索引.md) — 如果新增/删除模块，或模块分类/状态改变
|
|||
|
|
- [模块登记规则](../rules/30-模块登记规则.md) — 如果新增模块、分类口径或依赖关系变化
|
|||
|
|
- [架构说明](../rules/10-架构说明.md) — 如果涉及架构变化
|
|||
|
|
- TODO：链接相关功能/框架模块文档（如依赖方或被依赖方）
|
|||
|
|
- TODO：链接相关 spec 目录（如 `../../specs/openspec/<change-name>/业务参考总入口.md`）
|
|||
|
|
|
|||
|
|
> 注意：本模板位于 `modules/` 根目录。如果复制到 `modules/features/` 或 `modules/frameworks/` 下，请把 `../rules/` 和 `模块索引.md` 调整为 `../../rules/` 和 `../模块索引.md`。
|
|||
|
|
|
|||
|
|
## 下一步
|
|||
|
|
|
|||
|
|
- [ ] TODO
|
|||
|
|
|
|||
|
|
## 相关文档
|
|||
|
|
|
|||
|
|
- [模块索引](模块索引.md)
|
|||
|
|
- [模块登记规则](../rules/30-模块登记规则.md)
|
|||
|
|
- [架构说明](../rules/10-架构说明.md)
|
|||
|
|
- TODO：链接相关功能/框架模块文档
|
|||
|
|
|
|||
|
|
## 是否需要拆分文档
|
|||
|
|
|
|||
|
|
轻量模块可以只保留这个 README。
|
|||
|
|
|
|||
|
|
当模块出现独立计划、持续进度或多项待办时，再增加：
|
|||
|
|
|
|||
|
|
- `progress.md`
|
|||
|
|
- `tasks.md`
|