XXX项目系统设计说明书v2文档格式.docx

XXX项目系统设计说明书v2文档格式.docx

《XXX项目系统设计说明书v2文档格式.docx》由会员分享，可在线阅读，更多相关《XXX项目系统设计说明书v2文档格式.docx（41页珍藏版）》请在冰点文库上搜索。

●《计算机软件文档编制规范》GB/T8567-2006

●《计算机软件需求说明编制指南》GB/T9385-1988

●《需求规格说明书》

2.2术语和定义

●【验收acceptance】需方授权代表的一项活动，通过该活动，需方接受履行合同的部分或全部的软件产品的所有权。

●【需方acquirer】为自己或为另一个组织采购软件产品的组织。

在本项目中也可称为甲方。

●【批准approval】需方的授权代表或开发方的上级组织对开发方的项目计划、设计或其他方面表示满意并可以作下一阶段工作基础而签署的书面文件。

●【体系结构architecture】一个系统或CSCI（ComputerSoftwareConfigurationItem—计算机软件配置项）的组织结构，标明它的组成，这些组成的接口和它们之间的操作概念。

●【相关开发方associatedeveloper】一个既不是主承包方也不是开发方的分承包方的组织，但它在同一个或相关的系统或项目中承担开发工作。

●【行为设计behavioraldesign】从用户观点出发，对整个系统或CSCI的行为进行的设计，它只考虑满足用户需求而不考虑系统或CSCI的内部实现。

这种设计与体系结构设计不同，后者要标明系统或CSCI的内部部件，并有这些部件的详细设计。

●【构建版；

开发阶段build】

（1）软件的一个版本，它满足完整的软件所要满足的全部需求的一个特定的子集。

（2）开发满足特定需求子集的软件版本所经历的时间。

注：

术语“开发阶段”和“版本”之间的关系依赖于开发方：

例如，可以通过几个版本来实现一个开发阶段，一个并发阶段也可以发行几个并行的版本（如发往不同的地点），或者将它们作为同义词。

●【计算机数据库computerdatabase】见【数据库】。

●【计算机硬件computerhardware】能接收和存储计算机数据的，对计算机数据执行一系列系统性的操作的，或能产生控制输出的设备。

这类设备能实现基本的解释、计算、通信、控制或其他逻辑功能。

●【计算机程序computerprogram】能使计算机硬件实现计算或控制功能的计算机指令和数据定义的集合。

●【计算机软件computersoftware】见【软件】。

●【计算机软件配置项computersoftwareconfigurationitem（CSCI）】满足最终使用功能的软件集合，而且它由需方指定进行单独的配置管理。

CSCI应从下列诸因素中进行折衷选择：

软件功能、规模、宿主机或目标计算机、开发方、支持概念、重用计划、关键性、接口考虑、是否需要单独编写文档和控制以及其它因素。

●【配置项configurationitem】能满足最终使用功能的硬件集合、软件集合或者软、硬件两者的集合，且由需方指定进行单独的配置管理。

●【数据库database】以一种能被用户或计算机程序通过一个数据库管理系统进行访问的方式，存储在一个或多个计算机文件中的相关数据的集合。

●【数据库管理系统databasemanagementsystem】是一整套计算机程序，它提供为建立、修改、使用和完整性维护一个数据库所需的功能。

●【可交付的软件产品deliverablesoftwareproduct】合同要求交付给需方或其他指定的接受方的软件产品。

●【设计design】开发方为响应一定的需求而对一个系统或CSCI选取的一些性能/规格。

这些特性中有些是与需方相匹配的：

有一些是需求的精细化，如为了响应显示错误信息这一需求需定义的错误信息；

有一些则是与现实相关的，如为满足需求，决定选用哪些软件配置项和逻辑。

●【开发方developer】开发软件产品的组织（“开发”包括新的软件开发、修改、重用、再工程、维护或产生软件产品的任何其它活动）。

开发方可以是一个承制方或者政府机构。

也可称为乙方。

●【文档/文档编制document/documentation】能供人或机器阅读的，一般具有永久性的一套资料（不管它们记录在什么媒体上）。

