CI / test (push) Successful in 3m22s

Details

docs: 归档 2026-08-24 架构审查报告（Phase 5）

将本轮架构审查 HTML 报告按先例归档至 docs/archive/，并同步
登记 docs/README.md 与 docs/archive/README.md 索引。

本轮五个深化候选已全部落地：
- 候选① 智能作业结算统一（ADR-0012）
- 候选② 可见性接缝（require_live_eval 单一接缝）
- 候选③ storage/repository.py 拆分
- 候选④ 前端 ReadSlot 资源接缝
- 候选⑤ api.ts 拆分为 10 个域模块

刻意不做项（CAS 共享原语、db.py 拆分、app.py 关停顺序归一、
会话/任务状态机转换表）已在 v3 计划与 ADR-0012 中记录。

2026-08-24 05:54:54 +08:00

6.1 KiB

Raw Blame History

AgentEvalTool 文档索引

文档版本: v1.2 项目版本: v1.1.1 日期: 2026-08-18 状态: 已发布作者: AgentEval Team

一、简介

AgentEvalTool 是一个智能体质量评估工具集平台，用于评估 AI 数字员工（大模型 + RAG）和 AI 助手（OpenClaw）的服务质量、效率与安全性。

本文档集提供完整的项目文档，包括需求分析、架构设计、API 参考、部署指南和使用指南。

二、文档目录

2.1 核心文档

文档	说明	链接
需求分析	项目背景、功能需求、验证标准	requirements-v1.0.md
架构设计	系统架构、核心抽象、项目结构	architecture-v1.0.md
数据模型	数据库表结构、模型关系	data-models-v1.0.md

2.2 API 参考

文档	说明	链接
CLI 命令参考	所有 CLI 命令的详细用法	api-reference/cli-v1.0.md
Web API 参考	REST API 接口文档	api-reference/web-api-v1.0.md

2.3 部署文档

文档	说明	链接
部署概览	部署方式、环境要求、运维指南	deployment/README.md
t480 部署指南	t480 测试服务器具体部署步骤	deployment/t480-v1.0.md
volcengine-102 部署指南	正式线发布、验证与回滚	deployment/volcengine-102-v1.0.md

2.4 使用指南

文档	说明	链接
快速开始	5 分钟完成首次评测	guides/quick-start-v1.0.md
用户使用指南	详细功能说明和最佳实践	guides/user-guide-v1.0.md

2.5 版本发布说明

文档	说明	链接
V1.1.1 发布说明	智能评估全链路稳定化（方案③）、任务队列监控、UI/UX 一致性	release-notes-v1.1.1.md
V1.1.0 发布说明	Cron 池架构、智能评估可扩展性	release-notes-v1.1.0.md
V1.0.0 发布说明	双评测体系、耐久 Campaign、架构深化与双线部署	release-notes-v1.0.md
V0.8 发布说明	Campaign 周期对比与正式线演进基线	release-notes-v0.8.md
V0.2 发布说明	async 引擎、安全基线、测试基线、部署规范化	release-notes-v0.2.md
历史 V1.1 编号文档	早期原型阶段编号，不代表当前 SemVer	release-notes-v1.1.md

2.6 开发日志

文档	说明	链接
v0.3.0 开发计划	模型配置中心、统一模型调用与旧配置迁移	plan-v0.3.md
2026-07-15 评测执行页改版	布局修复、Tab 滚动、时区 Bug、时间过滤、UI 全面改版	dev-log-20260715.md

2.6 阶段归档

文档	说明	链接
归档索引	已验收阶段的目标、决策、证据与后续约束	archive/README.md
Campaign 架构深化	耐久作业、读模型、运行时和正式线交付总结	archive/campaign-architecture-deepening-20260811-v1.0.md
智能评估架构深化	scheduler 抽取、去重内化、状态机归一、残留清理、标签单一出口	archive/intelligent-eval-architecture-deepening-20260821-v1.2.html
架构审查（2026-08-24）	五个深化候选：可见性接缝、智能作业归一、repository 拆分、前端读取接缝、api.ts 拆域；候选已全部实施	archive/codebase-architecture-review-20260824.html

2.7 外部参考

文档	说明	位置
tutu-api 参考	tutu-api 接口文档	`docs/external-references/tutu-api/`

三、快速导航

3.1 我是新用户

阅读快速开始指南
安装并配置项目
完成首次评测
阅读用户使用指南了解更多功能

3.2 我是开发者

阅读架构设计文档了解系统设计
阅读数据模型文档了解数据结构
参考 CLI 命令参考和 Web API 参考
查看源代码和测试用例

3.3 我是运维人员

阅读部署概览
参考具体服务器的部署指南（如 t480 部署指南）
了解日常运维和故障排查

3.4 我要集成 OpenClaw

阅读架构设计文档的 OpenClaw 集成章节
参考 CLI 命令参考的 OpenClaw 集成示例
查看 backend/plugins/openclaw/ 目录的插件示例

四、版本说明

当前版本: v1.0.0
版本基线日期: 2026-08-11
状态: 已部署（t480 开发线、volcengine-102 正式线）

所有文档均标注版本号，便于追踪和管理。当前发布说明见 release-notes-v1.0.md。

五、文档规范

5.1 版本管理

文件名包含版本号（如 architecture-v1.0.md）
文档头部包含版本元数据
重大变更时更新版本号

5.2 文档结构

每个文档包含：

版本元数据（版本、日期、状态、作者）
清晰的章节结构
代码示例和配置说明
故障排查和最佳实践

5.3 更新流程

修改文档内容
更新版本号和日期（如有必要）
更新本文档索引（如有新增文档）
提交代码审查

六、反馈与支持

如有文档问题或建议：

提交 Issue
联系 AgentEval Team

最后更新: 2026-08-18

6.1 KiB Raw Blame History Unescape Escape