[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

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