软件开发文档模板.docx

1、软件开发文档模板软件开发文档模板软件开发文档模板附录A 软件需求分析报告文档模板附录B软件概要设计报告文档模板附录C软件详细设计报告文档模板附录D软件数据库设计报告文档模板附录E 软件测试（验收）大纲1.范围 62.总体要求 62.1总体功能要求 62.2软件开发平台要求 62.3软件项目的开发实施过程管理要求72.3.1软件项目实施过程总体要求 72.3.2软件项目实施变更要求 72.3.3软件项目实施里程碑控制 83.软件开发 83.1软件的需求分析 83.1.1需求分析 83.1.2需求分析报告的编制者 93.1.3需求报告评审 93.1.4需求报告格式 93.2软件的概要设计 93.2

2、.1概要设计 93.2.2编写概要设计的要求 93.2.3概要设计报告的编写者 103.2.4概要设计和需求分析、详细设计之间的关系和区别 103.2.5概要设计的评审 10326概要设计格式 103.3软件的详细设计 103.3.1详细设计 103.3.2 特例 103.3.3详细设计的要求 103.3.4数据库设计 113.3.5详细设计的评审 113.3.6详细设计格式 113.4软件的编码 113.4.1软件编码 113.4.2软件编码的要求 113.4.3编码的评审 113.4.4编程规范及要求 113.5软件的测试 113.5.1软件测试 123.5.2测试计划 123.6软件的交

3、付准备 123.6.1交付清单 123.7软件的鉴定验收 123.7.1软件的鉴定验收 123.7.2验收人员 123.7.3验收具体内容 133.7.4软件验收测试大纲 133.8培训 1 33.8.1系统应用培训 133.8.2系统管理的培训（可选） 131.范围本指南用于指导软件开发者为南京市交通局开发软件项目的过程，通过规范软 件项目承担单位的开发过程达到提高软件质量，降低维护成本的目的。开发者 应根据本指南进行软件开发和编制软件开发文档。本指南是对软件项目承担单 位的基本要求。在本指南的附录A至E中提供了文档的编写模板供开发者参考, 在进行具体软件开发时，开发者可根据实际情况采编写，

4、但必须提供双方约定 的文档，文档中约定的内容必须描述清楚。2.总体要求2.1总体功能要求网络应用环境以Internet/lntranet 技术为核心。开发者应在充分分析需求的基础上，选择采用 B/S结构或者C/S结构。软件系统的数据库应依照南京市交通局信息化数据库建设规范进行设计和 建设。本指南中没有规定开发者采用何种具体的软件工程开发方法，开发者可根据项 目具体特点、自身擅长来选择采用面向过程的方法、面向对象的方法或面向数 据的方法，但建议开发 商使用面向对象软件工程的方法，如：采用目前被广泛使用的RUP(Rational Unified Process)方法来进行分析、设计和开发。2.2软

5、件开发平台要求开发者开发的软件必须能够在南京市交通局规定的软件平台上正常运行。目前 软件平台为：数据库管理系统：Oracle 9i以上版本中间件(应用服务器)系统：IBM WebSphereOA系统：Lotus Domino /Notes网络架构：完全支持TCP/IP协议开发工具或技术体系：为保证软件的上下兼容性，开发者应选择比较通用的开发工具的较新版本进 行开发，如 Microsoft Visual Studio.Net ，Borland Delphi，C+ Builder,或 J2EE（Java2 P1atform En terprise Editio n） 等。2.3软件项目的开发实施过

6、程管理要求2.3.1软件项目实施过程总体要求（一） 开发者提交软件开发工作大纲，交通局组织专家组对工作大纲进行 评审，并提出整改意见。J（二） 通过评审后，开发者根据整改意见完善工作大纲，经过交通局认可后组织项目组进行软件开发。软件开发工作按照需求分析、概要设计、详 亍细设计、编码、测试等几个阶段进行，在开发过程中，开发者需分阶段提 交相关文档。（三） 在软件开发工作完成后，开发者应向交通局提交完整的软件文档， 交通局组织验收组对软件进行验收审查。2.3.2软件项目实施变更要求在开发过程中，需求或设计不可避免地需要发生变更，相关变更必须经过交通 局书面同 意方可进行。在需求或设计发生变更时，需

