软件开发规范之总体设计方案模板.docx

软件开发规范之总体设计方案模板一引言1.1编写目的本文档作为*与XXXXXXXXXX公司之间就*建立XXXX司（局或单位）XXXXXXXXXX系统需求理解达成一致共识的基础文件，作为双方界定项目范围、签定合同的主要基础，也作为本项目验收的主要依据。同时，本文档也作为*XXX后继工作开展的基础，供双方项目主管负责人、项目经理、技术开发人员、测试人员等理解需求之用。1.2适用范围本文档适用于所有与本项目有关的软件开发阶段及其相关人员，其中：*方面的项目负责人、公司方项目经理、技术开发人员（包括分析人员、设计人员、程序人员）、测试人员应重点阅读本文档各部分，其它人员可选择性阅读本文档。1.3文档概述本文档主要描述了XXXXXXXXXX系统项目的软件总体设计思路。本文档首先从业务背景、系统功能、运行环境等方面概要描述系统，其次从设计原则、功能设计、数据结构设计等方面描述系统的总体设计情况，然后进一步详细描述系统技术实现策略、项目实施以及待确定的问题。1.4参考资料列出本文的参考文件清单，包括出版单位、作者、版本、日期等信息。示范：仅供参考，不具备任何实质性的内容。XXX总体需求书 （XXX单位XXX提供）XXX需求调研报告 作者：XXX设计模式 XXXXXX出版社 UML用户指南 XXXXXXX出版社 1.5术语、定义和缩写列出本文档所涉及的专业术语、缩写词及相关定义。定义所有必要的术语，以便读者能够正确地解释软件需求规格说明，包括词头和缩写。你可能希望为整个公司创立一张跨越多项项目的词汇表，而且只包括特定于单一项目的软件需求规格说明中的术语。示范：仅供参考，不具备任何实质性的内容。1) OLTP：On-line Transaction Processing，联机事务处理。2) OLAP：On-Line Analytical Processing，联机分析处理；是使分析人员、管理人员或执行人员能够从多角度对信息进行快速、一致、交互地存取,从而获得对数据的更深入了解的一类软件技术。二总体概述2.1现有系统描述简要描述客户现有系统的功能、性能以及其它方面，若客户没有系统，则可裁减。另外，可描述客户现有系统的应用状况以及系统规模、人员使用状况。描述客户对象的应用环境平台，如软件环境、硬件环境、网络环境、通讯状况以及人员计算机使用水平等。示范：仅供参考，不具备任何实质性的内容。针对金融快报工作，*以前曾开发过一个C/S结构的系统，后台数据库为SQL Server，开发工具是VB6.0。该系统主要完成以下工作：1. 根据人行各业务司局每日上报的数据传真，将数据补录到系统中。2. 根据上报的数据制作金融快报文档。3. 将金融快报的数据转发到人行时间序列数据库中。金融快报系统的工作流程如下： 2.2存在问题经过上述现状描述，分析现有组织结构、现有系统等方面存在的问题。示范：仅供参考，不具备任何实质性的内容。该系统初步满足了金融快报工作的要求，可是，当前由于各级领导对快报内容的要求不断变化，系统无法经过参数配置来满足日益变化的内容要求。同时，由于系统的C/S架构特点，系统无法实现各业务司局自行报送统计数据的要求，因此需要对原系统进行改进以满足业务的需要。2.3系统建设目标简要说明本项目或系统的总体目标，即建成什么样的应用系统。示范：仅供参考，不具备任何实质性的内容。新的系统基于B/S结构，更加适合金融快报“快”的特点，打破了原系统过多依赖外部介质的陈规，以简便、易用为设计思想，以所见即所得为设计指导，以*内联网为传媒，真正实现了业务人员自主报送，管理人员专注管理工作。2.4需求概述能够用图表的形式给出总体业务流程图，并简要描述总体业务流程，业务范围和要求。以图表的形式给出隶属于总体业务流程图的子系统业务流程图并描述子系统业务流程。简要描述（子）业务规则，如智能化的计算规则，数据抽取、加载规则等业务规则。简要描述用户层的需求，可用图表的形式给出。若不需要在此表述，可裁剪。简要描述功能性和非功能性需求，能够图表的方式给出。示范：仅供参考，不具备任何实质性的内容。为了能使金融快报处理工作更方便，适合报表样式灵活变动的特点，*调查统计司提出：新的金融快报系统应该结合数据交换技术架构体系，由各司局人员自由报数；在金融快报系统内生成金融快报WORD文档、EXCEL文件和生成时间序列数据文件；采用灵活指标模式，方便添加指标；采用灵活的模板定制模式，方便更换报送文件模板。2.5新系统功能能够用图表的形式列出新系统具有哪些功能，特别是特色功能，并简要描述新系统的功能。示范：仅供参考，不具备任何实质性的内容。这套金融快报信息系统主要包含以下几个方面的功能： 1. 数据报送，帮助各业务司局方便的将数据录入到系统中。2. 数据管理，帮助调查统计司综合处对报送的数据进行审核。3. 快报输出，根据收集到的数据进行整理加工，并将数据的结果按照国办与中办的要求进行输出。4. 数据转发，收集到的数据按照接口的要求转送时间序列数据库。5. 系统管理，对系统的用户、权限进行管理。6. 配置管理，对数据报送的格式、金融快报的模版以及转发时间序列数据库的要求进行配置管理。三系统设计3.1设计原则简要描述本业务系统总体设计原则和设计依据。3.1.1总体设计路线描述本业务系统总体设计路线。示范：仅供参考，不具备任何实质性的内容。金融快报系统参考现有系统设计方案，采用B/S结构进行系统设计，提供与数据交换平台进行数据传输的软件接口，提供灵活的指标，模板定制方案，极大地提高金融快报处理工作效率。3.1.2总体技术架构以图表的形式勾画出新系统的体系结构图，应包括与外部应用系统的连接，硬件设备的连接，网络系统的连接等。示范：仅供参考，不具备任何实质性的内容。3.1.3总体功能架构能够用图表的形式列出那些与应用程序自动进行数据处理的过程相对应、需要经过用户交互来完成的处理过程。对于每种角色描述，应指出这种角色能够胜任哪些任务，有多少用户可能具备这种角色，以及（在可能情况下）这种角色能够在工作流批准或状态改变中充当哪些处理过程。能够用图表的形式列出本应用系统有哪些程序模块，每个模块的功能是什么。示范：仅供参考，不具备任何实质性的内容。金融快报系统的源数据由各司局人员在线报送得到，经过金融快报管理员处理后生成要报送的数据文件进行数据报送，整个金融快报系统工作流程如下：首先，各司局人员经过数据交换平台进行业务数据报送，系统接收数据后自动对当天数据进行加锁处理，如果业务人员需求重报数据，则需要通知系统管理员进行数据解锁。数据上报完毕后，管理人员对数据进行数据查看和数据修改，能够对要生成的文件添加注释等。处理完毕后，能够生成、下载快报文件和时间序列文件。系统功能图如下： 3.1.4系统功能部署把系统功能的部署情况逐一表述清楚。示范：仅供参考，不具备任何实质性的内容。金融快报所有模块均部署于服务器端，功能分别由金融快报管理信息系统模块和通用数据交换平台中的数据采集模块共同实现。其中通用数据交换平台实现单点登陆、权限验证、数据上报功能，而金融快报管理信息系统实现快报的系统管理、数据管理和文件生成等功能。3.1.5系统特点把系统的新特点情况逐一表述清楚。示范：仅供参考，不具备任何实质性的内容。金融快报系统具有以下特点： 良好的可扩充性和通用性：灵活多样的数据采集方式与报表定义模式，方便用户采集各种数据。 贴心的模板定制体系：采用大众熟悉的MS EXCEL所见即所得报表定义,无需特殊培训，能够使业务人员轻松实现报表定义。3.2系统用户列出本系统全部用户的整体信息。示范：仅供参考，不具备任何实质性的内容。3.2.1普通用户描述本系统的普通用户的整体信息。示范：仅供参考，不具备任何实质性的内容。3.2.2登录用户描述本系统的登录用户的整体信息。示范：仅供参考，不具备任何实质性的内容。3.2.3访客描述本系统的访问用户的整体信息。示范：仅供参考，不具备任何实质性的内容。3.2.4部门管理员描述本系统的部门级别管理员的整体信息。示范：仅供参考，不具备任何实质性的内容。3.2.5系统管理员描述本系统的系统管理员的整体信息。示范：仅供参考，不具备任何实质性的内容。3.2.6信息子系统列出本系统所含盖的全部子系统的参考清单等信息。示范：仅供参考，不具备任何实质性的内容。3.3系统功能设计示例列出本系统的功能参考文件清单。示范：仅供参考，不具备任何实质性的内容。3.3.1快报版本管理示例列出本模块实现的基本功能点等信息。示范：仅供参考，不具备任何实质性的内容。管理生成快报文件的版本。3.3.2快报文件结构管理示例列出本模块实现的基本功能点等信息。示范：仅供参考，不具备任何实质性的内容。管理快报文件的机构，内容和顺序。3.3.3文件内容管理示例列出本模块实现的基本功能点等信息。示范：仅供参考，不具备任何实质性的内容。管理用于生成快报文件的文件内容。3.3.4指标信息管理示例列出本模块实现的基本功能点等信息。示范：仅供参考，不具备任何实质性的内容。定义文件中所采用的指标信息。3.3.5快报生成模板管理示例列出本模块实现的基本功能点等信息。示范：仅供参考，不具备任何实质性的内容。编制定义金融快报中用来生成快报，转换数据查看，转换数据修改的模板文件。3.3.6数据采集模板管理示例列出本模块实现的基本功能点等信息。示范：仅供参考，不具备任何实质性的内容。编制定义用来在线报数，原始数据查看，原始数据修改的模板文件。3.3.7报送机构信息管理示例列出本模块实现的基本功能点等信息。示范：仅供参考，不具备任何实质性的内容。登记、维护要进行报送的司局信息。3.3.8报送规则维护示例列出本模块实现的基本功能点等信息。示范：仅供参考，不具备任何实质性的内容。管理各司局要报送的数据属性。3.3.9系统常量信息维护示例列出本模块实现的基本功能点等信息。示范：仅供参考，不具备任何实质性的内容。管理系统中的常量信息，如文件存放路径等。3.3.10快报管理示例列出本模块实现的基本功能点等信息。示范：仅供参考，不具备任何实质性的内容。经过快报管理，用户可根据模版选择生成金融快报，并可对历史各期快报进行分类检索。3.3.11数据查询示例列出本模块实现的基本功能点等信息。示范：仅供参考，不具备任何实质性的内容。金融快报管理员经过该功能查询各监管司局的各期报送数据。3.4数据结构设计以图表的形式列出本应用系统的数据结构并予以说明。示范：仅供参考，不具备任何实质性的内容。3.5接口设计1）内部接口设计以图表的形式列出本应用系统内部的数据接口、通信接口、应用接口设计，并予以说明。2）外部接口设计以图表的形式列出本应用系统与外部应用系统的接口设计，包括数据交换、网络通信等外部接口设计，并予以说明。3）与其它网络系统的接口设计以图表的形式列出本应用系统与其它网络系统的接口设计，包括网络协议，通信接口、数据传输接口等，并予以描述。示范：仅供参考，不具备任何实质性的内容。3.6系统性能及安全设计详细描述对于新系统的性能、安全性以及其它非功能性等方面是如何考虑设计的，如系统响应速度，数据处理速度、网络传输速度、数据加密、权限设计等方面。示范：仅供参考，不具备任何实质性的内容。四实现策略4.1技术策略从技术角度详细说明如何来实现新应用系统，采取哪些新技术，如何确保技术实现。示范：仅供参考，不具备任何实质性的内容。4.1.1B/S结构体系示例4.1.2JAVA/JNDI技术示例4.1.3LDAP技术示例4.2安全策略从实现的角度来说明如何实现安全设计，采取哪些安全策略来确保新系统能满足安全要求，如数据加密，CA认证、防火墙等。示范：仅供参考，不具备任何实质性的内容。4.3数据存储备份策略说明应用系统如何实现数据存储备份，应采取哪些策略，应遵循哪些存储规则和规范。示范：仅供参考，不具备任何实质性的内容。4.4系统整合策略说明本应用系统如何与其它系统进行整合，如何整合，采取哪些技术策略，整合后的系统如何确保性能最优，如何优化。示范：仅供参考，不具备任何实质性的内容。五运行环境以图表的形式列出新系统运行的服务器平台环境，如操作系统、以及诸如IIS、Microsoft SQL Server之类的必要应用程序。同时，描述所有需要相关数据结构及身份验证协议支持的特定需求。以图表的形式列出客户端环境需求与限制的相关细节，如CPU、操作系统、内存、存储容量、硬件、应用软件等。以图表的形式列出服务器与客户端以及远程访问所需要的网络环境，如硬件环境（路由器、网关、防火墙等），网络带宽、传输速度、网络协议等。5.1硬件环境列出硬件环境等信息。示范：仅供参考，不具备任何实质性的内容。 服务器端：取决于数据库产品和应用服务器产品，应用程序本身没有严格要求。 客户端：奔腾133以上，32M以上内存。5.2软件环境列出软件环境等信息。示范：仅供参考，不具备任何实质性的内容。服务器端：操作系统：Windows 98 、Windows NT 4.0、Windows 中文版应用软件：Office 中文版，Excel和WordWEB服务：IIS+MS .Net FrameWork V1.14数据库： SQL Server 开发平台：Microsoft Visual Studio.Net客户端：浏览程序：IE浏览器5.0版本或者以上5.3开发工具列出开发工具文件清单，包括出版单位、作者、版本、日期等信息。示范：仅供参考，不具备任何实质性的内容。六项目实施6.1工程实施内容列出具体的项目工程实施内容等信息。示范：仅供参考，不具备任何实质性的内容。根据对项目需求的分析以及金融快报的业务特点，初步确定工程的开发内容如下表：功能分类模块开发内容系统管理快报版本管理模板管理对快报版本的维护报送模板管理模板管理对报送模板的维护采集模板管理模板管理对采集模板的维护采集指标管理系统基本管理对采集指标的维护报送指标管理系统基本管理对报送指标的维护转换关系管理系统基本管理对指标的转换关系维护报送规则管理系统配置对报表的报送规则维护时间序列指标管理系统基本管理对要生成时间序列指标数据采集数据报送数据上报对业务数据进行数据上报处理数据加、解锁数据维护对已经上报的数据进行加、解锁判断和相关处理数据查看数据上报、数据维护查看已经上报的数据数据处理数据查看数据维护根据条件查看已经上报的数据数据修改数据维护对已经上报的数据和要生成的数据进行数据修改文件处理快报文件生成文件处理生成指定数据时间的快报文件，包括WORD文件和EXCEL文件快报文件下载文件处理下载已经生成的WORD文件和EXCEL文件时间序列文件生成文件处理生成指定数据时间和项目的时间序列文件时间序列文件下载文件处理下载已经生成的时间序列文件6.2工程实施计划列出具体的项目工程实施计划信息。示范：仅供参考，不具备任何实质性的内容。根据对开发内容的分析初步确定工程的实施计划如下表： 编号阶段任务描述起止时间1需求调研了解具体需求，形成调研报告 -7-15 -7-312需求分析详细分析需求、确认需求，形成需求规格说明书 -8-1 -8-203概要设计与详细设计进行概要设计，形成数据库设计说明书、概要设计说明书，详细设计说明书 -8-20 -9-305编码代码编写，形成程序 -10-8 -10-306测试单元测试、集成测试、测试修改 -11-1 -11-307试运行系统试运行 -12-1 -12-31工程开发总周期为5个月，试运行1个月。开发及试运行阶段总人力估计：12人/月。6.3售后服务与技术支持以图表的形式给出实施本项目需要的培训及其时间、人员等。说明本项目需要哪些技术支持，需要什么类型的技术支持人员，以及给客户提供什么样的技术支持，以什么方式提供支持。示范：仅供参考，不具备任何实质性的内容。n 技术培训项目实施结束后，XXX和XXXXXX公司将就系统使用、系统管理对用户进行培训，并提供详尽的用户手册和管理员手册。n 现场技术服务在遇到紧急事故需要进行现场处理的情况下，XXX和XXXXXXX公司承诺自系统验收合格之日起，提供日常到达现场维护保证（不可抗拒原因除外）。XXX和XXXXXX公司工程师将定期走访用户，解决用户问题，并提供技术建议。n 技术资料服务XXX和XXXXXX公司将经过E-mail（或上门的方式）向用户提供最新的产品和技术信息，包括网络故障处理案例资料、业务开放技术案例方案、新技术新设备资料以及相关维护技术文档以及软件程序漏洞发现通知。并定期举行技术交流活动。n 热线技术支持XXX和XXXXXXX公司提供本项目的日常热线技术支持，随时解答问题、排除故障。