Skip to content

技术文档索引

本目录包含项目的所有技术文档,按功能分类组织。

📋 核心文档入口

一站式阅读:下方主设计文档按大厂模板编写,包含完整的项目背景、目标、方案调研、架构设计和关键决策,建议首先阅读此文档

文档描述
project-design-document.md项目设计文档(主文档):背景 → 目标 → 需求 → 方案调研 → 架构设计 → 关键决策 → 性能 → 风险 → 验证
requirements.md需求规格说明书(SRS):详细功能与非功能需求
frontend-api-architecture-interaction.md前端、API、架构交互综合速览
feature-modules.md功能模块化与课程开放策略

文档分类

📐 架构文档

🧩 规格与计划 (已归档)

API 参考

AI 文档(模型与智能能力)

🚀 部署文档

💻 开发文档


快速导航

我想了解...阅读文档
项目整体设计思路和技术选型项目设计文档
系统如何部署运行快速启动
如何调用后端 APIAPI 文档
前端代码结构前端分层架构
功能需求明细需求规格说明

文档维护规范

  • ✅ 所有文档应保持与代码同步更新
  • ✅ 重要变更需要更新相关文档
  • ✅ 遵循 Markdown 格式规范
  • ✅ 主设计文档按大厂模板保持 3-5 页篇幅

相关资源

Released under the MIT License.