7、要对原有文档进行修改， 并提供完整的变更记录， 以使变更处于可控制的状态。变更单如下表所示：表2-1变更单需求变更申请申请变更的需求文档输入名称，版本，日期等信息变更的内客及其理由评估需求变更将对 项目造成的影响申请人签字变更申请的审批意见项目经理签字审批意见：签字日期客户签字 （合同项目）审批意见：签字日期更改需求文档变更后的 需求文档输入名称，版本，完成日期等信息更改人签字重新评审需求文档需求评审小组签字评审意见：1 签字日期变更结束项目经理签字签字日期233软件项目实施里程碑控制交通局将分四个阶段进行把关，召开专家审查会。（一） 需求分析（结合原型进行审查）确认；（二） 概要设计+数据库

8、设计；（三） 预验收（试运行后）；（四） 正式验收（推广使用后）。3.软件开发合同签订以后，项目承担单位即可组织项目组进行软件开发工作。软件开发必 须严格按照软件工程的要求进行。开发过程包括开发者的活动和任务。此过程 由软件需求分析、概要设计、详细设计、编码、测试、验收、鉴定等活动组成。3.1软件的需求分析3.1.1需求分析首先，开发者和交通局应共同对交通局的应用需求作充分的调研，提交完整的 需求分析 报告。在需求分析报告中必须描述的基本问题是：功能、性能、强加 于实现的设计限制、属 性、外部接口。应当避免把设计或项目需求写入需求分 析报告中。它必须说明由软件获得的 结果，而不是获得这些结果的

9、手段。2 软件需求可以用若干种方法来表达，如通过输入、输出说明；使用代表性的例 子；用规范化的模型。开发者应尽可能地使用模型的方式，因为这是表达复杂 需求的精确和有效的方法。比如用统一建模语言（UML）来描述需求。 编写需求分析报告的要求a 无歧义性对最终产品的每一个特性用某一术语描述；若某一术语在某一特殊的行文中使 用时具有多种含义，那么应对该术语的每种含义做出解释并指出其适用场合。 b .完整性需求分析报告应该包括全部有意义的需求，无论是关系到功能的、性能的、设 计约束的、还是关系到外部接口方面的需求；对所有可能出现的输入数据的响 应予以定义，要对合法和非合法的输入值的响应做出规定；填写全

10、部插图、表、 图示标记等；定义全部术语和度量单位。Jc可验证性 需求分析报告描述的每一个需求应是可以验证的。可以通过一个有限处理过程 来检查软件产品是否满足需求。d 一致性在需求分析报告中的各个需求的描述不能互相矛盾。e可修改性需求分析报告应具有一个有条不紊、易于使用的内容组织；没有冗余，即同一 需求不能在需求分析报告中出现多次。f 可追踪性每一个需求的源流必须清晰，在进一步产生和改变文件编制时，可以方便地引 证每一个需求。g.运行和维护阶段的可使用性需求分析报告必须满足运行和维护阶段的需要。在需求分析报告要写明功能的 来源和目的。J3.1.2需求分析报告的编制者需求分析报告应由交通局和开发者

11、双方共同完成。其中：交通局负责根据实际 需要提出希望软件实现的功能；软件开发者根据交通局提出的性能需求，结合 软件开发编写需求分析。3.1.3需求报告评审在软件需求分析工作完成后，软件开发者应向交通局提交软件需求分析报告 交通局组织有关人员对需求进行评审，以决定软件需求是否完善和恰当。评审 完成后，就可以进入软件的设计阶段。3.1.4需求报告格式软件需求分析报告需按一定的格式进行编写，具体的软件需求分析报告 文档编写模板请见附录 A。3.2软件的概要设计3.2.1概要设计在交通局和开发者双方认可的需求分析报告基础上，开发者进行下一一步 的工作。 首先，开发者需要对软件系统进行概要设计，即系统设

