67 lines
2.5 KiB
Markdown
67 lines
2.5 KiB
Markdown
# SDD 模板（S2 / S3 必填）
|
||
|
||
**何时必填：** S2（新功能、接口/配置/数据模型、跨模块行为）和 S3（权限、安全、迁移/删除、生产变更）动工前填本模板。S0 文案与 S1 契约内修复直接改代码，不套本模板。
|
||
|
||
**FR → AC：** 第 2 节每条 FR/NFR 在第 5 节有对应 AC（前置、操作、预期、验证方式）。S3 另填第 6 节发布与恢复。
|
||
|
||
本文件是当前项目的 SDD 模板。需要长期留存的设计文档可按本模板存入 `docs/specs/`（目录按需创建）；无需另找模板或索引。设计状态、批准状态、实现状态和验证结果应分别记录，不能互相替代。
|
||
|
||
# SDD-xxx：<功能名称>
|
||
|
||
| 字段 | 内容 |
|
||
|----------------|-----------------------|
|
||
| 版本 / 变更级别 | 0.1 / S2 或 S3 |
|
||
| 设计状态 | Draft |
|
||
| 实现状态 | Not Started |
|
||
| 负责人 / 日期 | 待指定 / YYYY-MM-DD |
|
||
| 关联需求 | - |
|
||
| 批准状态 | 未批准 |
|
||
|
||
## 1. 背景、目标与范围
|
||
- **当前行为与证据**：
|
||
- **本次目标**：
|
||
- **非目标**：
|
||
- **必须保留的行为**：
|
||
|
||
## 2. 需求与约束
|
||
- FR-01：当 <条件> 时，系统必须 <行为>。
|
||
- NFR-01：<性能 / 安全 / 兼容要求及测量方式>
|
||
- 边界条件、异常场景、权限要求
|
||
|
||
## 3. 架构与方案
|
||
- 涉及模块及职责
|
||
- 关键数据流 / 调用关系
|
||
- 复用哪些现有能力
|
||
- 关键取舍及理由
|
||
- Agent 可自主决定的实现细节
|
||
|
||
## 4. 接口、数据与配置契约
|
||
（已有权威文件时直接引用路径，仅说明差异）
|
||
- 接口变更：
|
||
- 数据模型 / 迁移：
|
||
- 配置变更：
|
||
- 兼容性：
|
||
|
||
## 5. 风险与验收
|
||
|
||
### 风险
|
||
| 风险或失败场景 | 防护 / 降级 / 恢复 | 可观察信号 |
|
||
|----------------|--------------------|------------|
|
||
| | | |
|
||
|
||
### 验收标准
|
||
| AC | 对应需求 | 前置条件与操作 | 预期结果 | 验证方式 | 结果 |
|
||
|-------|----------|----------------|----------|----------|----------|
|
||
| AC-01 | FR-01 | | | | Not Run |
|
||
|
||
## 6. 发布与恢复（S3 必填）
|
||
- 前置条件（配置、迁移、备份等）
|
||
- 发布顺序与健康检查
|
||
- 回滚或前向修复步骤
|
||
- 不可逆操作说明
|
||
|
||
## 7. 待决问题
|
||
| 问题 | 是否阻塞 | 推荐方案 |
|
||
|------|----------|----------|
|
||
| | | |
|