本标准支持软件用户对文档一致性、完备性、准确性和可用性的要求。它为文档管理者提供策略、策划、执行和控制。它指明贯穿整个软件生存周期的用户文档管理过程。它也包括用户文档管理的关键过程,即文档编制计划和文档管理计划。
本标准提供了软件文档编制和用于文档编制的信息管理过程的概述。同时还描述了用于文档编制的组合计划和内容管理。具体来说,它专注于以下内容:
———项目启动时的管理要求,包括建立过程和规范,建立基础设施,建立团队并列举用户文档团队所需要的角色;
———文档管理控制所需的测量和估算;
———对用户文档编制工作进行管理控制;
———支持过程的运用,例如变更管理,进度和成本控制,资源管理,质量管理和过程改进。
参考文献中所列内容对管理、准备和测试用户文档的过程提供了指南。
注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提供了关于生存周期过程中的信息项(文档)更详细的内容。
前言 Ⅲ
引言 Ⅳ
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 文档管理任务的WBS 7
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
9.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