12、计。概要设计需要对软件系统的设计 进行考虑，包括系统的基本处理流程、系统的组织结构、模块划分、功能分配、接口设计、 运行设计、数据结构设计和出错处理设计等，为软件的详细设计提供基础。3.2.2编写概要设计的要求a致性概要设计的要求应该与需求分析报告所描述的需求一致。同时，概要设计的各 项要求之间也应该一致。b 合理性概要设计所提出的设计方法和标准应该是合理的、恰当的。c可追踪性对概要设计所提出的各项要求应该可以得到它的清晰的源流，即在需求分析报 告客户有明确的需求描述。d 可行性根据概要设计进行详细设计、操作和维护应该是可行的。323概要设计报告的编写者概要设计报告由开发者根据需求分析报告的要

13、求进行编写。 324概要设计和需求分析、详细设计之间的关系和区别需求分析不涉及具体的技术实现，而概要设计注重于从宏观上和框架上来描述 采用何种技术手段、方法来实现这些需求。详细设计相对概要设计更注重于微 观上和框架内的设计， 是编码的依据。概要设计是指导详细设计的依据。325概要设计的评审在软件概要设计工作完成后，软件开发者应向交通提交软件系统概要设计报 告。在交通局对概要设计报告评审通过后，即可进入详细设计阶段。 326概要设计格式软件系统概要设计报告需按一定的格式进行编写，具体的软件系统概要 设计报告文档编写模板请见附录B。3.3软件的详细设计3.3.1详细设计在概要设计的基础上，开发者需

14、要进行软件系统的详细设计。在详细设计中， 描述实 现具体模块所涉及到的主要算法、数据结构、类的层次结构及调用关 系，需要说明软件系统各个层次中的每一个程序 （每个模块或子程序）的设计考 虑，以便进行编码和测试。应当保证 软件的需求完全分配给整个软件。详细设计应当足够详细，能够根据详细设计报告进行编码。n3.3.2特例如果软件系统比较简单，层次较少，可以不必进行专门的详细设计，而和概要设计结合起来。3.3.3详细设计的要求a致性详细设计的要求应该与需求分析报告所描述的需求、与概要设计一致。同时，详细设计的各项要求之间也应该是一致的。b 合理性详细设计所提出的设计方法和标准应该是合理的、恰当的。c

15、可追踪性对详细设计所提出的各项要求应该可以得到它的清晰的源流，即可在需求分析 报告、概要设计报告中有明确的需求描述。d 可行性根据详细设计进行编码、测试、操作和维护应该是可行的。334数据库设计如果软件产品需要使用到数据库，软件的详细设计应包括对数据库的设计。数 据库设计应在软件的需求分析、概要设计完成之后、详细设计的其它工作之前 进行。在进行数据库设计时，应当按照交通局制定的南京市交通局信息化数 据库建设规范要求进行。3.3.5详细设计的评审在软件详细设计完成后，软件开发者应向交通局提交软件系统数据库设计报 告和软件系统详细设计报告。在交通局对软件系统数据库设计报告、软件系统详细设计报告评审

16、通过后，即可进入软件编码阶段。3.3.6详细设计格式软件系统详细设计报告、软件系统数据库设计报告需按一定的格式进 行编写， 具体的软件系统详细设计报告文档编写模板和软件系统数据 库设计报告文档编写模 板请见附录C、附录D。3.4软件的编码3.4.1软件编码在软件编码阶段，开发者根据软件系统详细设计报告中对数据结构、算法 分析和模块实现等方面的设计要求，开始具体的编写程序工作，分别实现各模 块的功能，从而实现对目标系统的功能、性能、接口、界面等方面的要求。3.4.2软件编码的要求a.模块化编码b .代码可读性c 可维护性d .模块接口标准化e.界面风格统一e.注释的应用3.4.3编码的评审为了尽

17、早发现软件中的障碍，提高软件产品的质量，开发者在编码的过程中应 该强调代码评审工作。将代码评审报告作为文档的一部分，提交给交通局。3.4.4编程规范及要求为了提高编程实现的质量，软件的程序设计必须遵照国家颁布的相关编程规范。 主要内容包括：规范化的程序内部文档、数据结构的详细说明、清晰的语句结 构、编码规范。编码规范的内容包括命名规范、界面规范、提示及帮助信息规 范、热键定义等。其中数据库部分应遵守南京市交通局信息化数据库建设规范的要求。在软件编码的同时应进行单元测试。3.5软件的测试3.5.1软件测试为了尽早发现软件产品中的错误，从而达到提高软件质量、降低软件维护的费 用，开发者应在编码过程

