概要设计说明书模板.docx

1、概要设计说明书模板计算机学院*项目名称* 概要设计说明书小组序号：01编 撰 人：年 级 班 级：2011级应用 班指导教师：提交日期：2015年 月 日目录1. 引言 11.1. 编写目的 11.2. 背景 11.3. 术语 11.4. 参考资料 12. 总体设计 22.1. 系统体系结构 22.2. 系统组成结构 22.3. 运行环境 22.3.1. 运行环境网络结构说明 32.3.2. 运行环境说明细则 42.3.3. 支持软件 52.4. 系统的关键技术 53. 构件设计 53.1. 构件1 53.1.1. 功能模块1 53.1.2. 功能模块2(示例) 53.1.3. 功能模块n 6

2、3.2. 构件之间的关系 64. 接口设计 64.1. 外部接口 64.1.1. 接口1 64.1.2. 接口2 64.2. 内部接口 64.2.1. 接口1 74.2.2. 接口2 85. 运行设计 85.1. 运行模块组合 85.2. 运行控制 95.3. 运行时间 96. 系统出错处理 96.1. 出错信息 96.2. 补救措施 106.3. 系统维护设计 10引言编写目的说明编写这份概要设计说明书的目的，指出预期读者。背景描述系统产生的背景，包括：a、 需开发的软件系统的名称，和英文缩写（可选），项目编号（可选）；b、 列出此项目的任务提出者、开发者c、 软件系统应用范围、用户。术语列

3、出本文件中用到的专门术语、术语定义、外文首字母组词的原词组。参考资料本节列出用得着的参考资料，如：a 本项目经核准的计划任务书或合同、上级机关的批文；b 属于本项目的其他已发表的文件；c 本文件中各处引用的文件、资料、包括所要用到的软件开发标准。d 行业标准和规范。列出这些文件资料的标题、文件编号、发表日期和出版单位。总体设计系统体系结构编制并描述系统的体系结构图，并说明系统的运行原理。示例：图2-1 系统体系结构图系统功能结构用一览表及图的形式说明本系统的结构（构件、各层模块等）的划分。 示例：图2-2 系统功能结构图运行环境说明本产品的运行环境（包括硬件环境和软件环境）的规定。根据不同类型

4、、不同规模的项目，项目组可以对以下内容做增减。硬件环境1) 描述本软件运行对服务器、客户端的硬件要求：服务器：主要描述设备名称、设备型号、设备数量、处理器型号及内存容量；客户端：主要描述客户端的内存、处理器、硬盘容量。2) 描述本软件运行所使用的外围设备，主要包括：外存储设备的容量、媒体及其存储格式、设备型号和数量等；输入/输出设备的型号和数量等；数据通信设备的型号和数量等；其它专用硬件。软件环境描述本软件运行所使用的计算机软件及版本，包括：1) 操作系统；2) 数据库系统；3) 开发平台及工具；4) 通信协议；5) 其他软件。系统的关键技术说明系统中使用到的关键技术及对关键技术的测评结果构件

5、设计构件列表表3-1 构件列表序号构件分类构件名称依赖关系说明复用情况应说明复用的是资产库中的哪个构件，是完全复用还是部分复用构件集成说明应确定如下内容：集成顺序，说明集成时那个应先集成，那个后集成，可以根据构件的依赖关系确定；集成的策略，采用自底向上或自顶向下的集成策略等；集成就绪准则，根据项目的实际情况确定可以开始集成的准则； 集成结束准则，根据项目的实际情况确认可以结束集成的准则。构件1对构件进行简要说明功能模块列表表3-2 模块列表构件名称模块编号模块名称对应需求功能编号所对应需求功能实现优先级营销管理DS_YXGL01订单采集SRS_YXGL02.01订单采集高说明：1.模块编号，建

6、议采用设计的英文缩写_模块名称缩写（可以是中文缩写也可以是英文缩写）+序列号的方式；例如：DS_YXGL012.如果构件是来至复用，模块中也需说明模块是否复用。功能模块1如该功能模块下有子功能模块，请采用层级结构进一步说明。功能模块的描述，可以根据项目实际情况做裁剪和增补。一般需求明确如下内容：【模块编号】【功能描述】功能模块的概括性描述【前置条件】如果有，请描述进入此模块必要的业务或数据前提。【操作者】说明使用此模块的相关角色。【与本模块相关的代码表和表】表3-3 模块功能表名称中文注释类型作用代码表表【界面】具体的设计页面。【输入】解释各输入数据类型，并逐项说明其媒体、格式、数值范围、精度

7、等。【处理流程及说明】流程图：流程说明：【算法】【输出】解释各输出数据类型，并逐项说明其媒体、格式、数值范围、精度等。对输出中有明确要求输出量必须进行解释并举例，包括对正常结果输出、状态输出及异常输出，图形或显示报告的描述。功能模块2构件n功能模块列表功能模块m接口设计需说明接口的使用者/调用者、接口的目的、内容、数据格式、读写方式、约束等。表4-1 构件接口列表构件名称接口编号接口名称接口类型说明构件1内部外部外部接口本系统与硬件之间及本系统与各支持软件之间的接口。接口1接口属性设计表4-2 接口说明接口编号接口名称接口说明数据来源调用者输入输出调用方式说明接口2内部接口本系统内的各构件之间

8、的接口。接口11) 接口属性设计表4-3 接口说明接口编号接口名称接口说明数据来源调用者输入输出处理流程2) 接口处理流程图配合上面的“处理流程”；3) 类设计表4-4 类类名称分类描述使用到的其他类属性及方法描述使用/交互其他 接口2部署设计给出系统部署方案、部署结构图，尽量使用图表的形式，并辅以必要的文字说明。示例：图5-1 系统部署图对网络部署结构进行说明：。数据库设计系统出错处理出错信息用一览表的方式说明每种可能的出错或故障情况出现时，系统输出信息的形式、含意及处理方法。例如：表6-1 可能故障一览表错误分类子项及其编码错误名称错误代码备注数据库错误连接连接超时100001001连接断

9、开100001002数据库本身错误代码数据库本身错误代码100002+数据库错误代码TCP连接错误连接连接超时101001001连接断开101001002其它TCP连接错误(socket自身错误代码)101002+ socket错误代码配置信息错误未配置输入参数102001未配置输出参数102002补救措施说明故障出现后可能采取的变通措施，包括：1、 后备技术 说明准备采取的后备技术，当原始系统数据万一丢失时启用的副本的建立和启动的技术。例如，周期性地把磁盘信息记录到磁带上去就是对于磁盘媒体的一种后备技术。2、降效技术 说明准备采取的后备技术，使用另一个效率稍低的系统或方法来求得所需结果的某些部分。例如，一个自动系统的降效技术可以是手工操作和数据的人工记录。3、恢复及再启动技术 说明将使用的恢复再启动技术，使软件从故障点恢复执行或使软件从头开始重新运行的方法。系统维护设计说明为了系统维护的方便而在程序内部设计中作出的安排，包括在程序中专门安排用于系统的检查与维护的检测点和专用模块。