tupingr
77 lines
2.1 KiB
Markdown
77 lines
2.1 KiB
Markdown
# Dev AI 文档模板
|
|
|
|
下面三个模板用于 Dev AI 在 `review/{task_id}/` 下产出标准化文件。
|
|
|
|
---
|
|
|
|
## A. impact.md 模板（变更影响范围）
|
|
|
|
```markdown
|
|
# {TASK_ID} - 变更影响范围
|
|
|
|
## 修改的文件
|
|
| 文件路径 | 修改类型 | 影响等级 |
|
|
|---------|---------|---------|
|
|
| projects/P01_soc_sw_app/src/server/src/modules/auth/auth.service.ts | 新增 | HIGH |
|
|
| projects/P01_soc_sw_app/src/server/src/modules/auth/dto/login.dto.ts | 新增 | MEDIUM |
|
|
|
|
> 影响等级：HIGH=核心逻辑变更 | MEDIUM=新增文件 | LOW=注释/格式
|
|
|
|
## 影响的功能模块
|
|
- [x] 用户认证模块
|
|
- [ ] 芯片验证模块（无影响）
|
|
|
|
## 需要回归测试的场景
|
|
- 场景1: 用户登录成功流程
|
|
- 场景2: 密码错误返回 401
|
|
- 场景3: Token 过期后刷新
|
|
|
|
## 环境依赖变更
|
|
- 新增依赖: bcrypt, @nestjs/jwt
|
|
- 数据库迁移: 新增 users 表
|
|
```
|
|
|
|
**要点：**
|
|
- `修改的文件` 必须使用从仓库根目录开始的完整路径
|
|
- 影响等级要实事求是，不要全写 HIGH
|
|
- `需要回归测试的场景` 要写**用户视角**的场景，不是代码内部细节
|
|
|
|
---
|
|
|
|
## B. acceptance.md 模板（验收标准）
|
|
|
|
```markdown
|
|
# {TASK_ID} - 验收标准
|
|
|
|
## 功能验收
|
|
- [ ] 用户可以注册新账户（邮箱+密码）
|
|
- [ ] 密码强度不足时提示明确错误信息
|
|
- [ ] 登录成功返回有效 JWT Token
|
|
|
|
## 非功能验收
|
|
- [ ] API 响应时间 < 200ms
|
|
- [ ] 密码使用 bcrypt 加密存储
|
|
- [ ] JWT Token 有效期 24 小时
|
|
|
|
## 测试覆盖要求
|
|
- 单元测试覆盖率: >= 80%
|
|
- 集成测试覆盖率: >= 60%
|
|
- E2E 测试场景: >= 3 个
|
|
|
|
## 验收通过条件
|
|
- 所有功能点验证通过
|
|
- 测试覆盖率达标
|
|
- 无重大安全漏洞
|
|
```
|
|
|
|
**要点：**
|
|
- 功能验收用「用户可以…」句式，让 QA AI 和人类都能看懂
|
|
- 每个功能点对应 task.md 里的一项交付物
|
|
- 非功能验收写具体的可测量指标，不要写「性能好」「代码整洁」
|
|
|
|
---
|
|
|
|
## C. 没有 task.md 模板
|
|
|
|
task.md 由人类负责人创建，Dev AI 只读不写。Dev AI 如需补充技术细节，写在 impact.md 的「技术备注」段落中，不要直接修改 task.md。
|