18、中对各个模块的程序代码进行单元测试，系统集成时 进行集成测试，系统集成完成后对整个软件进行系统测试。单元测试是在软件 开发过程中针对程序模块进行正确性检验。集成测试是在单元测试的基础上， 将所有模块按照设计要求组装成系统或子系统，对模块组装过程和模块接口进n 行正确性检验。软件系统测试不仅是检测软件的整体行为表 现，从另一个侧j面看，也是对软件开发设计的再确认。进行软件系统测试工作时。测试主要包j 括界面测试、可用性测试、功能测试、稳定性（强度）测试、性能测试、强壮性（恢 复）测试、逻辑性测试、破坏性测试、安全性测试等。开发者针对单元测试，集成测试，系统测试分别制定测试计划。集成测试 需要根据

19、需求分析报告和概要设计制作测试用例，并须经过评审。软件测试按n 照测试计划、需求分析报告的要求进行，最后形成软件测试报告。3.5.2测试计划在软件编码开始之前，开发者应向交通局提交测试计划，在软件交付时， |开发者应向交通局提交软件测试报告，以确保开发者的软件得到了充分的 J 测试。开发的软件必须经过充分的测试证明其符合设计要求、运行稳定、安全 1 可用方可交付交通局。3.6软件的交付准备3.6.1交付清单在软件测试证明软件达到要求后，软件开发者应向交通局提交开发的目标安装 J 程序、数据库的数据字典、用户安装手册、用户使用指南、需求报告、 设计报告、测试报告等双方合同约定的产物。用户安装手册

20、应详细介绍安装软件对运行环境的要求、安装软件的定义和 J 内容、在客户端、服务器端及中间件的具体安装步骤、安装后的系统配置。用户使用指南应包括软件各项功能的使用流程、操作步骤、相应业务介绍、 特殊提示和注意事项等方面的内容，在需要时还应举例说明。3.7软件的鉴定验收3.7.1软件的鉴定验收在软件开发完成后，为了确保软件是按照需求分析的要求进行开发的，保证软 件产品的质量，需要对软件产品进行鉴定验收。在开发者如期交付软件后，由 交通局负责确定具体的鉴定验收日期。3.7.2验收人员 由交通局聘请具有一定的分析、设计、编程和软件测试经验的验收组长和其他 专业人员组成。验收组设组长一名（可设有副组长）

21、，负责整个验收的计划、组织 工作。3.7.3验收具体内容 验收内容应该包括：合法性检查、文档检查、软件一致性检查、软件系统测试 与测试结果评审等几项工作。合法性检查检查软件开发工具是否合法、使用的函数库、控件、组件是否有合 法的发布许可。文档检查检查开发者提交的文档必须齐全，质量是否过关。需要开发者提供的 文档包括：项目实施计划；详细技术方案；软件需求规格说明书（STP）（含数据字典）；概要设计说明书（PDD）；详细设计说明书（DDD）（含数据库设计说明书）；软件测试计划（STP）（含测试用例）；软件测试报告（STR）；用户手册（SUM）（含操作、使用、维护、应急处理手册）；源程序（SCL）（

22、不可修改的电子文档）；项目实施计划（PIP）订项目开发总结（PDS）；软件质量保证计划（SQAP）；此外，验收组可以根据需要对其它文档（如软件配置计划、项目进展报表、阶段 评审报表等）进行检查。文档的质量根据完备性、正确性、简明性、可追踪性、自说明性、规范件等方 面进行踪合评定。验收需要对软件代码进行检查，以确保其符合规范，并检查其一致性。3.7.4软件验收测试大纲在软件进行鉴定验收前，开发者需按照一定的格式编写软件验收测试大纲， 具体的格式请见附录E。3.8培训3.8.1系统应用培训主要培训内容包括：系统操作使用、业务管理流程。培训对象：应用操作人员。3.8.2系统管理的培训（可选） 主要培训内容包括：系统安装、调试、维护；系统管理。培训对象：系统管理人员。开发者应详细列出培训计划，包括培训内容、教材、时间和人员等。