72 lines
2.3 KiB
Markdown
72 lines
2.3 KiB
Markdown
# 模块详细设计文档索引
|
||
|
||
## 1. 设计文档说明
|
||
|
||
本目录存放 Universal Agent Demo Framework V1 的设计文档。需求文档回答“要做什么”，设计文档回答“怎么实现、边界在哪里、如何验证”。
|
||
|
||
文档命名统一使用中文编号，便于复试讲解和按顺序阅读。
|
||
|
||
## 2. 模块设计文档列表
|
||
|
||
| 顺序 | 文档 | 说明 |
|
||
|---|---|---|
|
||
| 0 | `0.设计文档索引.md` | 当前索引 |
|
||
| 1 | `1.智能体总体设计.md` | 智能核心总体链路、配置、输出和 Adapter |
|
||
| 2 | `2.功能流程设计.md` | 复试准备、演示、上传、入库、对话和审计流程 |
|
||
| 3 | `3.数据库设计.md` | Django 数据模型、字段、索引和初始化策略 |
|
||
| 4 | `4.页面与路由设计.md` | 页面结构、URL、跳转和异常状态 |
|
||
| 5 | `5.部署设计.md` | 本地、Docker、环境变量和持久化 |
|
||
|
||
模块详细设计位于 `模块设计/`：
|
||
|
||
| 模块 | 文档 |
|
||
|---|---|
|
||
| 配置 | `模块设计/1.配置模块详细设计.md` |
|
||
| 场景 | `模块设计/2.场景模块详细设计.md` |
|
||
| 文档 | `模块设计/3.文档模块详细设计.md` |
|
||
| 对话 | `模块设计/4.对话模块详细设计.md` |
|
||
| 审计 | `模块设计/5.审计模块详细设计.md` |
|
||
| 智能核心 | `模块设计/6.智能核心模块详细设计.md` |
|
||
|
||
## 3. 模块依赖关系
|
||
|
||
```text
|
||
config
|
||
|-- apps.scenarios
|
||
|-- apps.documents
|
||
|-- apps.chat
|
||
|-- apps.audit
|
||
|
||
apps.scenarios
|
||
|-- reads configs/*.yaml
|
||
|
||
apps.documents
|
||
|-- depends on apps.scenarios
|
||
|-- calls agent_core.rag.ingest
|
||
|
||
apps.chat
|
||
|-- depends on apps.scenarios
|
||
|-- calls agent_core.orchestrator
|
||
|-- calls apps.audit.services
|
||
|
||
apps.audit
|
||
|-- stores AgentResult snapshots
|
||
|
||
agent_core
|
||
|-- consumes scenario config
|
||
|-- uses RAG, tools, LLM provider and structured output parser
|
||
```
|
||
|
||
## 4. 推荐阅读顺序
|
||
|
||
1. `docs/需求分析/1.V1总需求文档.md`
|
||
2. `docs/需求分析/2.模块需求索引.md`
|
||
3. `docs/设计文档/1.智能体总体设计.md`
|
||
4. `docs/设计文档/2.功能流程设计.md`
|
||
5. `docs/设计文档/3.数据库设计.md`
|
||
6. `docs/设计文档/4.页面与路由设计.md`
|
||
7. `docs/设计文档/5.部署设计.md`
|
||
8. `docs/设计文档/模块设计/*.md`
|
||
|
||
后续编码时，每个模块应先对照对应需求文档和详细设计，再实现模型、服务、视图和测试。
|