架构设计文档
很多同学问做架构设计，怎么才能写出比较好的文档。其实很简单，都是有套路的，今天刚好借这个机会，和大家分享下一般做架构设计该怎么写文档。 背景 首先介绍下项目背景、基于什么原因需要需求。 如果是新产品，描述下产品启动的原因和背景、产品定位 如果是升级版本，描述升级需求、对原系统的影响，以及到达的预期效果 名词解释 文档中出现新的或者不常见的名词、概念给出定义和解释。 设计目标 实现功能 大致描述系统本身的功能性需求，不需描述外部依赖的系统。功能点之间的层级和关联关系要明晰。这里仅描述功能，不需要涉及实现方案、功能取舍等问题。 性能指标 描述系统性能需求。建议分条列出量化的性能指标，比如响应时间、超时率、资源占用、运行周期等。 系统环境 相关软件及硬件 在这里加入系统所需的软、硬件, 包括操作系统, 机器型号及配置要求。建议采用表格形式列出，最好还能规划出服务器和软件构件的部署图。 数据规模预估 通过经验或者调研，对数据规模进行估计，包括用户量、数据量、带宽消耗及增长速度等方面。 设计思路 描述系统设计中需要解决或考虑的关键问题或难点问题，解决这些问题可能有不同方案, 在这里加入方案设计的选择, 折衷及解释，并在后面的系统设计中对选中的方案给出进一步阐述。 建议分类列出，比如性能、可扩展性、安全性、服务稳定性、反作弊、复用等方面。建议使用调研数据支持设计方案的选择。 系统设计 基础介绍