软件文档管理存在的问题及对策 摘要：软件文档是指某种媒体和其中所记录的数据，具有永久性，并可由人或机器阅读，仅用于人工可读的内容。在软件工程中，文档常用来表示对活动、需求、过程或结果进行描述、定义、规定、报告、认证的任何书面或图示的信息。软件文档是软件产品必不可少的组成部分，高质量、高效率地管理和维护软件文档，对于转让、变更、修正、扩充和使用软件及充分发挥软件产品的效益有着重要的意义。 关键词：软件文档；问题；对策 1软件文档的作用 1.1管理依据。在软件开发过程中，管理者必须了解开发进度、存在的问题和预期目标。每一阶段计划安排的定期报告提供了项目的可见性，定期报告还提醒各级管理者注意该部门对项目承担的责任及该部门效率的重要性。开发文档规定若干个检查点和进度表，使管理者可评定项目的进度。如果开发文档有遗漏、不完善或内容陈旧，管理者将失去跟踪和控制项目的重要依据。 1.2任务之间联系的凭证。大多数软件开发项目通常被划分成若干任务，由不同的小组去完成，学科方面的专家建立项目，分析员阐述系统需求，设计员为程序员制定总体设计，程序员编制详细的程序代码，质量保证专家和审查员评价整个系统性能和功能的完整性，负责维护的程序员改进各种操作或增强某些功能。这些人员需要的互相联系是通过文档资料的复制、分发和引用而实现的，因而任务之间的联系是文档的一个重要功能。大多数系统开发方法为任务的联系规定了一些正式文档。分析员向设计员提供正式需求规格说明，设计员向程序员提供正式设计规格说明等等。 1.3质量保证。对于负责软件质量保证和评估系统性能的人员需要程序规格说明、测试和评估计划、测试该系统用的各种质量标准以及关于期望系统完成什么功能和系统怎样实现这些功能的清晰说明；必须制订测试计划和测试规程，并报告测试结果；还必须说明和评估完全、控制、计算、检验例行程序及其他控制技术。这些文档的提供可满足质量保证人员和审查人员上述工作的需要。 1.4培训与参考。软件文档的另一个功能是使系统管理员、操作员、用户、管理者和其他有关人员了解系统如何工作，以及为了达到各自的目的，如何使用系统。 1.5维护支持。维护人员需要软件系统的详细说明书以帮助熟悉系统，尽可能找出并修正错误、改进系统，以适应用户需求的变化或适应系统环境的变化。 1.6历史档案。软件文档可用作未来项目的一种资源。通常文档记载系统的开发历史，可使有关系统结构的基本思想为以后的项目所利用。系统开发人员通 过审阅以前的系统以查明什么部分已试验过，什么部分运行的很好，什么部分因某种原因难以运行而被排除。良好的系统文档有助于把程序移植到新的系统环境中。 2 软件文档管理中存在的问题 信息系统文档是企业重要的智力资产，它凝聚着信息项目建设中所有参与人员的智慧和汗水。这些软件文档一般以电子文档的形式存在，从内容上看，主要包括企业信息化规划、项目开发计划、需求规格说明书、设计规格说明书、程序清单、测试报告、系统维护手册、用户手册、系统变更报告、项目总结报告、会议记录以及经验心得报告等文档资料。近年来，信息化建设在资源整合的过程中，不断地实现了信息数据和应用系统的向上集中。但由于从事信息化工作的人员相对较少，且主要集中在系统建设、平台整合以及系统运维等工作上，在信息系统软件文档的管理存在不足。主要体现在以下几个方面： 2.1 文档管理制度不健全 在信息化高速发展的今天，制度建设依旧是一块短板，而软件文档作为软件的灵魂，也没能从制度层面加以保证和有效管理。软件文档的创建、保存以及利用也无法从根本上加以规范，从而造成文档查找缓慢、效率低下，文档安全缺乏保障，文档无法有效协作共享，知识管理效果不明显。 2.2 文档管理意识不深入 在多数在用的应用软件中，很少能见到带有“在线帮助”功能的软件，产生这个问题主要是在软件系统规划和设计过程中就没有考虑到这项功能的存在。在日常的软件维护工作中，常常发现使用人员由于操作不熟练，为一个简单的操作或流程束手无策而转向寻找供应商支持。软件供应商往往是极其被动地为用户提供相关软件文档，多数软件企业对文档重要性认识不够，对文档管理缺少规划和管理的问题仍然存在。 2.3 文档内容不够规范 文档内容不规范在以地区级和县级企业负责开发的软件较为明显。主要体现在：文档内容描写不够完善，内容更新不及时。其次文档编写不够规范，主要表现在软件项目实施过程中，没有对每一个阶段的文档进行整理，分层次管理，各类文档资料缺少一个可以参照的样本，更多的是在前人写好的基础上，对内容进行修改一下就算完成任务。另外，部分文档只追求形式，忽略了实际效用。 2.4 文档管理不够统一 随着信息系统的不断优化、升级，新需求和变更的不断产生，各种文档也越来越多，但我们尚没有建立一个计算机软件文档信息库，用来统一存放软件项目开发过程中不同时期的各类文档。而这些零散存在的文档，极容易造成查询和控 制的困难，加上目前文档管理上还没有一个好的工具，无法实现统一地管理。 3软件文档管理的对策 3.1从建立制度入手，逐步实行规范管理 为加强软件行业标准化建设，国家对软件文档专门制订了一些标准，主要包括《软件文档管理指南》（GB/T16680-1996）和《计算机软件文档编制规范》（GB/T 8567-2006）。在建立文档管理制度时，首先要以落实和执行这些标准为前提，保证开发文档、产品文档、管理文档得到规范地编制。在落实制度时，要根据合同规定，认真地检查软件生存周期内各阶段的文档是否得到编写，要在项目实施、组织评审验收等多个过程中确保软件文档管理制度得到切实地执行。同时，要结合企业的特点，重视软件服务外包和IT运维管理制度的建设和探索，重视新需求挖掘和应急处理，并以文档形式进行记录。通过积极推进质量管理体系建设，进一步强化过程的痕迹化管理；通过ITIL理论的推广应用，有效地利用变更管理、发布管理、知识管理等手段，实现软件价值的成功转化；通过建立和健全各类核心平台的管理规范，做到有序管理、主动管理，确保各类文档的完整性和可用性，做到IT服务的可持续性。应该在IT服务管理中，逐渐形成一种“有开发就有文档、有变更就有文档”的行为共识，有力推进文档的规范管理。 3.2做好文档源头管理，提升软件文档质量 造成软件文档质量不高的原因主要表现在以下两个方面：其一是软件软开发商缺乏实践经验，软件文档的质量缺乏评价的标准依据；其次是软件开发商不够重视文档编写工作或是对文档编写工作的安排不恰当。所以，要从抓好软件文档管理，要从抓软件文档的“生产者”入手，应当针对不同性质的软件项目，设置相应软件供应商的进入门槛，应该在签订的软件合同中专门强调或阐明文档的重要性，也可以考虑适当增加文档所占的分值比重。 3.3做好文档分级，提高注意力管理能力 在软件立项时，应该及时做好软件项目的文档规划，并进行文档等级的划分。文档等级指的是给所需软件文档的一个说明，它指出了文档的范围、内容、格式及质量，我们根据项目大小、费用高低或其它因素对文档进行分级。通过抓好文档等级标准落实，作为做好文档工作的着力点，提高管理过程的注意力，减少不必要的精力浪费。通过建立可行性分析报 告、项目开发计划、软件需求分析、概要设计、系统设计、系统维护以及用户操作手册等各部分的文档质量等级审查标准，在文档审查上下功夫，可以力求文档达到易读性和针对性。 3.4做好文档库建设，为日常运作提供高效便捷的信息支持 针对目前文档粗放式的管理方式，应该建立一套完善的文档数据库，以便实 现对软件项目文档的统一管理。通过系统权限设置，做到文档的安全控制和流转使用；通过建立文档目录和文档索引，在系统中可以充分体现其便捷性和清晰性；通过版本控制，及时剔除过时信息和更新有效信息，确保无二义性和可追溯性；通过建立文档技术评价体系，筛选出优秀的技术文档，作为团队资料，进行内部人员共同学习，从而可以增强信息化队伍的整体作战能力，为各类系统的正常运行提供高效、便捷的信息化技术支持。 4结束语 软件文档管理是一个长期的管理过程，也是我们做好信息化工作的一个重要基础，有必要引起我们足够的重视。随着企业信息化程度越来越高，拥有一个管理规范、高效便捷的软件文档管理体系，可以让我们从容应对各类业务风险，从而不断地推进组织信息化工作向前发展。同时，要认真做好软件文档的审核工作，对软件供应商提供的文档初稿，进行审核和归档，保证软件文档的质量。只有做好文档的审核，把握好源头管理，才能保证文档的质量，为软件后期运行维护和进一步开发打下坚实的基础。 参考文献： [1]张友生，系统分析师教程，清华大学出版社，2010. [2]田志刚，你的知识需要管理，辽宁科学技术出版社，2010. [3]My Way咨询公司，基于ITIL的服务管理，2008. 本文来源：https://www.wddqw.com/doc/c598c23f084e767f5acfa1c7aa00b52acfc79cae.html