135 lines
4.5 KiB
Markdown
135 lines
4.5 KiB
Markdown
# AgentEvalTool 文档索引
|
||
|
||
**版本**: v1.0
|
||
**日期**: 2026-07-09
|
||
**状态**: 已发布
|
||
**作者**: AgentEval Team
|
||
|
||
---
|
||
|
||
## 一、简介
|
||
|
||
AgentEvalTool 是一个智能体质量评估工具集平台，用于评估 AI 数字员工（大模型 + RAG）和 AI 助手（OpenClaw）的服务质量、效率与安全性。
|
||
|
||
本文档集提供完整的项目文档，包括需求分析、架构设计、API 参考、部署指南和使用指南。
|
||
|
||
## 二、文档目录
|
||
|
||
### 2.1 核心文档
|
||
|
||
| 文档 | 说明 | 链接 |
|
||
|------|------|------|
|
||
| **需求分析** | 项目背景、功能需求、验证标准 | [requirements-v1.0.md](requirements-v1.0.md) |
|
||
| **架构设计** | 系统架构、核心抽象、项目结构 | [architecture-v1.0.md](architecture-v1.0.md) |
|
||
| **数据模型** | 数据库表结构、模型关系 | [data-models-v1.0.md](data-models-v1.0.md) |
|
||
|
||
### 2.2 API 参考
|
||
|
||
| 文档 | 说明 | 链接 |
|
||
|------|------|------|
|
||
| **CLI 命令参考** | 所有 CLI 命令的详细用法 | [api-reference/cli-v1.0.md](api-reference/cli-v1.0.md) |
|
||
| **Web API 参考** | REST API 接口文档 | [api-reference/web-api-v1.0.md](api-reference/web-api-v1.0.md) |
|
||
|
||
### 2.3 部署文档
|
||
|
||
| 文档 | 说明 | 链接 |
|
||
|------|------|------|
|
||
| **部署概览** | 部署方式、环境要求、运维指南 | [deployment/README.md](deployment/README.md) |
|
||
| **t480 部署指南** | t480 测试服务器具体部署步骤 | [deployment/t480-v1.0.md](deployment/t480-v1.0.md) |
|
||
|
||
### 2.4 使用指南
|
||
|
||
| 文档 | 说明 | 链接 |
|
||
|------|------|------|
|
||
| **快速开始** | 5 分钟完成首次评测 | [guides/quick-start-v1.0.md](guides/quick-start-v1.0.md) |
|
||
| **用户使用指南** | 详细功能说明和最佳实践 | [guides/user-guide-v1.0.md](guides/user-guide-v1.0.md) |
|
||
|
||
### 2.5 版本发布说明
|
||
|
||
| 文档 | 说明 | 链接 |
|
||
|------|------|------|
|
||
| **V1.1 发布说明** | 前端重构、后端增强、关键 Bug 修复 | [release-notes-v1.1.md](release-notes-v1.1.md) |
|
||
| **V0.2 发布说明** | async 引擎、安全基线、测试基线、部署规范化 | [release-notes-v0.2.md](release-notes-v0.2.md) |
|
||
|
||
### 2.6 开发日志
|
||
|
||
| 文档 | 说明 | 链接 |
|
||
|------|------|------|
|
||
| **v0.3.0 开发计划** | 模型配置中心、统一模型调用与旧配置迁移 | [plan-v0.3.md](plan-v0.3.md) |
|
||
| **2026-07-15 评测执行页改版** | 布局修复、Tab 滚动、时区 Bug、时间过滤、UI 全面改版 | [dev-log-20260715.md](dev-log-20260715.md) |
|
||
|
||
### 2.6 外部参考
|
||
|
||
| 文档 | 说明 | 位置 |
|
||
|------|------|------|
|
||
| **tutu-api 参考** | tutu-api 接口文档 | `docs/external-references/tutu-api/` |
|
||
|
||
## 三、快速导航
|
||
|
||
### 3.1 我是新用户
|
||
|
||
1. 阅读 [快速开始指南](guides/quick-start-v1.0.md)
|
||
2. 安装并配置项目
|
||
3. 完成首次评测
|
||
4. 阅读 [用户使用指南](guides/user-guide-v1.0.md) 了解更多功能
|
||
|
||
### 3.2 我是开发者
|
||
|
||
1. 阅读 [架构设计文档](architecture-v1.0.md) 了解系统设计
|
||
2. 阅读 [数据模型文档](data-models-v1.0.md) 了解数据结构
|
||
3. 参考 [CLI 命令参考](api-reference/cli-v1.0.md) 和 [Web API 参考](api-reference/web-api-v1.0.md)
|
||
4. 查看源代码和测试用例
|
||
|
||
### 3.3 我是运维人员
|
||
|
||
1. 阅读 [部署概览](deployment/README.md)
|
||
2. 参考具体服务器的部署指南（如 [t480 部署指南](deployment/t480-v1.0.md)）
|
||
3. 了解日常运维和故障排查
|
||
|
||
### 3.4 我要集成 OpenClaw
|
||
|
||
1. 阅读 [架构设计文档](architecture-v1.0.md) 的 OpenClaw 集成章节
|
||
2. 参考 [CLI 命令参考](api-reference/cli-v1.0.md) 的 OpenClaw 集成示例
|
||
3. 查看 `backend/plugins/openclaw/` 目录的插件示例
|
||
|
||
## 四、版本说明
|
||
|
||
- **当前版本**: v0.3.0-dev
|
||
- **版本基线日期**: 2026-07-17
|
||
- **状态**: 开发中（t480 开发线运行）
|
||
|
||
所有文档均标注版本号，便于追踪和管理。版本发布说明见 [release-notes-v1.1.md](release-notes-v1.1.md)。
|
||
|
||
## 五、文档规范
|
||
|
||
### 5.1 版本管理
|
||
|
||
- 文件名包含版本号（如 `architecture-v1.0.md`）
|
||
- 文档头部包含版本元数据
|
||
- 重大变更时更新版本号
|
||
|
||
### 5.2 文档结构
|
||
|
||
每个文档包含：
|
||
- 版本元数据（版本、日期、状态、作者）
|
||
- 清晰的章节结构
|
||
- 代码示例和配置说明
|
||
- 故障排查和最佳实践
|
||
|
||
### 5.3 更新流程
|
||
|
||
1. 修改文档内容
|
||
2. 更新版本号和日期（如有必要）
|
||
3. 更新本文档索引（如有新增文档）
|
||
4. 提交代码审查
|
||
|
||
## 六、反馈与支持
|
||
|
||
如有文档问题或建议：
|
||
- 提交 Issue
|
||
- 联系 AgentEval Team
|
||
|
||
---
|
||
|
||
**最后更新**: 2026-07-17
|