Pārlūkot izejas kodu

📝 docs(architecture): 更新架构文档结构和开发指南

- 在architecture.md中添加文档拆分说明和架构文档索引引用
- 更新相关文档链接,反映新的文档结构
- 更新版本历史记录,添加最新修改记录
- 更新测试框架状态,反映已配置的测试基础设施
- 更新开发命令文档,将npm替换为pnpm并添加完整测试命令
- 补充数据库备份和恢复相关命令文档
- 更新安全测试部分,反映已集成的安全测试策略
- 添加测试结构说明,明确单元测试和集成测试目录位置
yourname 2 mēneši atpakaļ
vecāks
revīzija
31a1b3b482

+ 4 - 1
docs/architecture.md

@@ -12,6 +12,8 @@
 
 本文档定义了D8D Starter项目的架构增强方案,基于对现有代码的深度分析。主要目标是将技术实现转化为明确的业务价值主张,同时保持与现有系统的完全兼容。
 
+**注意**: 本项目的详细架构文档已拆分为多个子文档,位于 `docs/architecture/` 目录中。如需查看完整的架构文档结构,请参阅 [架构文档索引](./architecture/index.md)。
+
 ### 文档范围
 全面定义系统增强的架构方法和集成策略
 
@@ -546,7 +548,8 @@ src/server/
 - **增量增强策略**: 最小化风险,最大化现有投资回报
 
 ### 相关文档
-- 现有架构文档: `docs/brownfield-architecture.md`
+- 架构文档: `docs/architecture.md` (本文件)
+- 架构详细文档: `docs/architecture/` (包含组件架构、API设计、技术栈等子文档)
 - 产品需求文档: `docs/prd.md`
 - 测试策略文档: `docs/architecture/testing-strategy.md`
 - API文档: 通过 `/ui` 端点访问

+ 5 - 3
docs/architecture/appendix.md

@@ -6,15 +6,17 @@
 - **增量增强策略**: 最小化风险,最大化现有投资回报
 
 ## 相关文档
-- 现有架构文档: `docs/brownfield-architecture.md`
+- 架构文档: `docs/architecture.md`
+- 架构详细文档: `docs/architecture/` (包含组件架构、API设计、技术栈等子文档)
 - 产品需求文档: `docs/prd.md`
+- 测试策略文档: `docs/architecture/testing-strategy.md`
 - API文档: 通过 `/ui` 端点访问
 
 ## 联系方式
 - 架构师: Winston 🏗️
-- 最后更新: 2025-09-14
+- 最后更新: 2025-09-20
 
 ---
 
 **文档状态**: 正式版
-**下次评审**: 2025-10-14
+**下次评审**: 2025-12-20

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

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

+ 4 - 4
docs/architecture/coding-standards.md

@@ -2,12 +2,12 @@
 
 ## 现有标准合规性
 - **代码风格**: TypeScript严格模式,一致的缩进和命名
-- **linting规则**: 需要配置ESLint/Prettier
-- **测试模式**: 无现有测试框架配置
-- **文档风格**: 代码注释良好,但缺少完整文档
+- **linting规则**: 已配置ESLint,支持TypeScript和React
+- **测试模式**: 完整的测试框架已配置(Vitest + Testing Library + Playwright)
+- **文档风格**: 代码注释良好,测试策略文档完整
 
 ## 增强特定标准
-- **测试框架**: 添加Vitest + Testing Library + hono/testing
+- **测试框架**: 使用Vitest + Testing Library + hono/testing + Playwright
 - **测试位置**: `__tests__` 文件夹与源码并列
 - **覆盖率目标**: 核心业务逻辑 > 80%
 - **测试类型**: 单元测试、集成测试、E2E测试

+ 3 - 0
docs/architecture/introduction.md

@@ -10,3 +10,6 @@
 |------|------|------|------|
 | 2024-09-14 | 1.0 | 初始现有系统分析 | Winston |
 | 2025-09-14 | 2.0 | 增强架构文档 | Winston |
+| 2025-09-19 | 2.1 | 添加数据库定时备份策略 | Winston |
+| 2025-09-19 | 2.2 | 更新测试策略文档引用 | Winston |
+| 2025-09-20 | 2.3 | 根据实际项目结构更新测试架构和共享目录 | Winston |

+ 3 - 3
docs/architecture/security-integration.md

@@ -12,6 +12,6 @@
 - **合规要求**: 遵循OWASP Top 10安全最佳实践
 
 ## 安全测试
