前言
[可选，用于总体上描述本篇文档的内容和目的，一般包括项目名称（或者需求名称）、应用名称，目的一般都是“开发、测试、部署”]
[样例] 本文是扫码支付项目中会员域认证微服务的方案设计文档，用于指导认证微服务后续的开发、测试和部署。修订历史
[可选，文档会因为各种原因导致修订，通过修订历史来记录变更情况]
[样例，因 infoq 写作平台不支持插入表格，这里用图片代替，实际 word 文档请用表格]
词汇表
[可选，用于明确定义和说明一些英文缩写、术语等，请用表格来呈现]
[样例，因 infoq 写作平台不支持插入表格，这里用图片代替，实际 word 文档请用表格]
1. 项目背景
[必选，概要的介绍项目背景，一般可以从立项文档、会议纪要、架构设计文档中找到资料进行提炼，提炼的核心内容可以用 5W 模型（who、when、where、why、what）来写，建议不要超过 5 行，更详细的信息可以直接贴需求文档、项目立项文档等链接]
[样例] 香港地铁公司（who）为了方便广大市民出行（why），准备在 2021 年（when）实现手机扫码乘车的功能（what），一期项目计划在 XX 线试点（where）。详细的项目背景信息请参考（注：链接仅为示意，不是实际的项目立项文档）：XXX项目立项文档。2. 总体设计
[必选，概要介绍一下全流程的架构设计，如果架构有变化就需要介绍架构的变化，包括 Role、Relation；不管架构是否有变化，都要介绍一下需求的全流程的实现逻辑（对应 4R 架构定义的 Rule）。更详细的信息可以直接贴链接。]
[样例] 扫码支付的完整流程如下，详细请参考（注：链接仅为示意，不是实际的架构设计文档）：扫码支付架构设计文档。
3. 系统设计
系统设计就是指单个应用自己的设计。3.1 系统边界
[必选，描述为了实现需求，自己负责的应用与外部哪些应用有关联（relation），这些关联可能是直接的接口访问、也可能是通过消息队列发送消息等方式，可以用架构设计中的“系统边界黑盒图”来展现边界和关联。
注意这里不要一一列举所有的接口，而应该按照分类来介绍接口类别，例如：会员接口，库存接口、订单接口这种就可以了，详细的接口在后面会一一说明。]
[样例] 订单中心本次项目开发依赖如下关联系统：
3.2 逻辑设计
[必选，逻辑设计其实就是指导如何写代码的，如果是 Java 这种面向对象设计，那就是类设计；如果用了 DDD 之类的方法，那就是领域对象设计；如果是 golang 这种，那就是 goroutine 和 channel 这种设计。
注意这里不是写伪代码，而是写代码的设计思路。
为什么要单独拿出逻辑设计来写，而不是放在接口设计里面写呢？因为逻辑设计是给很多接口用的，不能放在某个接口里面写。]
3.3 存储设计
[可选，描述存储系统的数据结构如何设计，例如 MySQL 的表设计、Redis 的 key 设计，Elasticsearch 的 index 设计等。
为什么要单独将存储设计独立出来，而不是放在接口设计里面呢？原因和“逻辑设计”是一样的。]
3.4 接口设计
3.4.1 会员中心交互接口
3.4.1.1 接口流程
[必选，描述自己的系统内部接口的处理逻辑，一般用 UML 的 Sequence diagram 展示，用文字描述处理步骤的具体处理逻辑。]
3.4.1.2 接口输入
[必选，用表格的形式描述输入参数和要求，可以根据实际需求添加更多列]
3.4.1.3 接口输出
[必选，用表格的形式描述返回数据，重点是错误码，需要一一列举，并且说明含义]
3.4.1.4 关键设计
[可选，如果接口处理流程中有一些关键的设计，例如全局幂等、限流、算法、兼容旧接口、熔断、安全加密等，需要在这里特别描述，注意不要把关键设计放到接口流程里面讲，因为那样会导致不同的关注点混杂在一起，不方便阅读和理解]
3.4.1.5 接口要求
[必选，估算接口的性能要求、响应时间要求、请求量等]
3.4.1.6 接口依赖
[必选，用表格形式列出接口处理流程中依赖的其它系统的接口、前置条件等。]
3.4.2 促销中心交互接口
3.5 其它设计
[可选，包括特殊的网络设计、安全设计、证书设计、工具设计等。注意这里的相关设计内容是多个接口或者功能相关的，如果设计方案只针对某个接口，请放在接口设计部分的“关键设计”]
4. 部署设计
4.1 部署流程
[可选，部署的方式和步骤，方式包括金丝雀发布、灰度发布、蓝绿发布等，步骤包括准备工作、执行步骤、验证操作等，如果公司的基建比较完善，可以做到自动化，那么这部分可以简单描述。]
4.1.1 准备工作
4.1.2 执行步骤
4.1.3 部署验证
4.2 回滚流程
4.2.1 回滚标准
[可选，描述在什么情况下要进行回滚]
4.2.2 回滚操作
4.2.3 回滚验证
5. 风险评估
[可选，常见的风险有：
技术风险，例如引入了某个新技术，还不熟悉；
项目风险：人员不熟悉，人员变动大；
外部风险：政策风险、业务变动、外部配合进度等。]
5.1 疫情风险评估
5.1.1 风险评估
5.1.2 应对策略
若有收获，就点个赞吧
0 人点赞
