R02-软件开发设计规范模板.docx

《R02-软件开发设计规范模板.docx》由会员分享，可在线阅读，更多相关《R02-软件开发设计规范模板.docx（51页珍藏版）》请在课桌文档上搜索。

1、附录B软件概要设计报告文档模板附录B软件概要设计报告文档模板11 .引言31.1 编写目的31.2 项目风险31.3 预期读者和阅读建议31.4 参考资料42 .设计雌42.1 限制和约束52.2 设计原则和设计要求53 .系统逻辑设计53.1 系统组织设计63.2 系统结构设计73.2.1系统特性表.73.2.2系统特性结构图.81.3 系统接口设计93. 3.1系统接口表.94. 3.2系统接口传输协议说明.IO1.4 系统完整性设计Il4 .系统出错处理设计124.1 系统出错处理表124.2 维护处理过程表135 .技术设计155.1 系统开发技术说明表155.2 开发技术应用说明16

2、6 .数据库设计167 .词汇表178 .进度计划17附录C软件详细设计报告文档模板171 .引言241.1 编写目的241.2 项目风险241.3 文档约定241.4 预期读者和阅读建议251.5 参考资料252 .支撑环境262.1 数据库管理系统262.2 开发工具、中间件以及数据库接口272.3 硬件环境282.4 网络环境282.5 多种支撑环境开发要点283 .部件详细设计294 .词汇我315 .部件表格式316 .界面表格式32附录D软件数据库设计报告文档模板351 .引啻411.1 -1编写目的411.2 项目来源411.3 文档约定4114预期读者和阅读建议411.5 参考

3、资料422 .数据库命名规则433 .数据库设计说明433.1 数据库逻辑设计433.2 数据库物理设计433.3 数据库分布433.4 基表设计443.5 视图设计463.6 索引设计483.7 完整性约束493.8 授权设计493.9 触发器设计5()3.10 存储过程设计513.11 数据复制设计524 .词汇表535 .历史数据处理546 .溜果交付方式551 .引言引言是对这份软件系统概要设计报告的概览,是为了帮助阅读者了解这份文档是如何编写的，并且应该如何阅读、理解和解释这份文档。1.1 编写目的说明这份软件系统概要设计报告是基于哪份软件产品需求规格说明书编写的，开发这个软件产品意

4、义、作用、以及最终要达到的意图。通过这份软件系统概要设计报告详尽说明了该软件产品的软件结构，包括数据库结构和出错处理，从而对该软件产品的结构的描述。如果这份软件系统概要设计报告只与整个系统的某一部分有关系，那么只定义软件系统概要设计报告中说明的那个部分或子系统。1.2 项目风险具体说明本软件开发项目的全部风险承担者，以及各自在本阶段所需要承担的主要风险，首要风险承担者包括： 任务提出者； 软件开发者； 产品使用者。1.3 预期读者和阅读建议列举本软件系统概要设计报告所针对的各种不同的预期读者，例如，可能的读者包括： 用户； 开发人员； 项目经理； 营销人员； 测试人员； 文档编写人员;描述文档

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

6、要实现的目标,说明进行概要设计时应该遵循的设计原则和必须采用的设计方法。2.1 限制和约束简要描述起到限制和约束作用的各种可能存在的条件，例如: 技术条件; 资金状况; 开发环境（包括：工具和平台）； 时间限制;等等。并且说明在上述条件下，应该实现的系统目标,2 .2设计原则和设计要求描述对本软件系统进行概要设计的原则，通常可以考虑以下几方面的内容: 命名规则; 模块独立性原则: 边界设计原则; 数据库设计规则; 必须的安全措施; 安全性和保密原则; 系统灵活性要求; 系统易操作性要求; 系统可维护性要求;等等。3 .系统逻辑设计本节内容主要根据软件产品需求规格说明书和软件产品数据字典建立系统

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

