技术文档系列之架构设计文档模板

本文是对专栏文章架构设计文档模板的学习记录,可以购买以支持原作者

首先是备选方案模板

需求介绍

主要介绍需求的背景,目标与范围

随着xxx业务不断发展,业务拆分的子系统越来越多(阐述现有系统的问题),由此带来几个明显的系统问题

eg:
性能问题:
耦合问题:
效率问题:

基于以上背景,我们需要引入xxx,将目前的xxx功能改为xxx

需求分析

需要全方位描述相关的信息

5W

• Who
  需求的利益关系人:包括开发者,产品使用者,决策者等

eg: 消息队列系统主要是业务的子系统来使用,子系统发送消息或者接收消息

• When
  需求使用时间,包括时间,里程碑等

eg:当子系统需要发送异步通知的时候,需要使用消息队列系统

• What
  需求的产出,包括系统,数据,文件,开发库,平台等
  eg: 需要开发消息队列系统

• Where
  需求的应用场景
  eg: 开发,测试与生产环境的部署

• Why
  需求需要解决的问题,通常与需求背景有关
  eg:消息队列系统要把子系统解耦,把同步调用改为异步

1H

这部分主要是关键业务流程,复杂的业务系统可以独立成用例文档.

8C

8个Constraints

性能: 需要达到xxx的水平

成本: 参考 xx 公司的设计方案,不超过