docs: 项目规则新增文档同步流程规范
- 新增「每阶段开始前的文档准备」清单(8 项检查) - 新增「每个 Task 完成后的文档同步」清单(6 项检查) - 补充「每阶段结束时的额外检查」新增集成规范时间戳更新 Made-with: Cursor
This commit is contained in:
@@ -74,12 +74,33 @@ Phase 2c 待实现模块:group(群聊管理)、file(文件上传/MinIO
|
|||||||
4. **交叉引用**:相关文档之间保持引用链接一致(如设计文档引用 API 文档路径)
|
4. **交叉引用**:相关文档之间保持引用链接一致(如设计文档引用 API 文档路径)
|
||||||
5. **日期更新**:文档头部的「最后更新」日期保持最新
|
5. **日期更新**:文档头部的「最后更新」日期保持最新
|
||||||
|
|
||||||
|
### 每阶段(Phase)开始前的文档准备
|
||||||
|
|
||||||
|
- 创建阶段设计文档 `docs/plans/YYYY-MM-DD-phaseXx-design.md`
|
||||||
|
- 创建阶段实施计划 `docs/plans/YYYY-MM-DD-phaseXx-implementation.plan.md`
|
||||||
|
- 更新 `CURRENT_STATUS.md` 的下一阶段规划(含 Task 清单)
|
||||||
|
- 更新 `project-context.mdc` 的当前进度和待实现模块
|
||||||
|
- 更新 `system-architecture.md` 新增模块的状态标记(🔜)
|
||||||
|
- 更新 `echochat-system-design.md` 的分期规划 + 新增 API 列表
|
||||||
|
- 更新 `api/README.md` 新增模块的文档导航
|
||||||
|
- 创建新的功能分支
|
||||||
|
|
||||||
|
### 每个 Task 完成后的文档同步
|
||||||
|
|
||||||
|
- 更新 Task 状态标记(📋 → ✅)
|
||||||
|
- 更新 `CURRENT_STATUS.md` 功能描述和技术细节
|
||||||
|
- 如有新增 API → 更新/创建对应的 `docs/api/{frontend,admin}/*.md`
|
||||||
|
- 如有新增 WS 事件 → 更新 `docs/api/websocket.md`
|
||||||
|
- 如有架构变更 → 更新 `system-architecture.md`
|
||||||
|
- 代码提交前确认所有文档已同步
|
||||||
|
|
||||||
### 每阶段(Phase)结束时的额外检查
|
### 每阶段(Phase)结束时的额外检查
|
||||||
|
|
||||||
- 当前阶段设计文档状态标记为「✅ 已完成」
|
- 当前阶段设计文档状态标记为「✅ 已完成」
|
||||||
- 总体设计文档的开发分期部分更新完成标记
|
- 总体设计文档的开发分期部分更新完成标记
|
||||||
- project-context.mdc 的当前进度更新
|
- project-context.mdc 的当前进度更新
|
||||||
- CURRENT_STATUS.md 的下一阶段规划更新
|
- CURRENT_STATUS.md 的下一阶段规划更新
|
||||||
|
- 前后端集成规范 `docs/conventions/frontend-backend-integration.md` 的最后更新时间
|
||||||
|
|
||||||
## 前后端联动规范(必须遵守)
|
## 前后端联动规范(必须遵守)
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user