I 软件开发文档模版新版软件开发文档模版新版 2018 目录目录 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 数据库设计 如果软件产品需要使用到数据库，软件的详细设计应包括对数据库的设计。数据库设 计应在软件的需求分析、概要设计完成之后、详细设计的其它工作之前进行。在进行数据 库设计时，应当按照交通局制定的南京市交通局信息化数据库建设规范要求进行。