Files
NextEdu/docs
SpecialX 1fe30984b6 refactor(announcements,messaging,notifications): V1+V2 审计重构 — i18n 命名空间独立 + 通知标题 i18n 化 + 服务端过滤 + 编排下沉 + 表单错误展示 + 架构图同步
V1 改进(已完成):
- P0-4/P1-4/P1-5: 通知组件和 CRUD Action 从 messaging 迁移至 notifications 模块
- P1-5: 新增 getMessagesPageData / getAdminAnnouncementsPageData 编排函数
- P1-6: announcements schema 添加 superRefine 条件校验
- P1-7: 新增 useMessageSearch hook(防抖 + 请求竞态取消)+ 客户端分页 UI
- P1-9: deleteMessage 事务化
- P2-11: 全模块 trackEvent 埋点
- 全模块 i18n 接入 + Error Boundary + a11y 改进

V2 改进(本次完成):
- V2-P0-1: 通知 i18n 命名空间独立(notifications.json),useTranslations 从 "messages" 切换到 "notifications"
- V2-P0-2: 公告/消息通知标题 i18n 化,Server Action 中使用 getTranslations 生成通知标题
- V2-P1-1: AnnouncementList 纯服务端过滤,移除客户端 useState/useMemo
- V2-P1-2: MessageList 客户端过滤仅在初始数据时执行,搜索结果由服务端按 tab 过滤
- V2-P1-3: 消息详情页编排下沉,新增 getMessageDetailPageData 编排函数
- V2-P1-4: 表单服务端校验错误展示(fieldErrors + aria-invalid)
- V2-P2-1: 轮询间隔常量化(POLL_INTERVAL_MS)
- V2-P2-2: 架构图同步(004 + 005)
2026-06-22 18:43:12 +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. 新增文档:新增文档须在本索引中登记