31 lines
1.3 KiB
Markdown
31 lines
1.3 KiB
Markdown
|
# K12Study 架构设计分册
|
||
|
|
## 文档目标
|
||
|
|
本目录用于承载 4.13-7.1 里程碑执行所需的架构设计产物，作为 `docs/architecture.md` 的细化文档集合。
|
||
|
|
|
||
|
|
## 文档清单
|
||
|
|
- `logical-view.md`
|
||
|
|
- 系统逻辑视图、模块边界、主链路。
|
||
|
|
- `er-diagram.md`
|
||
|
|
- 核心业务 ER 关系与跨域数据依赖说明。
|
||
|
|
- `schema-baseline.sql`
|
||
|
|
- 数据与 AI 存储侧的增量 SQL 草案（设计基线）。
|
||
|
|
- `base-services.md`
|
||
|
|
- PG/Redis/知识图谱/向量库基础服务配置方案。
|
||
|
|
- `service-baseline.compose.yaml`
|
||
|
|
- 基础服务编排样例（开发环境基线）。
|
||
|
|
- `api-design.md`
|
||
|
|
- 基础架构 API 与业务功能 API 设计。
|
||
|
|
- `test-plan.md`
|
||
|
|
- 模块测试和项目整体测试计划。
|
||
|
|
- `系统架构.drawio`
|
||
|
|
- 系统分层、角色入口、Java/Python/数据层关系图。
|
||
|
|
- `代码架构.drawio`
|
||
|
|
- 前后端与服务模块、共享契约、基础设施代码架构图。
|
||
|
|
|
||
|
|
## 使用顺序
|
||
|
|
1. 先阅读 `logical-view.md` 明确边界。
|
||
|
|
2. 再阅读 `er-diagram.md` 与 `schema-baseline.sql` 对齐数据模型。
|
||
|
|
3. 按 `base-services.md` 与 `service-baseline.compose.yaml` 准备基础服务。
|
||
|
|
4. 依据 `api-design.md` 先冻结契约，再推进前后端实现。
|
||
|
|
5. 按 `test-plan.md` 执行模块测试与整体测试。
|