●【评价evaluation】确定一个项或一个活动是否满足指定准则的过程。

●【固件firmware】硬件设备和以只读软件的形式驻留在硬件设备上的计算机指令和/或计算机数据的集合。

●【硬件配置项hardwareconfigurationitem（HWCI）】满足最终使用功能并由需方指定进行单独配置管理的一套硬件。

●【独立验证与确认independentverificationandvalidation（IV&

V）】由一个机构对软件产品和活动作系统的评估，这个机构不负责该产品的开发或被评估的活动，IV&

V不在本标准的范围内。

●【接口interface】在软件开发中，两个或多个实体（如CSCI—CSCICSCI—HWCICSCI—用户，或软件配置项—软件配置项）之间的关系，这些实体依据这种关系共享、提供或交换数据，接口并不是CSCI、软件配置项或其他的系统部件；

接口只是这些实体间的一种关系。

●【联合评审jointreview】由需方和开发双方的代表参加的对的项目状态、软件产品和/或项目中的问题进行检查和讨论的活动或会议。

●【非交付的软件产品Non—deliverablesoftwareproduct】不是合同中的要求交付给需方或其他指定接受方的软件产品。

●【过程process】为实现某个既定目的而进行的一组有组织的活动，例如，软件开发过程。

●【合格性测试qualificationtesting】为了向需方表明一个CSCI或系统满足其指定的需求而进行的测试。

●【再工程reengineering】为了以一种新的形式重组一个现有的系统而对其进行检查和改造的过程。

再工程可包括逆向工程（分析一个系统并产生更高一级的抽象来表示它，如从代码到设计）、重构（在同一个抽象级上把系统从一种表示形式转换到另一种表示形式）、重编文档（分析一个系统并产生用户文档式支持文档）、正向工程（从现有系统的软件产品结合新的需求，产生新的系统）、重定目标系统（对系统进行转换以便将其安装到不同的目标系统上）和翻译（将源码从一种语言转换到另一种语言或者从一种语言的某个版本转换成另一种版本）。

●【需求requirement】

（1）为了使需方能够接受一个系统或CSCI所必需具备的特性。

（2）为标准或合同中规定的必须遵守的陈述。

●【可重用的软件产品reusablesoftwareproduct】为一个用途开发但还具有别的用途的软件产品，或者专门为了用于多个项目而开发的软件产品，或者在一个项目中有多种作用的软件产品。

例子包括（但不限于）上市的商用软件产品，需方已装备的软件产品，重用库中的软件产品和开发方现存的软件产品。

每一次使用包括这些软件产品的全部或部分，也可以涉及到对它的修改。

这个术语可以应用于任何软件产品（例如需求，体系结构等）而不只限于软件本身。

●【软件software】计算机程序和计算机数据库。

虽然有些产品的定义中包括文档，本标准把这个定义只限于计算机程序和计算机数据库。

●【软件开发softwaredevelopment】产生软件产品的一整套活动。

软件开发可以包括新开发、修改、重用、再工程、维护或者任何会产生软件产品的其他活动。

●【软件开发文件softwaredevelopmentfile（SDF）】与特定软件实体开发有关的资料库。

其内容一般包括（直接的或引用的）有关需求分析、设计和实现的考虑、原理和约束条件；

开发方内部的测试资料；

进度和状态资料。

●【软件开发库softwaredevelopmentlibrary（SDL）】一组受控的软件、文档、其他中间的和最终的软件产品，以及相关的用以促进软件的有序开发和后续支持的工具和方法。

●【软件开发过程softwaredevelopmentprocess】为了把用户的需求转换成软件产品而进行的一系列有组织的活动。

●【软件工程softwareengineering】一般情况下，它是软件开发的同义词，在本标准中，软件工程是软件开发的一个子集，它包含除了合格性测试之外的全部活动。

本标准之所以加以这种区分只是为了给软件工程和软件测试环境以不同的命名。

●【软件工程环境softwareengineeringenvironment】实施软件工程所需要的设施、硬件、软件、固件、方法和文档。

