111 lines
2.5 KiB
Markdown
111 lines
2.5 KiB
Markdown
# XWorkmate 测试规范模板与指南
|
|
|
|
> 适用范围: `XWorkmate`
|
|
> 目的: 提供可直接套用的验收写法，方便快速产出单次测试记录。
|
|
|
|
## 1. 这份文档的角色
|
|
|
|
这不是正式规范，而是模板和执行提示。正式规范见 `docs/quality/xworkmate-test-spec.md`。
|
|
|
|
## 2. 使用场景
|
|
|
|
- UI 行为调整
|
|
- 设置页、网关、凭据、存储、权限相关变更
|
|
- 路由、运行时、会话、同步链路相关变更
|
|
- 发布前验证
|
|
- 需要把日志任务、测试任务、验收结果统一归档
|
|
|
|
## 3. 写这份记录要回答什么
|
|
|
|
最少回答四个问题：
|
|
|
|
1. 这次改动改了什么
|
|
2. 哪些自动化测试已经覆盖
|
|
3. 哪些高风险点仍需人工确认
|
|
4. 失败或跳过时，后续该怎么补测
|
|
|
|
## 4. 建议输出目录
|
|
|
|
按变更类型选择一个最接近的目录：
|
|
|
|
- `docs/releases/`：发布前验收、日志任务、版本回收
|
|
- `docs/reports/`：专项测试报告、问题定位报告
|
|
- `docs/quality/`：正式测试规范、质量标准
|
|
- `docs/architecture/`：与测试相关的约束说明或验收边界
|
|
|
|
如果是正式规范，优先放到 `docs/quality/`。
|
|
如果是一次具体变更的验收结果，优先放到 `docs/releases/`。
|
|
|
|
## 5. 推荐结构
|
|
|
|
直接按下面结构填：
|
|
|
|
### 标题
|
|
|
|
- 用一句话说明主题
|
|
- 若是具体变更，可带日期或模块名
|
|
|
|
### 变更摘要
|
|
|
|
- 说明改动范围
|
|
- 说明功能是否变化
|
|
- 说明是否影响安全、存储、发布或交互
|
|
|
|
### 测试命令与结果
|
|
|
|
用表格列出：
|
|
|
|
- 命令
|
|
- 结果
|
|
- 测试数量或关键摘要
|
|
|
|
### 重点验证点
|
|
|
|
把需求拆成可验证的行为项：
|
|
|
|
- 每个行为项都要能映射到具体测试用例或人工步骤
|
|
- 不要写无法验证的抽象结论
|
|
|
|
### 失败项
|
|
|
|
如果有失败：
|
|
|
|
- 说明失败命令
|
|
- 摘要首个失败点
|
|
- 指出受影响文件或模块
|
|
|
|
如果没有失败，明确写 `无`
|
|
|
|
### 高风险回归点
|
|
|
|
只列仍然值得警惕的点：
|
|
|
|
- 自动化没有覆盖到的分支
|
|
- 需要真机、真服务、真账号验证的路径
|
|
- 依赖外部环境的路径
|
|
|
|
### 建议人工补测项
|
|
|
|
列出最小可执行步骤：
|
|
|
|
- 场景
|
|
- 操作路径
|
|
- 期望结果
|
|
|
|
### 相关文件
|
|
|
|
列出：
|
|
|
|
- 受影响的实现文件
|
|
- 对应测试文件
|
|
- 生成的文档文件
|
|
|
|
## 6. 参考示例
|
|
|
|
可参考现有验收文档：
|
|
|
|
- `docs/reports/2026-03-23-single-agent-test-acceptance.md`
|
|
- 正式规范: `docs/quality/xworkmate-test-spec.md`
|
|
- 长期自动化规划: `docs/testing/core-integration-auto-test-plan.md`
|
|
- 长期手动 case: `docs/cases/core-integration-manual-cases.md`
|