概要设计说明书模板.docx

1、概要设计说明书模板键入文档副标题 XX项目概要设计说明书上海恒志软件科技有限公司修改记录版本日期修改人修改内容V0.12009-10-26武勇建立初稿。目录1 概述 11.1 编写目的 11.2 阅读范围 11.3 名词定义 11.4 参考资料 12 总体设计 22.1 系统拓扑图 22.1.1 系统运行环境说明 22.2 开发工具/公用框架描述 22.3 系统功能结构图/系统模块划分图 22.3.1 功能需求和系统模块映射矩阵 22.3.2 系统模块部署关系 32.4 数据流图及说明 32.5 系统目录结构 33 接口设计 53.1 外部接口 53.2 内部接口 53.2.1 接口列表 53

2、.2.2 接口描述 53.2.2.1 接口名称1 54 数据模型 74.1 域对象模型关系 74.2 表结构设计 75 系统出错处理设计 85.1 出错信息 85.2 错误显示方式 85.3 异常和错误在程序中的处理方式 86 参考资料 91 概述1.1 编写目的1.2 阅读范围1.3 名词定义1.4 参考资料2 总体设计2.1 系统拓扑图概述系统网络拓朴结构。2.1.1 系统运行环境说明列出运行该软件所需要的硬设备。说明其中的新型设备及其专门功能。列出支持软件，包括要用到的操作系统、编译（或汇编）程序、测试支持软件等。说明该系统同其他系统之间的接口、数据通信协议等。2.2 开发工具/公用框架

3、描述概述系统运行软/硬件开发环境与开发工具。以及采用的本公司开发公用框架、类库，开源软件，以及相应的版本。2.3 系统层次架构图给出系统设置的层次结构，例如：两层、三层、或多层结构之间的调用关系，组件名称等。2.4 系统功能结构图/系统模块划分图给出系统结构总体框图，说明本系统的各模块的划分，扼要说明每个系统模块的标识符和功能，给出各模块之间的控制与被控制关系。2.4.1 功能需求和系统模块映射矩阵功能需求与系统模块的关系本条用一张矩阵图说明各项功能需求的实现同各模块的分配关系。系统模块1系统模块2系统模块m功能需求1功能需求2功能需求n2.4.2 系统模块部署关系功能模块（组件）部属表功能模

4、块（组件）服务器2.5 数据流图及说明描述系统内部模块、子系统及外部系统之间数据流转、生命周期。2.6 系统目录结构描述本系统开发的目录基本命名规范。模块路径模块名称说明域对象模型系统域对象模型，包括流程框架使用的域对象模型Struts配置文件和Action各专业的struts配置以及struts action实现类业务方法系统业务方法，包括流程框架的业务方法Web模块源码/Tasktask/jhtask/cs任务单页面jspRequirement需求单页面jspFrame页面框架的jsp和Htmlscripts系统使用的样式表和jsImages系统的图片JsBrick框架代码3 接口设计3.

5、1 外部接口说明本系统同外界的所有接口的安排包括软件与硬件之间的接口、本系统与各支持系统之间的接口关系。可以是一个简单表格，表述本系统所有接口列表，并指明接口设计文档名称。序号接口名称外部系统名称主要技术备注 如果外部接口是在单独文档中描述，请说明参考文档名称。3.2 内部接口说明本系统之内的各个系统元素之间的接口的安排。3.2.1 接口列表序号接口名称接口涉及模块名称备注3.2.2 接口描述3.2.2.1 接口名称14 数据模型4.1 域对象模型关系可说明指向某具体数据模型设计文档。4.2 表结构设计可说明指向某具体数据模型设计文档。5 系统出错处理设计5.1 错误类型及输入方式应说明本系统中异常的显示具体方式：页面报错，后台日志，对话框等。例如：出错信息输出形式处理方法业务方法出现异常日志文件例如，主要的异常类，异常的抛出、异常信息的设置，异常和错误处理的层次等内容。客户端出现异常客户端：页面报错/对话框后台：日志文件5.2 出错信息一览表用一览表的方式说明每种可能的出错或故障情况出现时，系统输出信息的形式、含意及处理方法。也可以用独立的文档另外给出。