系统与软件工程用户文档管理者的要求.doc
《系统与软件工程用户文档管理者的要求.doc》由会员分享,可在线阅读,更多相关《系统与软件工程用户文档管理者的要求.doc(41页珍藏版)》请在淘文阁 - 分享文档赚钱的网站上搜索。
1、ICS35.080L77中华人民共和国国家标准GB/T 16680XXXX/ISO/IEC 26511:2011代替GB/T 166801996系统与软件工程 用户文档管理者的要求Systems and software engineering Requirements for managers of user documentation(ISO/IEC 26511:2011,IDT)在提交反馈意见时请将您知道的相关专利连同支持性文件一并附上(本稿完成日期:2013年12月18日)XXXX - XX - XX发布XXXX - XX - XX实施GB/T 16680XXXX/ ISO/IEC 2
2、6511:2011目次前言III引言IV1范围12符合性12.1符合性的定义22.2符合性的情形23规范性引用文件24术语和定义25生存周期过程中的用户文档管理45.1软件生存周期中的用户文档管理45.2组合管理和内容管理55.3信息管理方针和策略66文档管理规划76.1文档管理任务的工作分解结构76.2用户文档编写规划86.2.1确定目标和受众86.2.2设计任务96.2.3开发任务96.2.4翻译和本地化任务106.2.5生产任务106.2.6变更管理和维护任务107用户文档计划107.1用户文档管理计划与文档编制计划107.2文档管理计划的内容117.3文档编制计划的内容128项目启动1
3、28.1授权,规程和规范128.2基础设施138.3信息开发团队138.3.1角色定义138.3.2用户文档编制的角色示例149用户文档管理控制方法179.1文档编制测量179.1.1用户文档产品测量189.1.2用户文档生产率的测量189.1.3用户文档质量测量199.1.4过程改进测量199.2文档估算2010管理控制在文档中的应用2010.1目的和成果2010.2变更管理2110.3进度和成本控制2110.4资源管理2110.4.1项目沟通2210.4.2管理文档团队成员和供方2210.4.3管理翻译服务2210.5质量管理2210.5.1管理产品质量评审和测试2210.5.2风险和问题
4、管理2310.5.3过程改进23附录A(资料性附录)文档编写计划示例24附录B(规范性附录)信息管理和软件文档管理过程31参考文献34前言本标准按照GB/T 1.12009给出的规则起草。本标准代替GB/T 166801996 软件文档管理指南。本标准对GB/T 166801996进行修订,与GB/T 166801996相比,主要变化如下:增加了第2章符合性;删除了第4章软件文档的作用;删除了第5章管理者的作用;增加了5.1生存周期过程中的用户文档管理;增加了第6章文档管理规划;第6章制订文档编制策略(见1996版)调整为本标准5.3信息管理方针和策略;删除了第7章制订文档编制标准和指南;增加
5、了第7章用户文档计划;增加了第8章项目启动;原标准第8章文档编制计划(见1996版)调整为本标准6.2用户文档编写规划删除了第9章制订文档规程;增加了第9章用户文档管理控制方法;增加了第10章管理控制在文档中的应用;10.1人员(见1996版)调整为本标准8.3信息开发团队;10.2设备(见1996版)调整为本标准8.2基础设施。本标准采用翻译法等同采用ISO/IEC 26511:2011,结合我国国情,编辑性修改内容如下:删除6.2.4“注:翻译和本地化工作宜由以目标语言为母语的工作者完成或者在目标语言所在的地区进行”删除8.3.2.14“翻译者的母语宜是目标语言”;修改9.1,将示例中“单
6、词”改为“文字”;修改10.3,将示例中货币单位由“欧元”修改为“人民币”。本标准由全国信息技术标准化技术委员会(SAC/TC 28)提出并归口。本标准起草单位:本标准起草人:GB/T 16680的历次版本发布情况为:GB/T 166801996。引言软件用户文档的有效管理是必不可少的工作,它能确保用户文档可用、准确,并能高效地形成与软件相匹配的文档资料,在用户需要时按时交付。本标准主要讨论用户文档的管理,包括软件和用户文档从初始开发到后续发布的整个过程中的所有用户文档管理工作。任何使用应用软件的人员都需要准确了解软件是如何帮助用户完成任务的。文档可能是第一个呈现在用户面前的有形产品,因此它将
7、影响着用户对产品的第一印象。如果文档表现形式便捷,很容易查找和理解,那么用户可以快速熟练地使用该软件产品。因此,文档编制过程的良好管理不仅能够帮助用户,还有益于降低培训和支持成本,同时也提高了产品、生产商和销售商的声誉。虽然许多软件设计者希望通过在设计中使用户界面更加直观的方法来减少独立文档的编写,但是这种方法事实上几乎是不可行的。用户文档是可用的软件产品的必不可少的组成部分。文档编制通常被认为是软件完成后的工作。然而,对于高质量的软件文档来说,它的编制宜从软件规划和设计阶段就开始,是软件生存周期过程的一个不可缺少的组成部分。正确的做法是:文档编制或信息管理需要有自己的过程和计划,来规划和完成
8、其包含的各项工作内容。本标准有助于使用以下两个标准的用户:ISO/IEC 15288:2008 系统和软件工程 系统生存周期过程,和ISO/IEC 12207:2008 系统和软件工程 软件生存周期过程,帮助他们把管理软件用户文档作为软件生存周期中的一部分工作。本标准从管理者的角度定义了软件文档编制过程。用于帮助他们制定、执行和评估用户文档的管理工作。注: 其他ISO/IEC 265NN系列国际标准描述的文档编制和信息管理过程,是从文档设计人员/开发人员,测试和评审人员,需方和供方的观点阐述的。本标准适用于生产一系列文档的个人或组织,也适用于开发单文档项目的组织,同样适合团队内部以及外包文档编
9、制的情况。除了用户手册,帮助系统,以及单独软件产品文档集的开发和生产以外,它还适用于更广泛的文档管理情况,包括安装、实施、管理和操作软件的最终用户所需要的文档。通常情况下,用户文档管理者还负责用于如下情况的信息(内容管理)的开发和重用: 随着软件版本的更新,多次更新用户文档; 多次重用或调整信息以支持相关的软件产品; 用户文档多个版本的翻译或本地化; 同时管理组织内一组不相关的文档项目。本标准的目的不是提倡文件的印刷或电子(屏幕)媒体的使用,或任何特定信息管理、内容管理、文档测试,项目管理工具或协议的使用,而是要求是尽可能的媒体独立。本标准适用于包含软件系统的用户文档编制工作,也适用于单独的软
10、件用户文档编制工作。35系统与软件工程 用户文档管理者的要求1 范围本标准支持软件用户对文档一致性、完备性、准确性和可用性的要求。它为文档管理者提供策略、规划、执行和控制。它指明贯穿整个软件生存周期的用户文档管理过程。它也包括用户文档管理的关键过程,即文档编制计划和和文档管理计划。本标准提供了软件文档编制和用于文档编制的信息管理过程的概览。同时还描述了用于文档编制的组合计划和内容管理。具体来说,它专注于以下内容: 项目启动时的管理要求,包括建立过程和规范,建立基础设施,建立团队并列举用户文档团队所需要的角色; 文档管理控制所需的测量和估算; 对用户文档编制工作进行管理控制; 支持过程的运用,例
11、如变更管理,进度和成本控制,资源管理,质量管理和过程改进。参考文献中所列内容对管理、准备和测试用户文档的过程提供了指南。注1: 过程中所涉及的文档管理者和其它的相关标准有:ISO/IEC 26514:2008 系统和软件工程 用户文档设计者和开发者的要求,ISO/IEC 26513:2009 系统与软件工程 用户文档测试者和评审者的要求和ISO/IEC 26512:2011 系统和软件工程 用户文档需方和供方的要求。本标准适用于用户文档编制项目的管理者的使用,适用于拥有信息设计和文档开发人员的组织。本标准也可供其他角色和对文档编制过程感兴趣的人员参考: 软件开发过程的管理者; 购买供方文档的用
12、户; 经验丰富的编写用户文档内容的人员; 创建电子版文档工具的开发人员; 研究使文档更加方便和易用的人因分析专家; 电子媒体方面的平面设计师; 共同设计文档在屏幕上展现形式的用户界面设计师和人体工程学专家。本标准也可用于管理以下类型的文档,尽管它并没有涵盖所有的方面: 用于帮助用户、培训和销售的文档和用于产品设计和开发的系统文档,这些文档是基于用户文档主题重用的; 非软件产品文档; 使用动画、视频和声音的多媒体销售演示; 正式培训课程中使用的基于计算机的培训(CBT computer-based training)资源文件包和特定的课程教材; 描述系统软件内部运作的维护文档。注2: ISO/I
13、EC 15289:2011提供了关于生存周期过程中的信息项(文档)更详细的内容。2 符合性2.1 符合性的定义项目或组织如果声称符合如下两个标准:ISO/IEC 15288:2008 系统和软件工程 系统生存周期过程,或ISO/IEC 12207:2008 系统和软件工程 软件生存周期过程,本标准可以用作符合性文档。本标准可以根据项目实际需求,从必要性和成本效益角度进行裁剪。裁剪可能是采取指定的方法,目的是符合某些标准规范,裁剪也可能是修改一些建议和方法,目的是更明确的反映软件和文档编制项目的特殊性。需方提出的裁剪决策宜在合同中明确说明。注: ISO/IEC 12207:2008的附录A(规范
14、性附录)描述了裁剪的过程。在本标准中,“应”(shall)一词用于表达具有约束力的规定,“宜”(should)一词用于表达一种尽可能的建议,“可以”(may)一词表明某些行为在本标准限定范围内是允许的。用户文档的部分内容(例如章节、主题、页、屏幕和窗口)使用了本标准中的术语,可以不要求声称符合性。2.2 符合性的场景软件用户文档管理的符合性针对不同情况有不同的解释。无论组织或者项目裁剪了所选择的软件生存周期过程还是全部采纳,都可以声称其信息管理和/或软件文档管理过程符合本标准。组织声称符合本标准时,应识别出一些相关联的情况,应发表一份关于裁剪的具体内容的公开声明。注1: 对于引用了“文档编制计
15、划”字样的段落,组织可以采用的一种处理方式是,对于任何特定的文档编制项目应在项目计划中对他们进行解释。 当项目声称符合本标准时,项目计划或者合同应明确记录对文档编制需求的裁剪。注2: 项目声称符合本标准时,通常也谈及到组织的标准符合性。 在一个多供方项目中:可能没有一个独立的合同能够描述所有需要的文档管理活动,因此每个独立的项目不能声称标准符合性。如果每一个需要的活动都由一个确定的团队完成,那么作为一个整体,项目可以声称标准符合性。项目计划应记录对需要任务的裁剪,对各方的任务分配,以及本标准中涉及到“合同”的段落的解释。 当各方(需方、供方,或者生产方)同意根据本标准由供方管理文档编制服务时,
16、本标准可能被包含在合同或者类似协议中。项目或组织也可将本标准作为内部标准,根据本标准管理文档编制服务。3 规范性引用文件下列文件对于本文件的应用是必不可少的。凡是注日期的引用文件,仅注日期的版本适用于本文件。凡是不注日期的引用文件,其最新版本(包括所有的修改单)适用于本文件。ISO/IEC 15288:2008 系统和软件工程 系统生存周期过程(Systems and software engineering - System life cycle processes)ISO/IEC 12207:2008 系统和软件工程 软件生存周期过程(Systems and software engine
17、ering-Software life cycle processes)ISO/IEC 24765:2010 系统和软件工程 词汇(Systems and software engineering - Vocabulary)4 术语和定义ISO/IEC 24765:2010中界定的以及下列术语和定义适用于本文件。注1: 本标准中的动词“包括(include)”表示,包括(1)给出了信息,或者(2)列出了信息的参考资料。注2: 本标准中的术语“文档”是指软件用户文档。本标准提到的“用户文档管理者”或“管理者”,适用于执行所需用户文档管理活动的任何人,忽略他们成本管理的头衔或责任。4.1受众 au
18、dience一类具有相同或相似特征和需求(例如,使用文档的原因、任务、教育水平、能力、培训和经验)的用户。ISO/IEC 26514:2008注:文档可能也有一些不同的受众(如管理人员、数据输入人员、维护人员),他们决定计划中的文档的内容、结构和使用。4.2完备 complete“文档”包含了受众需要的所有关键信息和其他任何必要的和相关的信息。4.3配置管理 configuration management包含配置标识、控制、状态报告和审核的技术和组织活动。ISO 10007:2003质量管理体系 配置管理指南4.4内容管理 content management通过元数据来控制信息单元,在文档
19、或信息项中,通过可变的结构和格式,进行选择性的重用。示例: 用户文档的内容管理,即帮助主题的管理,概念的解释,问题处理流程,依从性声明以及像软件产品名字和主机运行平台这样的变量,用于格式化输出中的元数据标签。4.5关键信息 critical information描述软件的安全使用、用软件创建的信息的安全性的信息,或对由软件创建或存储的个人敏感信息进行保护的信息。ISO/IEC 26514:20084.6顾客 customer供方提供的产品的接收者。注1:在合同上,顾客称为采购方。注2:顾客也可能是诸如最终顾客,用户,受益者或采购者。注3:顾客也可以是来自组织的内部或外部。GB/T 11457
20、-20064.7文档 document一种数据媒体和其上所记录的数据。它具有永久性并可以由人或机器阅读。在软件工程中 的例子,包括:项目计划、规格说明书、测试计划、用户手册。GB/T 11457-20064.8文档集 document set为了易于分发或使用,被划分为可单独识别的卷宗或文件的文档的集合。ISO/IEC 26514:20084.9文档汇集 documentation关于一给定主题的文档集合。GB/T 11457-20064.10插图 illustration与文本的主体部分分离的图形,通常会在主文本中被引用。注:在本标准中,术语“插图”用作表示表格、图形、展览、屏幕截图、流程图
21、、图表、绘画、图标以及其他类型的图形的通用术语。4.11信息设计 information design开发满足用户需求的文档内容的过程。4.12本地化 localization创建一个国家或指定区域的产品版本。注: 翻译过程和本地化过程可能是分开执行的。4.13最小化原则 minimalism精简文档的方法,只包含要完成文档所需的关键信息和最少数量的其他信息。4.14规程 procedure指明如何执行任务的一系列有序的步骤。4.15过程 process将输入转化为输出的一系列相互关联或是相互影响的活动。ISO/IEC 12207:2008,definition 3.174.16项目 proj
22、ect开发一个新产品或增强现有产品性能的一系列活动。ISO/IEC 12207:2008,ISO/IEC 15288:20084.17产品负责人 product authority对产品的功能和质量负全责的某个或某些人。4.18风险 risk事件发生的概率及其后果。ISO/IEC 16085:20064.19质量 quality产品、服务、系统、组件或者过程满足客户或者用户需要、期望或需求的能力。ISO/IEC/IEEE 24765:20104.20步骤 step规程中的一个元素(有编号的列项),用来告知用户执行一个(或多个)活动。 ISO/IEC 26514:2008注1: 软件的响应不被认
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 系统与软件工程 用户文档管理者的要求 系统 软件工程 用户 文档 管理者 要求
限制150内