1、股份有限公司概要设计说明书项目编号:项目经理:产品版本号:创 建 日 期编 写 人最后修改日期审 核 人审 核 日 期批 准 人批 准 日 期股份有限公司 概要设计说明书- 2 -变更记录变更章节号及名称变更内容描述变更人变更日期变更前版本号批准人M 封面 把“项目负责人”改为“项目经理” 。M 修改了页眉不一致的问题。D 1 前言删除“1.2 适用范围” 。A 3 总体设计增加“3.5 需求分配表”和“3.6接口需求表” 。M 3 总体设计把“3.3 功能模块 1”改为“3.2.1 功能模块 1”。依次类推。注:变更分三种:A增加,M修改,D删除股份有限公司 概要设计说明书- 3 -目录1
2、前言 .51.1 编写目的 .51.2 适用范围 .51.3 术语定义 .51.4 参考资料 .52 产品/项目概述 .62.1 产品/项目概述 .62.2 存在什么问题和风险 .62.3 局限性 .62.4 设计的前提条件 .63 总体设计 .63.1 总体架构 .63.2 功能模块描述及数据流图 .73.2.1 功能模块 1(请用功能模块 1 的名称代替) .73.2.2 功能模块 2(请用功能模块 2 的名称代替) .83.3 需求分配表 .83.4 接口需求表 .84 本版本的性能指标 .95 运行设计 .95.1 运行模块组合 .95.2 运行控制 .96 运行环境的配置 .96.1
3、 设备环境需求 .96.2 软件环境需求 .97 进度调整 .9股份有限公司 概要设计说明书- 4 -1 前言1.1 编写目的本设计报告的依据是产品需求规格说明书 。设计者对产品需求规格说明书进行分析,确定本软件的体系结构,主要描述“设计什么”和“如何设计” 。通过概要设计,使本项目与 ezONE 开发中心其他各项目组(包括群组所立的有关项目) 、测试组和美工文档组相关人员达成共识。根据产品需求规格说明书所列出的功能和性能需求,要明确说明本项目的设计思路、整体结构和主要有哪些模块组成,同时还要描述清楚各模块的结构及模块间信息传递的接口。为设计人员提供详细设计依据;为研发管理人员提供管理依据;为
4、系统测试人员提供测试依据;为文档人员提供书写各种说明书的依据。本报告的预期读者应该是 ezONE 开发中心的技术总监、售前技术支持人员、详细设计人员、产品经理、开发人员、测试人员、文档人员、美工人员和过程管理人员。1.2 适用范围本文档适用于股份有限公司。1.3 术语定义列出本文件中用到的专门术语的定义和外文首字母组词的原词组。1.4 参考资料包括:1) 产品需求规格说明书 ;2)文档所引用的资料、标准和规范股份有限公司 概要设计说明书- 5 -(列出这些资料的作者、标题、发表日期、出版单位或资料来源) 。2 产品/项目概述2.1 产品/项目概述用简洁的语言描述本产品/项目的设计目标。如果是新
5、产品,需要进行全面描述;如果是继续开发的产品,对以前的版本进行简单的描述,对新增内容详细描述。2.2 存在什么问题和风险请写出,到目前为止完成产品需求规格说明书中规定的任务还存在什么问题和风险。2.3 局限性说明本次完成的版本在应用时的局限性。2.4 设计的前提条件如果本项目是以插件形式发布,必须写出建立在什么平台上。同时写出对该平台功能和性能的需求。有些项目既可以独立发布,也可以在门户平台上发布,请分别写出设计的前提条件。3 总体设计3.1 总体架构如果是继续开发的项目,请将整体的体系结构写(或画)清楚,标明(用不同颜色或不同字体)本次将要开发的内容,并用文字描述本次开发部分的主股份有限公司
6、 概要设计说明书- 6 -要功能和性能;如果是新立项目,请写清楚本项目的体系结构,主要由哪些模块组成,并进行描述。3.2 功能模块描述及数据流图请写清楚每个模块的设计模式、扩展策略、复用策略、折衷策略等。设计模式最好用模式图表示。3.2.1功能模块 1(请用功能模块 1 的名称代替)3.2.1.1 本模块(请用名称代替)的功能描述及结构组成最好用逻辑图的方式表示本模块的结构。请分别写清楚本模块所要完成的所有功能,如果有输入数据,请写明数据来自何方(来自人工输入,来自其他模块等)及数据的内容,如果能提供数据格式更好;如果有输出数据,请写明输出数据内容及格式。例如:功能 1 描述功能 2 描述等等
7、3.2.1.2 本模块(请用名称代替)的程序设计叙述该模块的程序设计思想,设计模式和层次结构及包组织关系等。最好画出序列图。3.2.1.3 本模块(请用名称代替)的数据流图最好用图表示。3.2.1.4 本模块(请用名称代替)的数据结构主要是文件结构和数据结构的定义。如果不在这里说明,也可以在详细设计时说明。股份有限公司 概要设计说明书- 7 -数据结构必须定义,只需定义到表名,主键等库结构级别,与该模块的细节关系如涉及到该模块的数据字典放到详细设计中。3.2.1.5 本模块(请用名称代替)的界面描述如果有界面,请与美工商定界面的需求,并进行描述。如果在产品需求规格说明书中已经描述清楚,这里可以
8、不写,如果没有描述,这里必须写。3.2.1.6 本模块(请用名称代替)的性能指标如果没有可以写无。3.2.1.7 本模块(请用名称代替)用到的开源软件描述本模块用到的外部接口、算法、和配置信息。描述本模块用到的类的方法、属性等。具体各类的关系图放到详细设计。3.2.2功能模块 2(请用功能模块 2 的名称代替)顺序写下去,直至将所有模块描述完毕。3.3 需求分配表为给每个功能模块分配需求,请填写下表。标识 功能模块名分配的需求(功能、性能)约束条件派生需求与其他派生需求的关系3.4 接口需求表为识别功能模块之间的接口或对象接口,请填下表。股份有限公司 概要设计说明书- 8 -标识 功能模块名相
9、关的功能模块名接口内/外部接口约束条件4 本版本的性能指标主要是并发性、负载特性、稳定性、响应时间、运行时 CPU 占用情况,内存占用情况。5 运行设计5.1 运行模块组合逐个说明对系统施加不同的外界运行控制时,所引起的各种不同的运行模块组合,说明每种运行所历经的内部模块和支持软件。如果不在这里写,在详细设计时必须写出。5.2 运行控制说明每一种外界的运行控制的方法和操作步骤。6 运行环境的配置运行环境的最低配置。6.1 设备环境需求6.2 软件环境需求股份有限公司 概要设计说明书- 9 -7 进度调整如果对产品需求规格说明书中的计划进度有调整,可以在这里写清楚。填写说明:1、每项必填,如果这一项没有内容可以填“无” ;2、有补充内容或变更内容,要在本文档的基础上进行;3、本报告要经过产品经理审阅。