GBT166802015系统与软件工程用户文档的管理者要求

ICS35.080L77中华人民共和国国家标准GB/T16680—2015/ISO/IEC26511:2011代替GB/T16680—1996系统与软件工程用户文档的管理者要求Systemsandsoftwareengineering—Requirementsformanagersofuserdocumentation(ISO/IEC26511:2011,IDT)2015-12-31发布2016-07-01实施中华人民共和国国家质量监督检验检疫总局中国国家标准化管理委员会发布目次前言Ⅲ…………………………………………………………………………………………………………引言Ⅳ…………………………………………………………………………………………………………1范围1………………………………………………………………………………………………………2符合性2……………………………………………………………………………………………………2.1符合性定义2…………………………………………………………………………………………2.2符合性场景2…………………………………………………………………………………………3规范性引用文件2…………………………………………………………………………………………4术语和定义2………………………………………………………………………………………………5生存周期过程中的用户文档管理5………………………………………………………………………5.1软件生存周期中的用户文档管理5…………………………………………………………………5.2组合管理和内容管理6………………………………………………………………………………5.3信息管理策略与方针6………………………………………………………………………………6文档管理策划7……………………………………………………………………………………………6.1文档管理任务的WBS7………………………………………………………………………………6.2用户文档编写计划8…………………………………………………………………………………6.2.1确定目标和受众9………………………………………………………………………………6.2.2设计任务10………………………………………………………………………………………6.2.3开发任务10………………………………………………………………………………………6.2.4翻译和本地化任务10……………………………………………………………………………6.2.5生产任务11………………………………………………………………………………………6.2.6变更管理和维护任务11…………………………………………………………………………7用户文档计划11……………………………………………………………………………………………7.1用户文档管理计划与文档编制计划11………………………………………………………………7.2文档管理计划的内容12………………………………………………………………………………7.3文档编制计划的内容12………………………………………………………………………………8项目启动13…………………………………………………………………………………………………8.1授权、规程和规范13…………………………………………………………………………………8.2基础设施14……………………………………………………………………………………………8.3信息开发团队14………………………………………………………………………………………8.3.1角色定义14………………………………………………………………………………………8.3.2用户文档编制的角色示例15……………………………………………………………………9用户文档管理控制方法18…………………………………………………………………………………9.1文档编制测量18………………………………………………………………………………………9.1.1用户文档产品测量18……………………………………………………………………………9.1.2用户文档生产率的测量19………………………………………………………………………9.1.3用户文档质量测量19……………………………………………………………………………ⅠGB/T16680—2015/ISO/IEC26511:20119.1.4过程改进测量20…………………………………………………………………………………9.2文档估算20……………………………………………………………………………………………10管理控制在文档中的应用21……………………………………………………………………………10.1目的和成果21………………………………………………………………………………………10.2变更管理21…………………………………………………………………………………………10.3进度和成本控制21…………………………………………………………………………………10.4资源管理22…………………………………………………………………………………………10.4.1项目沟通22……………………………………………………………………………………10.4.2管理文档团队成员和供方22…………………………………………………………………10.4.3管理翻译服务22………………………………………………………………………………10.5质量管理23…………………………………………………………………………………………10.5.1管理产品质量———评审和测试23……………………………………………………………10.5.2风险和问题管理23……………………………………………………………………………10.5.3过程改进23……………………………………………………………………………………附录A(资料性附录)文档编写计划示例24………………………………………………………………附录B(规范性附录)信息管理和软件文档管理过程31…………………………………………………参考文献34……………………………………………………………………………………………………ⅡGB/T16680—2015/ISO/IEC26511:2011前言本标准按照GB/T1.1—2009给出的规则起草。本标准代替GB/T16680—1996《软件文档管理指南》。本标准对GB/T16680—1996进行修订,与GB/T16680—1996相比,主要变化如下:———名称改为“系统与软件工程用户文档的管理者要求”;———增加了第2章符合性;———删除了第4章软件文档的作用;———删除了第5章管理者的作用;———增加了5.1软件生存周期过程中的用户文档管理;———增加了第6章文档管理策划;———第6章制定文档编制策略(见1996版)调整为5.3信息管理策略与方针;———删除了第7章制定文档编制标准和指南;———增加了第7章用户文档计划;———增加了第8章项目启动;———原标准第8章文档编制计划(见1996版)调整为6.2用户文档编写计划;———删除了第9章制定文档规程;———增加了第9章用户文档管理控制方法;———增加了第10章管理控制在文档中的应用;———10.1人员(见1996版)调整为8.3信息开发团队;———10.2设备(见1996版)调整为8.2基础设施。本标准使用翻译法等同采用ISO/IEC26511:2011《系统与软件工程用户文档的管理者要求》。本标准做了以下编辑性修改:———为方便使用,将ISO/IEC12207:2008中的6.3.6和7.2.1节录,以表B.1形式给出。请注意本文件的某些内容可能涉及专利。本文件的发布机构不承担识别这些专利的责任。本标准由全国信息技术标准化技术委员会(SAC/TC28)提出并归口。本标准的起草单位:珠海南方软件网络评测中心、中国电子技术标准化研究院、北京师范大学珠海分校、国家网络软件产品质量监督检验中心(济南)。本标准的主要起草人:侯建华、梁勇、孙玮、倪玉华、彭宇帆、梁建新、黄兆森、黄姗姗、相福民、张雪莉、何春江、杨静、于文、张燕、张佳佳。GB/T16680的历次版本发布情况为:———GB/T16680—1996。ⅢGB/T16680—2015/ISO/IEC26511:2011引言软件用户文档的有效管理是必不可少的工作,它能确保用户文档可用、准确,并能高效地形成与软件相匹配的文档资料,在用户需要时按时交付。本标准主要讨论用户文档的管理,包括软件和用户文档从初始开发到后续发布的整个过程中的所有用户文档管理工作。任何使用应用软件的人员都需要准确了解软件是如何帮助用户完成任务的。文档可能是第一个呈现在用户面前的有形产品,因此它将影响着用户对产品的第一印象。如果文档表现形式便捷,很容易查找和理解,那么用户可以快速熟练地使用该软件产品。因此,文档编制过程的良好管理不仅能够帮助用户,还有益于降低培训和支持成本,同时也提高了产品、生产商和销售商的声誉。虽然许多软件设计者希望通过在设计中使用户界面更加直观的方法来减少独立文档的编写,但是这种方法事实上几乎是不可行的。用户文档是可用的软件产品的必不可少的组成部分。文档编制通常被认为是软件完成后的工作。然而,对于高质量的软件文档来说,它的编制宜从软件策划和设计阶段就开始,是软件生存周期过程的一个不可缺少的组成部分。正确的做法是:文档编制或信息管理需要有自己的过程和计划,来策划和完成其包含的各项工作内容。本标准有助于使用以下两个标准的用户:ISO/IEC15288:2008《系统和软件工程系统生存周期过程》,和ISO/IEC12207:2008《系统和软件工程软件生存周期过程》,帮助他们把管理软件用户文档作为软件生存周期中的一部分工作。本标准从管理者的角度定义了软件文档编制过程。用于帮助他们制定、执行和评估用户文档的管理工作。注:其他ISO/IEC265NN系列国际标准描述的文档编制和信息管理过程,是从文档设计人员/开发人员,测试和评审人员,需方和供方的观点阐述的。本标准适用于生产一系列文档的个人或组织,也适用于开发单文档项目的组织,同样适合团队内部以及外包文档编制的情况。除了用户手册,帮助系统,以及单独软件产品文档集的开发和生产以外,它还适用于更广泛的文档管理情况,包括安装、实施、管理和操作软件的最终用户所需要的文档。通常情况下,用户文档管理者还负责用于如下情况的信息(内容管理)的开发和重用:———随着软件版本的更新,多次更新用户文档;———多次重用或调整信息以支持相关的软件产品;———用户文档多个版本的翻译或本地化;———同时管理组织内一组不相关的文档项目。本标准的目的不是提倡文件的印刷或电子(屏幕)媒体的使用,或任何特定信息管理、内容管理、文档测试,项目管理工具或协议的使用,而是要求是尽可能的介质无关。本标准适用于包含软件系统的用户文档编制工作,也适用于单独的软件用户文档编制工作。ⅣGB/T16680—2015/ISO/IEC26511:2011系统与软件工程用户文档的管理者要求1范围本标准支持软件用户对文档一致性、完备性、准确性和可用性的要求。它为文档管理者提供策略、策划、执行和控制。它指明贯穿整个软件生存周期的用户文档管理过程。它也包括用户文档管理的关键过程,即文档编制计划和文档管理计划。本标准提供了软件文档编制和用于文档编制的信息管理过程的概述。同时还描述了用于文档编制的组合计划和内容管理。具体来说,它专注于以下内容:———项目启动时的管理要求,包括建立过程和规范,建立基础设施,建立团队并列举用户文档团队所需要的角色;———文档管理控制所需的测量和估算;———对用户文档编制工作进行管理控制;———支持过程的运用,例如变更管理,进度和成本控制,资源管理,质量管理和过程改进。参考文献中所列内容对管理、准备和测试用户文档的过程提供了指南。注1:过程中所涉及的文档管理者和其他的相关标准有:ISO/IEC26514:2008《系