13软件文档的管理办法13.doc

为了保证所开发软件的质量,作为软件开发过程中重要的组成部分----软件文档,其管理是非常重要的,特制定本办法。
适用范围
本管理办法适用于本公司所有软件文档的管理。
引用文件
GB/T 19001-2000《质量管理体系要求》
GB/T19000-《在软件开发、供应和维护中的使用指南》
GB/TA16680-1996《软件文档管理指南》
职责
副总经理负责对软件文档管理活动的组织与领导。
研发中心负责具体软件文档的编写。
综合管理部负责软件文档的具体归档及管理工作。
其他各部门协助技术质量部做好软件文档的管理工作。
工作程序
文档的管理范围
本公司所有开发软件中的相关文档。
软件文档的作用
管理依据;
任务之间联系的凭证;
质量保证;
培训与参考;
软件维护支持;
历史档案。
文档编制策略
a. 文档需要覆盖整个软件生存期;
b. 文档应是可管理的;
c. 文档应适合他的读者;
d. 文档应贯穿到软件的整个开发过程中;
e. 文档标准应被标识和使用;
f. 应规定支持工具。
(在需要时可对文档编制策略进行检查。文档策略检查表,见附录2中《文档策略检查表》)
规定文档类型和内容
软件文档归入如下三种类别
开发文档——描述开发过程本身
产品文档——描述开发过程的产物
管理文档——记录项目管理的信息
开发过程中可能形成的文档包括:
可行性研究和项目任务书;
需求规格说明;
功能规格说明;
设计规格说明、包括程序和数据规格说明;
开发计划;
软件集成和测试计划;
质量保证计划、标准、进度;
安全和测试信息。
(软件开发中心各项因素的总和同文件编制要求的关系。见附录1中表02)
基本的产品文档包括:
培训手册;
参考手册和用户指南;
软件支持手册;
产品手册和信息广告。
管理文档包括:
开发过程的每个阶段的进度和进度变更的记录;
软件变更情况的记录;
相对于开发的判定记录;
职责定义
制订文档规程:
文档计划一般内容
列出应编制文档应参考的标准;
提示编制文档应参考的标准;
指定文档管理员;
提供编制文档所需的条件,落实文档编写人员、所需经费以及编制工具等;
明确保证文档质量的方法,为了确保文档内容的正确性、合理性,应采取一定的措施,
如评审、鉴定等;
绘制进度表,以图表形式列出在软件生产开发期各阶段应产生的文档、编制日期、完
成日期、评审日期等。
文档计划制定
项目一旦确定,就应制定项目开发计划。
文档编写
文档的编写是件非常细致的工作,从最初提出文档编写提纲开始,经过逐步充实、完善,并经过复检和修改,直至正式交付使用为止。
编写文档应注意以下几点:
文档编写时间应与软件开发同步,在软件生存期的每一个阶段都应完成相应的文档编
写工作;
按文档计划要求编写文档;
按本单位指定的标准内容和格式编写相应的文档;
每个文档必须装订成册,并加封面和目次;
文档用纸的格式由各单位的有关标准格式编写相应文档;
归档用的文档还应有