- 作用： 识别项目中的潜在风险，并制定应对措施。
- 内容：
- 使用场景： 项目启动和规划阶段。
- 作用： 统一团队的开发风格和流程，提高代码质量和可维护性。
- 内容：
- 代码风格（命名规范、缩进规则）
- Git 提交规范（提交信息格式）
- 代码审查流程
- 使用场景： 开发阶段，作为团队协作的参考。
- 作用： 描述项目的当前进度、存在的问题和下一步计划，便于项目管理和沟通。
- 内容：
- 当前进度（完成的任务、未完成的任务）
- 存在的问题（风险、挑战）
- 下一步计划（任务分配、时间节点）
- 使用场景： 项目各个阶段的进度汇报。
- 作用： 明确项目的功能需求、非功能需求和用户需求，为开发团队提供明确的目标。
- 内容：
- 项目背景和目标
- 功能需求（用户故事、用例）
- 非功能需求（性能、安全性、兼容性等）
- 使用场景： 项目启动阶段，需求分析和评审。
- 作用： 描述系统的整体架构、模块设计和数据流程，指导开发人员实现系统。
- 内容：
- 系统架构图
- 模块设计（功能模块、接口设计）
- 数据库设计（ER 图、表结构）
- 使用场景： 开发阶段，作为开发人员的参考依据。
- 作用： 描述系统对外提供的 API 接口及其使用方法，方便前后端开发和联调。
- 内容：
- 接口 URL、请求方法、参数说明
- 请求示例和响应示例
- 错误码和异常处理
- 使用场景： 前后端开发、联调和测试阶段。
- 作用： 描述测试计划、测试用例和测试结果，确保系统功能符合需求。
- 内容：
- 测试计划（测试范围、测试工具）
- 测试用例（输入、预期输出）
- 测试报告（测试结果、缺陷记录）
- 使用场景： 测试阶段，用于功能测试、性能测试和回归测试。
- 作用： 描述系统的部署流程和环境配置，确保系统能够正确部署和运行。
- 内容：
- 环境要求（操作系统、数据库、依赖库）
- 部署步骤（安装、配置、启动）
- 常见问题及解决方案
- 使用场景： 系统上线和运维阶段。
- 作用： 指导最终用户如何使用系统，降低用户学习成本。
- 内容：
- 使用场景： 系统交付和用户培训阶段。
- 作用： 指导运维人员如何维护和监控系统，确保系统稳定运行。
- 内容：
- 系统监控（监控指标、报警规则）
- 日常维护（日志清理、备份策略）
- 故障处理（常见故障及解决方案）
- 使用场景： 系统上线后的运维阶段。
