Skip to content

Commit 5956383

Browse files
authored
Docs: update README.md
1 parent e0496d5 commit 5956383

File tree

1 file changed

+26
-14
lines changed

1 file changed

+26
-14
lines changed

README.md

Lines changed: 26 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,28 @@
1010
<img src="docs/images/webqa.svg" alt="WebQA Agent 业务功能图" />
1111
</p>
1212

13-
### 📋 核心特性概览
13+
### 📋 特性概览
1414

15-
- **🤖 AI智能测试**:兼容 OpenAI SDK 的模型,实现智能化的功能测试和用户体验评估,从页面抓取到测试执行,全程无需人工干预
16-
- **📊 多维度评估**涵盖功能测试、性能测试、用户体验测试和安全测试
15+
- **🤖 AI智能测试**:兼容 OpenAI SDK 的模型,实现智能化的功能测试和用户体验评估,自动完成从页面抓取、测试用例生成到执行的全流程测试,实现真正的全程零人工干预
16+
- **📊 多维度评估**覆盖功能、性能、用户体验、安全等核心测试场景,全面保障系统质量
1717
- **🎯 精准诊断**:基于真实浏览器环境的深度测试,提供可操作的优化建议
18-
- **📈 可视化报告**:生成详细的HTML测试报告,支持多种测试结果展示
18+
- **📈 可视化报告**:生成详细的HTML测试报告,多维度、可视化展示测试结果,便于分析与追踪
19+
20+
## 📌 测试案例
21+
22+
<p align="center">
23+
<img src="https://github.com/user-attachments/assets/b75f18bf-8b92-498e-b5e1-7c4dc5cd33f5" alt="AI 功能测试" width="45%"/>
24+
&nbsp;
25+
<img src="https://github.com/user-attachments/assets/560cd99d-1213-47b9-82dc-52d3f2d1c1e7" alt="其他功能测试" width="45%"/>
26+
</p>
27+
28+
<p align="center">
29+
<b>左:AI 智能测试 全自动执行流程</b> | <b>右:其他测试 覆盖多类场景</b>
30+
</p>
1931

2032
## 安装与配置
2133

22-
### 🚀 Docker一键启动(推荐)
34+
### 🚀 Docker一键启动
2335

2436
在开始之前,请确保已安装 Docker。如未安装,请参考官方安装指南:[Docker 安装指南](https://docs.docker.com/get-started/get-docker/)
2537

@@ -49,15 +61,15 @@ playwright install
4961

5062
```
5163

52-
Lighthouse 安装
64+
性能测试 - Lighthouse 安装(可选)
5365

5466
```bash
5567
# 需要 Node.js >= 18.0.0 package.json
5668
npm install
5769

5870
```
5971

60-
Nuclei 安装
72+
安全测试 - Nuclei 安装(可选)
6173

6274
下载地址: [Nuclei Releases](https://github.com/projectdiscovery/nuclei/releases/)
6375

@@ -73,17 +85,17 @@ nuclei -version # 验证安装成功
7385

7486
```
7587

76-
参考“使用说明 > 项目配置”进行 `config/config.yaml` 配置后,运行下方命令。
88+
参考“使用说明 > 测试配置”进行 `config/config.yaml` 配置后,运行下方命令。
7789

7890
```bash
7991
python webqa-agent.py
8092
```
8193

8294
## 使用说明
8395

84-
### 项目配置
96+
### 测试配置
8597

86-
`webqa-agent` 通过 YAML 配置项目的运行参数
98+
`webqa-agent` 通过 YAML 配置测试运行参数
8799

88100
```yaml
89101
target:
@@ -94,7 +106,7 @@ test_config: # 测试项配置
94106
function_test: # 功能测试
95107
enabled: True
96108
type: ai # default or ai
97-
business_objectives: example business objectives # 建议加入测试范围和数量描述,如:测试搜索功能,生成x个用例
109+
business_objectives: example business objectives # 建议加入测试范围,如:测试搜索功能
98110
ux_test: # 用户体验测试
99111
enabled: True
100112
performance_test: # 性能测试
@@ -133,10 +145,10 @@ UX(用户体验)测试专注于评估网站的交互设计、可用性和用
133145

134146
## RoadMap
135147

136-
1. AI功能测试持续优化:提升覆盖率与准确性,支持更多浏览器操作
137-
2. 功能遍历与页面校验:自动遍历页面,校验业务逻辑与数据完整性
148+
1. AI功能测试持续优化:提升覆盖率与准确性
149+
2. 功能遍历与页面校验:校验业务逻辑正确性与数据完整性
138150
3. 交互与可视化:用例可视化与本地服务实时展示推理过程
139-
4. 能力扩展:多模型接入与更多评估维度(含安全)集成
151+
4. 能力扩展:多模型接入与更多评估维度集成
140152

141153
## 开源许可证
142154

0 commit comments

Comments
 (0)