软件文档管理存在的问题及对策.pdfVIP

软件文档管理存在的问题及对策

摘要：软件文档是指某种媒体和其中所记录的数据，具有永久性，并可由人

或机器阅读，仅用于人工可读的内容。在软件工程中，文档常用来表示对活动、

需求、过程或结果进行描述、定义、规定、报告、认证的任何书面或图示的信息。

软件文档是软件产品必不可少的组成部分，高质量、高效率地管理和维护软件文

档，对于转让、变更、修正、扩充和使用软件及充分发挥软件产品的效益有着重

要的意义。

关键词：软件文档；问题；对策

1软件文档的作用

1.1管理依据。在软件开发过程中，管理者必须了解开发进度、存在的问题

和预期目标。每一阶段计划安排的定期报告提供了项目的可见性，定期报告还提

醒各级管理者注意该部门对项目承担的责任及该部门效率的重要性。开发文档规

定若干个检查点和进度表，使管理者可评定项目的进度。如果开发文档有遗漏、

不完善或内容陈旧，管理者将失去跟踪和控制项目的重要依据。

1.2任务之间联系的凭证。大多数软件开发项目通常被划分成若干任务，由

不同的小组去完成，学科方面的专家建立项目，分析员阐述系统需求，设计员为

程序员制定总体设计，程序员编制详细的程序代码，质量保证专家和审查员评价

整个系统性能和功能的完整性，负责维护的程序员改进各种操作或增强某些功

能。这些人员需要的互相联系是通过文档资料的复制、分发和引用而实现的，因

而任务之间的联系是文档的一个重要功能。大多数系统开发方法为任务的联系规

定了一些正式文档。分析员向设计员提供正式需求规格说明，设计员向程序员提

供正式设计规格说明等等。

1.3质量保证。对于负责软件质量保证和评估系统性能的人员需要程序规格

说明、测试和评估计划、测试该系统用的各种质量标准以及关于期望系统完成什

么功能和系统怎样实现这些功能的清晰说明；必须制订测试计划和测试规程，并

报告测试结果；还必须说明和评估完全、控制、计算、检验例行程序及其他控制

技术。这些文档的提供可满足质量保证人员和审查人员上述工作的需要。

1.4培训与参考。软件文档的另一个功能是使系统管理员、操作员、用户、

管理者和其他有关人员了解系统如何工作，以及为了达到各自的目的，如何使用

系统。

1.5维护支持。维护人员需要软件系统的详细说明书以帮助熟悉系统，尽可

能找出并修正错误、改进系统，以适应用户需求的变化或适应系统环境的变化。

1.6历史档案。软件文档可用作未来项目的一种资源。通常文档记载系统的

开发历史，可使有关系统结构的基本思想为以后的项目所利用。系统开发人员通

过审阅以前的系统以查明什么部分已试验过，什么部分运行的很好，什么部分因

某种原因难以运行而被排除。良好的系统文档有助于把程序移植到新的系统环境

中。

2软件文档管理中存在的问题

信息系统文档是企业重要的智力资产，它凝聚着信息项目建设中所有参与人

员的智慧和汗水。这些软件文档一般以电子文档的形式存在，从内容上看，主要

包括企业信息化规划、项目开发计划、需求规格说明书、设计规格说明书、程序

清单、测试报告、系统维护手册、用户手册、系统变更报告、项目总结报告、会

议记录以及经验心得报告等文档资料。近年来，信息化建设在资源整合的过程中，

不断地实现了信息数据和应用系统的向上集中。但由于从事信息化工作的人员相

对较少，且主要集中在系统建设、平台整合以及系统运维等工作上，在信息系统

软件文档的管理存在不足。主要体现在以下几个方面：

2.1文档管理制度不健全

在信息化高速发展的今天，制度建设依旧是一块短板，而软件文档作为软件

的灵魂，也没能从制度层面加以保证和有效管理。软件文档的创建、保存以及利

用也无法从根本上加以规范，从而造成文档查找缓慢、效率低下，文档安全缺乏

保障，文档无法有效协作共享，知识管理效果不明显。

2.2文档管理意识不深入

在多数在用的应用软件中，很少能见到带有“在线帮助”功能的软件，产生这

个问题主要是在软件系统规划和设计过程中就没有考虑到这项功能的存在。在日

常的软件维护工作中，常常发现使用人员由于操作不熟练，为一个简单的操作或

流程束手无策而转向寻找供应商支持。软件供应商往往是极其被动地为用户提供

相关软件文档，多数软件企业对文档重要性认识不够，对文档管理缺少规划和管

理的问题仍然存在。

2.3文档内容不够规范

文档内容不规范在以地区级和县级企业负责开发的软件较为明显。主要体现

在：文档内容描写不够完善，内容更新不及时。其次文档编