GB/T 16680-2015 in English

《GB/T 16680-2015系统与软件工程 用户文档的管理者要求》由TC28（全国信息技术标准化技术委员会）归口，TC28SC7（全国信息技术标准化技术委员会软件与系统工程分会）执行，主管部门为国家标准化管理委员会。
本标准支持软件用户对文档一致性、完备性、准确性和可用性的要求。它为文档管理者提供策略、策划、执行和控制。它指明贯穿整个软件生存周期的用户文档管理过程。它也包括用户文档管理的关键过程,即文档编制计划和文档管理计划。
本标准提供了软件文档编制和用于文档编制的信息管理过程的概述。同时还描述了用于文档编制的组合计划和内容管理。具体来说,它专注于以下内容:
―――项目启动时的管理要求,包括建立过程和规范,建立基础设施,建立团队并列举用户文档团队所需要的角色;
―――文档管理控制所需的测量和估算;
―――对用户文档编制工作进行管理控制;
―――支持过程的运用,例如变更管理,进度和成本控制,资源管理,质量管理和过程改进。
参考文献中所列内容对管理、准备和测试用户文档的过程提供了指南。
注1:过程中所涉及的文档管理者和其他的相关标准有:ISO/IEC26514:2008《系统和软件工程 对用户文档设计者和开发者的要求》(IEEE标准26514―2010,采用ISO/IEC26514:2008的IEEE标准,系统和软件工程 对用户文档设计者和开发者的要求),ISO/IEC26513:2009《系统与软件工程 对用户文档测试者和评审者的要求》(IEEE标准26513:2010,采用ISO/IEC26513:2009的IEEE标准,系统与软件工程 对用户文档测试者和评审者的要求)和ISO/IEC/IEEE26512:2011《系统和软件工程 对用户文档需方和供方的要求》。
本标准适用于用户文档编制项目的管理者的使用,适用于拥有信息设计和文档开发人员的组织。
本标准也可供其他角色和对文档编制过程感兴趣的人员参考:
―――软件开发过程的管理者;
―――购买供方文档的用户;
―――经验丰富的编写用户文档内容的人员;
―――创建电子版文档工具的开发人员;
―――研究使文档更加方便和易用的人因分析专家;
―――电子媒体方面的平面设计师;
―――共同设计文档在屏幕上展现形式的用户界面设计师和人体工程学专家。
本标准也可用于管理以下类型的文档,尽管它并没有涵盖所有的方面:
―――用于帮助用户、培训和销售的文档和用于产品设计和开发的系统文档,这些文档是基于用户文档主题重用的;
―――非软件产品文档;
―――使用动画、视频和声音的多媒体销售演示;
―――正式培训课程中使用的基于计算机的培训[computer-basedtraining(CBT)]资源文件包和特定的课程教材;
―――描述系统软件内部运作的维护文档。
注2:ISO/IEC/IEEE15289:2011提供了关于生存周期过程中的信息项(文档)更详细的内容。

Scope

This International Standard supports software users' requirements for documentation consistency, completeness, accuracy and usability. It provides policy, planning, execution and control for document managers. It specifies the user documentation management process throughout the software lifecycle. It also includes the key processes of user documentation management, namely documentation planning and documentation management planning. This International Standard provides an overview of software documentation and the information management processes used for documentation. Portfolio planning and content management for documentation are also described. Specifically, it focuses on the following: -- management requirements at project initiation, including establishing processes and norms, establishing infrastructure, establishing teams and enumerating the roles needed for user documentation teams; -- measures required for documentation management controls and estimates; --Management control over user documentation; --Use of supporting processes, such as change management, schedule and cost control, resource management, quality management and process improvement. The references listed provide guidance on the process of managing, preparing, and testing user documentation. This International Standard is intended for use by managers of user documentation projects and for organizations with information design and documentation developers. This standard can also be used as a reference for other roles and personnel interested in the documentation process: -- managers of the software development process; -- users who purchase supplier documentation; -- experienced personnel who write the content of user documentation; -- Developers of tools that create electronic versions of documents; --Human factors analysts, who study how to make documents more convenient and usable; --Graphic designers of electronic media; --User interface designers, who co-design how documents appear on the screen and ergonomics experts. This standard can also be used to manage the following types of documentation, although it does not cover all aspects: - documentation for user assistance, training and sales and system documentation for product design and development, which are based on user documentation topics - non-software product documentation; - multimedia sales presentations using animation, video, and sound; - computer-based training (CBT) resource file packages and specific Course materials; --Maintenance documents describing the inner workings of the system software.