浅谈软件工程时代的软件文档作用

【摘要】随着计算机应用的普及，软件数量日益增加，随着软件工作环境（硬件系统或系统软件的升级换代）变化和用户对软件需求的变化，软件维护工作增加。本文为了更好的完成这些工作进行了分析，认为有必要重视软件生存周期（计划、开发、和运行三个时期）软件文档的编写。在对软件工作规范化工程化的过程中软件文档在软件生存周期中起了重要的作用。

【关键词】软件；软件开发；工程；文档；生存周期；维护

1.前言

1.1 软件开发的规范化工程化

随着计算机技术、信息技术、多媒体技术、网络技术、通信技术等的发展，各行各业的众多工作越来越依赖计算机的应用，一方面使社会对软件产品的需求量增大。另一方面计算机软件产品在投入使用过程中，软件程序在运行时发现错误要设法改正；用户有了新的需求时要对程序做相应的修改；硬件系统或系统软件（主要是操作系统）的更新修改程序发适应新的工作环境。以上种种工作都对软件开发和软件维护提出要规范化工程化工作，

1.2 规范化工程化的目标

特别是软件生产及维护进入规范化工程化的软件工程时代，任何参加这些软件工程的人员，要在工程项目的总体要求和技术规范的约束下开展工作。组织实施软件工程项目，从技术各管理上采取了措施使在软件开发达到以下主要的目标：生产成本较低、软件功能达标、软件性能较好、软件易于移植、维护费用低、按时完成开发工作。为了达到这样的目标，特别要重视文字资料工作即软件文档。

1.3 软件文档的概念

软件文档（document）也称文件，通常指的是一些记录的数据和数据媒体，它具有固定不变的形式，可被人和计算机阅读。。软件文档是与软件开发、维护和使用有关的文字材料，如技术文档、设计文档、版本说明文档等，它和计算机程序共同构成了能完成特定功能的计算机软件。

2.软件文档的作用

2.1 提高软件项目开发过程的透明度，为项目管理提供了依据

软件是一种逻辑实体，而不是物理实体，软件产品不像生产其它产品看得见，摸得着。故在软件的开发生产过程中没有明显的制造过程。我们知道，硬件产品和产品资料在整个生产过程中都是有形可见的，软件生产则有很大不同，文档本身就是软件产品。

软件文档详细记录了软件项目开发过程中发生的事件，将通常“不可见的”软件开发进程转换成“可见的”文字资料，使软件项目开发过程的能见度、透明度提高了，是项目的管理的依据。软件产品在软件开发过程中管理者需要了解开发进度、存在的问题和预期目标。每一阶段计划安排的定期报告提供了项目的可见性。定期报告还提醒各级管理者注意该部门对项目承担的责任以及该部门效率的重要性。开发文档规定若干个检查点和进度表，使管理者可以评定项目的进度，如果软件文档有遗漏，不完善，或内容陈旧，则管理者将失去跟踪和控制项目的重要依据。

2.2 跟踪软件项目开发过程，使项目质量得到保证

软件项目开发过程的每一个阶段有必须完成的文档。那些负责软件质量保证和评估系统性能的人员需要程序规格说明、测试和评估计划、测试该系统用的各种质量标准以及关于期望系统完成什么功能和系统怎样实现这些功能的清晰说明；必须制订测试计划和测试规程，并报告测试结果；他们还必须说明和评估完全、控制、计算、检验例行程序及其他控制技术。这样完成对软件项目的过程进行跟踪，满足质量保证人员和审查人员上述工作的需要。

每一个阶段结束前都要对该阶段据所完成的文档或程序进行评审或测试，以便发现问题，排除故障，及时改正错误。有了软件文档的跟踪，可及时审查软件项目，保证软件质量。

2.3 便于各人员之间的交流与合作，是各任务之间联系的凭证

软件文档在软件开发人员、软件管理人员、维护人员、用户以及计算机之间的多种桥梁作用。使系统管理员、操作员、用户、管理者和其他有关人员了解系统如何工作，以及为了达到他们的各自的目的，如何使用系统。

大多数软件开发项目通常被划分成若干个任务，并由不同的小组（下转第74页）（上接第17页）去完成。项目小组内部、项目平行开发的各小组之间进行交流与联系是通过软件文档。大多数系统开发方法为任务的联系规定了一些正式文档学科方面的专家建立项目；分析员阐述系统需求，向设计员提供正式需求规格说明；设计员制定总体设计，向程序员提供正式设计规格说明；程序员编制详细的程序代码；质量保证专家和审查员评价整个系统性能和功能的完整性；负责维护的程序员改进各种操作或增强某些功能。各种人员需要的互相联系、互相交流、互相合作是通过文档资料的复制、分发和引用而实现的。

2.4 支持软件项目使用时的维护，发挥软件的最大效率

软件文档提供系统开发的全部必要技术资料。可以帮助维护保熟悉系统，顺利完成软件的安装。在软件运行过程中出现的各种问题可及时排除，及时处理，帮助客户使用软件操作顺利地利用软件进行工作。软件运行过程找出并修正错误，改进系统以适应用户需求的变化或适应系统环境的变化，开展维护工作，延长软件的生存周期，使软件的效率发到最大化。

2.5 记录软件的历史，为今后的软件开发提供参考

软件文档作为“记录软件历史的语言”，软件文档可用作以后项目的一种资源，软件项目的一种借鉴。通常文档记载系统的开发历史，可使有关系统结构的基本思想为以后的项目利用。系统开发人员通过审阅以前的系统以查明什么部分已试验过了，什么部分运行得很好，什么部分因某种原因难以运行而被排除。系统文档有助于完成软件的移植或将软件转移到各种新的系统环境中。

软件文档中还包含着“项目开发总结报告”自我总结的部分，有的项目负责人对这些文件往往不大在意，其实在这些文件中除了有关的软件项目的数据外，对项目的过程的进行了总结，优、缺点尽在其中，学习和借鉴这些文件对今后的工程管理将会有很大的促进作用。

3.总结

在软件工程时代，正确的使用软件文档对软件产品按质按量的交付使用，对于充分发挥软件产品的效益有着重要意义，故在软件开发中要重视软件文档的编写。

参考文献

[1]辛明海，潘孝铭等.软件文档编写[M].北京：高等教育出版社，2009.

[2]郑人杰，殷人昆，陶永雷.实用软件工程[M].北京：清华大学出版社，2003.

[3]张海藩.软件工程[M].北京：人民邮电出版社，2007.