tpm-spec-verify
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChinesePRD QA Enricher
PRD QA 增强工具
Add Quality Requirements and Acceptance Criteria to a Phase PRD, preparing it for test planning.
为阶段PRD添加质量需求和验收标准,为测试规划做好准备。
Inputs Required
所需输入
- Phase PRD — With R-nnnn requirements (use first if missing)
prd-phase-generator
- 阶段PRD — 包含R-nnnn需求(若缺失,先使用生成)
prd-phase-generator
Workflow
工作流程
- Audit for Quality Requirements — Identify missing non-functional concerns
- Add Q-nnn entries — Security, performance, accessibility, etc.
- Write Acceptance Criteria — Happy path, edge cases, error conditions for each R-nnnn
- Update traceability — Link ACs to requirements
- 质量需求审核 — 识别缺失的非功能性关注点
- 添加Q-nnn条目 — 安全、性能、可访问性等
- 编写验收标准 — 为每个R-nnnn编写正常流程、边缘案例、错误场景
- 更新可追溯性 — 将验收标准与需求关联
Step 1: Quality Requirements Audit
步骤1:质量需求审核
Review the Phase PRD and ask: what cross-cutting concerns are missing?
审阅阶段PRD并思考:哪些横切关注点缺失?
Quality Categories Checklist
质量类别检查清单
| Tag | Category | Questions to Ask |
|---|---|---|
| Performance | Response times? Throughput? Caching? |
| Security | Auth? Input validation? Data protection? |
| Availability | Uptime requirements? Failover? Recovery? |
| Scalability | Concurrent users? Data volume limits? |
| Accessibility | WCAG level? Keyboard nav? Screen readers? |
| Compatibility | Browsers? Devices? Integrations? |
| Internationalization | Languages? Locales? RTL support? |
| API Standards | Versioning? Rate limits? Error formats? |
| 标签 | 类别 | 需确认的问题 |
|---|---|---|
| 性能 | 响应时间?吞吐量?缓存机制? |
| 安全 | 身份验证?输入验证?数据保护? |
| 可用性 | Uptime要求?故障转移?恢复机制? |
| 可扩展性 | 并发用户数?数据量限制? |
| 可访问性 | WCAG级别?键盘导航?屏幕阅读器支持? |
| 兼容性 | 浏览器?设备?集成能力? |
| 国际化 | 语言?区域?RTL支持? |
| API标准 | 版本控制?速率限制?错误格式? |
Writing Quality Requirements
质量需求编写规范
markdown
Q-007 [COMPAT]: The system shall support Chrome, Firefox, Safari, and Edge (latest 2 versions)
**Applies to:** F-001, F-002, F-003
**Priority:** MustEach Q-nnn should:
- Have a category tag in brackets
- List which features it applies to
- Be testable and specific
markdown
Q-007 [COMPAT]: 系统应支持Chrome、Firefox、Safari和Edge(最新2个版本)
**适用范围:** F-001, F-002, F-003
**优先级:** 必须每个Q-nnn应包含:
- 括号内的类别标签
- 列出适用的功能
- 可测试且具体明确
Step 2: Acceptance Criteria
步骤2:验收标准
For each R-nnnn, write AC-nnnn entries covering:
为每个R-nnnn编写AC-nnnn条目,覆盖以下场景:
Coverage Categories
覆盖类别
- Happy path — Normal successful flow
- Edge cases — Boundary conditions, limits, empty states
- Error handling — Invalid input, failures, recovery
- State transitions — Before/after, concurrent access
- 正常流程 — 常规成功场景
- 边缘案例 — 边界条件、限制值、空状态
- 错误处理 — 无效输入、故障、恢复
- 状态转换 — 前后状态、并发访问
AC Format
验收标准格式
markdown
**Acceptance Criteria:**
- AC-R0142-01: Form accepts valid email formats (user@domain.tld)
- AC-R0142-02: Form rejects invalid emails with inline error message
- AC-R0142-03: Form requires non-empty name field
- AC-R0142-04: Form preserves input on validation failure
- AC-R0142-05: Submit button disabled until required fields populatedmarkdown
**验收标准:**
- AC-R0142-01:表单接受有效的邮箱格式(user@domain.tld)
- AC-R0142-02:表单拒绝无效邮箱并显示内联错误提示
- AC-R0142-03:表单要求姓名字段不能为空
- AC-R0142-04:验证失败时表单保留已输入内容
- AC-R0142-05:必填字段未填写时提交按钮处于禁用状态AC Writing Guidelines
验收标准编写指南
| Do | Don't |
|---|---|
| Specific, testable conditions | Vague ("works correctly") |
| One behavior per AC | Multiple behaviors combined |
| Observable outcomes | Implementation details |
| Include error states | Only happy path |
| 建议 | 避免 |
|---|---|
| 具体、可测试的条件 | 模糊表述(如“正常工作”) |
| 每个AC对应单一行为 | 多个行为合并在一个AC中 |
| 可观察的结果 | 实现细节 |
| 包含错误状态 | 仅覆盖正常流程 |
Typical AC Count
验收标准数量参考
- Simple requirement: 2-3 ACs
- Standard requirement: 3-5 ACs
- Complex requirement: 5-8 ACs
If a requirement needs >10 ACs, recommend splitting the requirement.
- 简单需求:2-3个AC
- 标准需求:3-5个AC
- 复杂需求:5-8个AC
若某个需求需要超过10个AC,建议拆分该需求。
Step 3: Update Traceability
步骤3:更新可追溯性
After adding ACs, update the Traceability Matrix:
| Requirement | Feature | Priority | Status | AC Count |
|---|---|---|---|---|
| R-0142 | F-014 | Must | Draft | 5 |
添加AC后,更新可追溯性矩阵:
| 需求 | 功能 | 优先级 | 状态 | AC数量 |
|---|---|---|---|---|
| R-0142 | F-014 | 必须 | 草稿 | 5 |
Quality Requirements Numbering
质量需求编号规则
Q-nnn is sequential across the entire product (like R-nnnn). Check previous Phase PRDs for last used Q-nnn.
Q-nnn在整个产品中按顺序编号(与R-nnnn规则一致)。需查看过往阶段PRD确认上一个使用的Q-nnn编号。
Reference
参考文档
See for ID format details and category tags.
references/naming-conventions.md详见获取ID格式细节和类别标签说明。
references/naming-conventions.md