xx概要设计说明书模板.docVIP

xx概要设计说明书 文档版本号[通过批准的版本号] 编写人： 审核人： 批准人： 北京映翰通网络技术有限公司 修订记录： 修订日期 版本 描述 编写人 目录 TOC \o 1-3 \h \z 1 引言 3 1.1 编写目的 3 1.2 背景 3 1.3 定义 3 1.4 参考资料 3 2 总体设计 3 2.1 系统功能 3 2.2 系统结构 4 2.3 系统设计 4 2.3.1 包图设计 4 2.3.2 类设计 4 2.3.3 数据库设计描述 4 2.3.4 对象状态描述 4 2.3.5 流程说明 4 2.4 分解描述 4 2.4.1 模块/子系统描述 4 2.4.2 数据设计 4 2.5 依赖性描述 5 2.6 接口描述 5 2.6.1 用户接口 5 2.6.2 外部接口 5 2.6.3 内部接口 5 3 数据结构设计 5 3.1 数据定义 5 3.2 数据格式 5 3.3 数据存储 6 3.3.1 逻辑设计 6 3.3.2 物理设计 6 3.3.3 ER图 6 4 运行环境 6 5 开发环境 6 5.1 开发工具 6 5.2 工程目录 6 5.2.1 工程目录图 6 5.2.2 工程目录描述 6 6 系统出错处理设计 7 6.1 出错信息 7 6.2 补救措施 7 7 系统维护设计 7 PAGE 4 北京映翰通网络技术有限公司 第 PAGE 2 页 共 NUMPAGES 8 页 北京映翰通网络技术有限公司 引言 编写目的 说明编写这份概要设计说明书的目的，指出预期的读者。 背景 说明： 待开发软件系统的名称； 定义 列出本文件中用到的专门术语的定义和外文首字母组词的原词组。 参考资料 列出有关的参考文件，如： 本项目的经核准的计划任务书或合同，上级机关的批文； 属于本项目的其他已发表文件； 本文件中各处引用的文件、资料，包括所要用到的软件开发标准。列出这些文件的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。 总体设计 系统功能 GENERATE – to request server to generate a specific report RETRIEVE – to retrieve a specific report’s physical path information CANCEL – to cancel a job request if it is being queue on the server PRINT – to print a specific report to the printer LIST – to list all requests of a specific request type ENQUIRY – to enquire for a particular request information base on some criteria like client id or date 系统结构 系统设计 在这里可以对各层所使用的技术做一个描述， 如，DAO层采用hibernate封装了所有对数据库的操作等 包图设计 类设计 数据库设计描述 对象状态描述 如果复杂的对象，需要描述对象状态 流程说明 描述系统架构模块之间的动态交互，来说明用例模型中典型用例场景。体现系统功能是如何实现的。 分解描述 本节描述系统中的子系统和模块。 模块/子系统描述 简介 功能列表 需要有序列图、执行过程描述、异常描述 数据设计 数据实体描述 按照以下格式描述： 标识： 类型： 目的： 依赖性描述 本节描述系统中的子系统，数据结构，模块，进程等设计实体间的关系。 依赖关系可以使用文字，结构图，（交互）事务图。 接口描述 用户接口 说明将向用户提供的命令和它们的语法结构，以及软件的回答信息。 外部接口 说明本系统同外界的所有接口的安排包括软件与硬件之间的接口、本系统与其他业务系统之间的接口关系。并定义接口测试级别（分高中低）。测试级别根据业务复杂度或技术难度来判断。 内部接口 说明本系