技术文档索引
本目录包含项目的所有技术文档,按功能分类组织。
📋 核心文档入口
一站式阅读:下方主设计文档按大厂模板编写,包含完整的项目背景、目标、方案调研、架构设计和关键决策,建议首先阅读此文档。
| 文档 | 描述 |
|---|---|
| ⭐ project-design-document.md | 项目设计文档(主文档):背景 → 目标 → 需求 → 方案调研 → 架构设计 → 关键决策 → 性能 → 风险 → 验证 |
| requirements.md | 需求规格说明书(SRS):详细功能与非功能需求 |
| frontend-api-architecture-interaction.md | 前端、API、架构交互综合速览 |
| feature-modules.md | 功能模块化与课程开放策略 |
文档分类
📐 架构文档
- 项目设计文档 ⭐ 主文档
- 系统架构总览
- 组件设计
- 前端分层架构
- 课程模块门控方案
- API 一致性与组件化改造计划
- Rust 增强 POC 计划(2026-02-11)
- API 模块归属与鉴权矩阵
- Shared Types & SDK 结构草案
- 功能模块化与课程开放策略
🧩 规格与计划 (已归档)
API 参考
AI 文档(模型与智能能力)
- AI 文档索引(写作课试点)
- 参考论文列表(Reading List)
- GraphRAG 用法
- 引导式学习(guided)
- 数据蒸馏(distillation)
- 学习状态分析模块
- 后训练与微调计划
- 训练数据规范
- 工具调用(Tool Calling)
🚀 部署文档
💻 开发文档
快速导航
| 我想了解... | 阅读文档 |
|---|---|
| 项目整体设计思路和技术选型 | 项目设计文档 ⭐ |
| 系统如何部署运行 | 快速启动 |
| 如何调用后端 API | API 文档 |
| 前端代码结构 | 前端分层架构 |
| 功能需求明细 | 需求规格说明 |
文档维护规范
- ✅ 所有文档应保持与代码同步更新
- ✅ 重要变更需要更新相关文档
- ✅ 遵循 Markdown 格式规范
- ✅ 主设计文档按大厂模板保持 3-5 页篇幅