Web应用软件开发概要设计文档.docx

1、Web应用软件开发概要设计文档软件概要设计文档模板文档编号页数14修改状态定稿生效日期2008-2-20拟制审核审批(版权所有，翻版必究)更改记录版本号修改原因/内容修改人审核人审批人修改时间发布2008-2-201. 引言引言是对这份软件系统概要设计报告的概览，是为了帮忙阅读者了解这份文档是如何编写的，而且应该如何阅读、明白得和说明这份文档。1.1 编写目的说明这份软件系统概要设计报告是基于哪份软件产品需求规格说明书编写的，开发那个软件产品意义、作用、和最终要达到的用意。通过这份软件系统概要设计报告详尽说明了该软件产品的软件结构，包括数据库结构和犯错处置，从而对该软件产品的结构的描述。若是这

2、份软件系统概要设计报告只与整个系统的某一部份有关系，那么只概念软件系统概要设计报告中说明的那个部份或子系统。1.2 背景说明待开发软件系统的名称，列出此项目的任务提出者、开发者、用户和将运行该软件的计算站（中心）。1.3 概念列出本文件顶用到的专门术语的概念和外文首字母组词的原词组。1.4 项目风险具体说明本软件开发项目的全数风险承担者，和各自在本时期所需要承担的要紧风险，首要风险承担者包括：任务提出者；软件开发者；产品利用者。1.5 预期读者和阅读建议列举本软件系统概要设计报告所针对的各类不同的预期读者，例如，可能的读者包括：用户；开发人员；项目领导；营销人员；测试人员；文档编写人员；等等。

3、描述文档中，其余部份的内容及其组织结构，而且针对每一类读者提出最适合的文档阅读建议。1.6 参考资料列举编写软件产品概要设计报告时所用到的参考文献及资料，可能包括：本项目的合同书；上级机关有关本项目的批文；本项目已经批准的打算任务书；用户界面风格指导；开发本项目时所要用到的标准；系统规格需求说明；利用实例文档；属于本项目的其它已发表文件；本软件系统概要设计报告中所引用的文件、资料：相关软件系统概要设计报告：等等。为了方便读者查阅，所有参考资料应该按必然顺排列。若是可能，每份资料都应该给出：标落款称；作者或合同签约者；文件编号或版本号；发表日期或签约日期；出版单位或资料来源。2. 设计概述本节描

4、述现有开发条件和需要实现的目标，说明进行概要设计时应该遵循的设计原那么和必需采纳的设计方式。2.1 限制和约束简要描述起到限制和约束作用的各类可能存在的条件，例如：技术条件；资金状况；开发环境(包括：工具和平台)；时刻限制；等等。而且说明在上述条件下，应该实现的系统目标，2.2 设计原那么和设计要求描述对本软件系统进行概要设计的原那么，通常能够考虑以下几方面的内容：命名规那么；模块独立性原那么：边界设计原那么；数据库设计规那么；必需的平安方法；平安性和保密原那么；系统灵活性要求；系统易操作性要求；系统可保护性要求；等等。3. 系统逻辑设计本节内容要紧依照软件产品需求规格说明书和软件产品数据字典

5、成立系统的逻辑模型。此种模型临时与系统的物理因素(例如：运算机、数据库治理系统)无关。它是系统需求与物理实现的中间结构，它的要紧结果是成立：系统结构图、系统界面结构图、系统犯错处置、和系统开发技术说明。说明：若是进行系统设计时尚未编写软件数据字典：应第一参照附录B说明，编写软件数据字典。在完成软件数据字典后，再进行系统设计。3.1 系统组织设计系统组织设计通过系统组织表描述本系统由哪些子系统(模块)组成，这些子系统与业务职能之间的关系，和各个子系统的安装地址。系统组织表的格式如下：子系统编号英文名称中文名称业务职能安装地点备注其中：子系统编号给出本系统中指定子系统的顺序编号。若是本系统末划分为

6、多个子系统，仅由一个运行模块组成；那么本项内容仍需要描述，可是本表内容只有一行。说明：在一个系统中有可能安装假设干个相同的子系统，在这种情形下，应该视为一个子系统，而且对多个安装地址别离进行描述。若是相同的子系统通过系统设置，实现的业务职能具有明显不同时，应该采纳多行进行别离描述，而且在备注中说明其不同所在。子系统英文名称给出本子系统的英文名称，该名称是在应用软件中实际利用的可执行文件名称，必需能够说明该子系统的特点。假设本系统中只有一个子系统，那么本项内容仍需要描述，可是本表内容只有一行。子系统中文名称给出本子系统的中文名称，该名称必需能够说明该子系统的特点。假设本系统中只有一个子系统，那么

