软件文档及其管理.pdfVIP

第 19 卷第 2 期 洛阳大学学报 Vol. 19 No. 2 　　　　　　　　　 　　　　　　　　　　　 2 0 0 4 年 6 月 JOURNAL OF LUOYANG UNIVERSITY Jun. 2004 软件文档及其管理 贾文峰 , 刘青梅 ① (洛阳大学 现代教育技术中心 , 河南 洛阳 471023) 摘 　要 : 介绍了软件文档的作用、分类及其质量要求 , 并提出了在软件文档管理和 维护中应注意的问题. 关键词 : 软件文档 ; 分类 ; 质量 ; 管理 ( ) 中图分类号: TP311. 5 　文献标识码 : A 　文章编号 : 1007 - 113X 2004 02 - 0067 - 04 软件文档是指某种数据媒体和其中所记录的数据. 它具有永久性 , 并可以由人或机器阅读 , 通常仅 用于描述人工可读的内容 , 例如 , 技术文件、设计文件、版本说明文件等. 在软件工程中 , 文档常常用来 表示对活动、需求、过程或结果进行描述、定义、规定、报告、认证的任何书面或图示的信息. 它们描述 和规定了软件设计和实现的细节 , 说明使用软件的操作命令. 软件文档是软件产品必不可少的组成部分. 软件文档的编制在软件开发工作中占有突出的地位 , 并 且需要相当大的工作量. 高质量、高效率地开发、分发、管理和维护文档 , 对于转让、变更、修正、扩充 和使用文档以及充分发挥软件产品的效益有着重要的意义. 1 　软件文档的作用 在软件的开发生产过程中 , 总是伴随着大量的信息需要记录和使用. 因此 , 文档在软件的开发过程 中起着非常重要的作用. ( ) 1 管理依据 : 在软件开发过程中 , 管理者必须了解开发进度、存在的问题和预期目标. 每一阶段计 划安排的定期报告提供了项目的可见性 , 定期报告还提醒各级管理者注意该部门对项目承担的责任以及 该部门效率的重要性. 开发文档规定若干个检查点和进度表 , 使管理者可以评定项目的进度. 如果开发 文档有遗漏、不完善 , 或内容陈旧 , 则管理者将失去跟踪和控制项目的重要依据. (2) 任务联系 : 大多数软件开发项目通常被划分成若干个任务 , 并由不同的小组去完成. 学科方面的 专家建立项目 , 分析员阐述系统需求 , 设计员为程序员制定总体设计 , 程序员编制详细的程序代码 , 质 量保证专家和审查员评价整个系统性能和功能的完整性 , 负责维护的程序员改进各种操作或增强某些功 能. 这些人员之间的联系是通过文档资料的复制、分发和引用而实现的 , 因而 , 任务之间的联系是文档 的一个重要功能. (3) 质量保证 : 对于负责软件质量保证和评估系统性能的人员来说 , 需要程序规格说明书、测试和评 估计划、测试该系统用的各种质量标准 , 以及关于期望系统完成什么功能和系统怎样实现这些功能的清 晰说明 , 必须制定测试计划和测试规程 , 并报告测试结果. 文档的提供可满足质量保证人员和审查人员 的工作需要. (4) 培训参考 : 软件文档的另一个功能是使系统管理员、操作员、用户、管理者和其他有关人员了解 系统如何工作 , 以及为了达到他们各自的目的, 如何使用系统. (5) 维护支持 : 维护人员需要软件系统的详细说明书以帮助他们熟悉系统 , 尽可能找出并修正错误 , 改进系统 , 以适应用户需求的变化或适应系统环境的变化. (6) 历史档案 : 软件文档可用作未来项目的一种资源. 通常文档记载系统的开发历史 , 可使有关系统