[docs][fix]: 补齐单文件模块状态字段与 MCP 维护 checklist

- 场景系统/数据配置框架/网络系统/Hotfix启动增加验证与当前状态
- 数据配置变更清单补充具体菜单/路径/命令
- 模块登记规则增加 README/使用指南/注意事项量化标准
- 模块文档模板明确 README 与使用指南分工
- MCP 使用规则维护要求改为 checklist

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
lms
2026-07-15 14:40:38 +08:00
parent bdadfd5759
commit d31b49221e
7 changed files with 85 additions and 15 deletions

View File

@@ -43,6 +43,18 @@ Bootstrap 阶段是普通资源的硬门禁。远端清单、代码下载、MD5
启动顺序变化必须同时检查非热更层、V2 门禁、普通资源和 UI 首屏,不能只修改热更入口一侧。 启动顺序变化必须同时检查非热更层、V2 门禁、普通资源和 UI 首屏,不能只修改热更入口一侧。
## 验证
- 构建 `GameMono``SFMono.csproj`)与非热更入口相关程序集。
- 构建 `GameHF.csproj`
- 在目标平台或 Editor 中验证 Bootstrap 阶段清单获取、MD5 校验、AOT/HotUpdate 加载顺序。
- 模拟 Bootstrap 失败(如断网、错误 MD5确认重试与回调行为。
- 验证普通资源更新后 `HFGameStart` 正常进入配置/场景加载。
## 当前状态
- 待验证
## 文档关联 ## 文档关联
| 文档 | 关联原因 | | 文档 | 关联原因 |

View File

@@ -76,6 +76,16 @@ HFFunCatalogue.Asset.LoadAsset(levelId, ...)
- 不要在场景里堆放运行时动态加载的资源。 - 不要在场景里堆放运行时动态加载的资源。
- 切场景时注意 UI 窗口的自动关闭/销毁配置。 - 切场景时注意 UI 窗口的自动关闭/销毁配置。
## 验证
- 构建 `GameHF.csproj``SFMono.csproj`
- 在 Unity Editor 中切换场景,确认加载回调、资源引用和 UI 自动关闭行为正确。
- 检查 `enHFSceneName` 与资源配置表的主键一致性。
## 当前状态
- 待验证
--- ---
## 相关模块 ## 相关模块

View File

@@ -79,13 +79,25 @@ HFFunCatalogue.NDB.ds_xxx.ReadTableDeterminant();
## 变更清单 ## 变更清单
1. 修改源表。 1. 修改源表`XLSX_SRC/CN/``XLSX_SRC/EN/`
2. 确认 settings / resolve 配置。 2. 确认 `ProjectSettings/ZYF/ZYXlsx/ZYXlsxProjectSettings.asset` 与 Resolve 配置。
3. 重新生成。 3. 通过 Unity 菜单 `StrayFog → XLSX → Generate Runtime Data`(或对应 MCP 白名单命令)重新生成。
4. 检查输出。 4. 检查输出数据目录 `Assets/AutoBuildAsset/{Editor,Hotfix}/AutoFrame/Google.Protobuf/XLSX_SRC/<语言>/`
5. 编译验证 5. 检查输出代码目录 `Assets/AutoBuildScript/{Editor,General,Hotfix}/AutoFrame/Google.Protobuf/XLSX_Script/`
6. 运行时验证 6. 编译 `GameGeneral``GameHF``SFMono` 等受影响程序集
7. 更新文档 7. 运行时验证:确认 `HFGameStart.LoadDB()` 成功且读取 API 返回预期
8. 更新本文档与 [模块索引](../模块索引.md)。
## 验证
- 生成器执行无 Error。
- 受影响程序集编译通过。
- 运行时 `LoadAllXlsx` 回调正常触发。
- 关键表(如 `EntityConfig``SkillGroup`)按主键读取结果正确。
## 当前状态
- 待验证
--- ---

View File

@@ -96,9 +96,11 @@ UI 任务必须先从 [UnityAI README](../../../../README.md) 进入 UI 文档
新增 MCP tool 时同步更新: 新增 MCP tool 时同步更新:
- `Tools/CodexUnityMcp/src/server.mjs` - [ ] `Tools/CodexUnityMcp/src/server.mjs`
- Unity Bridge 对应命令 - [ ] Unity Bridge 对应命令
- 本文档工具列表和验证步骤 - [ ] 本文档工具列表和验证步骤
- [ ] 对应测试用例或示例调用
- [ ] Bridge 白名单(如适用)
Bridge 返回统一结构: Bridge 返回统一结构:

View File

@@ -93,11 +93,22 @@ WSSession.ReceiveMessages(PacketType.Data)
## 协议变更清单 ## 协议变更清单
1. 修改 `.proto``msg.proto` 1. 修改 `.proto``msg.proto`
2. 登记 msgId / route。 2. 登记 msgId / route(如 `route.txt` 或对应生成配置)
3. 重新生成 C# 代码。 3. 通过生成器重新生成 C# 代码`Assets/Game/GameHFScripte/CopyToHF/Network/`
4. 检查 `HFNetWorkMsgIdMap.cs` / `HFWebSocket_Manager_AutoMsgMap.cs` 4. 检查 `HFNetWorkMsgIdMap.cs` / `HFWebSocket_Manager_AutoMsgMap.cs` 是否同步
5. 更新业务入口和监听。 5. 更新业务入口和监听。
6. 验证 6. 编译 `GameHF` 并运行连接/收发测试
## 验证
- 构建 `GameHF.csproj`
- 在支持服务器的运行环境中登录、收发 C2S/S2C 消息。
- 确认 `HFEvent_STC_*` 正确派发并在 `OnClose` 时移除监听。
- 验证错误码事件 `HFEvent_ErrorCode` 触发路径。
## 当前状态
- 待验证
--- ---

View File

@@ -50,4 +50,15 @@ TODO入口 -> 处理 -> 输出
| [模块登记规则](../rules/30-模块登记规则.md) | 文档分类和结构 | | [模块登记规则](../rules/30-模块登记规则.md) | 文档分类和结构 |
| [架构说明](../rules/10-架构说明.md) | 代码分层和依赖方向 | | [架构说明](../rules/10-架构说明.md) | 代码分层和依赖方向 |
轻量模块只保留 README。公共 API 较多时增加 `使用指南.md``开发指南.md`,特殊限制较多时增加 `注意事项.md`;一次性任务文档规则见 [工作流清单](../rules/40-工作流清单.md)。 ## 文档结构
- 轻量模块只保留 README。
- 公共 API 较多时增加 `使用指南.md``开发指南.md`,具体判断标准见 [模块登记规则](../rules/30-模块登记规则.md)。
- 特殊限制较多时增加 `注意事项.md`;一次性任务文档规则见 [工作流清单](../rules/40-工作流清单.md)。
### README 与使用指南的分工
| 文档 | 内容 |
|---|---|
| `README.md` | 模块定位、核心组成、使用规则、边界、导航链接 |
| `使用指南.md` | 详细 API、调用示例、数据流、架构图、最佳实践、边界场景 |

View File

@@ -25,6 +25,18 @@
- 模块发生大改时,讨论保留在对话中;实现后的稳定结论直接更新现有文档。 - 模块发生大改时,讨论保留在对话中;实现后的稳定结论直接更新现有文档。
- 模块新增、删除、重命名或状态变化时更新模块索引。 - 模块新增、删除、重命名或状态变化时更新模块索引。
### 量化标准
| 维度 | 使用一个 README | 增加使用/开发指南 | 增加注意事项 |
|---|---|---|---|
| 核心类/接口数 | ≤3 个 | ≥5 个公共方法或 ≥3 个配置项 | — |
| 状态机/生命周期复杂度 | 无复杂状态机 | 存在多阶段调用顺序 | — |
| 公共 API 数量 | ≤5 个 | >5 个 | — |
| 必须遵守的禁忌/性能约束 | ≤1 条 | — | ≥2 条 |
| 典型使用示例必要性 | 一句话可描述 | 需要完整调用链示例 | 存在特殊边界场景 |
`README.md` 只保留模块定位、核心组成、使用规则和导航链接;具体 API、调用链、架构图、最佳实践写入 `使用指南.md``开发指南.md`
## 登记规则 ## 登记规则
- 框架模块放入 `modules/frameworks/` - 框架模块放入 `modules/frameworks/`