附录:模块信息表模板
“模块信息表”是代码库的“导航地图”,它将项目的宏观功能与具体的代码目录和负责人关联起来。这使得无论是人类开发者还是AI,都能快速定位到需要修改或审查的代码,并明确责任人。
在项目初期或重构前,维护这样一份文档,是保障团队高效协作的关键。
模块信息表模板
请根据你的项目实际情况,复制并填写下表。
markdown
# 模块信息表
| 模块名称 | 核心职责 | 关键代码目录/文件 | 负责人 |
| :--- | :--- | :--- | :--- |
| **`[模块名-示例]`** | [该模块负责的核心功能,例如:用户认证与授权] | `src/modules/auth/` | [张三 (BE)] |
| **`[模块名-示例]`** | [例如:前端UI组件库] | `src/components/` | [李四 (FE)] |
| **`[模块名-示例]`** | [例如:数据处理与ETL流程] | `scripts/etl/` | [王五 (DE)] |
| | | | |使用说明
- 模块名称: 使用简洁、有意义的名称,最好与代码库中的目录名或服务名对应。
- 核心职责: 用一句话清晰描述该模块的商业价值或技术目标。
- 关键代码目录/文件: 指向该模块最核心的源代码位置。这为AI提供了最直接的上下文入口。
- 负责人: 明确该模块的主要维护者或开发者。这有助于在代码审查和问题排查时快速找到对的人。