软件开发文档模板

《软件开发文档模板》由会员分享，可在线阅读，更多相关《软件开发文档模板（17页珍藏版）》请在装配图网上搜索。

1、软件开发文档模板附录A软件需求分析报告文档模板附录B软件概要设计报告文档模板附录C软件详细设计报告文档模板附录D软件数据库设计报告文档模板附录E软件测试（验收）大纲目录1. 围42. 总体要求42.1总体功能要求42.2软件开发平台要求42.3软件项目的开发实施过程管理要求 5软件项目实施过程总体要求 5软件项目实施变更要求 6软件项目实施里程碑控制 73. 软件开发73.1软件的需求分析8需求分析8需求分析报告的编制者 9需求报告评审 9需求报告格式 103.2软件的概要设计 10概要设计10编写概要设计的要求 10概要设计报告的编写者 11概要设计和需求分析、详细设计之间的关系和区别 11

2、概要设计的评审 11概要设计格式113.3软件的详细设计 11详细设计113.3.2 特例11详细设计的要求 12数据库设计 12详细设计的评审 12详细设计格式 133.4软件的编码 13软件编码 13软件编码的要求 13编码的评审 13编程规及要求 133.5软件的测试 14软件测试 14测试计划 143.6软件的交付准备 15交付清单 153.7软件的鉴定验收 15软件的鉴定验收 15验收人员 15验收具体容 16软件验收测试大纲 173.8培训 17系统应用培训 17系统管理的培训（可选） 171. 围本指南用于指导软件开发者为市交通局开发软件项目的过程，通过规软件项目承担单位的开发过

3、程达到提高软件质量，降低维护成本的目的。开发者应根据本指南进行软件开发和编制软件开发文档。本指南是对软件项目承担单位的基本要 求。在本指南的附录A至E中提供了文档的编写模板供开发者参考，在进行具 体软件开发时，开发者可根据实际情况采编写，但必须提供双约定的文档，文档 中约定的容必须描述清楚。2. 总体要求2.1总体功能要求网络应用环境以Internet/lntranet技术为核心。开发者应在充分分析需求的基础上，选择采用B/S结构或者C/S结构。软件系统的数据库应依照市交通局信息化数据库建设规进行设计和建设。本指南中没有规定开发者采用种具体的软件工程开发法， 开发者可根据项目具体 特点、自身擅

4、长来选择采用面向过程的法、 面向对象的法或面向数据的法，但建 议开发 商使用面向对象软件工程的法，如：采用目前被广泛使用的RUP(Rational Unified Process)法来进行分析、设计和开发。2.2软件开发平台要求开发者开发的软件必须能够在市交通局规定的软件平台上正常运行。目前软件平台为：数据库管理系统：Oracle 9i以上版本中间件（应用服务器）系统：IBM WebSphereOA系统：Lotus Domino /Notes网络架构：完全支持TCP/IP协议开发工具或技术体系：为保证软件的上下兼容性，开发者应选择比较通用的开发工具的较新版本进行开发，如 Microsoft V

5、isual Studio.Net ，Borland Delphi ，C+ Builder,或J2EE（Java2 P1atform Enterprise Edition）等。2.3软件项目的开发实施过程管理要求软件项目实施过程总体要求（一）开发者提交软件开发工作大纲，交通局组织专家组对工作大纲进行 评审，并提出整改意见。（二）通过评审后，开发者根据整改意见完善工作大纲，经过交通局认可后组织项目组进行软件开发。软件开发工作按照需求分析、概要设计、详细设计、编码、测试等几个阶段进行，在开发过程中，开发者需分阶段提 交相关文档。（三）在软件开发工作完成后，开发者应向交通局提交完整的软件文档， 交通局

6、组织验收组对软件进行验收审查。232软件项目实施变更要求在开发过程中，需求或设计不可避免地需要发生变更，相关变更必须经过交通局 书面同意可进行。在需求或设计发生变更时，需要对原有文档进行修改，并提 供完整的变更记录， 以使变更处于可控制的状态。变更单如下表所示：表2-1变更单需求变更申请申请变更的需求文档输入名称，版本，日期等信息变更的客及其理由评估需求变更将对项目造成的影响申请人签字变更申请的审批意见项目经理签字审批意见：签字日期客户签字（合同项目）审批意见：签字日期更改需求文档变更后的需求文档输入名称，版本，完成日期等信息更改人签字重新评审需求文档需求评审小组签字评审意见：签字日期变更结束

7、项目经理签字签字日期233软件项目实施里程碑控制交通局将分四个阶段进行把关，召开专家审查会。（一）需求分析（结合原型进行审查）确认;（二）概要设计+数据库设计；（三）预验收（试运行后）；（四）正式验收（推广使用后）。3. 软件开发合同签订以后，项目承担单位即可组织项目组进行软件开发工作。软件开发必须 格按照软件工程的要求进行。开发过程包括开发者的活动和任务。此过程由软件需求分析、概要设计、详细设计、编码、测试、验收、鉴定等活动组成。3.1软件的需求分析需求分析首先，开发者和交通局应共同对交通局的应用需求作充分的调研，提交完整的需求分析 报告。在需求分析报告中必须描述的基本问题是：功能、性能、强

