软件文档管理指南GBT16680-1996

软件文档管理指南GB/T 16680—1996

《GB/T 16680—1996软件文档管理指南》(由原国家技术监督局于1996年12月18日发布,1997年7月1日起实施,

该标准为那些对软件或基于软件的产品的开发负有职赍的管理者提供软件文档的管理指南。该标准的目的在于协助管理者在他们的机构中产生有效的文档。该标准涉及策略、标准、规程、资源和计划,管理者必须关注这些内容,以便有效地管理软件文档。根据该标准,文档是指一种数据媒体和其上所记录的数据。它具有永久性并可以由人或机器阅读。通常倾于描述人工可读的内容,例如,技术文件、设计文件、版本说明文件。

软件文档的作用:管理依据、任务之间联系的凭证、质量保证、培训与参考;软件维护支持、历史档案。

软件文档可归入三种类别:开发文档(描述开发过程本身)、产品文档(描述开发过程的产物)、管理文档(记录项目管理的信息)。

1.文档计划

文档计划是指一个描述文档编制工作方法的管理用文档。该计划主要描述要编制什么类型的文档,这些文档的内容是什么,何时编写,由谁编写,如何编写,以及什么是影响期望结果的可用资源和外界因素。

文档计划一般包括以下几方面的内容:

(1)列出应编制文档的目录。

(2)提示编制文档应参考的标准。

(3)指定文档管理员。

(4)提供编制文档所需要的条件,落实文档编写人员、所需经费以及编制工具等。

(5)明确保证文档质量的方法,为了确保文档内容的正确性、合理性,应采取一定的措施,如评审、鉴定等等。

(6)绘制进度表,以图表形式列出在软件生存期各阶段应产生的文档、编制人员、编制日期、完成日期、评审日期等。

此外,文档计划规定每个文档要达到的质量等级,以及为达到期望结果必须考虑哪些外部因素。文档计划还确定该计划和文档的分发,并且明确叙述参与文档工作的所有人员的职贲。

2.开发文档

开发文档是描述软件开发过程,包括软件需求、软件设计、软件测试、保证软件质量的一类文档,开发文档也包括软件的详细技术描述(程序逻辑、程序间相互关系、数据格式和存储等)。开发文档起到如下五种作用:

(1)它们是软件开发过程中包含的所有阶段之间的通信工具,它们记录生成软件需求、设计、编码和测试的详细规定和说明。

(2)它们描述幵发小组的职责。通过规定软件、主题事项、文档编制、质量保证人员以及包含在开发过程中任何其他事项的角色来定义做什么、如何做和何时做。

(3)它们用作检验点而允许管理者评定开发进度,如果开发文档丢失、不完整或过时,

管理者将失去跟琮和控制软件项目的一个重要工具。

(4)它们形成了维护人员所要求的基本软件文档。而这些支持文档可作为产品文档的一部分。

(5)它们记录软件开发的历史。基本的开发文挡有可行性研究和项目任务书;需求规格说明:功能规格说明:设计规格说明,包括程序和数据规格说明;开发计划;软件集成和測试计划;质量保证计划、标准、进度:安全和测试信息。

3.产品文档

产品文档规定关于软件产品的使用、维护、增强、转换和传输的信息。产品文档起到如下三种作用:

(1)为使用和运行软件产品的任何人规定培训和参考信息;

(2)使得那些未参加本软件开发的程序员维护它;

(3)促进软件产品的市场流通或提髙可接受性。

产品文档用于下列类型的读者:

(1)用户。他们利用软件输入数据、检索信息和解决问题;

(2)运行者。他们在计算机系统上运行软件;

(3)维护人员。他们维护、增强或变更软件。

产品文档包括如下内容:

(1)用于管理者的指南和资料,他们监督软件的使用;

(2)宣传资料。通告软件产品的可用性并详细说明它的功能、运行环境等:

(3)一般信息。对任何有兴趣的人描述软件产品。

基本的产品文档有培训手册;参考手册和用户指南;软件支持手册;产品手册和广告信息。

4.管理文档

管理文档建立在项目信息的基础上,诸如:

(1)开发过程的每个阶段的进度和进度变更的记录;

(2)软件变更情况的记录;

(3)相对于开发的判定记录;

(4)职责定义。

这种文档从管理的角度规定涉及软件生存的信息。相关文档的详细规定和编写格式见GB 8567。

5.文档等级

文档等级是指所需文档的一个说明,它指出文档的范围、内容、格式及质量,可以根据项目、费用、预期用途、作用范围或其他因素选择文档等级。每个文档的质量必须在文档计划期间就有明确的规定,文档的质量可以按文档的形式和列出的要求划分为4级。

(1)最低限度文档(1级文档):适合开发工作量低于一个人月的开发者自用程序。该文档应包含程序清单、开发记录、测试数据和程序简介。

(2)内部文档(2级文档):可用于在精心研究后被认为似乎没有与其他用户共享资源的专用程序。除1级文档提供的信息外,2级文档还包括程序淸单内足够的注释以帮助用户安装和使用程序。

(3)工作文档(3级文档):适合于由同一单位内若干人联合开发的程序,或可被其他单位使用的程序。

(4)正式文档(4级文档):适合那些要正式发行供普迪使用的软件产品。关键性程序或具有重复管理应用性质(如工资计算)的程序需

要4级文档。4级文档应进守DES567的有关规定.

软件文档管理指南GB/T 16680—1996

《GB/T 16680—1996软件文档管理指南》(由原国家技术监督局于1996年12月18日发布,1997年7月1日起实施,

该标准为那些对软件或基于软件的产品的开发负有职赍的管理者提供软件文档的管理指南。该标准的目的在于协助管理者在他们的机构中产生有效的文档。该标准涉及策略、标准、规程、资源和计划,管理者必须关注这些内容,以便有效地管理软件文档。根据该标准,文档是指一种数据媒体和其上所记录的数据。它具有永久性并可以由人或机器阅读。通常倾于描述人工可读的内容,例如,技术文件、设计文件、版本说明文件。

软件文档的作用:管理依据、任务之间联系的凭证、质量保证、培训与参考;软件维护支持、历史档案。

软件文档可归入三种类别:开发文档(描述开发过程本身)、产品文档(描述开发过程的产物)、管理文档(记录项目管理的信息)。

1.文档计划

文档计划是指一个描述文档编制工作方法的管理用文档。该计划主要描述要编制什么类型的文档,这些文档的内容是什么,何时编写,由谁编写,如何编写,以及什么是影响期望结果的可用资源和外界因素。

文档计划一般包括以下几方面的内容:

(1)列出应编制文档的目录。

(2)提示编制文档应参考的标准。

(3)指定文档管理员。

(4)提供编制文档所需要的条件,落实文档编写人员、所需经费以及编制工具等。

(5)明确保证文档质量的方法,为了确保文档内容的正确性、合理性,应采取一定的措施,如评审、鉴定等等。

(6)绘制进度表,以图表形式列出在软件生存期各阶段应产生的文档、编制人员、编制日期、完成日期、评审日期等。

此外,文档计划规定每个文档要达到的质量等级,以及为达到期望结果必须考虑哪些外部因素。文档计划还确定该计划和文档的分发,并且明确叙述参与文档工作的所有人员的职贲。

2.开发文档

开发文档是描述软件开发过程,包括软件需求、软件设计、软件测试、保证软件质量的一类文档,开发文档也包括软件的详细技术描述(程序逻辑、程序间相互关系、数据格式和存储等)。开发文档起到如下五种作用:

(1)它们是软件开发过程中包含的所有阶段之间的通信工具,它们记录生成软件需求、设计、编码和测试的详细规定和说明。

(2)它们描述幵发小组的职责。通过规定软件、主题事项、文档编制、质量保证人员以及包含在开发过程中任何其他事项的角色来定义做什么、如何做和何时做。

(3)它们用作检验点而允许管理者评定开发进度,如果开发文档丢失、不完整或过时,

管理者将失去跟琮和控制软件项目的一个重要工具。

(4)它们形成了维护人员所要求的基本软件文档。而这些支持文档可作为产品文档的一部分。

(5)它们记录软件开发的历史。基本的开发文挡有可行性研究和项目任务书;需求规格说明:功能规格说明:设计规格说明,包括程序和数据规格说明;开发计划;软件集成和測试计划;质量保证计划、标准、进度:安全和测试信息。

3.产品文档

产品文档规定关于软件产品的使用、维护、增强、转换和传输的信息。产品文档起到如下三种作用:

(1)为使用和运行软件产品的任何人规定培训和参考信息;

(2)使得那些未参加本软件开发的程序员维护它;

(3)促进软件产品的市场流通或提髙可接受性。

产品文档用于下列类型的读者:

(1)用户。他们利用软件输入数据、检索信息和解决问题;

(2)运行者。他们在计算机系统上运行软件;

(3)维护人员。他们维护、增强或变更软件。

产品文档包括如下内容:

(1)用于管理者的指南和资料,他们监督软件的使用;

(2)宣传资料。通告软件产品的可用性并详细说明它的功能、运行环境等:

(3)一般信息。对任何有兴趣的人描述软件产品。

基本的产品文档有培训手册;参考手册和用户指南;软件支持手册;产品手册和广告信息。

4.管理文档

管理文档建立在项目信息的基础上,诸如:

(1)开发过程的每个阶段的进度和进度变更的记录;

(2)软件变更情况的记录;

(3)相对于开发的判定记录;

(4)职责定义。

这种文档从管理的角度规定涉及软件生存的信息。相关文档的详细规定和编写格式见GB 8567。

5.文档等级

文档等级是指所需文档的一个说明,它指出文档的范围、内容、格式及质量,可以根据项目、费用、预期用途、作用范围或其他因素选择文档等级。每个文档的质量必须在文档计划期间就有明确的规定,文档的质量可以按文档的形式和列出的要求划分为4级。

(1)最低限度文档(1级文档):适合开发工作量低于一个人月的开发者自用程序。该文档应包含程序清单、开发记录、测试数据和程序简介。

(2)内部文档(2级文档):可用于在精心研究后被认为似乎没有与其他用户共享资源的专用程序。除1级文档提供的信息外,2级文档还包括程序淸单内足够的注释以帮助用户安装和使用程序。

(3)工作文档(3级文档):适合于由同一单位内若干人联合开发的程序,或可被其他单位使用的程序。

(4)正式文档(4级文档):适合那些要正式发行供普迪使用的软件产品。关键性程序或具有重复管理应用性质(如工资计算)的程序需

要4级文档。4级文档应进守DES567的有关规定.


相关文章

  • 信息安全工作方案
  • 一、工作目的 按照《云南省工业和信息化委员会关于开展20xx年度云南省政府信息系统安全检查工作的通知》要求,根据《国务院办公厅关于加强政府信息安全和保密管理工作的通知》、《国务院办公厅关于印发<政府信息系统安全检查办法>的通知》以及《云南省政府办公厅关于印发<政府信息系统安全检查实 ...

  • 软件技术服务合同
  • 甲方:淄博四维软件科技开发有限公司 乙方: 甲方作为城建档案管理软件信息平台的提供商,乙方作为甲方业务的接受方,根据《中华人民共和国合同法》,双方本着互惠互得并在遵守国家有关政策法规的基础上,经平等协商,就《城建档案信息化综合管理系统》软件技术服务事宜达成一致意向,并签定本合同,双方共同信守执行. ...

  • 室内空气污染治理委托合同
  • 委托方(全称):_________ 治理方(全称):_________ 根据<中华人民共和国合同法>.<室内空气质量标准>(gbt 18883-xx).<民用建筑工程室内环境污染控制规范>(gb50325-xx),经委托方与治理方协商一致,签订本合同. 一.内容和 ...

  • 弱电工程承包合同
  • 甲方委托乙方完成工程的施工安装任务,双方本着友好合作的态度,按照<合同法>等相关法律,在平等公正的情况下签定如下合同 一. 施工责任 1.工程队独立自主,完成分包下去的工程,施工现场必须指派一名熟练固定的施工负责班长,工程过程中我公司专指派现场负责人指导.监督工程施工进度及质量. 2.施 ...

  • 软件工程课设心得
  • 软件工程是一门实践性很强.交叉性很强的学科,它提供给我们的不仅是一种方法论,更是一种世界观. 在没有接触软件工程这门课时,我一直认为软件就是程序.能编出解决问题的程序就ok了,从没有想过,在写一个程序之前还要构思几份文档(可行性分析.需求分析.概要设计).不过对于那些大型软件如植物僵尸大战(至少对于 ...

  • 软件项目管理小结2篇
  • 软件项目管理已经到了学期的最后,我们seed小组的软件项目也已完工,这一个学期真的是获益匪浅! 礼平老师曾经说我既可以走技术路线也可以走管理路线,一切都看我自己。真的很是佩服老师的看人眼光,很犀利。我知道,现在的我不是没有能力去做好,只是自己没有去做,一直在殿外徘徊,不肯付出努力向前迈进。从大一到现 ...

  • 软件经销授权合同
  • 编号:×××××× 甲方:×××××× 乙方:××××××(授权经销商商名称) 鉴于: 1.××××××××××××开发.生产相应的软件产品,并拥有该等软件产品的计算机软件著作权: 2.乙方是××××××××××××在××××××地区设立的授权经销商营销机构,并已获得充分的授权向甲方授予×××××× ...

  • 软件工程实习总结
  •   一.实习题目   c/s模式下的网络游戏平台(类似于联众)   二.题目要求   a. 平台上至少能够提供两种游戏(仅供两人参加)供用户选择。   b. 服务器端实现用户账号、密码的管理,监控用户上下线状态管理。   c. 服务器端实现用户游戏数据及文本通信数据的中转交换。   d. 客户端能够 ...

  • 新闻行业竞选演讲稿(多媒体工作室主任)
  • 各位领导,各位同事,你们好,接下来的十分钟里,我会竭尽全力地向你们证明,我胜任多媒体工作室主任一职. 我叫xxx,1995年毕业于xxx大学信息管理系,1999年就读xxx大学计算机理论与软件专业的研究生课程班,xx年6月获得中山大学计算机系硕士学位. 从1995年7月开始,我先后在档案管理科.技术 ...

  • 软件工程小结
  • 今天视频看完了,可是没有总结。还是感觉不会总结。一想到50讲的课,怎么总结呢?开始听的时候,是真不知道从哪里下手,因为开始看的时候有种迷迷糊糊的感觉。软件工程,我期待的一门课就这么听完了一遍。很有些囫囵吞枣的感觉,不过收获还是很多的,至少知道了软件工程的阶段不是只有需求分析、编程和测试维护。当然这个 ...