服务器架构设计文档,架构设计文档
很多同学问做架构设计，怎么才能写出比较好的文档。其实很简单，都是有套路的，今天刚好借这个机会，和大家分享下一般做架构设计该怎么写文档。
背景
首先介绍下项目背景、基于什么原因需要需求。
如果是新产品，描述下产品启动的原因和背景、产品定位
如果是升级版本，描述升级需求、对原系统的影响，以及到达的预期效果
名词解释
文档中出现新的或者不常见的名词、概念给出定义和解释。
设计目标
实现功能
大致描述系统本身的功能性需求，不需描述外部依赖的系统。功能点之间的层级和关联关系要明晰。这里仅描述功能，不需要涉及实现方案、功能取舍等问题。
性能指标
描述系统性能需求。建议分条列出量化的性能指标，比如响应时间、超时率、资源占用、运行周期等。
系统环境
相关软件及硬件
在这里加入系统所需的软、硬件, 包括操作系统, 机器型号及配置要求。建议采用表格形式列出，最好还能规划出服务器和软件构件的部署图。
数据规模预估
通过经验或者调研，对数据规模进行估计，包括用户量、数据量、带宽消耗及增长速度等方面。
设计思路
描述系统设计中需要解决或考虑的关键问题或难点问题，解决这些问题可能有不同方案, 在这里加入方案设计的选择, 折衷及解释，并在后面的系统设计中对选中的方案给出进一步阐述。
建议分类列出，比如性能、可扩展性、安全性、服务稳定性、反作弊、复用等方面。建议使用调研数据支持设计方案的选择。
系统设计
基础介绍
对系统整体的简要说明。
系统架构图
把系统分解为若干子系统或模块，给出系统架构图，同时简单阐述每个模块完成的主要功能(必要时，给出模块划分的解释，即说明为什么把某些功能设计在某个模块中)。
系统流程图
通过流程图说明系统之间的模块是怎么交互来实现系统功能的
XXX 模块说明
XXX 模块功能
描述该模块要实现的功能，可以先简要描述，再分条列出。对于模块相关的关键功能和关键技术，也在此说明，供详细设计人员参考。
与其它模块的接口
在此描述该模块与系统内其它模块的接口，不包括模块内部的接口
风险评估
已知的或可预知的风险
在这里加上已经知道的或可能会发生的风险，包括技术、业务等方面。最好针对每个风险，列出相应的应对措施
与其它系统可能的影响
这里描述这些依赖关系可能带来的影响。包括本系统对其它系统可能造成的影响以及其它系统可能给本系统造成的影响两个方面
附件及参考资料
填写文档相关的附件或参考资料
彩蛋
对高可用架构感兴趣的同学可以购买 <>。该专栏能切实帮助你提高架构可用性，实现高可用的目标。
本专栏能收获什么
熟悉平台架构设计
优化架构产品
保证系统高可靠、高性能、高可扩展性
服务器架构设计文档,架构设计文档相关推荐
- 朱晔的互联网架构实践心得S1E9：架构评审一百问和设计文档五要素
朱晔的互联网架构实践心得S1E9:架构评审一百问和设计文档五要素 [下载文本PDF进行阅读] 本文我会来说说我认为架构评审中应该看的一些点,以及我写设计文档的一些心得.助你在架构评审中过五关斩六将,助 ...
- 基于java基于微服务架构的设备管理系统的设计与实现计算机毕业设计源码+系统+lw文档+mysql数据库+调试部署
基于java基于微服务架构的设备管理系统的设计与实现计算机毕业设计源码+系统+lw文档+mysql数据库+调试部署 基于java基于微服务架构的设备管理系统的设计与实现计算机毕业设计源码+系统+lw文 ...
- java计算机毕业设计BS架构考研交流学习平台设计与实现MyBatis+系统+LW文档+源码+调试部署
java计算机毕业设计BS架构考研交流学习平台设计与实现MyBatis+系统+LW文档+源码+调试部署 java计算机毕业设计BS架构考研交流学习平台设计与实现MyBatis+系统+LW文档+源码+调 ...
- java计算机毕业设计微服务”架构下新闻头条的设计与实现源码+系统+数据库+lw文档
java计算机毕业设计微服务"架构下新闻头条的设计与实现源码+系统+数据库+lw文档 java计算机毕业设计微服务"架构下新闻头条的设计与实现源码+系统+数据库+lw文档 本源码技 ...
- JAVA毕业设计BS架构考研交流学习平台设计与实现计算机源码+lw文档+系统+调试部署+数据库
JAVA毕业设计BS架构考研交流学习平台设计与实现计算机源码+lw文档+系统+调试部署+数据库 JAVA毕业设计BS架构考研交流学习平台设计与实现计算机源码+lw文档+系统+调试部署+数据库 本源码技 ...
- java计算机毕业设计BS架构考研交流学习平台设计与实现源码+数据库+系统+lw文档
java计算机毕业设计BS架构考研交流学习平台设计与实现源码+数据库+系统+lw文档 java计算机毕业设计BS架构考研交流学习平台设计与实现源码+数据库+系统+lw文档 本源码技术栈: 项目架构:B ...
- SLG手游Java服务器的设计与开发——架构分析
微信公众号[程序员江湖] 作者黄小斜,斜杠青年,某985硕士,阿里 Java 研发工程师,于 2018 年秋招拿到 BAT 头条.网易.滴滴等 8 个大厂 offer,目前致力于分享这几年的学习经验. ...
- 一个电子商务网站的设计及开发环境配置文档
开发环境配置文档 1.涉及的技术,工具 : + ANT1.6.2 ( 项目管理 ) + Eclipse2.1.2 ( 开发代码工具 ) + Junit2.1.1 ( 代码测试工具 ) + JDK ...
- java毕业论文_【毕业论文】基于java的博客网站设计与开发毕业论文(word文档)
<[毕业论文]基于java的博客网站设计与开发毕业论文.doc>由会员分享,可免费在线阅读全文,更多与<[毕业论文]基于java的博客网站设计与开发毕业论文(word文档)>相 ...
- JAVA毕业设计Web美食网站设计计算机源码+lw文档+系统+调试部署+数据库
JAVA毕业设计Web美食网站设计计算机源码+lw文档+系统+调试部署+数据库 JAVA毕业设计Web美食网站设计计算机源码+lw文档+系统+调试部署+数据库 本源码技术栈: 项目架构:B/S架构 开 ...
最新文章
- win10系统电脑wifi图标不见了的开启方法
- Android SurfaceView实现静态于动态画图效果
- 使用NGUI来制作技能的CD冷却效果
- 【ElasticSearch】ElasticSearch 嵌套查询：如何搜索嵌入的文档
- BZOJ2655 calc（动态规划+拉格朗日插值法）
- Java编程提高性能时需注意的地方
- 【spring】spring源码搭建
- 对抗神经网络（一）——GAN
- 案例分析十大管理领域理论背诵要点
- 《R3Det：Refined Single-Stage Detector with Feature Refinement for Rotating Object》论文笔记
- XJTU 新闻英语阅读微课内容总结
- python均线斜率_【每日一策】Matlab量化交易策略之 均线拐头配合出场
- 【知其然，知其所以然】配置中心 Apollo源码剖析
- qq批量登录软件_把微信PC版越甩越远：QQ电脑版这些新功能太良心
- ISA禁止skype网络电话的原理
- WINDOWS 2000下如何获得用户登录名和密码
- 用matlab实现运筹学最短路问题,运筹学 最短路问题.ppt
- 爬取贝壳上北京房屋的租赁信息
- Microsoft Dynamics CRM Server 2013下载
- homeassistant 在虚拟机中通过supervised方式安装