8、个子系统，仅由一个运行模块组成；则本项内容仍需要描述，但是本表内容只有一行。说明：在一个系统中有可能安装若干个相同的子系统，在这种情况下，应该视为一个子系统，并且对多个安装地点分别进行描述。如果相同的子系统通过系统设置，实现的业务职能具有明显差异时，应该采用多行进行分别描述，并且在备注中说明其差异所在。 子系统英文名称给出本子系统的英文名称，该名称是在应用软件中实际使用的可执行文件名称，必须能够说明该子系统的特点。若本系统中只有一个子系统，则本项内容仍需要描述，但是本表内容只有一行。 子系统中文名称给出本子系统的中文名称，该名称必须能够说明该子系统的特点。若本系统中只有一个子系统，则本项内容仍

9、需要描述，但是本表内容只有一行。 业务职能描述该子系统完成的核心业务。 安装地点描述该子系统实际安装的部门、或者某个具体地点。 备注针对该子系统，需要说明的其它有关问题。3.2系统结构设计本节将对系统特性作较为详细的描述，并给出系统特性结构图。3.2.1 系统特性表系统特性是系统中完成某项具体操作的基本单元，它由入口参数，出口参数以及处理过程三部分组成。系统特性可以具有操作界面，也可以没有操作界面；可以被其它操作界面、或者系统特性调用，也可以调用其它操作界面、非操作界面、或者系统特性；但是不允许递归调用（调用自己），包括间接递归调用。当系统由多个子系统（模块）组成时，每个子系统分别使用一张系统

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

11、，这里的系统对象可以是系统特性、也可以是操作界面。说明：某些较低层的系统特性，可能不存在被调用对象。 备注描述与该系统特性有关的其它注意事项。 说明描述与该系统特性表有关的其它注意事项。3.2.2系统特性结构图系统特性结构图给出系统特性在逻辑层面上相互之间的关系,其主要依据来源于需求规格说明书中，系统特性一节中的有关描述。如果系统划分为多个子系统，应分别给出系统与子系统、以及各个子系统与系统特性的结构图。绘制系统与子系统结构图时，一般不需要描绘出系统特性，如果确有必要，尽可能只画出第一层系统特性。绘制子系统与系统特性结构图时,通常也不需要描绘出第二层系统特性,如果确有必要可以画出，但是尽可能不

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

13、型接口性质接口速率接口协议备注说明：其中:子系统编号含义同上。子系统英文名称子系统中文名称含义同上。 接口编号整个系统所有接口的统一编号。 接口名称系统接口的正式名称，必须符合通常习惯。 接口类型指出该接口所传输的数据在该模块中起到的作用。 接口性质指出该接口在通讯中起到的作用，这里的作用可以是：输入；输出；双向。 接口速率指出该接口的传输速率。如果该接口依赖于其它通讯方式，那么传输速率将不高于它所依赖的其它通讯方式的速率。 接口协议给出该接口实际使用的通讯协议。 相关对象给出直接使用本接口的系统对象，这里的系统对象，可以是操作界面，也可以是系统特性。 备注描述与该系统接口有关的其它注意事项。

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

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

16、信息处理方式备注说明：其中: 子系统编号含义同上。 子系统英文名称含义同上。 子系统中文名称含义同上。 错误编号整个系统所有错误的统一编号。 错误名称错误的正式名称，该名称应该是常用的，并且为人们所普遍接受的。 错误原因对该错误产生原因的解释与说明。 错误信息产生该错误时，向用户发出的提示信息。 处理方式对该错误处理的一种建议，此项允许缺省。 备注描述与该系统错误有关的其它注意事项。 说明描述与该系统错误表有关的其它注意事项。4 .2维护处理过程表系统出错时，将调用维护处理过程对错误进行处理，有关维护处理过程的各项内容由维护处理过程表进行描述。当系统有多个子系统（模块）组成时，每个子系统分别使

