name: 技术规范 description: 为软件项目创建详细的技术规范，覆盖需求、架构、API和测试策略。在规划功能、文档化系统设计或创建架构决策记录时使用。
技术规范
为软件项目创建全面的技术规范。
规范模板
# 技术规范: [功能名称]
## 元数据
- **状态**: 草稿 | 审核中 | 已批准
- **作者**: [姓名]
- **审核者**: [姓名]
- **最后更新**: [日期]
## 执行摘要
[2-3句话：解决了什么问题？提出的解决方案是什么？]
## 背景与上下文
- 当前的痛点
- 为什么现在？
- 相关工作
## 目标
### 主要目标
1. [可衡量的目标]
### 非目标
- [本规范明确不覆盖的内容]
## 功能需求
| ID | 需求 | 优先级 |
|----|-------------|----------|
| FR-1 | [描述] | P0 |
| FR-2 | [描述] | P1 |
## 非功能需求
- **性能**: 响应时间 < 200ms
- **可扩展性**: 支持10K并发用户
- **可用性**: 99.9% 正常运行时间
- **安全性**: [需求]
## 技术设计
### 架构
[图表或描述]
### API设计
POST /api/v1/resource 请求: { “field”: “value” } 响应: { “id”: “123”, “field”: “value” }
### 数据库模式
```sql
CREATE TABLE resources (
id UUID PRIMARY KEY,
field VARCHAR(255)
);
实施计划
| 阶段 | 时间线 | 交付物 |
|---|---|---|
| 1 | 第1-2周 | 核心功能 |
| 2 | 第3周 | API端点 |
| 3 | 第4周 | 测试与文档 |
测试策略
- 单元测试: 80% 覆盖率
- 集成测试: API端点
- 端到端测试: 关键流程
风险与缓解措施
| 风险 | 概率 | 影响 | 缓解措施 |
|---|---|---|---|
| [风险] | 中等 | 高 | [计划] |
成功标准
- [ ] 所有P0需求已实施
- [ ] 测试通过
- [ ] 性能目标达成
- [ ] 文档完成
## 完整模板
查看 [references/template.md](references/template.md) 获取包括以下内容的全面复制粘贴模板：
- 完整的元数据部分
- 成功指标表
- 架构图
- 详细的API设计部分
- 安全威胁分析
- 监控与可观察性
- 风险评估矩阵
- 推出和回滚计划
- 依赖跟踪
- 开放问题部分
## 最佳实践
**做:**
- 包含可衡量的验收标准
- 添加架构图
- 定义明确的API合同
- 量化性能目标
- 记录风险与缓解措施
- 在实施前获得利益相关者审核
- 包括安全考虑
- 定义回滚程序
**不做:**
- 使用模糊需求 ("快", "可扩展")
- 跳过非功能需求
- 忽略安全考虑
- 留下替代方案未探索
- 省略测试策略
- 忘记依赖和风险