89 lines
2.1 KiB
Markdown
89 lines
2.1 KiB
Markdown
# <规格名称>
|
|
|
|
| 字段 | 内容 |
|
|
|------|------|
|
|
| 状态 | Draft |
|
|
| 级别 | S2 / S3 |
|
|
| 负责人 | Logan.Li |
|
|
| 创建日期 | YYYY-MM-DD |
|
|
| 最后更新 | YYYY-MM-DD |
|
|
| 关联任务 | <链接或说明> |
|
|
|
|
## 1. 背景与证据
|
|
|
|
描述当前行为、问题和触发本变更的证据，引用实际代码、接口、日志或数据。
|
|
|
|
## 2. 目标与非目标
|
|
|
|
### 目标
|
|
|
|
- <本次必须达成的结果>
|
|
|
|
### 非目标
|
|
|
|
- <明确不在本次处理的事项>
|
|
|
|
## 3. 用户场景
|
|
|
|
- 当 <角色> 在 <条件> 下执行 <动作> 时，系统必须 <可观察结果>。
|
|
|
|
## 4. 需求
|
|
|
|
### 功能需求
|
|
|
|
- `FR-01`：<确定、可验证的行为要求>。
|
|
|
|
### 非功能需求
|
|
|
|
- `NFR-01`：<性能、安全、可靠性、兼容性或可维护性要求>。
|
|
|
|
## 5. 设计与契约
|
|
|
|
### 模块边界
|
|
|
|
说明复用点、所有权和不应新增的重复能力。
|
|
|
|
### API / 事件
|
|
|
|
列出路径、方法、请求、响应、错误码、权限、幂等、超时与重试。
|
|
|
|
### 数据与迁移
|
|
|
|
列出字段、约束、索引、默认值、回填、兼容窗口、数据量影响和迁移版本。
|
|
|
|
### UI / 交互
|
|
|
|
列出入口、权限、加载、空、错误、禁用、响应式和国际化状态。
|
|
|
|
## 6. 风险与可观测性
|
|
|
|
| 风险/失败模式 | 防护或降级 | 观测信号 |
|
|
|---------------|------------|----------|
|
|
| <风险> | <处理方式> | <日志/指标/任务状态> |
|
|
|
|
## 7. 验收标准
|
|
|
|
- `AC-01`：给定 <前置条件>，当 <动作>，则 <可观察结果>。
|
|
- `AC-02`：给定 <异常或边界条件>，当 <动作>，则 <失败行为或降级结果>。
|
|
|
|
## 8. 验证追踪
|
|
|
|
| 验收标准 | 测试或检查 | 结果 |
|
|
|----------|------------|------|
|
|
| AC-01 | `<命令、测试名或人工步骤>` | Pending |
|
|
| AC-02 | `<命令、测试名或人工步骤>` | Pending |
|
|
|
|
## 9. 发布与回滚
|
|
|
|
说明发布顺序、配置/迁移前置条件、健康检查、备份、回滚步骤和不可逆事项。S3 必填。
|
|
|
|
## 10. 决策记录
|
|
|
|
| 日期 | 决策 | 原因与影响 |
|
|
|------|------|------------|
|
|
| YYYY-MM-DD | <决定> | <依据、取舍和影响范围> |
|
|
|
|
## 11. 遗留事项
|
|
|
|
- <不阻塞本次验收但需要后续跟踪的工作>
|