软件开发需求文档模板.doc

I 目录目录 1. 范围范围.1 2. 总体要求总体要求 1 2.1 总体功能要求.1 2.2 软件开发平台要求.1 2.3 软件项目的开发实施过程管理要求.2 2.3.1 软件项目实施过程总体要求.2 2.3.2 软件项目实施变更要求.2 2.3.3 软件项目实施里程碑控制.2 3. 软件开发软件开发 3 3.1 软件的需求分析.3 3.1.1 需求分析.3 3.1.2 需求分析报告的编制者.4 3.1.3 需求报告评审.4 3.1.4 需求报告格式.4 3.2 软件的概要设计.4 3.2.1 概要设计.4 3.2.2 编写概要设计的要求.4 3.2.3 概要设计报告的编写者.4 3.2.4 概要设计和需求分析、详细设计之间的关系和区别.4 3.2.5 概要设计的评审.4 3.2.6 概要设计格式.4 3.3 软件的详细设计.5 3.3.1 详细设计.5 3.3.2 特例.5 3.3.3 详细设计的要求.5 3.3.4 数据库设计.5 3.3.5 详细设计的评审.5 3.3.6 详细设计格式.5 3.4 软件的编码.5 3.4.1 软件编码.5 3.4.2 软件编码的要求.5 3.4.3 编码的评审.6 3.4.4 编程规范及要求.6 3.5 软件的测试.6 3.5.1 软件测试.6 3.5.2 测试计划.6 3.6 软件的交付准备.6 3.6.1 交付清单.6 II 3.7 软件的鉴定验收.7 3.7.1 软件的鉴定验收.7 3.7.2 验收人员.7 3.7.3 验收具体内容.7 3.7.4 软件验收测试大纲.7 3.8 培训.7 3.8.1 系统应用培训.7 3.8.2 系统管理的培训（可选）.8 附录附录 A 软件需求分析报告文档模板软件需求分析报告文档模板.9 附录附录 B 软件概要设计报告文档模板软件概要设计报告文档模板 .21 附录附录 C 软件详细设计报告文档模板软件详细设计报告文档模板.33 附录附录 D 软件数据库设计报告文档模板软件数据库设计报告文档模板.43 附录附录 E 软件测试软件测试(验收验收)大纲大纲.55 1 1. 范围范围 本指南用于指导软件开发者为南京市交通局开发软件项目的过程，通过规范软件项目 承担单位的开发过程达到提高软件质量，降低维护成本的目的。开发者应根据本指南进行 软件开发和编制软件开发文档。本指南是对软件项目承担单位的基本要求。在本指南的附 录 A 至 E 中提供了文档的编写模板供开发者参考，在进行具体软件开发时，开发者可根据 实际情况采编写，但必须提供双方约定的文档，文档中约定的内容必须描述清楚。 2. 总体要求总体要求 2.1 总体功能要求总体功能要求 网络应用环境以 Internet/Intranet 技术为核心。 开发者应在充分分析需求的基础上，选择采用 B/S 结构或者 C/S 结构。 软件系统的数据库应依照南京市交通局信息化数据库建设规范进行设计和建设。 本指南中没有规定开发者采用何种具体的软件工程开发方法，开发者可根据项目具体 特点、自身擅长来选择采用面向过程的方法、面向对象的方法或面向数据的方法，但建议 开发 商使用面向对象软件工程的方法，如：采用目前被广泛使用的 RUP(Rational Unified Process)方法来进行分析、设计和开发。 2.2 软件开发平台要求软件开发平台要求 开发者开发的软件必须能够在南京市交通局规定的软件平台上正常运行。目前软件平 台为： 数据库管理系统： Oracle 9i 以上版本 中间件(应用服务器)系统： IBM WebSphere OA 系统： Lotus Domino/Notes 网络架构： 完全支持 TCP/IP 协议 开发工具或技术体系： 为保证软件的上下兼容性，开发者应选择比较通用的开发工具的较新版本进行开 发，如 Microsoft Visual Studio.Net，Borland Delphi，C+ Builder, 或 J2EE(Java2 P1atform Enterprise Edition)等。 2 2.3 软件项目的开发实施过程管理要求软件项目的开发实施过程管理要求 2.3.1 软件项目实施过程总体要求 （一）开发者提交软件开发工作大纲，交通局组织专家组对工作大纲进行评审，并提 出整改意见。 （二）通过评审后，开发者根据整改意见完善工作大纲，经过交通局认可后组织项目 组进行软件开发。软件开发工作按照需求分析、概要设计、详细设计、编码、测试等 几个阶段进行，在开发过程中，开发者需分阶段提交相关文档。 （三）在软件开发工作完成后，开发者应向交通局提交完整的软件文档，交通局组织 验收组对软件进行验收审查。 2.3.2 软件项目实施变更要求 在开发过程中，需求或设计不可避免地需要发生变更，相关变更必须经过交通局书面 同 意方可进行。在需求或设计发生变更时，需要对原有文档进行修改，并提供完整的变 更记录， 以使变更处于可控制的状态。变更单如下表所示： 表 2-1 变更单 需求变更申请 申请变更的需求文档 输入名称，版本，日期等信息 变更的内客及其理由 评估需求变更将对 项目造成的影响 申请人签字 变更申请的审批意见 项目经理签字 审批意见： 签字 日期 客户签字 (合同项目) 审批意见： 签字 日期 更改需求文档 变更后的 需求文档 输入名称，版本，完成日期等信息 更改人签字 重新评审需求文档 需求评审小组签字 评审意见： 签字 日期 变更结束 项目经理签字 签字 日期 2.3.3 软件项目实施里程碑控制 交通局将分四个阶段进行把关，召开专家审查会。 （一） 需求分析（结合原型进行审查）确认； （二） 概要设计+数据库设计； 3 （三） 预验收（试运行后） ； （四） 正式验收（推广使用后） 。 3. 软件开发软件开发 合同签订以后，项目承担单位即可组织项目组进行软件开发工作。软件开发必须严格 按照软件工程的要求进行。开发过程包括开发者的活动和任务。此过程由软件需求分析、 概要设计、详细设计、编码、测试、验收、鉴定等活动组成。 3.1 软件的需求分析软件的需求分析 3.1.1 需求分析 首先，开发者和交通局应共同对交通局的应用需求作充分的调研，提交完整的需求分 析 报告。在需求分析报告中必须描述的基本问题是：功能、性能、强加于实现的设计限 制、属 性、外部接口。应当避免把设计或项目需求写入需求分析报告中。它必须说明由软 件获得的 结果，而不是获得这些结果的手段。 软件需求可以用若干种方法来表达，如通过输入、输出说明；使用代表性的例子；用 规范化的模型。开发者应尽可能地使用模型的方式，因为这是表达复杂需求的精确和有效 的方法。比如用统一建模语言（UML）来描述需求。 编写需求分析报告的要求 a无歧义性 对最终产品的每一个特性用某一术语描述；若某一术语在某一特殊的行文中使用时具 有多种含义，那么应对该术语的每种含义做出解释并指出其适用场合。 b完整性 需求分析报告应该包括全部有意义的需求，无论是关系到功能的、性能的、设计约束 的、还是关系到外部接口方面的需求；对所有可能出现的输入数据的响应予以定义，要对 合法和非合法的输入值的响应做出规定；填写全部插图、表、图示标记等；定义全部术语 和度量单位。 c可验证性 需求分析报告描述的每一个需求应是可以验证的。可以通过一个有限处理过程来检查 软件产品是否满足需求。 d一致性 在需求分析报告中的各个需求的描述不能互相矛盾。 e可修改性 需求分析报告应具有一个有条不紊、易于使用的内容组织；没有冗余，即同一需求不 能在需求分析报告中出现多次。 f可追踪性 每一个需求的源流必须清晰，无限恐怖 ，在进一步产生和改变文件 编制时，可以方便地引证每一个需求。 g运行和维护阶段的可使用性 需求分析报告必须满足运行和维护阶段的需要。在需求分析报告要写明功能的来源和 目的。 4 3.1.2 需求分析报告的编制者 需求分析报告应由交通局和开发者双方共同完成。其中：交通局负责根据实际需要提 出希望软件实现的功能；软件开发者根据交通局提出的性能需求，结合软件开发编写需求 分析。 3.1.3 需求报告评审 在软件需求分析工作完成后，软件开发者应向交通局提交软件需求分析报告 。交通 局组织有关人员对需求进行评审，以决定软件需求是否完善和恰当。评审完成后，就可以 进入软件的设计阶段。 3.1.4 需求报告格式 软件需求分析报告需按一定的格式进行编写，具体的软件需求分析报告文档 编写模板请见附录 A。 3.2 软件的概要设计软件的概要设计 3.2.1 概要设计 在交通局和开发者双方认可的需求分析报告基础上，开发者进行下步的工作。 首先，开发者需要对软件系统进行概要设计，即系统设计。概要设计需要对软件系统 的设计 进行考虑，包括系统的基本处理流程、系统的组织结构、模块划分、功能分配、 接口设计、 运行设计、数据结构设计和出错处理设计等，为软件的详细设计提供基础。 3.2.2 编写概要设计的要求 a一致性 概要设计的要求应该与需求分析报告所描述的需求一致。同时，概要设计的各项要求 之间也应该一致。 b合理性 概要设计所提出的设计方法和标准应该是合理的、恰当的。 c可追踪性 对概要设计所提出的各项要求应该可以得到它的清晰的源流，即在需求分析报告客户 有明确的需求描述。 d可行性 根据概要设计进行详细设计、操作和维护应该是可行的。 3.2.3 概要设计报告的编写者 概要设计报告由开发者根据需求分析报告的要求进行编写。 3.2.4 概要设计和需求分析、详细设计之间的关系和区别 需求分析不涉及具体的技术实现，而概要设计注重于从宏观上和框架上来描述采用何 种技术手段、方法来实现这些需求。详细设计相对概要设计更注重于微观上和框架内的设 计， 是编码的依据。概要设计是指导详细设计的依据。 3.2.5 概要设计的评审 在软件概要设计工作完成后，软件开发者应向交通提交软件系统概要设计报告 。在 交通局对概要设计报告评审通过后，即可进入详细设计阶段。 3.2.6 概要设计格式 软件系统概要设计报告需按一定的格式进行编写，异世邪君 ， 具体的软件系统概要设计报 告文档编写模板请见附录 B。 5 3.3 软件的详细设计软件的详细设计 3.3.1 详细设计 在概要设计的基础上，开发者需要进行软件系统的详细设计。在详细设计中，描述实 现具体模块所涉及到的主要算法、数据结构、类的层次结构及调用关系，需要说明软件系 统各个层次中的每一个程序(每个模块或子程序)的设计考虑，以便进行编码和测试。应当 保证 软件的需求完全分配给整个软件。详细设计应当足够详细，能够根据详细设计报 告进行编码。 3.3.2 特例 如果软件系统比较简单，层次较少，可以不必进行专门的详细设计，而和概要设计结 合起来。 3.3.3 详细设计的要求 a一致性 详细设计的要求应该与需求分析报告所描述的需求、与概要设计一致。同时，详细设 计的各项要求之间也应该是一致的。 b合理性 详细设计所提出的设计方法和标准应该是合理的、恰当的。 c可追踪性 对详细设计所提出的各项要求应该可以得到它的清晰的源流，即可在需求分析报告、 概要设计报告中有明确的需求描述。 d可行性 根据详细设计进行编码、测试、操作和维护应该是可行的。 3.3.4 数据库设计 如果软件产品需要使用到数据库，软件的详细设计应包括对数据库的设计。数据库设 计应在软件的需求分析、概要设计完成之后、详细设计的其它工作之前进行。在进行数据 库设计时，应当按照交通局制定的南京市交通局信息化数据库建设规范要求进行。 3.3.5 详细设计的评审 在软件详细设计完成后，软件开发者应向交通局提交软件系统数据库设计报告和 软件系统详细设计报告 。在交通局对软件系统数据库设计报告 、 软件系统详细设计 报告评审通过后，即可进入软件编码阶段。 3.3.6 详细设计格式 软件系统详细设计报告 、 软件系统数据库设计报告需按一定的格式进行编写， 具体的软件系统详细设计报告文档编写模板和软件系统数据库设计报告文档编写 模 板请见附录 C、附录 D。 3.4 软件的编码软件的编码 3.4.1 软件编码 在软件编码阶段，开发者根据软件系统详细设计报告中对数据结构、算法分析和 模块实现等方面的设计要求，开始具体的编写程序工作，分别实现各模块的功能，从而实 现对目标系统的功能、性能、接口、界面等方面的要求。 3.4.2 软件编码的要求 a模块化编码 6 b代码可读性 c可维护性 d模块接口标准化 e界面风格统一 e注释的应用 3.4.3 编码的评审 为了尽早发现软件中的障碍，提高软件产品的质量，开发者在编码的过程中应该强调 代码评审工作。将代码评审报告作为文档的一部分，提交给交通局。 3.4.4 编程规范及要求 为了提高编程实现的质量，软件的程序设计必须遵照国家颁布的相关编程规范。 主要内容包括：规范化的程序内部文档、数据结构的详细说明、清晰的语句结构、编 码规范。编码规范的内容包括命名规范、界面规范、提示及帮助信息规范、热键定义等。 其中数据库部分应遵守南京市交通局信息化数据库建设规范的要求。 在软件编码的同时应进行单元测试。 3.5 软件的测试软件的测试 3.5.1 软件测试 为了尽早发现软件产品中的错误，从而达到提高软件质量、降低软件维护的费用，开 发者应在编码过程中对各个模块的程序代码进行单元测试，系统集成时进行集成测试，系 统集成完成后对整个软件进行系统测试。单元测试是在软件开发过程中针对程序模块进行 正确性检验。集成测试是在单元测试的基础上，将所有模块按照设计要求组装成系统或子 系统，对模块组装过程和模块接口进行正确性检验。软件系统测试不仅是检测软件的整体 行为表 现，从另一个侧面看，也是对软件开发设计的再确认。进行软件系统测试工作 时。测试主要包括界面测试、可用性测试、功能测试、稳定性(强度)测试、性能测试、强 壮性(恢复)测试、逻辑性测试、破坏性测试、安全性测试等。 开发者针对单元测试，集成测试，系统测试分别制定测试计划 。集成测试需要根据 需求分析报告和概要设计制作测试用例，并须经过评审。软件测试按照测试计划 、 需 求分析报告的要求进行，最后形成软件测试报告 。 3.5.2 测试计划 在软件编码开始之前，开发者应向交通局提交测试计划 ，在软件交付时，开发者应 向交通局提交软件测试报告 ，以确保开发者的软件得到了充分的测试。开发的软件必须 经过充分的测试证明其符合设计要求、运行稳定、安全可用方可交付交通局。 3.6 软件的交付准备软件的交付准备 3.6.1 交付清单 在软件测试证明软件达到要求后，软件开发者应向交通局提交开发的目标安装程序、 数据库的数据字典、 用户安装手册 、 用户使用指南 、需求报告、设计报告、测试报告 等双方合同约定的产物。 用户安装手册应详细介绍安装软件对运行环境的要求、安装软件的定义和内容、 在客户端、服务器端及中间件的具体安装步骤、安装后的系统配置。 用户使用指南应包括软件各项功能的使用流程、操作步骤、相应业务介绍、特殊 提示和注意事项等方面的内容，在需要时还应举例说明。 7 3.7 软件的鉴定验收软件的鉴定验收 3.7.1 软件的鉴定验收 在软件开发完成后，为了确保软件是按照需求分析的要求进行开发的，保证软件产品 的质量，需要对软件产品进行鉴定验收。在开发者如期交付软件后，由交通局负责确定具 体的鉴定验收日期。 3.7.2 验收人员 由交通局聘请具有一定的分析、设计、编程和软件测试经验的验收组长和其他专业人 员组成。验收组设组长一名(可设有副组长)，负责整个验收的计划、组织工作。 3.7.3 验收具体内容 验收内容应该包括：合法性检查、文档检查、软件一致性检查、软件系统测试与测试 结果评审等几项工作。 合法性检查检查软件开发工具是否合法、使用的函数库、控件、组件是否有合法的发 布许可。 文档检查检查开发者提交的文档必须齐全，质量是否过关。需要开发者提供的文档包 括： 项目实施计划； 详细技术方案； 软件需求规格说明书(STP)(含数据字典)； 概要设计说明书(PDD)； 详细设计说明书(DDD)(含数据库设计说明书)； 软件测试计划(STP)(含测试用例)； 软件测试报告(STR)； 用户手册(SUM)(含操作、使用、维护、应急处理手册)； 源程序(SCL)(不可修改的电子文档)； 项目实施计划(PIP)； 项目开发总结(PDS)； 软件质量保证计划(SQAP)； 此外，验收组可以根据需要对其它文档(如软件配置计划、项目进展报表、阶段评审报 表等)进行检查。 文档的质量根据完备性、正确性、简明性、可追踪性、自说明性、规范件等方面进行 踪合评定。 验收需要对软件代码进行检查，以确保其符合规范，并检查其一致性。 3.7.4 软件验收测试大纲 在软件进行鉴定验收前，开发者需按照一定的格式编写软件验收测试大纲 ，具体的 格式请见附录 E。 3.8 培训培训 3.8.1 系统应用培训 主要培训内容包括：系统操作使用、业务管理流程。 培训对象：应用操作人员。 8 3.8.2 系统管理的培训（可选） 主要培训内容包括：系统安装、调试、维护；系统管理。 培训对象：系统管理人员。 开发者应详细列出培训计划，包括培训内容、教材、时间和人员等。应详细列出培训计划，包括培训内容、教材、时间和人员等。 9 附录附录 A 软件需求分析报告文档模板软件需求分析报告文档模板 1. 引言引言 11 1.1 编写目的11 1.2 项目风险11 1.3 文档约定11 1.4 预期读者和阅读建议11 1.5 产品范围12 1.6 参考文献12 2. 综合描述综合描述 12 2.1 产品的状况12 2.2 产品的功能13 2.3 用户类和特性13 2.4 运行环境13 2.5 设计和实现上的限制13 2.6 假设和约束(依赖).14 3. 外部接口需求外部接口需求 14 3.1 用户界面14 3.2 硬件接口15 3.3 软件接口15 3.4 通讯接口16 4. 系统功能需求系统功能需求 16 4.1 说明和优先级16 4.2 激励响应序列17 4.3 输入输出数据17 5. 其它非功能需求其它非功能需求 17 5.1 性能需求17 5.2 安全措施需求18 5.3 安全性需求18 5.4 软件质量属性18 5.5 业务规则18 5.6 用户文档18 6. 词汇表词汇表 19 7. 数据定义数据定义 19 8. 分析模型分析模型 20 9. 待定问题列表待定问题列表 20 10 11 1. 引言引言 引言是对这份软件产品需求分析报告的概览，是为了帮助阅读者了解这份文档是如何 编写的，并且应该如何阅读、理解和解释这份文档。 1.1 编写目的编写目的 说明这份软件产品需求分析报告是为哪个软件产品编写的，开发这个软件产品意义、 作用、以及最终要达到的意图。通过这份软件产品需求分析报告详尽说明了该软件产品的 需求规格，包括修正和(或)发行版本号，从而对该软件产品进行准确的定义。 如果这份软件产品需求分析报告只与整个系统的某一部分有关系，那么只定义软件产 品需求分析报告中说明的那个部分或子系统。 1.2 项目风险项目风险 具体说明本软件开发项目的全部风险承担者，以及各自在本阶段所需要承担的主要风 险，首要风险承担者包括： 任务提出者； 软件开发者； 产品使用者。 1.3 文档约定文档约定 描述编写文档时所采用的标准(如果有标准的话)，或者各种排版约定。排版约定应该 包括： 正文风格； 提示方式； 重要符号； 也应该说明高层次需求是否可以被其所有细化的需求所继承，或者每个需求陈述是否 都有其自己的优先级。 1.4 预期读者和阅读建议预期读者和阅读建议 列举本软件产品需求分析报告所针对的各种不同的预期读者，例如，可能包括： 用户； 开发人员； 项目经理； 营销人员； 测试人员； 文档编写入员。 并且描述了文档中，其余部分的内容及其组织结构，并且针对每一类读者提出最适合 12 的文档阅读建议。 1.5 产品范围产品范围 说明该软件产品及其开发目的的简短描述，包括利益和目标。把软件产品开发与企业 目标，或者业务策略相联系。 描述产品范围时需注意，可以参考项目视图和范围文档，但是不能将其内容复制到这 里。 1.6 参考文献参考文献 列举编写软件产品需求分析报告时所用到的参考文献及资料，可能包括： 本项目的合同书； 上级机关有关本项目的批文； 本项目已经批准的计划任务书； 用户界面风格指导； 开发本项目时所要用到的标淮； 系统规格需求说明； 使用实例文档； 属于本项目的其它己发表文件； 本软件产品需求分析报告中所引用的文件、资料； 相关软件产品需求分析报告； 为了方便读者查阅，所有参考资料应该按一定顺序排列。如果可能，每份资料都应该 给出： 标题名称； 作者或者合同签约者； 文件编号或者版本号； 发表日期或者签约日期； 出版单位或者资料来源。 2. 综合描述综合描述 这一部分概述了正在定义的软件产品的作用范围以及该软件产品所运行的环境、使用 该软件产品的用户、对该软件产品己知的限制、有关该软件产品的假设和依赖。 2.1 产品的状况产品的状况 描述了在软件产品需求分析报告中所定义的软件产品的背景和起源。说明了该软件产 品是否属于下列情况： 是否是产品系列中的下一成员； 是否是成熟产品所改进的下一代产品； 是否是现有应用软件的替代品(升级产品)； 13 是否是一个新型的、自主型的产品。 如果该软件产品需求分析报告定义的软件系统是： 大系统的一个组成部分； 与其它系统和其它机构之间存在基本的相互关系。 那么必须说明软件产品需求分析报告定义的这部分软件是怎样与整个大系统相关联的， 或者（同时）说明相互关系的存在形式，并且要定义出两者之间的全部接口。 2.2 产品的功能产品的功能 因为将在需求分析报告的第 4 部分中详细描述软件产品的功能，所以在此只需要概略 地总结。仅从业务层面陈述本软件产品所应具有的主要功能，在描述功能时应该针对每一 项需求准确地描述其各项规格说明。如果存在引起误解的可能，在陈述本软件产品主要功 能的作用领域时，也需要对应陈述本软件产品的非作用领域，以利读者理解本软件产品。 为了很好地组织产品功能，使每个读者都容易理解，可以采用列表的方法给出。也可 以采用图形方式，将主要的需求分组以及它们之间的联系使用数据流程图的顶层图或类图 进行表示，这种表示方法是很有用的。 参考用户当前管理组织构架，了解各个机构的主要职能，将有助于陈述软件产品的主 要功能。 2.3 用户类和特性用户类和特性 确定有可能使用该软件产品的不同用户类，并且描述它们相关的特征。往往有一些软 件需求，只与特定的用户类有关。描述时，应该将该软件产品的重要用户类与非重要用户 类区分开。 用户不一定是软件产品的直接使用者，通过报表、应用程序接口、系统硬件接口得到 软件产品的数据和服务的人、或者机构也有他们的需求。所以，应该将这些外部需求视为 通过报表、应用程序接口、系统硬件接口附加给软件产品的附加用户类。 2.4 运行环境运行环境 描述了本软件的运行环境，一般包括： 硬件平台； 操作系统和版本； 支撑环境(例如：数据库等)和版本； 其它与该软件有关的软件组件； 与该软件共存的应用程序。 2.5 设计和实现上的限制设计和实现上的限制 确定影响开发人员自由选择的问题，并且说明这些问题为什么成为一种限制。可能的 限制包括下列内容： 必须使用的特定技术、工具、编程语言和数据库； 避免使用的特定技术、工具、编程语言和数据库； 14 要求遵循的开发规范和标准 例如，如果由客户的公司或者第三方公司负责软件维护，就必须定义转包者所使用的 设计符号表示和编码标准； 企业策略的限制； 政府法规的限制； 工业标准的限制； 硬件的限制 例如，定时需求或存储器限制； 数据转换格式标淮的限制。 2.6 假设和约束假设和约束(依赖依赖) 列举出对软件产品需求分析报告中，影响需求陈述的假设因素(与己知因素相对立)。 如果这些假设因素不正确、不一致或者被修改，就会使软件产品开发项目受到影响。这些 假设的因素可能包括： 计划使用的商业组件，或者其它软件中的某个部件； 假定产品中某个用户界面将符合一个特殊的设计约定； 有关本软件用户的若干假定(例如：假定用户会熟练使用 SQL 语言。)； 有关本软件开发工作的若干假定(例如：用户承诺的优惠、方便、上级部门给予的 特殊政策和支持等。)； 有关本软件运行环境的一些问题； 此外，确定本软件开发项目对外部约束因素所存在的依赖。有关的约束可能包括： 工期约束； 经费约束； 人员约束； 设备约束； 地理位置约束； 其它有关项目约束； 3. 外部接口需求外部接口需求 通过本节描述可以确定，保证软件产品能和外部组件正确连接的需求。关联图仅能表 示高层抽象的外部接口，必须对接口数据和外部组件进行详细描述，并且写入数据定义中。 如果产品的不同部分有不同的外部接口，那么应该把这些外部接口的全部详细需求并入到 这一部分实例中。 注意：必须将附加用户类的特征与外部接口需求加以区分，附加用户类的特征描述的 是通过接口取得软件产品的数据和服务的人的需求；而外部接口需求描述的是接口本身的 需求。 3.1 用户界面用户界面 陈述需要使用在用户界面上的软件组件，描述每一个用户界面的逻辑特征。必须注意， 15 这里需要描述的是用户界面的逻辑特征，而不是用户界面。以下是可能包括的一些特征： 将要采用的图形用户界面(GUl)标准或者产品系列的风格； 有关屏幕布局或者解决方案的限制； 将要使用在每一个屏幕(图形用户界面)上的软件组件，可能包括： 选单； 标准按钮； 导航链接； 各种功能组件； 消息栏； 快捷键； 各种显示格式的规定，可能包括： 不同情况下文字的对齐方式； 不同情况下数字的表现格式与对齐方式 日期的表现方法与格式； 计时方法与时间格式； 等等。 错误信息显示标准； 对于用户界面的细节，例如：一个特定对话框的布局，应该写入具体的用户界面设计 说明中，而不能写入软件需求规格说明中。 如果采用现成的、合适的用户界面设计规范(标准)，或者另文描述，可以在这里直接 说明，并且将其加入参考文献。 3.2 硬件接口硬件接口 描述待开发的软件产品与系统硬件接口的特征，若有多个硬件接口，则必须全都描述。 接口特征的描述内容可能包括： 支持的硬件类型； 软、硬件之间交流的数据； 控制信息的性质； 使用的通讯协议； 3.3 软件接口软件接口 描述该软件产品与其它外部组件的连接，这些外部组件必须明确它们的名称和版本号 以资识别，可能的外部组件包括： 操作系统； 数据库； 工具； 函数库； 集成的商业组件 说明：这里所说的“集成的商业组件” ，是指与系统集成的商业组件，而不是与软件产 品集成的商业组件。例如：中间件、消息服务，等等。 描述并且明确软件产品与软件组件之间交换数据或者消息的目的。描述所需要的服务， 以及与内部组件通讯的性质。确定软件产品将与组件之间共享的数据。如果必须使用一种 16 特殊的方法来实现数据共享机制，例如：在多用户系统中的一个全局数据区，那么就必须 把它定义为一种实现上的限制。 3.4 通讯接口通讯接口 描述与软件产品所使用的通讯功能相关的需求，包括： 电子邮件； WEB 浏览器； 网络通讯标准或者协议； 数据交互用电子表格； 必须定义相关的： 消息格式； 通讯安全或加密问题； 数据传输速率； 同步和异步通讯机制； 4. 系统功能需求系统功能需求 需要进行详细的需求记录，详细列出与该系统功能相关的详细功能需求，并且，唯一 地标识每一项需求。这是必须提交给用户的软件功能，使得用户可以使用所提供的功能执 行服务或者使用所指定的使用实例执行任务。描述软件产品如何响应己知的出错条件、非 法输入、非法动作。 如果每一项功能需求都能用一项，也只需要用一项测试用例就能进行验证，那么就可 以认为功能需求已经适当地进行描述了。如果某项功能需求找不到合适的测试用例，或者 必须使用多项测试用例才能验证，那么该项功能需求的描述必然存在某些问题。 功能需求是根据系统功能，即软件产品所提供的主要服务来组织的。可以通过使用实 例、运行模式、用户类、对象类或者功能等级来组织这部分内容，也可以便用这些元素的 组合。总而言之，必须选择一种是读者容易理解预期产品的组织方案。 用简短的语句说明功能的名称，例如：“4.1 系统参数管理” 。按照服务组织的顺序， 逐条阐述系统功能。无论说明的是何种功能，都应该针对该系统功能重复叙述 4.1 4.3 这 三个部分。 可以通过各种方式来组织这一部分内容，例如采用：使用实例、运行模式、用户类、 对象类、功能等级等，也可以采用它们的组合。其最终目的是，让读者容易理解即将开发 的软件产品。一般来说，每个使用实例都对应一个系统功能，因而按照使用实例来组织内 容比较容易让用户理解。 对应一些被共享的独立使用实例，可以定义一些公用系统功能。 必须特别注意的是，在 2.2 节“产品的功能”中描述的全部需求，以及它们的规格说 明；必须在某个系统功能描述中有所反映，而且不应重复。 4.1 说明和优先级说明和优先级 对该系统功能进行简短的说明，并且指出该系统功能的优先级是：高、中、还是低。 17 需要的话，还可以包括对特定优先级部分的评价，例如：利益、损失、费用和风险，其相 对优先等级可以从 1(低)到 9(高)。 4.2 激励响应序列激励响应序列 列出输入激励(用户动作、来自外部设备的信号或者其它触发)并且定义针对这功 能行为的系统响应序列，这些序列将与使用实例中相关的对话元素相对应。 描述激励响应序列时，不仅需要描述基本过程，而且应该描述可选(扩充)过程，包 括例外(引起任务不能顺序完成的情况称为例外)。疏忽了可选过程，有可能影响软件产品 的功能；如果遗漏例外过程，则有可能会引发系统崩溃。 如果采用流程图来描述激励响应序列，比较容易让用户理解。 4.3 输入输出数据输入输出数据 列出输入数据(用户输入、来自外部接口的输入或者其它输入)并且定义针对这些输入 数据的处理(计算)方法，以及相应地输出数据，描述对应区别：输入数据和输出数据。 当有大量数据需要描述时，也可以分类描述数据，并且注明各项数据的输入、输出属 性。 对于每一项数据，均需要描述： 数据名称； 实际含义； 数据类型； 数据格式； 数据约束； 对于复杂的处理方法，仅仅给出算法原理是不够的，必须描述详细的计算过程，并且 列出每一步具体使用的实际算式；如果计算过程中涉及查表、判断、迭代等处理方法，应 该给出处理依据和相关数据。如果计算方法很简单，也可以将其从略，不加描述。 5. 其它非功能需求其它非功能需求 在这里列举出所有非功能需求，主要包括可靠性、安全性、可维护性、可扩展性、可 测试性等。 5.1 性能需求性能需求 阐述不同应用领域对软件产品性能的需求，并且说明提出需求的原理或者依据，以帮 助开发人员做出合理的设计选择。尽可能详细地描述性能需求，如果需要，可以针对每个 功能需求或者特征分别陈述其性能需求。在这里确定： 相互合作的用户数量； 系统支持的并发操作数量； 响应时间； 与实时系统的时间关系： 18 容量需求 存储器； 磁盘空间； 数据库中表的最大行数。 5.2 安全措施需求安全措施需求 详尽陈述与软件产品使用过程中可能发生的损失、破坏、危害相关的需求。定义必须 采取的安全保护或动作，以及必须预防的潜在危险动作。明确软件产品必须遵从的安全标 准、策略、或规则。 5.3 安全性需求安全性需求 详尽陈述与系统安全性、完整性问题相关的需求，或者与个人隐私问题相关的需求。 这些问题将会影响到软件产品的使用，和软件产品所创建或者使用的数据的保护。定义用 户身份认证，或备授权需求。明确软件产品必须满足的安全性或者保密性策略。也可以通 过称为完整性的质量属性来阐述这些需求。一个典型的软件系统安全需求范例如下：“每 个用户在第一次登录后，必须更改他的系统预置登录密码，系统预置的登录密码不能重用。 ” 5.4 软件质量属性软件质量属性 详尽陈述对客户和开发人员至关重要的在软件产品其它方面表现出来的质量功能。这 些功能必须是确定的、定量的、在需要时是可以验证的。至少也应该指明不同属性的相对 侧重点，例如：易用性优于易学性，或者可移植性优于有效性。 5.5 业务规则业务规则 列举出有关软件产品的所有操作规则，例如：那些人在特定环境下可以进行何种操作。 这些本身不是功能需求，但是他们可以暗示某些功能需求执行这些规则。一个业务规则的 范例如下：“进行达到或者超过 10，000，00 元人民币的储蓄业务时，必须通过附加的管 理员认证。 ” 列举业务规则时，可以根据规则的数量，选取合适的编目方式。 5.6 用户文档用户文档 列举出将与软件产品一同交付的用户文档，并且明确所有己知用户文档的交付格式或 标准，例如： 安装指南 纸质文档，16 开本； 用户手册 纸质文档，16 开本； 19 在线帮助 电子文档，与软件产品一同分发、配置； 使用教程电子文档，与软件产品一同分发、配置。 6. 词汇表词汇表 列出本文件中用到的专业术语的定义，以及有关缩写的定义(如有可能，列出相关的外 文原词)。为了便于非软件专业或者非计算机专业人士阅读软件产品需求分析报告，要求使 用非软件专业或者非计算机专业的术语描述软件需求。所以这里所指的专业术语，是指业 务层面上的专业术语，而不是软件专业或者计算机专业的术语。但是，对于无法回避的软 件专业或者计算机专业术语，也应该列入词汇表并且加以准确定义。 7. 数据定义数据定义 数据定义是一个定义了应用程序中使用的所有数据元素和结构的共享文档，其中对每 个数据元素和结构都准确描述：含义、类型、数据大小、格式、计量单位、精度以及取值 范围。数据定义的维护独立于软件需求规格说明，并且在软件产品开发和维护的任何阶段， 均向风险承担者开放。 如果为软件开发项目创建一个独立的数据定义，而不是为每一项特性描述有关的数据 项，有利于避免冗余和不一致性。但是却不利于多人协同编写需求分析报告，容易遗漏数 据，也不方便阅读。因此还是建议为每个特性描述有关的数据项，汇总数据项创建数据定 义，再根据数据定义复核全部数据，使得它们的名称和含义完全一致。必须注意的是，为 了避免二义性，在汇总数据项时应该根据数据项所代表的实际意义汇总，而不是根据数据 项的名称汇总。 在数据定义中，每个数据项除了有一个中文名称外，还应该为它取一个简短的英文名 称，该英文名称应该符合命名规范，因为在软件开发时将沿用该英文名称。可以使用等号 表示数据项，名称写在左边，定义写在右边。常见数据项的描述方式如下： 原数据元素 一个原数据元素是不可分解的，可以将一个数量值赋给它。定义原数据元素必须确定 其 含义、类型、数据大小、格式、计量单位、精度以及取值范围。采用以星号为界的一 行 注释文本，描述原数据元素的定义。 选择项 选择项是一种只可以取有限离散值的特殊原数据元素，描述时一一枚举这些值，并用 方 括号括起来写在原数据元素的定义前。在两项离散值之间，使用管道符分隔。 组合项 组合项是一个数据结构或者记录，其中包含了多个数据项。这些数据项可以是原数据 元 素，也可以是组合数据项，各数据项之间用加号连接。其中每个数据项都必须是数据 20 定 义中定义过的，结构中也可以包括其它结构，但是绝对不允许递归。如果数据结构中 有 可选项，使用圆括号把该项括起来。 重复项 重复项是组合项的一种特例，其中有一项将有多个实例出现在数据结构中，使用花括 号 把该项括起来。如果知道该项可能允许的范围，就按“最小值：最大值”的形式写在 花 括号前。 8. 分析模型分析模型 这是一个可选部分，包括或涉及到相关的分析模型，例如： 数据流程图； 类图； 状态转换图； 实体-关系图。 9. 待定问题列表待定问题列表 编辑一张在软件产品需求分析报告中待确定问题时的列表，把每一个表项都编上号， 以便跟踪调查。 21 附录附录 B 软件概要设计报告文档模板软件概要设计报告文档模板 1. 引言引言 23 1.1 编写目的.23 1.2 项目风险.23 1.3 预期读者和阅读建议.23 1.4 参考资料.23 2. 设计概述设计概述 24 2.1 限制和约束.24 2.2 设计原则和设计要求.24 3. 系统逻辑设计系统逻辑设计 25 3.1 系统组织设计.25 3.2 系统结构设计.25 3.2.1 系统特性表.26 3.2.2 系统特性结构图.27 3.3 系统接口设计.27 3.3.1 系统接口表.27 3.3.2 系统接口传输协议说明.28 3.4 系统完整性设计.28 4. 系统出错处理设计系统出错处理设计 29 4.1 系统出错处理表.29 4.2 维护处理过程表.30 5. 技术设计技术设计 31 5.1 系统开发技术说明表.31 5.2 开发技术应用说明.32 6. 数据库设计数据库设计 32 7. 词汇表词汇表 32 22 8. 进度计划进度计划 32 23 24 1. 引言引言 引言是对这份软件系统概要设计报告的概览，是为了帮助阅读者了解这份文档是如何 编写的，并且应该如何阅读、理解和解释这份文档。 1.1 编写目的编写目的 说明这份软件系统概要设计报告是基于哪份软件产品需求规格说明书编写的，开发这 个软件产品意义、作用、以及最终要达到的意图。通过这份软件系统概要设计报告详尽说 明了该软件产品的软件结构，包括数据库结构和出错处理，从而对该软件产品的结构的描 述。 如果这份软件系统概要设计报告只与整个系统的某一部分有关系，那么只定义软件系 统概要设计报告中说明的那个部分或子系统。 1.2 项目风险项目风险 具体说明本软件开发项目的全部风险承担者，以及各自在本阶段所需要承担的主要风 险，首要风险承担者包括： 任务提出者； 软件开发者； 产品使用者。 1.3 预期读者和阅读建议预期读者和阅读建议 列举本软件系统概要设计报告所针对的各种不同的预期读者，例如，可能的读者包括： 用户； 开发人员； 项目经理； 营销人员； 测试人员； 文档编写人员； 等等。 描述文档中，其余部分的内容及其组织结构，并且针对每一类读者提出最适合的文档 阅读建议。 1.4 参考资料参考资料 列举编写软件产品概要设计报告时所用到的参考文献及资料，可能包括： 本项目的合同书； 上级机关有关本项目的批文； 25 本项目已经批准的计划任务书； 系统规格需求说明； 使用实例文档； 属于本项目的其它已发表文件； 本软件系统概要设计报告中所引用的文件、资料： 相关软件系统概要设计报告： 等等。 为了方便读者查阅，所有参考资料应该按一定顺排列。如果可能，每份资料都应该给 出： 标题名称； 作者或者合同签约者； 文件编号或者版本号； 发表日期或者签约日期； 出版单位或者资料来源。 2. 设计概述设计概述 本节描述现有开发条件和需要实现的目标，说明进行概要设计时应该遵循的设计原则 和必须采用的设计方法。 2.1 限制和约束限制和约束 简要描述起到限制和约束作用的各种可能存在的条件，例如： 技术条件； 资金状况； 开发环境(包括：工具和平台)； 时间限制； 等等。 并且说明在上述条件下，应该实现的系统目标， 2.2 设计原则和设计要求设计原则和设计要求 描述对本软件系统进行概要设计的原则，通常可以考虑以下几方面的内容： 命名规则； 模块独立性原则： 边界设计原则； 数据库设计规则； 必须的安全措施； 安全性和保密原则； 系统灵活性要求； 系统易操作性要求； 系统可维护性要求； 26 等等。 3. 系统逻辑设计系统逻辑设计 本节内容主要根据软件产品需求规格说明书和软件产品数据字典建立系统的逻辑模型。 此种模型暂时与系统的物理因素(例如：计算机、数据库管理系统)无关。它是系统需求与 物理实现的中间结构，它的主要结果是建立：系统结构图、系统界面结构图、系统出错处 理、以及系统开发技术说明。 说明：如果进行系统设计时尚未编写软件数据字典：应首先参照附录 B 说明，编写软 件数据字典。在完成软件数据字典后，再进行系统设计。 3.1 系统组织设计系统组织设计 系统组织设计通过系统组织表描述本系统由哪些子系统(模块)组成，这些子系统与业 务职能之间的关系，以及各个子系统的安装地点。系统组织表的格式如下： 子系统编号英文名称中文名称业务职能安装地点备注 其中： 子系统编号 给出本系统中指定子系统的顺序编号。如果本系统末划分为多个子系统，仅由 一 个运行模块组成；则本项内容仍需要描述，但是本表内容只有一行。 说明：在一个系统中有可能安装若干个相同的子系统，在这种情况下，应该视 为 一个子系统，并且对多个安装地点分别进行描述。如果相同的子系统通过系统 设 置，实现的业务职能具有明显差异时，应该采用多行进行分别描述，并且在备 注 中说明其差异所在。 子系统英文名称 给出本子系统的英文名称，该名称是在应用软件中实际使用的可执行文件名称， 必须能够说明该子系统的特点。 若本系统中只有一个子系统，则本项内容仍需要描述，但是本表内容只有一行。 子系统中文名称 给出本子系统的中文名称，该名称必须能够说明该子系统的特点。 若本系统中只有一个子系统，则本项内容仍需要描述，但是本表内容只有一行。 业务职能 描述该子系统完成的核心业务。 安装地点 27 描述该子系统实际安装的部门、或者某个具体地点。 备注 针对该子系统，需要说明的其它有关问题。 3.2 系统结构设计系统结构设计 本节将对系统特性作较为详细的描述，并给出系统特性结构图。 3.2.1 系统特性表 系统特性是系统中完成某项具体操作的基本单元，它由入口参数，出口参数以及处理 过程三部分组成。 系统特性可以具有操作界面，也可以没有操作界面；可以被其它操作界面、或者系统 特性调用，也可以调用其它操作界面、非操作界面、或者系统特性；但是不允许递归调用 (调用自己)，包括间接递归调用。 当系统由多个子系统(模块)组成时，每个子系统分别使用一张系统特性表进行描述。 系统特性表的格式如下： 子系统编号： 子系统英文名称： 子系统中文名称： 特性编号系统特征 英文名称 系统特征 中文名称 操作功能调用对象被调用 对象 备注 说明： 其中 子系统编号 含义同上。 子系统英文名称 含义同上。 子系统中文名称 含义同上。 特性编号 整个系统所有特性的统一编号。 系统特性英文名称 系统特性的英文正式名称，将来用于软件开发中，必须符合命名规范。 系统特性中文名称 系统特性的中文正式名称，来源于需求规格说明书中，系统特性一节中的有关 描 述。 操作功能 是指该特性实际完成的操作说明。 调用对象 是指调用该系统特性的系统对象，这里的系统对象可以是系统特性、也可以是 操作界面。 28 被调用对象 是指被该系统特性调用的系统对象，这里的系统对象可以是系统特性、也可以 是操作界面。 说明：某些较低层的系统特性，可能不存在被调用对象。 备注 描述与该系统特性有关的其它注意事项。 说明 描述与该系统特性表有关的其它注意事项。 3.2.2 系统特性结构图 系统特性结构图给出系统特性在逻辑层面上相互之间的关系，其主要依据来源于需求 规格说明书中，系统特性一节中的有关描述。 如果系统划分为多个子系统，应分别给出系统与子系统、以及各个子系统与系统特性 的结构图。 绘制系统与子系统结构图时，一般不需要描绘出系统特性，如果确有必要，尽可能只 画出第一层系统特性。绘制子系统与系统特性结构图时，通常也不需要描绘出第二层系统 特性，如果确有必要可以画出，但是尽可能不要画出第三层系统特性。 3.3 系统接口设计系统接口设计 系统接口是一种非可视的系统界面，在多数情况下，它对用户是透明的。 本节将对系统接口作较为详细的描述，并给出接口说明清单。 3.3.1 系统接口表 接口作为系统的一种输入输出形式，分为网络接口、数据库接口、RS-232 串行通讯 接口、IEEE485 串行总线接口、并行 I/O 接口等等多种类型。 对于一些为可视界面服务的接口，例如：打印机接口、显示器接口等，因为这类接口 对应用软件是透明的，所以不在本节描述范围内。 当系统由多个子系统(模块)组成时，每个子系统分别使用一张系统接口表进行描述。 系统接口表的格式如下： 子系统编号 子系统英文名称 子系统中文名称 接口 编号 接口 名称 接口 类型 接口 性质 接口 速率 接口 协议 备注 说明： 其中： 子系统编号 含义同上。 子系统英文名称 含义同上。 子系统中文名称 29 含义同上。 接口编号 整个系统所有接口的统一编号。 接口名称 系统接口的正式名称，必须符合通常习惯。 接口类型 指出该接口所传输的数据在该模块中起到的作用。 接口性质 指出该接口在通讯中起到的作用，这里的作用可以是： 输入； 输出； 双向。 接口速率 指出该接口的传输速率。如果该接口依赖于其它通讯方式，那么传输速率将不 高于它所依赖的其它通讯方式的速率。 接口协议 给出该接口实际使用的通讯协议。 相关对象 给出直接使用本接口的系统对象，这里的系统对象，可以是操作界面，也可以 是系统特性。 备注 描述与该系统接口有关的其它注意事项。 说明 描述与该系统接口表有关的其它注意事项。 3.3.2 系统接口传输协议说明 逐项详细描述系统接口表中所列出各个系统接口使用的传输协议，以及其它相关内容， 例如：驱动程序、动态连接库、等等。 3.4 系统完整性设计系统完整性设计 描述系统对象(数据元、数据类)，所受到的逻辑约束关系。 当系统由多个子系统(模块)组成时，每个子系统应分别使用一张系统完整性约束表进 行描述。系统完整性约束表的格式如下： 子系统编号 子系统英文名称 子系统中文名称 约束编号完整性名称相对对象名约束表达式备注 说明： 其中： 子系统编号 含义同上。 30 子系统英文名称 含义同上。 子系统中文名称 含义同上。 约束编号 整个系统所有约束的统一编号。 完整性名称 系统完整性约束的正式名称，必须符合通常习惯。 相对对象名 完整性约束中的相关对象(数据元和数据类)。 约束表达式 用一阶逻辑表达式表达的约束方程式。 备注 描述与该系统完整性约束有关的其它注意事项。 说明 描述与该系统完整性约束表有关的其它注意事项。 4. 系统出错处理设计系统出错处理设计 本节描述系统发生外界及内在错误时，所提供的错误信息及处理方法，它包括系统出 错处理表及维护处理过程表。 4.1 系统出错处理表系统出错处理表 本表给出有关出错处理的产生原因、提示信息、以及建议处理方法。 当系统由多个子系统(模块)组成时，每个子系统分别使用一张系