它可以包括（但不限于）计算机辅助软件工程（CASE）的工具、编译程序、汇编程序、连接程序、装载程序、操作系统、排错程序、仿真程序、模拟程序、文档工具和数据库管理系统。

●【软件产品softwareproduct】为了满足一个合同而建立、修改、或组合的软件及相关资料。

例如包括计划、需求、设计、代码、数据库、测试资料和手册。

●【软件质量softwarequality】软件满足所规定的需求的能力。

●【软件支持softwaresupport】为保证软件安装后能继续按既定目标持续运行而且在系统的运行中能起到既定的作用而实施的一系列活动，软件支持包括软件维护、用户支持和有关的活动。

●【软件系统softwaresystem】只由软件组成的系统，有时可能还包括该软件赖以运行的计算机设备。

●【软件测试环境softwaretestenvironment】为完成软件合格性测试和可能的其他测试所需的设施、硬件、软件、固件、方法和文档。

其要素可以包括（但不限于）仿真程序、代码分析程序、测试用例生成程序和路径分析程序，还可能包括在软件工程环境下用的要素。

●【软件移交softwaretransition】使软件开发的责任从一个组织转交给另一个组织的一系列活动。

一般说，前一个组织是实现初期软件开发，而后一个组织是进行软件支持。

●【软件单元softwareunit】CSCI设计中的一个基本单位，例如，CSCI的一个主要分支，该分支的一个组成部分、一个类、对象、模块、函数、子程序或者数据库。

软件配置项可以出现在层次结构的不同层次上并可以由其他的软件配置项组成。

设计中的软件配置项与实现它们的代码和数据实体（例程、过程、数据库、数据文件等）及或包含这些实体的计算机文件之间不一定有一一对应的关系。

●【HTTP】指超文本传输协议（HypertexttransferProtocol），是互联网上应用最为广泛的一种网络传输协议。

●【SSL】指SecureSocketsLayer，是一种国际标准的加密及身份认证通信协议。

●【B/S】指浏览器/服务器（Browser/Server）。

●【C/S】指客户机/服务器（Client/Server）。

●【Web】指Internet的图形、多媒体部分，由众多Web页组成，可使用称为Web浏览器的程序对Web进行浏览。

●【WebService】指能够用编程的方法通过Web来调用的应用程序。

●【WSDL】指WebServicesDescriptionLanguage，是一种XML格式的服务描述语言。

●【UDDI】指统一描述、发现与集成（UniversalDescriptionDiscoveryandIntegration），是一种服务查找规范。

●【SOAP】指SimpleObjectAccessProtocol，是一种用于定义高级别应用程序的协议，提供了一种在分散或分布环境中交换结构化和类型信息的机制。

●【SOA】指面向服务分析（ServiceOrientedAnalyzing）。

●【OOA】指面向对象分析（ObjectOrientedAnalyzing）。

●【OOD】指面向对象设计（ObjectOrientedDesign）

●【XML】指可扩展标记语言（ExtensibleMarkupLanguage）

●【UML】指统一建模语言（UnifiedModelingLanguage），是一种定义良好、易于表达、功能强大且普遍适用的面向对象的建模语言。

●【胖客户端】指以个人计算机为代表的、基于开放性工业标准架构的、功能比较强大的客户端设备。

●【瘦客户端】指胖客户端以外的客户端设备。

●【异构系统】指服务于一个业务的、包含了不同架构甚至基于不同操作系统的软件系统。

●【J2EE】指JAVA2企业版（Java2EnterpriseEdition），是使用Java进行企业开发的一套扩展标准。

●【STRUTS】指一种Web框架（Framework）。

●【WEB服务器】指WORLDWIDEWEB服务器，也被称为WWW服务器，以提供网上信息浏览服务为主要功能。

●【中间件】指一种独立的系统软件或服务程序，位于客户机服务器的操作系统之上，被分布式应用软件用于在不同的技术之间共享资源。