7、本项内容仍需要描述，可是本表内容只有一行。业务职能描述该子系统完成的核心业务。安装地址描述该子系统实际安装的部门、或某个具体地址。备注针对该子系统，需要说明的其它有关问题。3.2 系统结构设计本节将对系统特性作较为详细的描述，并给出系统特性结构图。3.2.1 系统特性表系统特性是系统中完成某项具体操作的大体单元，它由入口参数，出口参数和处置进程三部份组成。系统特性能够具有操作界面，也能够没有操作界面；能够被其它操作界面、或系统特性挪用，也能够挪用其它操作界面、非操作界面、或系统特性；可是不许诺递归挪用(挪用自己)，包括间接递归挪用。当系统由多个子系统(模块)组成时，每一个子系统别离利用一张系统

8、特性表进行描述。系统特性表的格式如下：子系统编号：子系统英文名称：子系统中文名称：特性编号系统特征英文名称系统特征中文名称操作功能调用对象被调用对象备注说明：其中子系统编号含义同上。子系统英文名称含义同上。子系统中文名称含义同上。特性编号整个系统所有特性的统一编号。系统特性英文名称系统特性的英文正式名称，以后用于软件开发中，必需符合命名标准。系统特性中文名称系统特性的中文正式名称，来源于需求规格说明书中，系统特性一节中的有关描述。操作功能是指该特性实际完成的操作说明。挪用对象是指挪用该系统特性的系统对象，那个地址的系统对象能够是系统特性、也能够是操作界面。被挪用对象是指被该系统特性挪用的系统对

9、象，那个地址的系统对象能够是系统特性、也能够是操作界面。说明：某些较低层的系统特性，可能不存在被挪用对象。备注描述与该系统特性有关的其它注意事项。说明描述与该系统特性表有关的其它注意事项。3.2.2 系统特性结构图系统特性结构图给出系统特性在逻辑层面上彼此之间的关系，其要紧依据来源于需求规格说明书中，系统特性一节中的有关描述。若是系统划分为多个子系统，应别离给出系统与子系统、和各个子系统与系统特性的结构图。绘制系统与子系统结构图时，一样不需要刻画出系统特性，若是确有必要，尽可能只画出第一层系统特性。绘制子系统与系统特性结构图时，通常也不需要刻画出第二层系统特性，若是确有必要能够画出，可是尽可能

10、不要画出第三层系统特性。3.3 系统接口设计系统接口是一种非可视的系统界面，在多数情形下，它对用户是透明的。本节将对系统接口作较为详细的描述，并给出接口说明清单。3.3.1 系统接口表接口作为系统的一种输入输出形式，分为网络接口、数据库接口、RS-232串行通信接口、IEEE485串行总线接口、并行I/O接口等等多种类型。关于一些为可视界面效劳的接口，例如：打印机接口、显示器接口等，因为这种接口对应用软件是透明的，因此不在本节描述范围内。当系统由多个子系统(模块)组成时，每一个子系统别离利用一张系统接口表进行描述。系统接口表的格式如下：子系统编号子系统英文名称子系统中文名称接口编号接口名称接口

11、类型接口性质接口速率接口协议备注说明：其中：子系统编号含义同上。子系统英文名称含义同上。子系统中文名称含义同上。接口编号整个系统所有接口的统一编号。接口名称系统接口的正式名称，必需符合通常适应。接口类型指出该接口所传输的数据在该模块中起到的作用。接口性质指出该接口在通信中起到的作用，那个地址的作用能够是：输入；输出；双向。接口速度指出该接口的传输速度。若是该接口依托于其它通信方式，那么传输速度将不高于它所依托的其它通信方式的速度。接口协议给出该接话柄际利用的通信协议。相关对象给出直接利用本接口的系统对象，那个地址的系统对象，能够是操作界面，也能够是系统特性。备注描述与该系统接口有关的其它注意事

12、项。说明描述与该系统接口表有关的其它注意事项。3.3.2 系统接口传输协议说明逐项详细描述系统接口表中所列出各个系统接口利用的传输协议，和其它相关内容，例如：驱动程序、动态连接库、等等。3.4 系统完整性设计描述系统对象(数据元、数据类)，所受到的逻辑约束关系。当系统由多个子系统(模块)组成时，每一个子系统应别离利用一张系统完整性约束表进行描述。系统完整性约束表的格式如下：子系统编号子系统英文名称子系统中文名称约束编号完整性名称相对对象名约束表达式备注说明：其中：子系统编号含义同上。子系统英文名称含义同上。子系统中文名称含义同上。约束编号整个系统所有约束的统一编号。完整性名称系统完整性约束的正

