[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:
@@ -50,4 +50,15 @@ TODO:入口 -> 处理 -> 输出
|
||||
| [模块登记规则](../rules/30-模块登记规则.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、调用示例、数据流、架构图、最佳实践、边界场景 |
|
||||
|
||||
Reference in New Issue
Block a user