17、用一张维护处理过程表进行描述。维护处理过程表的格式如下：子系统编号：子系统英文名称：子系统中文名称：错误编号处理过程处理过程处理功能入口参数出口参数备注英文名称中文名称说明：其中: 子系统编号含义同上。 子系统英文名称含义同上。 子系统中文名称含义同上。 错误编号含义同上。 处理过程英文名称系统维护处理过程的英文正式名称，将来用于软件开发中，必须符合命名规范。 处理过程中文名称系统维护处理过程的中文正式名称，是系统维护处理过程英文名称的中文说明。 处理功能描述本维护处理过程对错误的处理方式。由于一个维护处理过程有可能具有对多个错误进行处理的能力，因此该处理功能必须是针对本项错误编号的。 人口参

18、数进行本项错误处理时，赋给维护处理过程的人口参数。 出口参数进行本项错误处理时，维护处理过程返回的出口参数。 备注描述与该系统错误有关的其它注意事项。说明描述与该系统错误表有关的其它注意事项。5 .技术设计系统技术设计描述系统各个特性实际使用的开发技术，以及具体开发技术使用时应该注意的事项。5.1 系统开发技术说明表本表描述系统各个特性开发时实际使用的具体技术，只有一些不太常用的技术需要在这里描述。一些常用技术，例如：通过数据库接口调用存储过程，则不必冗述。当系统由多个子系统（模块）组成时,每个子系统分别使用一张系统开发技术说明表进行描述。系统开发技术说明表的格式如下：子系统编号：子系统英文名

19、称：子系统中文名称：技术编号开发技术开发技术处理功能系统特性编号备注英文名称中文名称说明：其中：子系统编号含义同上。子系统英文名称含义同上。子系统中文名称含义同上。技术编号这个系统所使用各种技术的统一编号。 开发技术英文名称该开发技术的英文正式名称，可以便用缩写。该名称应该是常用的，并且为人们所普遍接受的。 开发技术中文名称该开发技术的中文正式名称，是该开发技术英文名称的中文说明。该名称应该是常用的，并且为人们所普遍接受的。 处理功能描述本开发技术的处理目的。 系统特性编号含义同上。由于一项开发技术可能在多处使用，因此针对一项开发技术，有可能存在多个系统特性编号，在此必须一一列出。 备注描述与

20、该系统开发技术相关的其它注意事项。 说明描述与该系统开发技术说明表有关的其它注意事项。5.2开发技术应用说明逐项详细描述系统开发技术说明表中所列出各项系统开发技术使用的技术要点，以及其它相关内容，例如：所需的服务、使用的动态连接库、调用的组件、等等。6 .数据库设计如果该软件产品需要使用数据库，不论是使用数据库平台支撑的，还是采用由软件产品开发者自行定义的；都应该在完成软件产品需求分析报告后，开始进行软件产品详细设计之前，按照软件产品数据库设计说明文档模板完成数据库设计工作。7 .词汇表列出本文件中用到的专业术语的定义，以及有关缩写的定义（如有可能，列出相关的外文原向）。为了便于非软件专业或者

21、非计算机专业人士阅读软件系统概要设计报告，要求使用非软件专业或者非计算机专业的术语进行描述。所以这里所指的专业术语，是指业务层面上的专业术语，而不是软件专业或者计算机专业的术语。但是，对于无法回避的软件专业或者计算机专业术语，也应该列入词汇表，并且加以准确定义。8 .进度计划列出进度计划，包括各子系统、各子模块完成进度计划，人员配备计划等。附录C软件详细设计报告文档模板1 .范围错误!未定义书签。2.总体要求错误!未定义书签。2.1 总体功能要求错误!未定义书签。2.2 2软件开发平台要求错误!未定义书签。2.3 软件项目的开发实施过程管理要求错误!未定义书签。2. 3.1软件项目实施过程总体

