概要设计说明书怎么写( 四 ) _概要

(1) 系统架构：一般来说会有个简单的架构图，并配以文字对架构进行简要说明；
(2) 模块简介：架构图中如果有很多模块，需要对各个模块的功能进行简要介绍；
(3) 设计与折衷：设计与折衷是总体概要设计中最重要的部分；
(4) 潜在风险（可选）；
输出总体概要设计的时候，很多方案还是不确定的，需要在设计评审会议上确认。
总体概要设计重点在“方案折衷”，总体概要设计评审完毕之后，此时应该是所有方案都确认了，需要输出各模块的详细设计，详细设计重点在“详细”：
(1)总体概要设计结论汇总（可选）：达成一致的结论有个简要概述，说明详设是对这些结论的实现；
(2)交互流程：简要的交互可用文字说明，复杂的交互建议使用流程图，交互图或其他图形进行说明；
(3)数据库设计：这个是应该放在总设还是详设呢？
(4)接口形式：有了数据库+接口+流程，别的同学拿到详设文档，基本也能够搞定了；
(5)其他细节：例如公式等；
理论上输出了详细设计之后，无论谁拿到了这个详设文档，都是能够完成该项目的。
个人实践分享：
一、大图
(1) 大系统或复杂流程，其架构图或者流程图会非常大，经常比A4纸或word的一页大很多，此时不宜在word中直接贴图形，贴了也看不清，建议将图放在wiki上，文档中直接贴链接；
(2) 一定要保存viso或者其他图形的源文件，否则今后改动起来要重画，代价可想而知；
二、设计与折衷
(1) 设计与折衷是总设中最重要的内容，总设评审中，主要就是讨论这些折衷的优劣；
(2) 评审过后，不但要邮件周知结论，还要在总设中进行更新，说明最终决定使用了哪种方案，为什么使用这种方案；根据自己的经验，接手别人的模块、项目，拿到代码和文档，设计方案对我来说完全是个谜！！！
(3) 有时候因为排期或者其他原因，不一定采用了最优的设计方案，此时更应该在总设中记录决策的过程与原因；
(4) 最后，设计折衷是一个很好的自我辩解的机会：因为项目进度，或者历史遗留问题，我不得不采取了一个这样的设计，不要再骂我了。
【概要设计说明书怎么写】三、性能目标
性能目标是新模块文档必不可少的一部分，很多项目对性能影响较大的话，也必须撰写性能目标，性能一般来说可能包含以下部分：
(1) 日平均请求：一般来自产品人员的评估；
(2) 平均QPS：日平均请求除以 4w秒得出，为什么是4w秒呢，24小时化为86400秒，取用户活跃时间为白天算，除2得4w秒；
(3) 峰值QPS：一般可以以QPS的2~4倍计算；
互联网公司，产品迭代块，项目周期长，基本没有“文档”一说，但其实写好文档，对系统和项目未来的维护是非常有帮助的。
8.详细设计说明书到底怎么写原发布者：fxort04
LyraResourcePlatform文档详细设计说明书详细设计说明书1.引言1.1编写目的本详细设计说明书是针对网络信息体系结构的课程作业而编写。目的是对该项目进行详细设计，在概要设计的基础上进一步明确系统结构，详细地介绍系统的各个模块，为进行后面的实现和测试作准备。本详细设计说明书的预期读者为本项目小组的成员以及对该系统感兴趣，在以后想对系统进行扩展和维护的人员。2.系统的结构ui：系统界面部分，负责接受用户输入，显示系统输出，负责其他模块功能的协调调用，并含有站内搜索功能，即在用户指定的已打开的ftp站点中搜索用户需要的资源。ui部分调用common部分的功能读取xml文件中保存的界面元素属性信息，用户最近访问过的10个ftp信息，用户选择的下载的ftp内容列表及其他需要通过xml文件保存的信息。client：实现ftp客户端的功能，ftp连接，ftp上传及下载：上传或下载用户指定的1LyraResourcePlatform文档详细设计说明书资源，并返回相应的信息。search：资源实时检索部分，根据用户输入的资源名称关键字，资源类型和选择的检索方式检索用户需要的资源，并验证资源的可用性，返回可用资源及其大小，速度等相关信息。preview：资源预览部分，显示用户选择的资源的部分内容，以使用户决定是否需要该资源。preview部分调用common部分读取属性文件的内容亦显示预览资源内容的显示格式。3.模块