概要设计说明书文档格式.docx

概要设计说明书文档格式.docx

《概要设计说明书文档格式.docx》由会员分享，可在线阅读，更多相关《概要设计说明书文档格式.docx（10页珍藏版）》请在冰豆网上搜索。

表示提示作者该如何来撰写这部分内容，在成文后这部分文字应该删除。

1．在正式成文提交审核时，文中不应该再存在上述由“[]”包括的文字。

2．对于小型项目，有些章节可能不需要，则在该章节中注明“无”。

修订页

编号

章节

名称

修订内容简述

修订

日期

修订前

版本号

修订后

修订人

批准人

1

全部

2011-9-1

1.引言

1.1.编写目的

[提示：

说明编写这份概要设计说明书的目的。

]

[示例：

根据项目需求，确定系统架构和实现功能，作为架构设计师、设计师、编码工程师、测试策划师之间交流的工具，为后续的详细设计、测试策划、软件验收提供依据，也作为后续维护人员接手的材料。

1.2.背景

软件系统的名称：

[项目名称]

本项目的任务提出者：

[产品部]

本项目的任务开发者：

本项目的用户：

1.3.术语定义

列出文件中用到的专门术语的定义和外文首字母的原词组。

1.4.参考资料

列出参考资料，如

1、本项目开发任务书或合同等；

2、属于本项目的其他已发表的文件；

3、本文件中各处引用的文件、资料、包括所需用到的软件开发标准。

2.系统概述

2.1.功能目标

[内容可以从分析设计说明书中摘录。

2.2.性能目标

[内容可以从需求分析说明书中摘录。

2.3.工作环境

工作环境配置清单

如PC机型、操作系统、虚拟机、开发工具、其他软硬件支持等，所有软件必须注明版本及数量，有必要时要注明小版本号。

需外购或领用的组件清单

需外购或领用的组件如下表：

序号

名称及版本

来源

用途

2.4.可提炼组件

[这里列出本系统中完成的、可以建议提炼为公司级可重用的组件清单，对于公司级的可重用组件，在项目测试中后期由架构师提出，召集项目经理、技术规划部代表等相关人员进行提炼，提炼完成后需要提供使用说明等文档，并归入财富库。

可提炼的组件如下表：

2.5.条件与限制

1、不支持的业务功能、使用上的限制，如系统只能在一台机器上使用等。

2、不支持的环境，如操作系统等。

3.架构设计

3.1.设计思路

设计规范

说明本系统设计需遵循的规范（如界面设计规范、数据库设计规范、项目开发命名标准等）。

设计思路

1、难点问题及不容易理解需要特别说明的系统；

2、采用的设计思想/模式/框架/协议；

3、软件结构：

C/S，B/S，n-layer。

关键技术

说明本系统所采用的关键技术进行说明，对关键技术只需要进行概述]

技术架构

应用J2EE标准的系统设计需要撰写本小节。

以下图为参考，如果项目所采用的技术与下图不一致，请在下图的基础上进行修改，并进行相应的说明]

图3.1***系统技术架构图

架构简单说明：

1、整个架构主要由客户层、中间层（web层、架构层、EJB层）、资源层组成。

2、客户层：

系统最终用户的使用界面和设备。

一般为基于浏览器的瘦客户端，比如IE等；

3、中间层：

用户和系统之间的交互管理，提供用户层的展现逻辑和对资源层的访问接口。

该层主要采用FrontController,RequestProcessor,Command,ViewDispatcher，DAO、工厂等设计模式来实现。

4、资源层（EIS）：

各种信息系统资源，在本系统中主要用到了：

RDBMS（数据库）。

3.2.体系结构设计

[提示：

1、系统体系结构图。

如果涉及与其他系统的接口，图中也要体现；

2、以总分结构来描述体系结构，有可能需要多个结构图来分级描述

3、说明系统组成及及各组成部分的功能。

如果系统有子系统，子系统的模块组成也要描述清楚。

组成可以用树状图或形式其他形式描述；

4、确定模块之间的调用关系；

5、需要明确哪些部分是属于本系统的，哪些属于外部系统；

明确哪些模块是本期设计完成的，哪些是规划中的模块。

6、对于某些项目，如果系统组成图还不足以反映其软件结构，那么本节可根据实际情况进行扩展，比如增加系统的纵向结构图、数据体系结构图等

3.3.部署方案设计

网络拓扑结构

用VISIO画出基本的硬件部署。

根据用户数量等因素，确定产品的各种部署方案。

网络模型与配置

此网络模型图是对系统网络拓扑的细化，需要描绘出各系统的部署情况，需要列出软硬件配置清单及数量。

3.4.安全设计

[分别从以下几个不同的层面设计相应的安全解决方案：

1）数据传输过程中的安全解决方案，可选技术：

PKI体系；

2）访问控制的安全解决方案，可选技术列表如下：

●防火墙

●入侵检测与监控

●访问日志记录

●访问口令管理与系统操作管理

●双网卡策略

●网络物理隔离策略

●对数据本身制定安全管理策略（如：

数据外网加密，传递到内网再解密）

3）数据备份与恢复方案

对于整个系统的数据设计详细的备份方案。

4）权限分配策略及审计

5）应用本身的防篡改设计，比如加解密算法dll的防替换设计。

6）数据存储的安全性设计，如处于外网上的数据库关键字段加密，做摘要等。

3.5.性能设计

[在这里列出所有为提高系统的设计，可选择的技术如下：

1）引用CACHE技术；

2）引入多线程并行执行技术；

3）关键算法优化；

4）其他有利于性能提高的技术；

5）硬件选型，如选择更高性能设备；

6）集群技术；

7）应用交换机等。

3.6.出错处理设计

1．错误信息代码

[系统错误信息和提示通过配置文件方式配置，通过统一的接口来获取错误信息和提示信息；

[错误信息代码通过向品管部申请，使用80******-80******代码段，具体规划如下：

第5位按照模块来划分，如下表所示：

第5位代码

系统模块

错误举例

提示举例

公共

80000001

80100001

3.7.维护设计

[说明为了系统维护的方便而在程序内部设计中作出的安排，指明哪些功能和数据需要维护，及其实现维护功能的模块。

1、针对如何快速的扩展功能所所作的设计

2、如何快速定位故障所作的设计

4.模块设计

4.1.模块结构图

[

1.用VISIO画细分后的模块层次结构图，层次结构图目的在于描述模块与模块之间的相关关系。

2.每个模块用VISIO画细分图，细分粒度要求：

到具体功能/操作，以树状图形表示。

此二类图如果能在一张图中清楚描述，可二合一。

4.2.模块功能及关系

具体说明每个模块的功能、模块相互的关系。

可采用下表的格式或层次图等方式进行描述。

**模块１

模块编号

二级模块

三级模块

功能描述

实现流程

备注

**模块２

4.3.关键模块设计实现

涉及组件、服务等关键模块都必须写设计实现，格式根据实际情况可以调整

模块一

4.3.1.1.功能描述

4.3.1.2.实现流程

主要描述组件实现需求

4.3.1.3.数据结构

4.3.1.4.对外接口

模块二

5.接口设计

5.1.内部接口

这里描述系统内部各子系统之间、各模块之间的接口。

需要详细描述接口方式、方法名、参数、以及作用等，不能有二义性。

5.2.外部接口

描述本系统同外界的所有接口的安排，包括软件与硬件之间的接口、网络通讯接口、本系统与各支持软件之间的接口关系。

6.数据库设计

[对于大中型项目，数据库设计应该另外单独成文，作为概要设计说明书的附件，数据库设计的模板参见附件；

对于小型项目，数据库设计可以和合成在本文，数据库设计的章节安排参见数据库设计模板。

[参见《附件n——数据库设计》]

7.其他数据对象设计

7.1.文件设计

这里必须包含如下内容：

1．软件安装完成后的目录结构以及文件列表

2．各类配置文件的描述，包括作用、命名规则、内部格式定义等等

3．其他文件设计]

7.2.包结构设计

[对于J2EE、C#项目，在这里列出项目的包结构，以及说明各个包之间的关系和作用。

7.3.内存映像设计

描述系统全局性的关键的变量.结构设计]

水调歌头·

明月几时有

宋代：

苏轼

丙辰中秋，欢饮达旦，大醉，作此篇，兼怀子由。

明月几时有？

把酒问青天。

不知天上宫阙，今夕是何年。

我欲乘风归去，又恐琼楼玉宇，高处不胜寒。

起舞弄清影，何似在人间？

转朱阁，低绮户，照无眠。

不应有恨，何事长向别时圆？

人有悲欢离合，月有阴晴圆缺，此事古难全。

但愿人长久，千里共婵娟。