22、要求错误!未定义书签。3. 3.2软件项目实施变更要求错误!未定义书签。4. 3.3软件项目实施里程碑控制.错误!未定义书签。3.软件开发错误!未定义书签。3.1 软件的需求分析错误!未定义书签。3. 1.1需求分析.错误!未定义书签。3. 1.2需求分析报告的编制者错误!未定义书签。3. 1.3需求报告评审.错误!未定义书签。3. 1.4需求报告格式.错误!未定义书签。3.2软件的概要设计错误!未定义书签。3. 2.1概要设计.错误!未定义书签。3. 2.2编写概要设计的要求错误!未定义书签。3. 2.3概要设计报告的编写者错误!未定义书签。3. 2.4概要设计和需求分析、详细设计之间的关系

23、和区别错误!未定义书签。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.4软件的编码错误!未定义书签。3. 4.1软件编码.错误!未定义书签。3. 4.2软件编码的要求.错误!未定义书签。3. 4.3编码的评审.错误!未定义书签。3. 4.4编程规范及要求.错

24、误!未定义书签。3. 5软件的测试错误!未定义书签。3. 5.1软件测试.错误!未定义书签。3. 5.2测试计划.错误!未定义书签。3. 6软件的交付准备错误!未定义书签。5. 6.1交付清单错误!未定义书签。3.7软件的鉴定验收错误!未定义书签。1.1.1 7.1软件的鉴定验收.错误!未定义书签。1.1.2 2验收人员错误!未定义书签。1.1.3 验收具体内容.错误!未定义书签。1.1.4 软件验收测试大纲.错误!未定义书签。3.8培训错误!未定义书签。3.8.1系统应用培训.错误!未定义书签。3.8.2系统管理的培训（可选）错误!未定义书签。1 .引啻错误!未定义书签。1.1 编写目的错误

25、!未定义书签。12项目风险错误!未定义书签。1.3 文档约定错误!未定义书签。14预期读者和阅读建议错误!未定义书签。15产品范围错误!未定义书签。1.6参考文献错误!未定义书签。2 .综合描述错误!未定义书签。2.1 产品的状况错误!未定义书签。2.2 产品的功能错误!未定义书签。2.3 用户类和特性错误!未定义书签。2.4 4运行环境错误!未定义书签。2.5 5设计和实现上的限制错误!未定义书签。2.6 假设和约束（依赖）错误!未定义书签。3 .外部接口需求错误!未定义书签。3.1 用户界面错误!未定义书签。3.2硬件接口错误!未定义书签。3.3软件接口错误!未定义书签。3.4通讯接口错误

26、!未定义书签。4.系统功能需求错误!未定义书签。4.1 说明和优先级错误!未定义书签。4. 2激励/响应序列错误!未定义书签。5. 3输入/输出数据错误!未定义书签。6. 其它非功能需求错误!未定义书签。6.1 性能需求错误!未定义书签。6.2 安全措施需求错误!未定义书签。6.3 安全性需求错误!未定义书签。5.4软件质量属性错误!未定义书签。5.5业务规则错误!未定义书签。5.6用户文档错误!未定义书签。6 .词汇盘错误!未定义书签。7 .数据定义错误!未定义书签。8 .分析模型错误!未定义书签。9 .待定问题列表错误!未定义书签。1 .弓I音31.1 编写目的31.2 项目风险313预期

27、读者和阅读建议31.4 参考资料42 .设计Iftii41 .1限制和约束52 .2设计原则和设计要求53 .系统逻辑设计3.1 系统组织设计63.2 系统结构设计73.2.1系统特性表.73.2.2系统特性结构图.83.3系统接口设计93.3.1系统接口表.93.3.2系统接口传输协议说明.103.4系统完整性设计114 .系统出错处理设计124.1 系统出错处理表124.2 维护处理过程表135 .技术设计155.1 系统开发技术说明表155.2 开发技术应用说明166 .数据库设计167 .词汇般178 .进度计划171 .引言241.1 编写目的241.2 项目风险241.3 文档约定