-- **现有安全测试**: 无自动化安全测试
-- **新安全测试要求**: 添加安全扫描、渗透测试计划
-- **渗透测试**: 计划季度安全审计
+- **现有安全测试**: 已集成安全测试到测试策略中
+- **安全测试要求**: 包括输入验证测试、认证测试、数据保护测试
+- **渗透测试**: 计划季度安全审计,使用OWASP ZAP等工具

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

@@ -20,6 +20,7 @@ d8d-starter/
 │   │   ├── types/        # TypeScript类型
 │   │   └── utils/        # 工具函数
 │   └── share/            # 前后端共享代码
+│       └── types.ts      # TypeScript类型定义
 ```
 
 ## 新文件组织
@@ -46,9 +47,11 @@ d8d-starter/
 │   │       ├── generic-crud.routes.ts
 │   │       └── errorHandler.ts         # 需要增强的错误处理
 │   └── share/            # 现有结构保持不变
+│       └── types.ts      # TypeScript类型定义
 ```
 
 ## 集成指南
 - **文件命名**: 保持现有kebab-case命名约定
 - **文件夹组织**: 遵循功能模块划分,添加__tests__文件夹
+- **测试结构**: 单元测试位于`__tests__/`目录,集成测试位于`__integration_tests__/`目录
 - **导入/导出模式**: 使用ES模块,保持现有别名系统(@/)

+ 3 - 0
docs/architecture/version-info.md

@@ -2,3 +2,6 @@
 | 版本 | 日期 | 描述 | 作者 |
 |------|------|------|------|
 | 2.0 | 2025-09-14 | 增强架构文档 | Winston |
+| 2.1 | 2025-09-19 | 添加数据库定时备份策略 | Winston |
+| 2.2 | 2025-09-19 | 更新测试策略文档引用 | Winston |
+| 2.3 | 2025-09-20 | 根据实际项目结构更新测试架构和共享目录 | Winston |

+ 27 - 12
docs/development.md

@@ -4,6 +4,7 @@
 | 版本 | 日期 | 描述 | 作者 |
 |------|------|------|------|
 | 1.0 | 2025-09-15 | 初始开发指南 | Sarah (PO) |
+| 1.1 | 2025-09-20 | 更新为pnpm命令,添加完整测试命令 | Claude |
 
 ## 1. 环境要求
 
@@ -149,24 +150,38 @@ src/
 ### 4.2 常用开发命令
 ```bash
 # 开发命令
-npm run dev          # 启动完整开发环境
-npm run dev:client   # 仅启动前端
-npm run dev:server   # 仅启动后端
+pnpm dev             # 启动完整开发环境(前后端同时运行)
+
+# 测试命令
+pnpm test            # 运行API测试 (Vitest)
+pnpm test:api        # 运行API测试
+pnpm test:components # 运行组件测试
+pnpm test:integration # 运行集成测试
+pnpm test:e2e        # 运行E2E测试
+pnpm test:e2e:chromium # 运行Chrome E2E测试
+pnpm test:e2e:ui     # 运行E2E测试UI模式
+pnpm test:e2e:debug  # 运行E2E调试模式
 
 # 构建命令
-npm run build        # 生产构建
-npm run build:client # 仅构建前端
-npm run build:server # 仅构建后端
+pnpm build           # 生产构建
+pnpm build:client    # 仅构建前端
+pnpm build:server    # 仅构建后端
 
 # 数据库命令
-npm run db:migrate   # 运行数据库迁移
-npm run db:seed      # 填充种子数据
-npm run db:reset     # 重置数据库
+pnpm db:migrate      # 运行数据库迁移
+pnpm db:seed         # 填充种子数据
+pnpm db:reset        # 重置数据库
+pnpm db:backup       # 数据库备份
+pnpm db:restore      # 数据库恢复
+pnpm db:backup:list  # 列出备份文件
+pnpm db:backup:latest # 获取最新备份
+pnpm db:backup:cleanup # 清理旧备份
 
 # 代码质量
-npm run lint         # 代码检查
-npm run lint:fix     # 自动修复
-npm run typecheck    # 类型检查
+pnpm lint            # ESLint检查
+pnpm lint:fix        # 自动修复ESLint问题
+pnpm typecheck       # TypeScript类型检查
+pnpm test:coverage   # 生成测试覆盖率报告
 ```
 
 ### 4.3 热重载和调试