技术方案模板

新公司，新要求；leader要求需求写技术方案；第一次写，记录下来规范；以后持续更新，希望成为模板；

技术方案

1.项目背景

1.1、 概述

简要概述项目背景；为什么要这么做

1.2、 目标

通过xmind描述项目的核心目标及价值。需要思考我们为什么做这个项目，做这个项目希望解决什么业务问题，关键的衡量达成的指标是什么。

1.3 、项目成员

项目的实际参与人，方便后续历史回溯和沟通。

1.4 、时间计划

项目roadmap，关键的milestone。可用xmind实现

需要详细分解任务，并评估工时。分级不能超过两级，单个任务的工时尽量不超过3MD。

2.用例和业务描述

描述业务的关键业务场景和用户使用的案例，讲清楚业务的使用流程和想达到的效果。可以使用xmind，UML的用例图等工具来进行描述。

3.技术调研

概述

需求需要用到什么技术；具体描述；

3.1、方案1

详细介绍技术1；项目的中如何使用；明确利弊；

4.系统部署图

系统的应用架构和部署图

5.详细设计

5.1 数据库

5.1.1 表1

简述介绍

表名	****
是否存在	否
是否修改	否
表数据量	数据量
是否考虑sql效率	需要建立索引
是否分表	否
****	****

• 表结构

字段名	类型	长度	不是null	注释
ID	VARCHAR2	8	√	主键

索引：

索引名	索引栏位	索引类型
IDX_AREA	PROVINCE ASC, CITY ASC, DISTRICT ASC	Non-Unique

• 业务sql：

  SELECT ******
  UPDATE *****

5.2 接口文档

接口概述

• 请求地址

Get:  /reportThirdPartySite/search

• 请求媒体类型

application/json

• 请求参数

{	
**********
}

类型	类型	必填	说明

• 返回数据示例

json格式：
{
	************
}		 

5.3 领域设计

领域模型

5.4 关键业务流程

关键业务的时序图设计

6.监控设计

关键监控日志埋点、监控报表和报警；

7.发布计划

回滚方案、灰度和执行详细步骤。

8.回归测试验收步骤