Przeglądaj źródła

📝 docs(architecture): update documentation with new sections and details

- 在相关文档部分添加开发工作流和编码标准文档链接
- 细化测试覆盖描述,明确包含单元测试、集成测试和E2E测试
- 添加性能监控指标章节,包括应用性能、数据库性能和缓存性能等指标
- 新增安全监控和响应章节,描述实时监控、安全事件响应等内容
- 完善测试位置说明,明确前后端及工具测试的目录结构
- 将PostgreSQL版本更新为17,反映当前使用的数据库版本
yourname 2 miesięcy temu
rodzic
commit
e4fbfc1e48

+ 3 - 1
docs/architecture/appendix.md

@@ -7,10 +7,12 @@
 
 ## 相关文档
 - 架构文档: `docs/architecture.md`
-- 架构详细文档: `docs/architecture/` (包含组件架构、API设计、技术栈等子文档)
+- 架构详细文档: `docs/architecture/` (包含组件架构、API设计、技术栈、安全架构、监控策略等子文档)
 - 产品需求文档: `docs/prd.md`
 - 测试策略文档: `docs/architecture/testing-strategy.md`
 - API文档: 通过 `/ui` 端点访问
+- 开发工作流: `docs/architecture/development-workflow.md`
+- 编码标准: `docs/architecture/coding-standards.md`
 
 ## 联系方式
 - 架构师: Winston 🏗️

+ 1 - 1
docs/architecture/checklist-results.md

@@ -5,7 +5,7 @@
 ✅ **架构模式**: 分层架构、模块化设计验证通过
 ✅ **代码质量**: 类型安全、错误处理需要增强
 ✅ **安全性**: 基础安全措施存在,需要加强
-✅ **测试覆盖**: 完整的测试基础设施已配置(Vitest + Testing Library + Playwright)
+✅ **测试覆盖**: 完整的测试基础设施已建立(Vitest + Testing Library + Playwright),包含单元测试、集成测试、E2E测试
 ✅ **部署策略**: Docker部署成熟稳定
 ✅ **备份策略**: 数据库定时备份方案已设计
 

+ 13 - 1
docs/architecture/operations-monitoring.md

@@ -58,4 +58,16 @@ interface ApiError {
 - **全局错误处理**: 统一错误处理中间件
 - **数据库错误**: 连接池管理和重试机制
 - **外部服务错误**: 熔断器和降级处理
-- **日志记录**: 所有错误记录详细上下文信息
+- **日志记录**: 所有错误记录详细上下文信息
+
+### 性能监控指标
+- **应用性能指标**: 请求响应时间(p50, p95, p99)、错误率、吞吐量
+- **数据库性能**: 查询执行时间、连接池使用率、锁等待时间
+- **缓存性能**: Redis命中率、内存使用率、响应时间
+- **基础设施**: CPU使用率、内存使用率、磁盘IO、网络带宽
+
+### 业务监控指标
+- **用户活跃度**: 日活用户(DAU)、月活用户(MAU)、用户留存率
+- **API使用统计**: 各端点调用频率、成功率、平均响应时间
+- **功能使用**: 关键功能使用率、用户行为漏斗分析
+- **业务健康度**: 订单成功率、支付成功率、用户满意度

+ 6 - 0
docs/architecture/security-integration.md

@@ -47,3 +47,9 @@
 - **现有安全测试**: 已集成安全测试到测试策略中
 - **安全测试要求**: 包括输入验证测试、认证测试、数据保护测试
 - **渗透测试**: 计划季度安全审计,使用OWASP ZAP等工具
+
+### 安全监控和响应
+- **实时监控**: 监控异常登录尝试、API滥用、数据泄露迹象
+- **安全事件响应**: 建立安全事件响应流程,30分钟内响应关键安全事件
+- **漏洞管理**: 定期安全扫描,关键漏洞24小时内修复
+- **合规审计**: 季度安全合规审计,确保符合行业安全标准

+ 3 - 0
docs/architecture/source-tree.md

@@ -78,3 +78,6 @@ d8d-starter/
 - **文件夹组织**: 遵循功能模块划分,添加__tests__文件夹
 - **测试结构**: 单元测试位于`__tests__/`目录,集成测试位于`__integration_tests__/`目录
 - **导入/导出模式**: 使用ES模块,保持现有别名系统(@/)
+- **测试位置**: 前端集成测试位于`__integration_tests__/`,页面单元测试位于`__tests__/`
+- **后端测试**: API测试位于路由`__tests__/`目录,服务测试位于模块`__tests__/`目录
+- **工具测试**: 通用工具测试位于`utils/__tests__/`目录

+ 1 - 1
docs/architecture/tech-stack.md

@@ -7,7 +7,7 @@
 | 框架 | Hono | 4.8.5 | Web框架和API路由 | RPC类型安全 |
 | 前端框架 | React | 19.1.0 | 用户界面构建 | 最新版本 |
 | 构建工具 | Vite | 7.0.0 | 开发服务器和构建 | 热重载支持 |
-| 数据库 | PostgreSQL | 15 | 数据持久化存储 | 通过TypeORM |
+| 数据库 | PostgreSQL | 17 | 数据持久化存储 | 通过TypeORM |
 | ORM | TypeORM | 0.3.25 | 数据库操作抽象 | 实体管理 |
 | 样式 | Tailwind CSS | 4.1.11 | 原子化CSS框架 | 设计一致性 |
 | 状态管理 | React Query | 5.83.0 | 服务端状态管理 | 数据同步 |