●【消息中间件】指面向消息的中间件（MessageOrientedMiddleware，MOM），发送者将消息发送给消息服务器，消息服务器将消息存放在若干队列中，在合适的时候再将消息转发给接收者。

●【构件】指软件系统中具有相对独立功能、可以明确辨识、接口由契约指定、和语境有明显依赖关系、可独立部署、可组装、可重复使用的软件实体，广义上讲，构件可以是数据，也可以是被封装的对象类、软件构架、文档、测试用例等。

●【组件】指可用代码的封装，这些代码采用可以更改的数据形式，可以执行应用程序的一些功能。

●【工作流技术】指以恰当的模型对工作流（Workflow）中各项工作前后组织的逻辑和规则在计算机中进行表示并对其实施计算的技术。

●【分布式体系结构】指每一个客户端都有数据的副本、查询等数据操作都使用副本进行、通过定期或不定期地与数据交换中心进行交换来获得最新数据的体系结构。

●【文件】包括纯文件资料、表格资料。

●【系统】在本文中，独立使用“系统”一词时，“系统”是指本项目开发的系统。

●【报表】应用系统中数据的一种表现形式，可以很直观的反映数据的内部联系。

●【视图】在系统之中，主要是通过视图来控制系统地流程和功能的，它对系统的流程和功能起了决定性的作用。

视图是一个包括报表，审核公式和运算公式的容器，一个项目的各个步骤在系统中都是以不同的视图来实现的，通过对视图的条件设置，还可以控制用户对该视图的操作。

●【数据集】数据集是用来存储报表中的数据的。

一张报表中的数据可以是一个或者多个数据集中的数据，这主要决定于数据的类型。

每一个数据集就相当于数据库中的一张报表。

2.3缩略语

●CASE

计算机辅助软件工程（ComputerAssistantSoftwareEngineering）

●COM

计算机操作手册（ComputerOperationManual）

●CPM

计算机编程手册（ComputerProgrammingManual）

●CSCI

计算机软件配置项（ComputerSoftwareConfigurationItem）

●DBDD

数据库（顶层）设计说明（DatabaseDesignDescription）

●DID

资料条目说明（DataItemDescription）

●DPMR

开发进度月报（DevelopmentPlanMonthReport）

●DRD

数据需求说明（DatarequirementDescription）

●FAR

可行性分析报告（FeasibilityanalysisReport）

●HWCI

配件配置项（HardwareConfigurationItem）

●IDD

接口设计说明（InterfaceRequirementSpecification）

●IRS

接口（软件）需求规格说明（InterfaceRequirementSpecification）

●IV&

V

独立验证和确认（Independentverificationandvalidation）

●OCD

运行概念说明（OperationConceptionDescription）

●PDSR

项目开发总结报告（ProjectDevelopmentSummaryReport）

●SCCB

软件配置控制委员会（SoftwareConfigurationControlBoard）

●SCM

软件配置管理（SoftwareConfigurationManager）

●SCMP

软件配置管理计划（SoftwareConfigurationManagerPlan）

●SDD

软件（结构）设计说明（SoftwareDesignDescription）

●SDF

软件开发文件（SoftwareDevelopmentFile）

●SFDD

软件开发文档（SoftwareDevelopmentDocument）

●SDL

软件开发库（SoftwareDevelopmentLibrary）

●SDP

软件开发计划（SoftwareDevelopmentPlan）

●SIP

软件安装计划（SoftwareInstallationPlan）

●SPS

软件产品规格说明（SoftwareProductS0pecification）

●SQA

软件质量保证（SoftwareQualityAssure）

●SQAP

软件质量保证计划（SoftwareQualityAssurePlan）

●SRS

软件需求规格说明（SoftwareRequirementSpecification）

●SSDD

系统/子系统设计（结构设计）说明（SystemSubsystemDesignSpecification）

●SSS

系统/子系统需求规格说明（SystemSubsystemRequirementSpecification）

●STD

软件测试说明（SoftwareTestingDescription）

●STP

软件测试计划（SoftwareTestingPlan）

●STR

软件测试报告（SoftwareTestingReport）

