docs: 全项目架构审查与文档体系重写
- 全项目逐文件审查: 4 份审计报告(shared/core-business/management/new-modules) - 重写 004 架构影响地图: 图优先 + 模块依赖图 + 数据流 + 调用链 + 问题分级 - 更新 005 结构化数据: 新增 architectureOverview/moduleDependencyGraph/knownIssues/dbTables 节点 - 更新 006 功能清单: 143 项功能标注实现状态, P0 覆盖率 80%->92% - 更新 007 差距审计: v2->v3, P0 完成 69%->84%, 新增架构技术债章节 - 更新 001 项目概览: 6 角色/54 权限/26 模块/54 表 - 新增 docs/README.md 文档索引 - 归档 11 份过时文档(002x2/003/designx8) 标注 - 更新 work_log
This commit is contained in:
@@ -2,6 +2,54 @@
|
||||
|
||||
## 2026-06-17
|
||||
|
||||
### 架构全面审查与文档重构
|
||||
|
||||
#### 问题背景
|
||||
用户反馈:架构文档阅读后仍无法理解各模块、函数关系,说明文档质量不足或代码耦合度过高。006/007 及其他文档长期未更新。
|
||||
|
||||
#### 完成工作
|
||||
|
||||
##### 1. 全项目逐文件审查(4 份审查报告)
|
||||
- `docs/architecture/audit/shared-audit.md` - shared 基础设施层(69 文件,15 问题)
|
||||
- `docs/architecture/audit/core-business-audit.md` - 核心业务模块(exams/homework/questions/textbooks/grades)
|
||||
- `docs/architecture/audit/management-modules-audit.md` - 管理模块(school/classes/scheduling/attendance/users/audit/course-plans/announcements)
|
||||
- `docs/architecture/audit/new-and-other-modules-audit.md` - 新增模块和其他模块(elective/proctoring/diagnostic/notifications/dashboard/messaging/parent/settings/files/auth/layout/student)
|
||||
- `docs/architecture/audit/00_summary.md` - 汇总报告
|
||||
|
||||
##### 2. 发现的关键问题
|
||||
**P0 严重问题(6 项)**:
|
||||
1. `classes/data-access.ts` 2104 行,超硬上限 2.1 倍,混入 homework/scheduling/grades 逻辑
|
||||
2. `homework/data-access.ts` 1038 行,超硬上限,混入排名计算
|
||||
3. `shared/lib` ↔ `auth` 循环依赖
|
||||
4. `dashboard/data-access.ts` 直查 11 张跨模块表
|
||||
5. `messaging` 绕过 `notifications` 直接写通知
|
||||
6. `classSchedule` 表三处写入口(数据完整性风险)
|
||||
|
||||
**P1 较严重问题(6 项)**:
|
||||
- 跨模块直接 DB 查询普遍存在(classes 被 8+ 处直接查询)
|
||||
- actions 层混入数据访问逻辑
|
||||
- auth.ts 混合 5 类职责
|
||||
- users/import-export.ts 四重职责
|
||||
- proctoring/exam-mode-config.tsx 死代码
|
||||
- notifications 反向依赖 messaging
|
||||
|
||||
##### 3. 重写架构文档(5 份)
|
||||
- **004 架构影响地图**:从"罗列函数签名"重构为"图优先 + 结构化",含分层架构图、模块依赖关系图(标注合理/违规/循环依赖)、数据流向图、核心调用链路、26 个模块清单、P0/P1/P2 问题分级与解耦建议
|
||||
- **005 架构数据 JSON**:新增 architectureOverview、moduleDependencyGraph(25 节点 37 边)、knownIssues(12 问题)、dbTables(54 表按业务域分组)节点;补全 permissions(52→54)、apiRoutes(10→11)
|
||||
- **006 功能清单**:添加"当前实现状态"列,143 个功能项标注 ✅/⚠️/❌,P0 覆盖率 80%→92%
|
||||
- **007 差距审计报告**:v2→v3,总体完成度 P0 69%→84%,P2 路线图 8/14=57%,新增架构技术债章节
|
||||
- **001 项目概览**:更新为 6 角色/54 权限/26 模块/54 表,新增架构原则和项目状态章节
|
||||
|
||||
##### 4. 文档治理
|
||||
- 创建 `docs/README.md` 文档索引(架构/审查/专题/归档分类)
|
||||
- 11 个过时文档添加"已归档"标注(002×2/003/设计文档×8)
|
||||
- 所有文档保持活跃维护与归档分离
|
||||
|
||||
#### 验证
|
||||
- 待验证 lint + tsc
|
||||
|
||||
---
|
||||
|
||||
### P2 质量保障类实现(5 项全部完成)
|
||||
|
||||
#### 1. 屏幕阅读器兼容性增强(a11y)
|
||||
|
||||
Reference in New Issue
Block a user