架构设计文档

很多同学问做架构设计,怎么才能写出比较好的文档。其实很简单,都是有套路的,今天刚好借这个机会,和大家分享下一般做架构设计该怎么写文档。

背景

首先介绍下项目背景、基于什么原因需要需求。

  • 如果是新产品,描述下产品启动的原因和背景、产品定位
  • 如果是升级版本,描述升级需求、对原系统的影响,以及到达的预期效果

名词解释

文档中出现新的或者不常见的名词、概念给出定义和解释。

设计目标

实现功能

大致描述系统本身的功能性需求,不需描述外部依赖的系统。功能点之间的层级和关联关系要明晰。这里仅描述功能,不需要涉及实现方案、功能取舍等问题。

性能指标

描述系统性能需求。建议分条列出量化的性能指标,比如响应时间、超时率、资源占用、运行周期等。

系统环境

相关软件及硬件

在这里加入系统所需的软、硬件, 包括操作系统, 机器型号及配置要求。建议采用表格形式列出,最好还能规划出服务器和软件构件的部署图。

数据规模预估

通过经验或者调研,对数据规模进行估计,包括用户量、数据量、带宽消耗及增长速度等方面。

设计思路

描述系统设计中需要解决或考虑的关键问题或难点问题,解决这些问题可能有不同方案, 在这里加入方案设计的选择, 折衷及解释,并在后面的系统设计中对选中的方案给出进一步阐述。

建议分类列出,比如性能、可扩展性、安全性、服务稳定性、反作弊、复用等方面。建议使用调研数据支持设计方案的选择。

系统设计

基础介绍

对系统整体的简要说明。

系统架构图

把系统分解为若干子系统或模块,给出系统架构图,同时简单阐述每个模块完成的主要功能(必要时,给出模块划分的解释,即说明为什么把某些功能设计在某个模块中)。

系统流程图

通过流程图说明系统之间的模块是怎么交互来实现系统功能的

XXX 模块说明

XXX 模块功能

描述该模块要实现的功能,可以先简要描述,再分条列出。对于模块相关的关键功能和关键技术,也在此说明,供详细设计人员参考。

与其它模块的接口

在此描述该模块与系统内其它模块的接口,不包括模块内部的接口

风险评估

已知的或可预知的风险

在这里加上已经知道的或可能会发生的风险,包括技术、业务等方面。最好针对每个风险,列出相应的应对措施

与其它系统可能的影响

这里描述这些依赖关系可能带来的影响。包括本系统对其它系统可能造成的影响以及其它系统可能给本系统造成的影响两个方面

附件及参考资料

填写文档相关的附件或参考资料

彩蛋

对高可用架构感兴趣的同学可以购买 <<带你玩转高可用>>。该专栏能切实帮助你提高架构可用性,实现高可用的目标。

本专栏能收获什么

  1. 熟悉平台架构设计
  2. 优化架构产品
  3. 保证系统高可靠、高性能、高可扩展性