【整合】 框架使用规则
This commit is contained in:
@@ -1,84 +1,53 @@
|
||||
# 模块名称
|
||||
|
||||
## 分类
|
||||
|
||||
- 项目功能 / 项目框架 / 编辑器工具
|
||||
|
||||
## 目的
|
||||
|
||||
TODO:一句话说明这个模块是做什么的,从玩家/产品/技术视角写。
|
||||
TODO:一句话说明模块解决的问题。
|
||||
|
||||
## 主要路径
|
||||
|
||||
| 类型 | 路径 | 说明 |
|
||||
|---|---|---|
|
||||
| 逻辑代码 | `Assets/...` | TODO |
|
||||
| UI 代码 | `Assets/...` | TODO |
|
||||
| 资源 | `Assets/...` | TODO |
|
||||
| 配置 | `XLSX_SRC/...` 或 `GoogleProtobufNetwork/...` | TODO |
|
||||
| 源码 | `Assets/...` | TODO |
|
||||
| 生成代码 | `Assets/...` | 没有则删除本行 |
|
||||
| 资源/配置 | `Assets/...` | TODO |
|
||||
|
||||
## 入口
|
||||
## 边界
|
||||
|
||||
- 运行入口:TODO
|
||||
- 编辑器入口:TODO
|
||||
- 资源入口:TODO
|
||||
- 本模块负责:TODO
|
||||
- 本模块不负责:TODO
|
||||
- 源码与生成结果:TODO
|
||||
|
||||
## 数据流
|
||||
|
||||
```text
|
||||
TODO:用箭头图描述关键流程
|
||||
TODO:入口 -> 处理 -> 输出
|
||||
```
|
||||
|
||||
## 关键类 / API
|
||||
## 关键类与接口
|
||||
|
||||
| 类/方法 | 用途 |
|
||||
|---|---|
|
||||
| `ClassName` | TODO |
|
||||
|
||||
## 依赖
|
||||
|
||||
- 依赖的框架模块:TODO
|
||||
- 依赖的其他功能模块:TODO
|
||||
- 依赖的第三方插件:TODO
|
||||
|
||||
## 当前状态
|
||||
## 使用规则
|
||||
|
||||
- TODO
|
||||
|
||||
## 变更记录
|
||||
## 验证
|
||||
|
||||
| 日期 | 变更内容 | 关联 spec/change | 影响范围 |
|
||||
|---|---|---|---|
|
||||
| YYYY-MM-DD | 简要描述 | `[<change-name>]`(对应 `specs/openspec/<change-name>/业务参考总入口.md`) | 相关模块/文件 |
|
||||
- TODO:编译、Unity、运行时或目标平台验证方式。
|
||||
|
||||
## 当前状态
|
||||
|
||||
- 已识别 / 初步梳理 / 待验证 / 已完成 / 未发现实现
|
||||
|
||||
## 文档关联
|
||||
|
||||
本模块发生变更时,以下文档必须同步更新:
|
||||
| 文档 | 关联原因 |
|
||||
|---|---|
|
||||
| [模块索引](模块索引.md) | 模块入口和状态 |
|
||||
| [模块登记规则](../rules/30-模块登记规则.md) | 文档分类和结构 |
|
||||
| [架构说明](../rules/10-架构说明.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`
|
||||
轻量模块只保留 README。公共 API 较多时增加 `使用指南.md` 或 `开发指南.md`,特殊限制较多时增加 `注意事项.md`;一次性任务文档规则见 [工作流清单](../rules/40-工作流清单.md)。
|
||||
|
||||
Reference in New Issue
Block a user