我的设计模板

Posted on Mon 29 August 2022 in Journal

Design Template

1. 总体介绍
1.1 需求
1.1.1 业务需求和目标
需求分析, 用户场景及用例图

1.1.2 技术需求: 容量需求,高可用性,安全性,伸缩性

1.2 背景
1.2.1 业务背景
1.2.2 技术背景: 当前架构, 容量, 局限和性能瓶颈

2. 设计
2.1 总体架构
总体框图

2.2 备选方案

2.3 领域设计
主要的领域对象, 流程以及实体关系图

2.4 范围与影响
所影响的范围以及对于其他上下游组件的影响

2.5 详细设计

2.5.1 接口描述
2.5.2 逻辑描述
2.5.3 数据结构
2.5.4 局限与限制
2.5.5 性能问题
2.5.6 设计约束
2.5.7 意外情况处理

3. 依赖条件
3.1 平台
3.2 数据库
3.3 其他服务及其 SDK

4. 部署
4.1 配置
4.2 安装
4.3 部署及验证

5. 度量
5.1 关键因素 KPI
5.2 度量设计
5.3 度量工具

6. 测试方案
6.1 测试用例
6.2 API 测试方案
6.3 集成测试和端到端测试方案
6.4 性能测试方案

7. 问题与风险
当前存在的问题与可能存在的风险

8. 参考文档和链接