94 lines
3.3 KiB
Markdown
94 lines
3.3 KiB
Markdown
# docs/pid.md 文档更新说明
|
||
|
||
## 更新时间
|
||
2026-01-25
|
||
|
||
## 更新内容
|
||
|
||
### 1. 更新了第3.2节 - 项目目录结构
|
||
|
||
**更新前**: 使用传统的Flask项目结构（app目录）
|
||
**更新后**: 采用新的团队协作目录结构
|
||
|
||
**变更说明**:
|
||
- 后端结构从 `backend/app/` 更新为 `backend/src/`，包含更清晰的分层架构（controllers, services, models, routes, middleware, utils）
|
||
- 前端结构从基本的React项目结构更新为包含types、hooks、styles等子目录的现代React项目结构
|
||
- 新增了 `testing/` 目录，包含testcases、reports、data、scripts、docs等子目录
|
||
- 为每个工作区添加了WORKSTANDARDS.md和README.md
|
||
|
||
### 2. 新增第3.3节 - 工作目录说明
|
||
|
||
**新增内容**:
|
||
- 后端程序员工作区职责和主要工作
|
||
- 前端程序员工作区职责和主要工作
|
||
- 测试工程师工作区职责和主要工作
|
||
|
||
### 3. 新增第3.4节 - 权限限制
|
||
|
||
**新增内容**:
|
||
- 明确规定各角色只能在指定目录中工作
|
||
- 添加权限控制文档链接
|
||
- 强调跨目录工作需要技术总监批准
|
||
|
||
### 4. 新增第4章 - 团队协作
|
||
|
||
**新增内容**:
|
||
- 4.1 角色职责: 详细说明各角色的工作职责
|
||
- 4.2 工作流程: 包含需求分析、后端开发、前端开发、测试、代码审查五个阶段的详细流程
|
||
- 4.3 代码提交规范: 明确各角色的提交信息格式和类型说明
|
||
- 4.4 文档规范: 说明后端、前端、测试的文档规范
|
||
- 4.5 沟通机制: 说明日常沟通、文档沟通、技术总监审查的方式
|
||
|
||
### 5. 更新章节编号
|
||
|
||
由于新增了第4章"团队协作"，后续章节编号全部+1:
|
||
- 原第4章"数据库设计" → 现第5章
|
||
- 原第5章"API设计" → 现第6章
|
||
- 原第6章"前端设计" → 现第7章
|
||
- 原第7章"安全设计" → 现第8章
|
||
- 原第8章"部署方案" → 现第9章
|
||
- 原第9章"后续优化建议" → 现第10章
|
||
- 原第10章"开发计划" → 现第11章
|
||
|
||
### 6. 新增第12章 - 相关文档
|
||
|
||
**新增内容**:
|
||
- 12.1 团队协作文档链接
|
||
- 12.2 角色工作规范链接
|
||
- 12.3 技术文档链接
|
||
- 12.4 项目文档链接
|
||
|
||
### 7. 更新所有子章节编号
|
||
|
||
所有子章节编号根据父章节编号进行了相应更新:
|
||
- 数据库设计: 4.1-4.2 → 5.1-5.2
|
||
- API设计: 5.1-5.4 → 6.1-6.4
|
||
- 前端设计: 6.1-6.4 → 7.1-7.4
|
||
- 安全设计: 7.1-7.3 → 8.1-8.3
|
||
- 部署方案: 8.1-8.2 → 9.1-9.2
|
||
- 后续优化建议: 9.1-9.3 → 10.1-10.3
|
||
- 开发计划: 10.1-10.3 → 11.1-11.3
|
||
|
||
## 影响范围
|
||
|
||
1. **文档结构**: 文档从10章扩展到12章，新增了团队协作和相关文档两章
|
||
2. **项目架构**: 完全按照当前的项目目录结构更新，与实际的backend/、frontend/、testing/目录保持一致
|
||
3. **角色分工**: 明确了后端程序员、前端程序员、测试工程师的具体职责和工作范围
|
||
4. **协作流程**: 提供了详细的团队协作流程，从前端到后端再到测试的完整工作链
|
||
|
||
## 后续维护
|
||
|
||
- 后端程序员需要在 `backend/docs/api.md` 中维护API文档
|
||
- 前端程序员需要在 `frontend/docs/components.md` 中维护组件文档
|
||
- 测试工程师需要在 `testing/docs/` 中维护测试文档
|
||
- 技术总监负责维护本设计文档 (`docs/pid.md`)
|
||
|
||
## 文档状态
|
||
|
||
✅ 已完成更新，文档与当前项目架构保持一致
|
||
|
||
---
|
||
|
||
**更新人**: 技术总监
|
||
**审核**: 待审核
|