总体设计内容说明书模板.doc

《总体设计内容说明书模板.doc》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、xxxx有限公司总体设计说明书总体设计说明书编制人：xxxx等日期：2015/09/11版本修订历史记录：版本日期修改内容作者1.02015/09/11初始版本xxxx等地址:广东省汕头市嵩山路xxxx有限公司说明书目录第一章概述21.1目的21.2范围21.3术语定义21.4参考资料2第二章总体结构设计32.1系统约束32.2子系统与模块编号规则32.3系统总体架构32.4xxx程序结构设计42.4.1程序功能概述42.4.2程序外部环境说明42.4.3总体结构和模块外部设计42.4.4模块功能分配42.4.5模块外

2、部接口设计42.4.6模块运行设计52.4.7全局数据结构设计52.4.8物理数据结构设计52.4.9运行环境设计52.4.10程序维护设计52.4.11出错处理设计52.5xxx程序结构设计5第三章数据库设计63.1数据库ER图设计63.2数据库表设计63.3数据库其他设计6第四章通信协议设计75.1协议设计思想75.2协议格式75.3协议设计7第一章地址:广东省汕头市嵩山路第6页xxxx有限公司说明书概述1.1目的本文档的目的旨在推动软件工程的规范化，使设计人员遵循统一的详细设计书写规范，节省制作文档的时间，降低系

3、统实现的风险，做到系统设计资料的规范性与全面性，以利于系统的实现、测试、维护、版本升级等。本文说明了xxx系统的总体设计方案，便于系统开发人员可以根据本文设计详细的设计说明书。1.2范围本文作为总体设计方案，为以后的更加详细的设计提出了开发思路，具体内容包括：1、系统总体结构及各个模块的划分。各个模块的功能说明。2、数据库的总体设计思路，便于进行进一步的数据系统设计。3、系统各个部分的接口设计方法4、错误处理设计5、系统权限设计方法1.3术语定义1.4参考资料如项目合同需求分析说明书用户需求说明书第一章地址:广东省汕头

4、市嵩山路第6页xxxx有限公司说明书总体结构设计2.1系统约束本系统应该遵循J2EE和SNMP协议要求；本系统运行于Windowsserver2005中，数据库采用Oracle；本系统功能和界面需要满足和xxx公司签署的合同要求；本系统需要具有前瞻性，满足今后对系统扩展的要求；本系统应该界面友好，容易使用。2.2子系统与模块编号规则本系统根据功能大体分为如下几个模块，各个模块的特征标志符如下：基础资料：base用户管理：user系统维护：sys设备管理，包含如下三个小模块：SNMP服务：snmp图形显示：disp消息处

5、理：msg资料管理：data各自模块的文件命名、函数命名和宏定义等必须以各个模块的特征名开始2.3系统总体架构从系统结构上看，本系统采用J2EEMVC三层架构体系。如下图所示控制器servlet浏览器模型javabeanhibernate视图数据库设备文件主要业务在模型层完成，通过访问数据库，文件或者网络设备，获取相关信息并通过视图层表现出来。这些结构模型目前在J2EE程序设计中已经很成熟，就不再详述。地址:广东省汕头市嵩山路第6页xxxx有限公司说明书系统功能模块结构如下图所示：网络监管系统基础资料SNMP监控设备管

6、理系统维护用户管理报警处理图形显示资料处理2.4xxx程序结构设计2.4.1程序功能概述概述程序的功能2.4.2程序外部环境说明说明与本程序有关系的人、其他程序、外部设备、文件、数据库等所有外部联系。2.4.3总体结构和模块外部设计说明本程序的总体结构和模块划分，各个模块的主要功能。2.4.4模块功能分配表明各项功能与模块的关系，如：模块编号模块名称模块功能分配备注G-1Base管理基础资料G-2user用户管理定义用户权限G-3sys系统维护管理系统资源G-4map网络拓扑显示G-5snmp管理snmp协议通信处理G

7、-6disp流量图形显示2.4.5模块外部接口设计给出每个模块的接口形式及说明，面向对象的程序可以按照对象说明。地址:广东省汕头市嵩山路第6页xxxx有限公司说明书2.4.6模块运行设计说明主要功能由哪些模块组合实现的过程2.4.7全局数据结构设计给出程序所用的全局数据类别及关键数据形式，面向对象的程序可以按照对象说明。2.4.8物理数据结构设计主要是程序涉及访问的各种文件格式及命名。2.4.9运行环境设计软件平台：如采用tomcatweb服务器，适当采用strut,hibernate等框架。硬件平台：如内存4G以上，

8、千兆网卡，CPU2Ghz以上，250G以上硬盘的专用服务器网络环境要求：说明网络通信环境要求2.4.10程序维护设计说明为方便维护工作的设施，如维护模块等2.4.11出错处理设计尽量列出所有出错提示说明出错后如何处理2.5xxx程序结构设计地址:广东省汕头市嵩山路第6页xxxx有限公司说明书第一章数据库设计3.1数据库ER图设计3