15-SZY01-软件设计说明书模板v2.0

国家水资源监控能力建设项目（2012-2014年）SZY615-2013承建子项目名称软件设计说明书模板SoftwareDesignDescriptionTemplate（试行）文件编号：SZY01_MWR_PM_SDDT_DHC_V2.0当前版本：2.0编制单位：DHC发布日期：2013-06-25北京东华合创科技有限公司编制国家水资源监控能力建设项目（2012-2014年）XXX设计文档模板北京东华合创科技有限公司编制I前言本规范是对国家水资源监控能力建设项目的项目标准的补充，用于规范设计方案的编写、为项目承建商编写设计方案提供文档模式参考。本文档模板由国家水资源监控能力建设项目办公室提出。本文档模板由国家水资源监控能力建设项目办公室归口。本文档模板由北京东华合创科技有限公司负责编制。本文档模板由北京东华合创科技有限公司负责解释。主要起草人员：张绍夫、靳春平、朱洪欣、张振、陈星晓等。国家水资源监控能力建设项目（2012-2014年）XXX设计文档模板北京东华合创科技有限公司编制II目录前言...............................................................I1引言.............................................................11.1标识..................................................................11.2定义..................................................................11.2.1术语..............................................................11.2.2缩略语............................................................11.2.3标识符定义........................................................11.3参考资料..............................................................21.4描述约定..............................................................22系统概述.........................................................32.1系统简介..............................................................32.2系统用户..............................................................33系统总体设计......................................................43.1设计原则与思路........................................................43.1.1总体设计原则......................................................43.1.2总体设计思路......................................................43.1.3总体实施方法......................................................43.2总体技术路线..........................................................43.3总体架构设计..........................................................43.4软件组成设计..........................................................43.5部署设计..............................................................53.6非功能性设计..........................................................63.7UI规划设计...........................................................63.8数据设计..............................................................74（XXX系统1名称）设计..............................................84.1设计依据与约束........................................................8国家水资源监控能力建设项目（2012-2014年）XXX设计文档模板北京东华合创科技有限公司编制III4.1.1需求规定..........................................................84.1.2环境要求..........................................................84.2体系结构设计..........................................................84.2.1功能部件划分......................................................84.2.2部件协作关系设计..................................................94.2.3部署设计.........................................................104.3功能部件设计.........................................................104.3.1XXX部件1........................................................104.3.2XXX部件2........................................................155（XXX系统2名称）设计.............................................166设计跟踪矩阵.....................................................17国家水资源监控能力建设项目（2012-2014年）XXX设计文档模板北京东华合创科技有限公司编制11引言本章应分为以下几条。1.1标识本条应包含本文档适用的系统和软件的完整标识。(若适用)包括标识号、标题、缩略词语、版本号、发行号。1.2定义1.2.1术语描述本文档中涉及的术语含义。例如：XXX术语在此对该术语进行定义与描述。1.2.2缩略语描述本文档中涉及的缩略语的全称及其含义。例如：表格1缩略语序号英文缩写英文全称中文名称1.1.2.3标识符定义描述本系统涉及的接口标识符和功能标识符的定义。国家水资源监控能力建设项目（2012-2014年）XXX设计文档模板北京东华合创科技有限公司编制21.3参考资料本章应列出本文档引用的所有文档的编号、标题、修订版本和日期，本章也应标识所有文档的来源。1.4描述约定在此，对本文档涉及的各类描述进行约束。1）一般图例采用Visio软件绘制，在提交本文档时需要提供相应*.vsd格式的源文件，有特殊要求的图例除外。2）类图和时序图采用rose软件绘制，并且需要提供*.mdl源文件。3）在本模板中，特殊的题注（时序图、类图、数据交互关系图等）需要单独命名，比如：类的题注，需要以“类图+编号”的方式命名。其它的图表，图以“图+编号”，表以“表格+编号”的方式命名。3）本文档涉及的图符说明如下。表格2描述约定表图符名称描述国家水资源监控能力建设项目（2012-2014年）XXX设计文档模板北京东华合创科技有限公司编制32系统概述本条应简述本文档适用的系统和软件的用途。2.1系统简介描述系统与软件的一般性质，比如，系统的背景及任务目标等。2.2系统用户标识项目的投资方和最终用户机构。国家水资源监控能力建设项目（2012-2014年）XXX设计文档模板北京东华合创科技有限公司编制43系统总体设计本章应分条描述系统体系结构设计。3.1设计原则与思路3.1.1总体设计原则依照系统在系统架构、技术路线运行的灵活性等方面与传统应用系统的区别，在此描述系统将要遵循的设计原则。3.1.2总体设计思路在此，根据用户要求和实际应用要求，整理本系统的总体设计思路。3.1.3总体实施方法在此，阐述对本软件（系统）的总体建设方法。3.2总体技术路线按照用户要求以及系统设计原则，在此描述系统将要采用的技术实现路线方法。3.3总体架构设计以图表形式说明整个技术架构的体系层次。并对体系层次加以描述和说明。3.4软件组成设计本模板以软件（系统）部件单元子单元颗粒度为例介绍软件功能设计部分。在实际应用过程中，可根据情况酌情增删。国家水资源监控能力建设项目（2012-2014年）XXX设计文档模板北京东华合创科技有限公司编制5用一系列图表列出本系统内的每个部件的名称、标识符、功能。描述每个软件（系统）部件的功能用途，并标识分配给它的需求与功能划分。软件划分组成图示例如下（仅供参考，可根据实际情况酌情增加）：图1XXX软件（系统）划分组成示意图3.5部署设计根据软件（系统）的定位，给出软件（系统）的部署方案。部署图示例如下：（仅供参考）国家水资源监控能力建设项目（2012-2014年）XXX设计文档模板北京东华合创科技有限公司编制6网络统一用户系统CA认证系统业务系统业务应用门户水资源数据库（业务应用）图2系统部署拓扑结构示意图在此对系统部署拓扑结构示意图进行描述说明。部署列表示例如下（仅供参考）：表格3系统部署列表序号服务器名称系统名称需要的支撑软件环境123453.6非功能性设计在此给出安全性、可靠性、易用性、异常处理机制等非功能性设计。3.7UI规划设计遵循易操作、人性化等UI界面设计原则，对图形用户接口进行规划设计，并给出设计UI。国家水资源监控能力建设项目（2012-2014年）XXX设计文档模板北京东华合创科技有限公司编制73.8数据设计在此给出数据结构、数据存储等设计。国家水资源监控能力建设项目（2012-2014年）XXX设计文档模板北京东华合创科技有限公司编制84（XXX系统1名称）设计可根据实际情况分条说明XXX系统的详细设计。可根据实际情况扩展章节。本模板以系统部件单元子单元为例介绍功能模块设计部分。在实际应用过程中，可根据实际情况酌情增删。但最后一级颗粒度要求必须包含处理说明、类设计、时序图以及出错处理设计等内容。比如，在本模板中，子单元这一级必须包含处理说明、类设计、时序图以及出错处理设计等内容,如果最后一级为单元这一级，则要求该单元包含处理说明、类设计、时序图以及出错处理设计等内容。4.1设计依据与约束4.1.1需求规定按照项目对系统的实际需求，并充分考虑其适用性，在此描述该系统将要在本项目中的需求定位及其将要发挥的作用。4.1.2环境要求在此给出系统对软、硬件环境的要求。4.2体系结构设计在此对系统的结构进行设计