本文档提供OSPAY项目文档的目录结构和导航指南。
| 目录 | 子目录 | 用途说明 |
|---|---|---|
| 1. Development/ | 开发相关文档和代码规范 | |
| database/ | 数据库相关文档，包括数据库设计、表结构、索引设计等 | |
| guides/ | 开发指南文档，包括编码规范、开发流程、最佳实践等 | |
| api/ | API接口文档，包括接口定义、参数说明、返回值等 | |
| frontend/ | 前端开发文档，包括组件库、状态管理、路由等 | |
| backend/ | 后端开发文档，包括模块划分、中间件使用等 | |
| 2. Deployment/ | 部署相关文档 | |
| environments/ | 各环境(开发、测试、生产)的部署配置说明 | |
| docker/ | Docker容器化部署文档 | |
| monitoring/ | 系统监控和告警配置文档 | |
| maintenance/ | 系统维护和运维指南 | |
| 3. Design/ | 系统设计文档 | |
| architecture/ | 系统架构设计，包括技术栈选择、模块划分等 | |
| ui-ux/ | UI/UX设计文档，包括界面原型、交互设计等 | |
| database/ | 数据库设计文档，包括ER图、数据流图等 | |
| security/ | 安全设计文档，包括认证授权、数据加密等 | |
| 4. Meetings/ | 会议记录和文档 | |
| sprint-planning/ | 迭代计划会议记录 | |
| retrospectives/ | 回顾会议记录 | |
| design-reviews/ | 设计评审会议记录 | |
| decisions/ | 重要决策记录和依据 | |
| 5. References/ | 参考资料 | |
| research/ | 研究论文和技术报告 | |
| standards/ | 行业标准和规范 | |
| third-party/ | 第三方API和服务文档 | |
| benchmarks/ | 性能基准和对比分析 | |
| 6. Requirements/ | 需求文档 | |
| functional/ | 功能性需求规格说明 | |
| non-functional/ | 非功能性需求说明(性能、安全、可用性等) | |
| user-stories/ | 用户故事和场景描述 | |
| change-management/ | 需求变更管理流程和记录 | |
| 7. Testing/ | 测试相关文档 | |
| test-plans/ | 测试计划和策略 | |
| test-cases/ | 测试用例和场景 | |
| performance/ | 性能测试方案和结果 | |
| security/ | 安全测试方案和结果 | |
| 8. User-guides/ | 用户指南 | |
| admin/ | 管理员使用手册 | |
| end-user/ | 终端用户使用手册 | |
| faq/ | 常见问题解答 | |
| troubleshooting/ | 故障排除指南 |
| 文档目录 | 计划补充文档 | 完成状态 |
|---|---|---|
| development/ | • ✅ 后端代码结构说明 • ✅ API接口规范文档 • ✅ WebSocket通信规范 • ✅ 前端组件开发指南 |
已完成 |
| database/ | • ✅ 数据库ER图 • ✅ 关键表结构说明 • ✅ 数据库查询优化指南 • ✅ Redis缓存使用规范 |
已完成 |
| deployment/ | • ✅ 开发环境搭建指南 • 生产环境部署流程 • Docker容器配置说明 • 系统监控与维护指南 |
待完成 |
| design/ | • ✅ 系统整体架构图 • ✅ 模块交互流程图 • 数据流图 • 安全设计文档 |
部分完成 |
| testing/ | • API测试计划 • 前端UI测试用例 • 性能测试方案 • 安全测试清单 |
待完成 |
| user-guides/ | • 用户操作手册 • 常见问题解答 • 错误代码说明 |
待完成 |
| requirements/ | • 功能需求规格说明 • 非功能性需求说明 • 变更需求管理流程 |
待完成 |
| references/ | • 相关技术标准文档 • 第三方API参考资料 • 行业最佳实践参考 |
待完成 |
[类别]-[主题]-[版本].md，例如：api-用户认证-v1.0.md如有任何关于文档的问题或建议，请联系项目文档管理员。