软件开发概要设计说明书模板样本.doc

概要设计说明书文件状态: 草稿 正式发布 正在修改文件标识: 当前版本: X.Y作 者: 完成日期: YYYY-MM-DD版 本 历 史版本/状态作者参与者起止日期备注目 录1.引言11.1编写目的11.2定义11.3参考资料12.范围12.1系统主要目标12.2主要软件需求12.3设计约束、 限制13.软件系统结构设计13.1复审数据流、 控制流13.2软件体系结构13.2.1软件程序结构图13.2.2模块命名规则13.2.3模块描述13.3功能需求追溯23.4复用策略24.数据设计24.1数据字典复审24.2数据项24.3数据库结构设计24.4数据结构与程序的关系34.5文件设计35.接口设计35.1用户界面设计规则35.2内部接口设计35.3外部接口设计36.出错处理设计37.系统维护设计31. 引言1.1 编写目的说明编写这份概要设计说明书的目的, 并指出预期的读者。1.2 定义列出文件中用到的专门术语的定义和外文首字母的原词组。1.3 参考资料列出用的着的参考资料, 如: 本项目的经核准的计划任务书或合同, 上级机关的批文。属于本项目的其它已发表的文件本文件中各处引用的文件、 资料、 包括所需用到的软件开发标准。2. 范围对需求规格说明书进行复审, 如有变更需要在本节进行说明。以下内容描述软件概要设计的整体范围, 其主要信息来自于需求规格说明书。2.1 系统主要目标2.2 主要软件需求2.3 设计约束、 限制3. 软件系统结构设计3.1 复审数据流、 控制流复审需求分析阶段对软件的功能需求的描述( 如系统的DFD图和IDEF0图) 是否合理和精化。否则, 应在本节进行进一步分解和精化。3.2 软件体系结构经过变换映射( 如基于DFD或基于IDEF0的结构设计) , 并采用适当的优化准则进行软件结构的优化。该过程可在本节中分段落进行描述。已得到优化的软件体系结构用结构图( Structure Chart) 进行描述。描述的内容包括: 3.2.1 软件程序结构图画出软件体系结构的树状层次。3.2.2 模块命名规则给出软件模块的命名规则, 保证模块名称在项目内的唯一性和无二义性。3.2.3 模块描述可用IPO图结合下表对每一软件模块进行描述。名 称标识子系统名 称系统名称接口说明输入输出功能说明运行环境说明简要地说明对本模块的运行环境( 包括硬件环境和支持环境) 的规定调用关系说明调用模块被调用模块3.3 功能需求追溯本节说明需求规格说明书中的各项功能需求已在软件体系结构中得到分配。可用如下的二维表说明各项功能需求与软件模块的对应关系。模块1模块2模块M功能需求1功能需求2功能需求m此表能够采用其它适用形式,如拆分为两张表: 功能需求对应模块、 模块对应功能需求对应的模块功能需求1功能需求m对应的功能需求模块1模块m3.4 复用策略说明软件可复用的数据、 接口和模块。复用既指可利用的现有构件资源, 也指软件中可抽取的新建构件。4. 数据设计本章对软件所使用的数据进行定义和概要设计。本章内容在项目的其它文档中若有描述, 请在相应小节指明。4.1 数据字典复审对需求分析阶段形成的数据字典进行复审和精化。4.2 数据项定义软件使用的数据项, 可能包括: 名称、 简称、 类型、 长度、 别名等。4.3 数据库结构设计将需求分析阶段形成的实体模型转化为数据库系统支持的数据库模型。如根据ER图或IDEF1x图建立数据库的物理模型。4.4 数据结构与程序的关系给出本系统内所使用的每个数据结构的名称、 标识符, 说明各个数据结构与访问这些数据结构的各个程序模块间的对应关系, 可采用如下的矩阵图的形式: 模块1模块2模块M数据结构1数据结构2数据结构m4.5 文件设计说明数据存储文件的逻辑结构、 文件组织方式、 容量、 存取权限等。5. 接口设计5.1 用户界面设计规则分析需求规格说明书中的用户特点, 设计交互、 信息显示和数据输入等用户界面规则。若有的话, 列出用户的强制标准和开发单位的强制标准。5.2 内部接口设计说明软件内部模块间的接口安排。5.3 外部接口设计说明本系统同外界的所有接口的安排, 包括软件与硬件之间的接口, 本系统与各支持软件之间的接口关系。内部和外部的接口设计必须结合模块内部的数据验证和出错处理。6. 出错处理设计说明每种可能的出错或故障情况, 并对她们命名和编号; 给出出错时的信息显示界面; 和相应的补救措施。7. 系统维护设计说明为了系统维护的方便而在程序内部设计中作出的安排, 指明哪些功能和数据需要维护及其实现维护功能的模块。