57 lines
3.1 KiB
Markdown
57 lines
3.1 KiB
Markdown
|
# TSP 智能助手 — 文档索引
|
|||
|
|
|
|||
|
|
> **面向 AI 助手的使用指南**: 本文件是文档体系的入口。根据问题类型查阅对应文件即可获取详细信息。大多数问题只需本文件 + 1~2 个子文件即可回答。
|
|||
|
|
|
|||
|
|
## 文档目录
|
|||
|
|
|
|||
|
|
| 文件 | 内容摘要 | 适用问题 |
|
|||
|
|
|------|---------|---------|
|
|||
|
|
| [codebase_info.md](codebase_info.md) | 项目基本信息、技术栈、目录结构、启动流程 | "这个项目是什么？" "用了什么技术？" "怎么启动？" |
|
|||
|
|
| [architecture.md](architecture.md) | 系统架构图、架构模式（单例/Blueprint/装饰器/多租户）、线程模型 | "系统怎么组织的？" "请求怎么流转？" "多租户怎么实现？" |
|
|||
|
|
| [components.md](components.md) | 所有核心组件的职责说明（业务层、基础设施层、Web 层） | "DialogueManager 做什么？" "有哪些 Blueprint？" |
|
|||
|
|
| [interfaces.md](interfaces.md) | REST API 列表、WebSocket 接口、外部集成时序图、装饰器接口 | "工单 API 有哪些？" "飞书怎么集成的？" |
|
|||
|
|
| [data_models.md](data_models.md) | ORM 模型 ER 图、字段说明、配置 Dataclass、业务枚举 | "WorkOrder 有哪些字段？" "数据库表结构？" |
|
|||
|
|
| [workflows.md](workflows.md) | 6 个关键流程的时序图（启动、对话、工单同步、知识搜索、飞书消息、Agent） | "消息怎么处理的？" "工单怎么同步到飞书？" |
|
|||
|
|
| [dependencies.md](dependencies.md) | 所有 Python 依赖分类说明、外部服务依赖图 | "用了哪些库？" "有哪些外部依赖？" |
|
|||
|
|
| [review_notes.md](review_notes.md) | 文档一致性/完整性检查结果、待补充区域、改进建议 | "文档有什么遗漏？" "哪些地方需要补充？" |
|
|||
|
|
|
|||
|
|
## 快速导航
|
|||
|
|
|
|||
|
|
### 按任务类型
|
|||
|
|
|
|||
|
|
- **修 Bug / 改功能** → `components.md` 找到对应组件 → `architecture.md` 理解依赖关系
|
|||
|
|
- **加新 API** → `interfaces.md` 了解现有 API 模式 → `architecture.md` 中的装饰器模式
|
|||
|
|
- **改数据库** → `data_models.md` 查看表结构和关系
|
|||
|
|
- **理解流程** → `workflows.md` 查看时序图
|
|||
|
|
- **加新依赖** → `dependencies.md` 了解现有依赖
|
|||
|
|
- **部署/配置** → `codebase_info.md` 查看启动方式
|
|||
|
|
|
|||
|
|
### 按代码位置
|
|||
|
|
|
|||
|
|
- `src/core/` → `components.md` 基础设施组件 + `data_models.md`
|
|||
|
|
- `src/web/blueprints/` → `interfaces.md` API 列表 + `components.md` Blueprint 说明
|
|||
|
|
- `src/dialogue/` → `components.md` 对话组件 + `workflows.md` 对话流程
|
|||
|
|
- `src/integrations/` → `interfaces.md` 外部集成 + `workflows.md` 飞书流程
|
|||
|
|
- `src/config/` → `data_models.md` 配置 Dataclass
|
|||
|
|
- `start_dashboard.py` → `workflows.md` 启动流程
|
|||
|
|
|
|||
|
|
## 文件间关系
|
|||
|
|
|
|||
|
|
```mermaid
|
|||
|
|
graph TD
|
|||
|
|
INDEX["index.md (本文件)"] --> CI["codebase_info.md"]
|
|||
|
|
INDEX --> ARCH["architecture.md"]
|
|||
|
|
INDEX --> COMP["components.md"]
|
|||
|
|
INDEX --> INTF["interfaces.md"]
|
|||
|
|
INDEX --> DM["data_models.md"]
|
|||
|
|
INDEX --> WF["workflows.md"]
|
|||
|
|
INDEX --> DEP["dependencies.md"]
|
|||
|
|
INDEX --> RN["review_notes.md"]
|
|||
|
|
|
|||
|
|
ARCH --> COMP
|
|||
|
|
COMP --> INTF
|
|||
|
|
COMP --> DM
|
|||
|
|
INTF --> WF
|
|||
|
|
DM --> WF
|
|||
|
|
```
|