概要设计说明书

项目名称

概要设计说明书

V1.0

起草部门：研发部

管理部门：

撰写人：

审核人：

批准人：

发布日期：2011 年 09 月 01 日

特别说明

本页为本文的格式说明性文字，并不是概要说明书的一部分，因此在正式的概要说明书中，应该删除本页。

本模板用各种不同颜色的斜体“[”“]”对来表示各种含义的文字，其意义分别如下：

[模板V2.0 ]：表示这段文字在正式文档中不需要，应该删除。

[项目名称]：表示在生成正式文档时，应该用实际值替换这段文字。

[这里应该写项目产生的背景]：表示提示作者该如何来撰写这部分内容，在成文后这部分文字应该删除。

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

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

修订页

目录

1.引言 (1)

1.1.编写目的 (1)

1.2.背景 (1)

1.3.术语定义 (1)

1.4.参考资料 (1)

2.系统概述 (1)

2.1.功能目标 (1)

2.2.性能目标 (1)

2.3.工作环境 (1)

2.3.1. 工作环境配置清单 (1)

2.3.2. 需外购或领用的组件清单 (2)

2.4.可提炼组件 (2)

2.5.条件与限制 (2)

3.架构设计 (2)

3.1.设计思路 (2)

3.1.1. 设计规范 (2)

3.1.2. 设计思路 (2)

3.1.3. 关键技术 (3)

3.1.4. 技术架构 (3)

3.2.体系结构设计 (3)

3.3.部署方案设计 (4)

3.3.1. 网络拓扑结构 (4)

3.3.2. 网络模型与配置 (4)

3.4.安全设计 (4)

3.5.性能设计 (5)

3.6.出错处理设计 (5)

3.7.维护设计 (5)

4.模块设计 (6)

4.1.模块结构图 (6)

4.2.模块功能及关系 (6)

4.2.1. **模块１ (6)

4.2.2. **模块２ (6)

4.3.关键模块设计实现 (6)

4.3.1. 模块一 (6)

4.3.2. 模块二 (7)

5.接口设计 (7)

5.1.内部接口 (7)

5.2.外部接口 (7)

6.数据库设计 (7)

7.其他数据对象设计 (7)

7.1.文件设计 (7)

7.2.包结构设计 (7)

7.3.内存映像设计 (7)

1.引言

1.1.编写目的

[提示：说明编写这份概要设计说明书的目的。]

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

1.2.背景

软件系统的名称：[项目名称]

本项目的任务提出者：[产品部]

本项目的任务开发者：[产品部]

本项目的用户：

1.3.术语定义

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

1.4.参考资料

[提示：列出参考资料，如

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

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

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

2.系统概述

2.1.功能目标

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

2.2.性能目标

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

2.3.工作环境

2.3.1.工作环境配置清单

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

2.3.2.需外购或领用的组件清单

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

2.4.可提炼组件

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

可提炼的组件如下表：

2.5.条件与限制

[提示：

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

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

3.架构设计

3.1.设计思路

3.1.1.设计规范

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

3.1.2.设计思路

[提示：

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

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

3、软件结构：C/S，B/S，n-layer。]

3.1.3.关键技术

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

3.1.

4.技术架构

[提示：应用J2EE标准的系统设计需要撰写本小节。以下图为参考，如果项目所采用的技术与下图不一致，请在下图的基础上进行修改，并进行相应的说明]

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

架构简单说明：

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

2、客户层：系统最终用户的使用界面和设备。一般为基于浏览器的瘦客户端，比如IE等；

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

该层主要采用Front Controller, Request Processor, Command, View Dispatcher，DAO、工厂等设计模式来实现。

4、资源层（EIS）：各种信息系统资源，在本系统中主要用到了：RDBMS(数据库)。

3.2.体系结构设计

[提示：

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

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

3、说明系统组成及及各组成部分的功能。如果系统有子系统，子系统的模块组成也要描述清

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