28、2414预期读者和阅读建议251.5 参考资料252 .支撑环境262.1 数据库管理系统262.2 2开发工具、中间件以及数据库接口272.3 硬件环境282.4 网络环境282.5 多种支撑环境开发要点283 .部件详细设计294 .词汇衰315 .部件表格式316 .界面表格式321 .引言411.1 编写目的411.2 项目来源411.3 文档约定4114预期读者和阅读建议411.5 参考资料422 .数据库命名规则433 .数据库设计说明433.1 数据库逻辑设计433.2 数据库物理设计433.3 数据库分布433.4 基表设计443.5 视图设计463.6 索引设计483.7 完

29、整性约束493.8 授权设计493.9 触发器设计5（）3.10 存储过程设计513.11 数据复制设计524 .词汇我535 .历史数据处理546 .引啻错误!未定义书签。6.1 目的错误!未定义书签。12术语错误!未定义书签。13参照标准错误!未定义书签。7 .测试日期安排错误!未定义书签。8 .测试小组及成员错误!未定义书签。9 .溜试具体内容错误!未定义书签。9.1 合法性检查错误!未定义书签。9.2 软件文档检查错误!未定义书签。4.2.1必须提供检查的文档.错误!未定义书签。4.2.2其他可能需要检查的文档.错误!未定义书签。4.2.3由业主确定必须检查的其他文档错误!未定义书签。

30、4.2.4文档质量的度量准则.错误!未定义书签。4.3软件代码测试错误!未定义书签。4.3.1源代码一般性检查错误!未定义书签。4.3.2软件一致性检查.错误!未定义书签。4.4软件系统测试错误!未定义书签。4.4.1界面（外观）测试.错误!未定义书签。4.4.2可用性测试.错误!未定义书签。4.4.3功能测试.错误!未定义书签。4.4.4稳定性（强度）测试.错误!未定义书签。4.4.5性能测试.错误!未定义书签。4.4.6强壮性（恢复）测试.错误!未定义书签。4.4.7逻辑性测试.错误!未定义书签。4.4.8破坏性测试.4.4.9安全性测试.错误!未定义书签。错误!未定义书签.5.测试结果交

31、付方式1 .引言引言是对这份软件系统详细设计报告的概览,是为了帮助阅读者了解这份文档如何编写的，并且应该如何阅读、理解和解释这份文档。1.1 编写目的说明这份软件系统详细设计报告是基于哪份软件产品需求分析报告、哪份软件产品概要设计报告和哪份软件产品数据库设计说明书（如果该软件产品需要数据库支持）编写的,开发这个软件产品意义、作用、以及最终要达到的意图。通过这份软件系统详细设计报告详尽说明了该软件产品的编码结构，从而对该软件产品的物理组成进行准确的描述。如果这份软件系统详细设计报告只与整个系统的某一部分有关系，那么只定义软件系统详细设计报告中说明的那个部分或子系统。1.2 项目风险具体说明本软件

32、开发项目的全部风险承担者，以及各自在本阶段所需要承担的主要风险，首要风险承担者包括： 任务提出者； 软件开发者； 产品使用者。1.3 文档约定描述编写文档时所采用的标准（如果有标准的话），或者各种编写约定。编写约定应该包括： 部件编号方式； 界面编号方式； 命名规范：1.4 预期读者和阅读建议列举本软件系统详细设计报告所针对的各种不同的预期读者，例如，可能的读者包括: 开发人员； 项目经理； 测试人员； 文档编写人员； 等等。描述文档中，其余部分的内容及其组织结构，并且针对每一类读者提出最适合的文档阅读建议。1.5 参考资料列举编写软件系统详细设计报告时所用到的参考文献及资料，可能包括： 本项

