02dc1093fb
- 新增 docs/standards/coding-standards.md 编码规范文档(16 章节) - 适配当前项目: 单应用+模块化架构(非 Monorepo) - 保留 data-access.ts 模式(非 services/) - 使用 proxy.ts(Next.js 16 重命名) - 保留企业级行数规范(组件 500/800, Actions 800/1000) - 保留 Tailwind v4 CSS 变量设计令牌 - 保留 ActionState<T> 类型 - 含"与原规范的差异说明"附录(10 项差异及原因) - 更新 .trae/rules/project_rules.md: - 新增编码规范章节, 引用 coding-standards.md - 新增架构分层/模块结构/TS规则/命名/组件/Action/Tailwind/安全/提交规范 - 架构文档清单新增解耦路线图 - 新增 .prettierrc 配置(匹配现有代码风格: 双引号/无分号/2空格) - 更新 docs/README.md 新增编码规范章节 - 更新 work_log
96 lines
5.0 KiB
Markdown
96 lines
5.0 KiB
Markdown
# 文档索引
|
||
|
||
> Next_Edu 项目文档总索引。按用途分类，标注维护状态。
|
||
> 活跃文档随代码同步维护；已归档文档仅保留历史参考。
|
||
|
||
---
|
||
|
||
## 架构文档（活跃维护）
|
||
|
||
| 文档 | 用途 |
|
||
|------|------|
|
||
| [001 项目概览](architecture/001_project_overview.md) | 项目入口概览：技术栈、角色权限、模块、数据库、路由、架构原则、项目状态 |
|
||
| [004 架构影响地图](architecture/004_architecture_impact_map.md) | 全模块·全函数·全参数级别架构图（人类可读） |
|
||
| [005 架构数据](architecture/005_architecture_data.json) | AI 友好的结构化架构数据（JSON） |
|
||
| [006 功能清单](architecture/006_k12_feature_checklist.md) | 企业级 K12 标准功能模块清单（P0/P1/P2 优先级） |
|
||
| [007 差距审计报告](architecture/007_gap_audit_report.md) | 功能差距审计与补齐路线图 |
|
||
|
||
## 架构审查报告
|
||
|
||
| 文档 | 用途 |
|
||
|------|------|
|
||
| [审查汇总](architecture/audit/00_summary.md) | 全项目架构审查汇总报告 |
|
||
| [解耦路线图](architecture/audit/01_decoupling_roadmap.md) | 过耦合问题清单与解耦执行计划（P0/P1/P2 优先级） |
|
||
| [shared 层审查](architecture/audit/shared-audit.md) | 共享基础设施层审查 |
|
||
| [核心业务模块审查](architecture/audit/core-business-audit.md) | exams/homework/questions/textbooks 等核心模块审查 |
|
||
| [管理模块群审查](architecture/audit/management-modules-audit.md) | school/classes/users/audit 等管理模块审查 |
|
||
| [新增模块和其他模块审查](architecture/audit/new-and-other-modules-audit.md) | diagnostic/elective/proctoring/notifications 等新增模块审查 |
|
||
|
||
## 编码规范
|
||
|
||
| 文档 | 用途 |
|
||
|------|------|
|
||
| [编码规范](standards/coding-standards.md) | 适配当前项目的企业级编码规范（TypeScript/React/Next.js/Tailwind/安全/测试/CI） |
|
||
| [项目规则](../.trae/rules/project_rules.md) | AI 助手项目规则（架构图优先 + 核心强制规则） |
|
||
|
||
## 专题文档（活跃维护）
|
||
|
||
| 文档 | 用途 |
|
||
|------|------|
|
||
| [无障碍审计](accessibility/a11y-audit.md) | WCAG 2.1 AA 合规审计报告 |
|
||
| [视觉回归测试](testing/visual-regression.md) | Playwright 视觉回归测试方案 |
|
||
| [通知渠道](notifications/channels.md) | 多渠道通知（站内/短信/微信/邮件）集成文档 |
|
||
| [安全扫描](security/scanning.md) | 依赖审计/Snyk/Trivy/OWASP ZAP 安全扫描指南 |
|
||
| [灾备计划](dr/dr-plan.md) | 灾难恢复计划（RTO/RPO 目标） |
|
||
| [灾备操作手册](dr/dr-runbook.md) | 生产环境故障处理操作手册 |
|
||
| [数据库 Schema 变更日志](db/schema-changelog.md) | 数据库迁移变更记录 |
|
||
|
||
## 工作日志
|
||
|
||
| 文档 | 用途 |
|
||
|------|------|
|
||
| [工作日志](work_log.md) | 项目开发进度日志 |
|
||
|
||
## 脚本
|
||
|
||
| 文档 | 用途 |
|
||
|------|------|
|
||
| [考试种子数据脚本](scripts/seed-exams.ts) | 考试模块测试数据生成脚本 |
|
||
|
||
---
|
||
|
||
## 已归档文档
|
||
|
||
> 以下文档记录的是历史阶段的设计/实现/分析，当前已由架构文档（004/005/006/007）取代。
|
||
> 保留用于历史参考，不再维护。
|
||
|
||
### 架构历史文档
|
||
|
||
| 文档 | 归档原因 |
|
||
|------|---------|
|
||
| [002 RBAC 重构方案](architecture/002_rbac_refactoring.md) | 描述修复前的安全隐患，当前所有 Server Action 已接入 `requirePermission()` |
|
||
| [002 角色路由 RFC](architecture/002_role_based_routing.md) | 2025-12-23 提案，当前角色域路由已全部实现 |
|
||
| [003 UI 重构计划](architecture/003_ui_refactoring_plan.md) | 2026-06-16 重构计划，当前已执行完毕 |
|
||
|
||
### 设计历史文档
|
||
|
||
| 文档 | 归档原因 |
|
||
|------|---------|
|
||
| [002 教师仪表盘实现](design/002_teacher_dashboard_implementation.md) | 2025-12-23 实现记录，已由 004 dashboard 模块章节取代 |
|
||
| [003 教材模块实现](design/003_textbooks_module_implementation.md) | 2025-12-23 实现记录，已由 004 textbooks 模块章节取代 |
|
||
| [004 题库模块实现](design/004_question_bank_implementation.md) | 2025-12-23 实现记录，已由 004 questions 模块章节取代 |
|
||
| [005 考试模块实现](design/005_exam_module_implementation.md) | 考试模块实现设计，已由 004 exams 模块章节取代 |
|
||
| [006 作业模块实现](design/006_homework_module_implementation.md) | 2025-12-31 实现记录，已由 004 homework 模块章节取代 |
|
||
| [008 教师页面实现](design/008_teacher_pages_implementation.md) | 2026-03-03 页面分析，路由已大幅扩展 |
|
||
| [009 功能差距分析](design/009_feature_gap_analysis.md) | 2026-03-03 功能对比，已由 007 差距审计报告取代 |
|
||
| [010 QA 测试计划](design/010_qa_test_plan_and_feedback.md) | 2026-03-18 测试方案，测试体系已演进 |
|
||
|
||
---
|
||
|
||
## 文档维护规则
|
||
|
||
1. **改码必同步图**：源码修改后须同步更新 004/005 架构文档
|
||
2. **归档不删除**：过时文档添加归档标注，不删除
|
||
3. **活跃文档**：001/004/005/006/007 + 专题文档随代码同步维护
|
||
4. **新增文档**：新增文档须在本索引中登记
|