13、式名称，必需符合通常适应。相对对象名完整性约束中的相关对象(数据元和数据类)。约束表达式用一阶逻辑表达式表达的约束方程式。备注描述与该系统完整性约束有关的其它注意事项。说明描述与该系统完整性约束表有关的其它注意事项。4. 系统犯错处置设计本节描述系统发生外界及内在错误时，所提供的错误信息及处置方式，它包括系统犯错处置表及保护处置进程表。4.1 系统犯错处置表本表给出有关犯错处置的产生缘故、提示信息、和建议处置方式。当系统由多个子系统(模块)组成时，每一个子系统别离利用一张系统犯错处置表进行描述。系统犯错处置表的格式如下：子系统编号：子系统英文名称：子系统中文名称：错误编号错误名称错误原因错误信

14、息处理方式备注说明：其中：子系统编号含义同上。子系统英文名称含义同上。子系统中文名称含义同上。错误编号整个系统所有错误的统一编号。错误名称错误的正式名称，该名称应该是经常使用的，而且为人们所普遍同意的。错误缘故对该错误产生缘故的说明与说明。错误信息产生该错误时，向用户发出的提示信息。处置方式对该错误处置的一种建议，此项许诺缺省。备注描述与该系统错误有关的其它注意事项。说明描述与该系统错误表有关的其它注意事项。4.2 保护处置进程表系统犯错时，将挪用保护处置进程对错误进行处置，有关保护处置进程的各项内容由保护处置进程表进行描述。当系统有多个子系统(模块)组成时，每一个子系统别离利用一张保护处置进

15、程表进行描述。保护处置进程表的格式如下：子系统编号：子系统英文名称：子系统中文名称：错误编号处理过程处理过程处理功能入口参数出口参数备注英文名称中文名称说明：其中：子系统编号含义同上。子系统英文名称含义同上。子系统中文名称含义同上。错误编号含义同上。处置进程英文名称系统保护处置进程的英文正式名称，以后用于软件开发中，必需符合命名标准。处置进程中文名称系统保护处置进程的中文正式名称，是系统保护处置进程英文名称的中文说明。处置功能描述本保护处置进程对错误的处置方式。由于一个保护处置进程有可能具有对多个错误进行处置的能力，因此该处置功能必需是针对本项错误编号的。入口参数进行本项错误处置时，赋给保护处

16、置进程的入口参数。出口参数进行本项错误处置时，保护处置进程返回的出口参数。备注描述与该系统错误有关的其它注意事项。说明描述与该系统错误表有关的其它注意事项。5. 技术设计系统技术设计描述系统各个特性实际利用的开发技术，和具体开发技术利历时应该注意的事项。5.1 系统开发技术说明表本表描述系统各个特性开发时实际利用的具体技术，只有一些不太经常使用的技术需要在那个地址描述。一些经常使用技术，例如：通过数据库接口挪用存储进程，那么没必要冗述。当系统由多个子系统(模块)组成时，每一个子系统别离利用一张系统开发技术说明表进行描述。系统开发技术说明表的格式如下：子系统编号：子系统英文名称：子系统中文名称：

17、技术编号开发技术开发技术处理功能系统特性编号备注英文名称中文名称说明：其中：子系统编号含义同上。子系统英文名称含义同上。子系统中文名称含义同上。技术编号那个系统所利用各类技术的统一编号。开发技术英文名称该开发技术的英文正式名称，能够便用缩写。该名称应该是经常使用的，而且为人们所普遍同意的。开发技术中文名称该开发技术的中文正式名称，是该开发技术英文名称的中文说明。该名称应该是经常使用的，而且为人们所普遍同意的。处置功能描述本开发技术的处置目的。系统特性编号含义同上。由于一项开发技术可能在多处利用，因此针对一项开发技术，有可能存在多个系统特性编号，在此必需一一列出。备注描述与该系统开发技术相关的其

18、它注意事项。说明描述与该系统开发技术说明表有关的其它注意事项。5.2 开发技术应用说明逐项详细描述系统开发技术说明表中所列出各项系统开发技术利用的技术要点，和其它相关内容，例如：所需的效劳、利用的动态连接库、挪用的组件、等等。6. 数据库设计若是该软件产品需要利用数据库，不论是利用数据库平台支撑的，仍是采纳由软件产品开发者自行概念的；都应该在完成软件产品需求分析报告后，开始进行软件产品详细设计之前，依照软件产品数据库设计说明文档模板完成数据库设计工作。6.1 数据库物理结构设计本系统设备之间的物理结构图；给出本系统内所利用的每一个数据结构中的每一个数据项的存储要求，访问方式、存取单位、存取的物理关系（索引、设备、存储区域）、设计考虑和保密条件。6.2 数据库逻辑结构设计给出本系统内所利用的每一个数据结构的名称、标识符和它们当中每一个数据项、记录、文卷和系的标识、概念、长度及它们之间的层次的或表格的彼此关系。数据对象之间的ER图。7. 进度打算列出进度打算，包括各子系统、各子模块完成进度打算，人员配备打算等。