33、目的合同书； 上级机关有关本项目的批文； 本项目已经批准的计划任务书； 用户界面风格指导； 开发本项目时所要用到的标难； 系统规格需求说明； 使用实例文档； 属于本项目的其它己发表文件； 本软件系统详细设计报告中所引用的文件、资料； 相关软件系统详细设计报告； 等等。为了方便读者查阅，所有参考资料应该按一定顺序排列。如果可能，每份资料都应该给出： 标题名称; 作者或者合同签约者； 文件编号或者版本号； 发表日期或者签约日期； 出版单位或者资料来源。2.支撑环境2.1 数据库管理系统描述数据库管理系统、以及安装配置情况，需要描述的内容可能包括： 产品名称以及发行厂商这里的产品名称指的是数据库发行

34、厂商发布产品时公布的正式商品名称，不应该使用别名、简称、研发代号等非正式名称，以免混淆；同样的道理，发行厂商的名称也应该使用正式名称。 版本号数据库管理系统的准确版本号，必须按产品的实际情况描述到最细节的版本号。 补丁包版本号描述实际上将要使用的数据库管理系统补丁包的版本号，必须注意，在某些情况下该版本号不一定是最新的版本号。 语言或代码集对于只支持一种语言或者一个代码集的数据库管理系统来说，该项描述不具意义。对于支持多种语言或者多个代码集的数据库管理系统来说，该项描述指的是实际使用的语言或者代码集。安装位置描述数据库管理系统的实际安装位置，应该分别对管理系统安缺位置和数据存放位置进行描述，应

35、该指明服务器名和安装卷号（盘号）。对于分布式数据库，必须分别描述每一个数据库管理系统。配置参数描述数据库管理系统在实际安装时应该配置的各个参数，对于分布式数据库，必须分别描述每一个数据库管理系统的配置参数。等等同时参照南京市交通局信息化数据库建设规范。2.2 开发工具、中间件以及数据库接口描述所选用的工具软件和中间件的名称、版本号，以及开发工具与数据库或者中间件接口的情况。如果使用了多种开发工具辅助开发工具、第三方软件部件、多种中间件、多种接口、等答应该逐项分别描述，并且说明每一项的适用范围。需要描述的内容可能包括: 产品名称以及发行厂商同中产品名称以及发行厂商。 版本号同中版本号。 补丁包版

36、本号同中补丁包版本号。 语言或代码集同中语言或代码集。 数据库接口名称描述数据库接口的名称，如果使用别名时，应同时描述使用的别名。 数据库接口方式描述与数据库接口的方式，并说明该接口方式的特点；如果需要，还应该说明使用时的注意事项。 数据库接口设置描述各种接口设置，包括：协议、端口号等等。同时参照南京市交通局信息化数据库建设规范。1.1 3硬件环境描述所选用的硬件环境，各种机型，例如：服务器、工作站，应该分别描述。需要描述的内容可能包括： 机型； 主频； 内存容量； 磁盘容量； 特殊部件； 操作系统； 使用位置； 等等。2.4 网络环境描述可能影响应用软件访问数据库的各种网络环境，如果存在加密

37、传输、VPN链路等情况，也必须描述。对于结构复杂的网络，还应该提供网络拓扑图和数据流向示意图。需要描述的内容可能包括： 网络结构； 网络操作系统； 网络带宽； 路由组织； 加密传输方式； VPN链路连接方式； 等等。2.5 多种支撑环境开发要点当软件产品将来可能遇到的多种运行环境时，应该分别按照节至节的内容列表描述。如果软件产品各个子系统的运行环境不完全一样时，应该分子系统按照节至节的内容列表描述。遇到上述情况时，不仅需要详细描述各种软件开发、调试、测试的环境，为了确实保证软件产品将来能够在各种可能的运行环境中正常运行,还需要对软件产品进行严格的配置管理。3.部件详细设计这里所提及的软件部件，