8、加于 实现的设计限制、属 性、外部接口。应当避免把设计或项目需求写入需求分析 报告中。它必须说明由软件获得的 结果，而不是获得这些结果的手段。软件需求可以用若干种法来表达，如通过输入、输出说明；使用代表性的例子； 用规化的模型。开发者应尽可能地使用模型的式，因为这是表达复杂需求的精确 和有效的法。比如用统一建模语言（UML ）来描述需求。编写需求分析报告的要求a 无歧义性对最终产品的每一个特性用某一术语描述；若某一术语在某一特殊的行文中使用时具有多种含义，那么应对该术语的每种含义做出解释并指出其适用场合。b .完整性需求分析报告应该包括全部有意义的需求， 无论是关系到功能的、性能的、设计 约束

9、的、还是关系到外部接口面的需求；对所有可能出现的输入数据的响应予以 定义，要对合法和非合法的输入值的响应做出规定；填写全部插图、表、图示标 记等；定义全部术语和度量单位。C 可验证性需求分析报告描述的每一个需求应是可以验证的。可以通过一个有限处理过程来检查软件产品是否满足需求。d 一致性在需求分析报告中的各个需求的描述不能互相矛盾。e 可修改性需求分析报告应具有一个有条不紊、 易于使用的容组织；没有冗余，即同一需求 不能在需求分析报告中出现多次。f 可追踪性每一个需求的源流必须清晰，在进一步产生和改变文件编制时，可以便地引证每 一个需求。g.运行和维护阶段的可使用性需求分析报告必须满足运行和维

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

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

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

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

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

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

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

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

18、编码开始之前，开发者应向交通局提交测试计划，在软件交付时，开 发者应向交通局提交软件测试报告，以确保开发者的软件得到了充分的测试。开发的软件必须经过充分的测试证明其符合设计要求、运行稳定、安全可用可交 付交通局。3.6软件的交付准备361交付清单在软件测试证明软件达到要求后，软件开发者应向交通局提交开发的目标安装程 序、数据库的数据字典、用户安装手册、用户使用指南、需求报告、设 计报告、测试报告等双合同约定的产物。用户安装手册应详细介绍安装软件对运行环境的要求、安装软件的定义和容、 在客户端、服务器端及中间件的具体安装步骤、安装后的系统配置。用户使用指南应包括软件各项功能的使用流程、操作步骤、

19、相应业务介绍、特殊提示和注意事项等面的容，在需要时还应举例说明。3.7软件的鉴定验收软件的鉴定验收在软件开发完成后，为了确保软件是按照需求分析的要求进行开发的， 保证软件 产品的质量，需要对软件产品进行鉴定验收。在开发者如期交付软件后，由交通 局负责确定具体的鉴定验收日期。验收人员由交通局聘请具有一定的分析、设计、编程和软件测试经验的验收组长和其他专 业人员组成。验收组设组长一名（可设有副组长），负责整个验收的计划、组织工 作。验收具体容验收容应该包括：合法性检查、文档检查、软件一致性检查、软件系统测试与测 试结果评审等几项工作。合法性检查检查软件开发工具是否合法、使用的函数库、控件、组件是否

20、有合法 的发布可。文档检查检查开发者提交的文档必须齐全，质量是否过关。需要开发者提供的文 档包括：项目实施计划；详细技术案；软件需求规格说明书（STP）（含数据字典）；概要设计说明书（PDD）；详细设计说明书（DDD）（含数据库设计说明书）；软件测试计划（STP）（含测试用例）；软件测试报告（STR）;用户手册（SUM）（含操作、使用、维护、应急处理手册）；源程序（SCL）（不可修改的电子文档）；项目实施计划（PIP）；项目开发总结（PDS）;软件质量保证计划（SQAP）；此外，验收组可以根据需要对其它文档（如软件配置计划、项目进展报表、阶段 评审报表等）进行检查。文档的质量根据完备性、正确性、简明性、可追踪性、自说明性、规件等面进行 踪合评定。验收需要对软件代码进行检查，以确保其符合规，并检查其一致性。软件验收测试大纲在软件进行鉴定验收前，开发者需按照一定的格式编写软件验收测试大纲， 具体的格式请见附录E。3.8培训系统应用培训主要培训容包括：系统操作使用、业务管理流程。培训对象：应用操作人员。系统管理的培训（可选）主要培训容包括：系统安装、调试、维护；系统管理。培训对象：系统管理人员。开发者应详细列出培训计划，包括培训容、教材、时间和人员等。