Files
NextEdu/docs
SpecialX a3dc22cb9e refactor(classes): 客户端组件迁移至 useQuery + queryKeys 示范
Task 19: 将 class-invitation-manager.tsx 从 initialCodes prop + 本地 codes state +
手动 Action 调用 + 手动 state 更新模式,迁移至 V5 缓存策略新 API:

- 列表查询: useActionQuery + queryKeys.classes.invitations(classId)
- 撤销 mutation: useActionMutation + actionId "classes.invitation.revoke"
  (成功后由 CLIENT_INVALIDATION_MAP 自动失效 ["classes", "invitations"] 前缀)
- 生成回调: queryClient.invalidateQueries 手动失效本班级 invitations 查询
- 移除 initialCodes prop + codes state + isSubmitting 手动管理

配套改动:
- actions-invitations.ts: 新增并导出 ClassInvitationCodeOption 强类型接口,
  listClassInvitationCodesAction 返回类型从 Array<Record<string, unknown>>
  收窄为 ClassInvitationCodeOption[]
- actions.ts barrel: 补充 type ClassInvitationCodeOption 与遗漏的
  bulkEnrollStudentsAction / bulkAssignSubjectTeachersAction 导出
- 架构文档 004/005 同步更新 hook 消费方与 actions.ts exports 清单
2026-07-05 18:57:10 +08:00
..

文档索引

Next_Edu 项目文档总索引。按用途分类,标注维护状态。 活跃文档随代码同步维护;已归档文档仅保留历史参考。


架构文档(活跃维护)

文档 用途
001 项目概览 项目入口概览:技术栈、角色权限、模块、数据库、路由、架构原则、项目状态
004 架构影响地图 全模块·全函数·全参数级别架构图(人类可读)
005 架构数据 AI 友好的结构化架构数据JSON
006 功能清单 企业级 K12 标准功能模块清单P0/P1/P2 优先级)
007 差距审计报告 功能差距审计与补齐路线图

架构审查报告

文档 用途
审查汇总 全项目架构审查汇总报告
解耦路线图 过耦合问题清单与解耦执行计划P0/P1/P2 优先级)
shared 层审查 共享基础设施层审查
核心业务模块审查 exams/homework/questions/textbooks 等核心模块审查
管理模块群审查 school/classes/users/audit 等管理模块审查
新增模块和其他模块审查 diagnostic/elective/proctoring/notifications 等新增模块审查

编码规范

文档 用途
编码规范 适配当前项目的企业级编码规范TypeScript/React/Next.js/Tailwind/安全/测试/CI
项目规则 AI 助手项目规则(架构图优先 + 核心强制规则)

专题文档(活跃维护)

文档 用途
无障碍审计 WCAG 2.1 AA 合规审计报告
视觉回归测试 Playwright 视觉回归测试方案
通知渠道 多渠道通知(站内/短信/微信/邮件)集成文档
安全扫描 依赖审计/Snyk/Trivy/OWASP ZAP 安全扫描指南
灾备计划 灾难恢复计划RTO/RPO 目标)
灾备操作手册 生产环境故障处理操作手册
数据库 Schema 变更日志 数据库迁移变更记录

工作日志

文档 用途
工作日志 项目开发进度日志

脚本

文档 用途
考试种子数据脚本 考试模块测试数据生成脚本

已归档文档

以下文档记录的是历史阶段的设计/实现/分析当前已由架构文档004/005/006/007取代。 保留用于历史参考,不再维护。

架构历史文档

文档 归档原因
002 RBAC 重构方案 描述修复前的安全隐患,当前所有 Server Action 已接入 requirePermission()
002 角色路由 RFC 2025-12-23 提案,当前角色域路由已全部实现
003 UI 重构计划 2026-06-16 重构计划,当前已执行完毕

设计历史文档

文档 归档原因
002 教师仪表盘实现 2025-12-23 实现记录,已由 004 dashboard 模块章节取代
003 教材模块实现 2025-12-23 实现记录,已由 004 textbooks 模块章节取代
004 题库模块实现 2025-12-23 实现记录,已由 004 questions 模块章节取代
005 考试模块实现 考试模块实现设计,已由 004 exams 模块章节取代
006 作业模块实现 2025-12-31 实现记录,已由 004 homework 模块章节取代
008 教师页面实现 2026-03-03 页面分析,路由已大幅扩展
009 功能差距分析 2026-03-03 功能对比,已由 007 差距审计报告取代
010 QA 测试计划 2026-03-18 测试方案,测试体系已演进

文档维护规则

  1. 改码必同步图:源码修改后须同步更新 004/005 架构文档
  2. 归档不删除:过时文档添加归档标注,不删除
  3. 活跃文档001/004/005/006/007 + 专题文档随代码同步维护
  4. 新增文档:新增文档须在本索引中登记