38、系指能够完成特定功能、相对独立的一些代码集合，它们可以是插件、组件、控件、函数、过程、子程序、动态连接库、等等。具体呈何种形态，取决于实际采用的开发工具和将要实现的软件结构。按照合适的顺序，逐个描述软件部件的详细情况。描述的顺序可以是按层次横向进行描述，也可以是按模块纵向进行描述，总之描述的方式必须有利于读者理解软件结构。每个部件采用一张软件部件表进行描述，软件部件表的格式见附表一，其中； 部件编号软件部件的统一顺序编号；对于实行配置管理的软件开发项目来说，该编号必须与该部件在配置管理中的编号相同。 部件名称软件部件的正式英文名称，该名称是程序中使用的实际名称，必须符合国家相关软件命名标准。

39、所属子系统指该部件所属的子系统；对于不分为多个子系统的软件来说，不必填写该栏。 部件调用者指调用该部件的部件（或界面参数）的编号和名称。 部件被调用者指被该部件所调用的部件的编号和名称。 部件人口参数指该部件入口数据类名称或者数据名称，以及对这些数据的描述；如果部件没有入口参数，该栏为空。 部件出口参数指该部件出口数据类名称或者数据名称，以及对这些数据的描述；如果部件没有出口参数，该栏为空。 算法指该部件的算法形式表示，如果很简单、或者不存在，也可以为空。 流程描述指该部件的处理流程的详细表示或描述。 部件表示形式指该部件完成开发后的最终表示形式，具体形式取决于开发工具和软件结构，表示形式可能

40、是：插件、组件、控件，函数、过程、子程序，存储过程，动态连接库，等等。 运行环境描述该部件所适合的运行环境，即说明该部件是针对何种运行环境所开发的；可以直接描述运行环境，也可以描述运行环境的编号；对于实行配置管理的软件开发项目来说，该描述必须与该部件在配置管理中的描相同。 性能要求指开发该部件时必须满足的专门要求，这些要求可以是：精度灵活性响应时间可重用性等等。提出的要求一般不宜超过3项，以排列的先后顺序表示优先级。4 .词汇表列出本文件中用到的专业术语的定义，以及有关缩写的定义（如有可能，列出相关的外文原词）。为了便于非软件专业或者非计算机专业人士也能够在一定的范围内，读懂软件系统详细设计报

41、告，要求尽可能使用非软件专业或者非计算机专业的术语进行描述。所以这里所指的专业术语，是指业务层面上的专业术语，而不是软件专业或者计算机专业的术语。但是，对于无法回避的软件专业或者计算机专业术语，也应该列入词汇表，并且加以准确定义。5 .部件表格式部件编号部件名称所属子系统部件调用者部件被调用者部件人口参数部件人口参数算法：流程描述:表示性能运行环境性能要求说明：如果软件不见使用一张表表述不完时，可以采用续表描述，但是必须注明是那张表的续表。6 .界面表格式界面编号部件名称界面性质界面介质表示形式：界面参数参数名内容说明说明：如果软件不见使用一张表表述不完时，可以采用续表描述，但是必须注明是那张

42、表的续表。附录D软件数据库设计报告文档模板1 .范围错误!未定义书签。2 .总体要求错误!未定义书签。2.1 总体功能要求错误!未定义书签。2.2软件开发平台要求错误!未定义书签。2.3软件项目的开发实施过程管理要求错误!未定义书签。2. 3.1软件项目实施过程总体要求错误!未定义书签。3. 3.2软件项目实施变更要求错误!未定义书签。4. 3.3软件项目实施里程碑控制.错误!未定义书签。3.软件开发错误!未定义书签。3.1 软件的需求分析错误!未定义书签。3. 1.1需求分析.错误!未定义书签。3. 1.2需求分析报告的编制者错误!未定义书签。3. 1.3需求报告评审.错误!未定义书签。3. 1.4需求报告格式.错误!未定义书签。3.2软件的概要设计错误!未定义书签。3. 2.1概要设计.错误!未定义书签。3. 2.2编写概要设计的要求错误!未定义书签。3. 2.3概要设计报告的编写者错误!未定义书签。3. 2.4概要设计和需求分析、详细设计之间的关系和区别错误!未