●STrP

软件移交计划（SoftwareTransferPlan）

●SUM

软件用户手册（SoftwareUserManual）

●SVD

软件版本说明（SoftwareVersionDescription）

●SW

软件（Software）

3、体系结构设计

3.1体系结构

通过对系统业务的分析，我们进行了详细的系统设计，设计后的方案架构概况图如下所示：

根据系统的逻辑体系结构，系统决定采用J2EE架构，使用面向B/S结构，完全基于Web、中间件和大型数据库的N层体系结构。

由浏览器——WEB服务器——应用服务器——数据库服务器组成。

J2EE是针对web服务、业务对象、数据访问和消息传送的一组规范。

这组应用编程接口（API）确定了web应用与驻留它们的服务器之间的通信方式。

J2EE注重两件事，一是建立标准，使web应用的部署与服务器无关；

二是使服务器能控制组件的生命周期和其它资源，以便能够处理扩展、并发、事务处理管理和安全性等问题。

J2EE平台为设计、开发、安装和部署企业应用提供基于组件的方法。

这种方法不但能降低成本，还能快速跟踪设计和实施。

J2EE平台能提供多层分布式应用模型，重复利用组件，提供统一安全模式，并灵活地控制事务处理。

借助J2EE，能使基于J2EE组件、不依赖于平台的解决方案不被锁定到任何厂商的产品和API上。

3.2组件结构

方案组件模型图如下所示：

组件名称

显示平台

责任

显示逻辑平台组件处理的对象为用户的界面。

处理方式是按照用户的角色和选择的模块将相应的内容展示到屏幕上，将页面显示与处理逻辑中的对象相对应。

规格

业务逻辑处理的对象是系统中的业务逻辑。

同时处理的是异步运算的事务。

对于一些运算量较大的操作，需要系统按照一定的时间表来进行计算，这样即方便用户使用，也可以将系统运算的压力按时间均匀分开，不至于引起运算的瓶颈。

业务逻辑包括以下内容：

对象名、数据来源

对象的计算方法

对象权限信息

对象数据的规格化

逻辑控制

逻辑控制处理的是页面之间的跳转逻辑，即通过统一的控制中心，页面将请求发往控制中心，由控制中心统一流转。

逻辑控制包括以下内容：

控制中心

调度中心

接口

页面的模板

页面的对象

页面的权限

页面的个性化

实施方法

逻辑控制主要使用Struts技术，Struts是一个基于Sun 

J2EE平台的MVC框架，主要是采用Servlet和JSP技术来实现的。

工作流组件

工作流平台提供按照岗位职责和分工设置相应的工作流程，按照预定的工作流程自动进行相应的文档的流转，保证审核体系严密规范，数据信息传递安全真实。

逻辑抽象是将系统中工作流部分进行抽象，形成工作流引擎,方便用户的存取和修改。

操作方式有输入、审核、审批、分析等方法

流程可定制、可维护、可变更

在工作流平台中进行工作流程的定义，包括定义审批的条件以及相应的审批人。

审批分为有条件审批和无条件审批，有条件审批是指在系统中设定好满足怎样的条件由哪个人进行审批，无条件审批是设定好逐级审批的流程，也就是设置从下级到上级的一个审批过程。

审批人可以是跨单位的，即上级单位的人员可以被定义进下级单位的工作流程中。

工作流程定义好后，在业务发生时就能进行审批权限控制。

系统自动将相关的审批信息以交办事务、待办事务的形式即时传递给相关人员审批。

对于审批人员来说，可以在‘待办事务’工作区，集中对需要他进行审批的各种文档进行审批，并标注各种批语。

在‘待办事务’工作区，提交审批的人员能够查询到自己提交的申请目前处于什么状态。

可以进行审批代理人的设置。

这样在审批人外出或者其他情况下，可以通过授权给代理人的方式来完成工作流程。

基于工作流的审批流程可以方便地实现审批过程的会签，代签以及审批过程的动态调整。

采用自主开发的工作流引擎作为申报、审批、更改等业务工作流的支撑平台，