浅析文档在软件项目开发中的作用

摘要: 在软件开发的过程中,文档的作用不可小视。它们不仅能帮助开发人员了解自己的工作进度,方便自己和他人阅读和改进代码,还能够帮助项目的管理人员管理软件开发进程、提高软件开发的效率和质量、改进软件开发过程。

Abstract: Documents are useful in software development procedure. Not only can they help programmer to know about his job processing and to read and improve his code easily, but also they can help manager to control and improve software development procedure and to enhance software development productivity.

关键词: 软件工程;文档

Key words: software engineering;documents

中图分类号:TP31文献标识码:A文章编号:1006-4311(2010)26-0151-01

0引言

软件产品是包括程序、数据及其相关文档的完整集合。其中,程序是按事先设计的功能和性能要求执行的指令序列;数据是使程序能正常操纵信息的数据结构;文档是与程序开发、维护和使用有关的图文材料。由软件产品的定义可见,文档是软件产品不可或缺的组成部分。在计算机系统中,软件是与硬件相互依存的部分,它与硬件合为一体完成系统功能。

1软件生存周期中的文档

一个软件从定义到开发、使用和维护,直到最终被放弃所经历的漫长时期,被称为生存周期。软件开发模型是跨越整个软件生存周期的系统开发、运作、维护所实施的全部工作和任务的结构框架,能够反映软件生存周期内各种工作应如何组织及软件生存周期各个阶段如何衔接。常用的软件开发模型有:瀑布模型、螺旋模型、原型模型、第四代技术模型等。

通常,在制定软件开发计划时,就要选定软件开发的模型来描述软件的生存周期,将生存周期进行阶段划分,各阶段依次进行。前一个阶段任务的完成是后一个阶段任务开始的前提和基础,后一个阶段的工作通常是前一个阶段提出方案的具体化。表1描述了软件开发的不同阶段及各阶段需要提交的文档资料。

2文档的重要作用

2.1 软件产品的组成部分从软件的定义可以看出,文档和代码、数据一起构成了软件产品。文档记录了软件产品定义、分析、设计、实现、安装维护等各个阶段的信息处理过程。描述清楚、完备的文档便于客户了解软件的功能、性能等各项指标,为客户选购符合自己需要的软件提供依据,是用户选择和使用产品的有效工具。

2.2 交流的工具文档是一种无声的语言,它记录了软件项目开发过程中有关软件开发、运行、维护和培训等方面的信息,这些信息有利于管理人员、开发人员、操作人员、用户之间的交流和合作,便于软件项目能在规定的时间、费用内完成开发和投产应用。例如,“需求定义和分析”的阶段总是被软件开发人员视为整个软件生命周期中最困难的环节。

2.3 里程碑的构件之一为了保证软件项目如期保质的顺利完成,通常,项目经理会在开发过程中设置一些里程碑。通过监督每一个里程碑是否顺利完成,来确知软件开发的进度。在里程碑处,开发人员不仅要提供相关模块的代码,还要提供相关的文档以供评审。只有通过评审的代码和文档才能作为基线,存入配置库中。也只有按照软件开发计划,提交了该里程碑处需要提供的所有相关资料,才能够说这个里程碑顺利完成。故文档是里程碑的构件之一。

2.4 开发与管理的依据文档在软件项目的开发过程中起到了关键的作用,文档作为一种日常交流的重要依据和工作成果的总结显得尤为重要,从某种意义上来说,文档是软件项目开发规范的体现和指南。按照规范要求编制一整套文档的过程,就是按照开发规范完成一个软件项目开发的过程。

2.5 评审的内容软件项目开发各阶段完成后,各单位组织人员对软件产品进行阶段评审。本阶段的产品包括文档、程序、数据以及调试记录。文档参与到软件开发过程中评审的各个阶段。在软件需求评审中,需评审的文档有:软件需求规格说明、接口需求规格说明、软件质量保证计划、软件配置管理计划;评审依据的文档有:系统分析和软件定义、软件项目任务书、软件项目开发计划。在概要设计评审的阶段,需评审的文档有:软件概要设计说明、接口概要设计说明;评审依据是:软件需求规格说明书、接口需求规格说明书。在详细设计阶段,需评审的文档有:详细设计说明书、接口详细设计说明书;评审的依据是:软件概要设计说明、软件需求规格说明。在软件验证与确认评审的阶段,需评审的内容有:软件验证和确认计划、功能、软件文档及程序文本;评审的依据有:软件设计说明、需求说明、测试报告和各阶段的文档。故,文档是评审的重要内容。

3结论

软件开发人员在各个阶段中以文档作为前阶段工作成果的体现和后阶段工作的依据,这些文档(计划和报告)提供给管理人员,以获得到必要的支持。管理人员可通过这些文档了解软件开发项目安排、进度、资源使用和成果等。软件开发人员需为用户了解软件的使用、操作和维护提供详细的资料。文档的重要性体现在软件生命周期的各个阶段,在软件开发过程中占有很大的工作量。高效率、高质量地开发、分发、管理和维护文档是搞笑保质完成软件项目的必要条件。

参考文献:

[1]陈明.软件工程学教程[M].北京:科学出版社,2002,(7).

[2]张海藩.软件工程[M].北京:清华大学出版社,2009,(7).

[3]杨一平.软件能力成熟度模型CMM方法及其应用[M].北京:人民邮电出版社,2001,(4).