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

《xx概要设计说明书模板.doc》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、xx概要设计说明书文档版本号[通过批准的版本号]编写人：审核人：批准人：北京映翰通网络技术有限公司修订记录：修订日期版本描述编写人目录1引言31.1编写目的31.2背景31.3定义31.4参考资料32总体设计32.1系统功能32.2系统结构42.3系统设计42.3.1包图设计42.3.2类设计42.3.3数据库设计描述42.3.4对象状态描述42.3.5流程说明42.4分解描述42.4.1模块/子系统描述42.4.2数据设计42.5依赖性描述52.6接口描述52.6.1用户接口52.6.2外部接口52.6.3内部接口53数据结构设计53.1数据定义53.2数据格式53.3数据存储63.3.1

2、逻辑设计63.3.2物理设计63.3.3ER图64运行环境65开发环境65.1开发工具65.2工程目录65.2.1工程目录图65.2.2工程目录描述66系统出错处理设计76.1出错信息76.2补救措施77系统维护设计71引言1.1编写目的说明编写这份概要设计说明书的目的，指出预期的读者。1.2背景说明：a.待开发软件系统的名称；1.3定义列出本文件中用到的专门术语的定义和外文首字母组词的原词组。1.4参考资料列出有关的参考文件，如：a.本项目的经核准的计划任务书或合同，上级机关的批文；b.属于本项目的其他已发表文件；c.本文件中各处引用的文件、资料，包括所要用到的软件开发标准。列出这些文件的

3、标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。2总体设计2.1系统功能ØGENERATE–torequestservertogenerateaspecificreportØRETRIEVE–toretrieveaspecificreport’sphysicalpathinformationØCANCEL–tocancelajobrequestifitisbeingqueueontheserverØPRINT–toprintaspecificreporttotheprinterØLIST–tolistallrequestsofaspecificrequesttypeØEN

4、QUIRY–toenquireforaparticularrequestinformationbaseonsomecriterialikeclientidordate1.1系统结构1.2系统设计在这里可以对各层所使用的技术做一个描述，如，DAO层采用hibernate封装了所有对数据库的操作等1.2.1包图设计1.2.2类设计1.2.3数据库设计描述1.2.4对象状态描述如果复杂的对象，需要描述对象状态1.2.5流程说明描述系统架构模块之间的动态交互，来说明用例模型中典型用例场景。体现系统功能是如何实现的。1.3分解描述本节描述系统中的子系统和模块。1.3.1模块/子系统描述1、简介2、功能

5、列表需要有序列图、执行过程描述、异常描述1.3.2数据设计1、数据实体描述按照以下格式描述：标识：类型：目的：1.1依赖性描述本节描述系统中的子系统，数据结构，模块，进程等设计实体间的关系。依赖关系可以使用文字，结构图，（交互）事务图。1.2接口描述1.2.1用户接口说明将向用户提供的命令和它们的语法结构，以及软件的回答信息。1.2.2外部接口说明本系统同外界的所有接口的安排包括软件与硬件之间的接口、本系统与其他业务系统之间的接口关系。并定义接口测试级别（分高中低）。测试级别根据业务复杂度或技术难度来判断。1.2.3内部接口说明本系统各个层或者模块之间接口方法。并定义方法测试级别（分高、中、

6、低）。测试级别根据业务复杂度或技术难度来判断。2数据结构设计2.1数据定义给出本系统内会使用的哪些主要数据对象2.2数据格式指明本系统的数据对象的格式2.3数据存储主是数据库表的定义及表关系1.1.1逻辑设计1.1.2物理设计1.1.3ER图2运行环境列出系统运行的环境及版本号3开发环境3.1开发工具列出项目中使用的工具及版本号3.2工程目录3.2.1工程目录图列出项目的工程目录图3.2.2工程目录描述工程目录的详细说明4系统出错处理设计4.1出错信息说明每种可能的出错或故障情况出现时，系统输出信息的形式、含意及处理方法。1.1补救措施说明故障出现后可能采取的变通措施，包括：a.后备技术说明

7、准备采用的后备技术，当原始系统数据万一丢失时启用的副本的建立和启动的技术，例如周期性地把磁盘信息记录到磁带上去就是对于磁盘媒体的一种后备技术；b.降效技术说明准备采用的后备技术，使用另一个效率稍低的系统或方法来求得所需结果的某些部分，例如一个自动系统的降效技术可以是手工操作和数据的人工记录；c.恢复及再启动技术说明将使用的恢复再启动技术，使软件从故障点恢复执行或使软件从头开始重新运行的方法。2系统维护设计说明