总体设计说明书模板.docxVIP

错误!未指定书签。 编制人:XXXX等 日期:2015/09/11 版本修订历史记录: 版本 日期 修改内容 作者 1.0 2015/09/11 初始版本 XXXX 等 目 录 TOC \o 1-5 \h \z \o Current Document 第一章概述 2 \o Current Document 1目的 2 \o Current Document 1.2范围 2 \o Current Document 1.3术语定义 2 \o Current Document 1.4参考资料 2 \o Current Document 第二章总体结构设计 3 \o Current Document 1系统约束 3 \o Current Document 2. 2子系统与模块编号规则 3 \o Current Document 2. 3系统总体架构 3 \o Current Document 2. 4 xxx程序结构设计 4 2.4.1程序功能概述 4 2. 4. 2程序外部环境说明 4 2. 4. 3总体结构和模块外部设计 4 2.4.4模块功能分配 4 2.4.5模块外部接口设计 4 2. 4. 6模块运行设计 5 2. 4. 7全局数据结构设计 5 2. 4. 8物理数据结构设计 5 2. 4. 9运行环境设计 5 2.4.10程序维护设计 5 2.4. 11出错处理设计 5 \o Current Document 2. 5 xxx 程序结构设计 5 \o Current Document 第三章数据库设计 6 \o Current Document 3.1数据库ER图设计 6 \o Current Document 3.2数据库表设计 6 \o Current Document 3.3数据库其他设计 6 \o Current Document 第四章通信协议设计 7 \o Current Document 5.1协议设计思想 7 5. 2协议格式 7 \o Current Document 5.3协议设计 7 第一章概述 1.1目的 本文档的目的旨在推动软件工程的规范化，使设计人员遵循统一的详细设计书写规范，节省制作文 档的时间，降低系统实现的风险，做到系统设计资料的规范性与全面性，以利于系统的实现、测试、维 护、版本升级等。 本文说明了 XXX系统的总体设计方案，便于系统开发人员可以根据本文设计详细的设计说明书。 1.2范围 本文作为总体设计方案，为以后的更加详细的设计提出了开发思路，具体内容包扌舌： 1、 系统总体结构及各个模块的划分。各个模块的功能说明。 2、 数据库的总体设计思路，便于进行进一步的数据系统设计。 3、 系统各个部分的接口设计方法 4、 错误处理设计 5、 系统权限设计方法 「3术语定义 「4参考资料 如项目合同 需求分析说明书 用户需求说明书 第二章总体结构设计 2. 1系统约束 本系统应该遵循J2EE和SNMP协议要求； 本系统运行于Windows server 2005屮，数据库釆用Oracle； 本系统功能和界面需要满足和XXX公司签署的合同要求； 本系统需要具有前瞻性，满足今后对系统扩展的要求； 本系统应该界面友好，容易使用。 2. 2 2. 2子系统与模块编号规则 ?? 本系统根据功能大体分为如下几个模块，各个模块的特征标志符如下： 基础资料：base 用户管理：user 系统维护：sys 设备管理，包含如下三个小模块： SNMP 服务：snmp 图形显示：disp 消息处理：msg 资料管理：data 各白模块的文件命名、函数命名和宏定义等必须以各个模块的特征名开始 2. 3系统总体架构 从系统结构上看，本系统采用J2EE MVC三层架构体系。如下图所示 主要业务在模型层完成，通过访问数据库，文件或者网络设备，获取相关信息并通过视图层表现出 來。这些结构模型目前在J2EE程序设计中己经很成熟，就不再详述。 系统功能模块结构如下图所示: 2. 4 xxx程序结构设计 2. 4. 1程序功能概述 概述程序的功能 2. 4. 2程序外部环境说明 说明与本程序有关系的人、其他程序、外部设备、文件、数据库等所有外部联系。 2. 4. 3总体结构和模块外部设计 说明本程序的总体结构和模块划分，各个模块的主要功能。 2. 4. 4模块功能分配 表明各项功能与模块的关系，如： 模块编号 模块名称 模块功能分配 备注 G-1 Base 管理基础资料 G-2 user 用户管理 定义用户权限 G-3 sys 系统维护 管理系统资源 G-4 map 网络拓扑显示 G-5 snmp 管理sninp协议 通信处理 G-6 disp 流量图形显