作为 2001 版 EN 62079 的替代版本,ISO/IEC 82079-1“编制使用说明书”是一个所谓的标准。IEC 82079-1 标准不仅适用于特定产品或行业,也包含适用于几乎所有工业领域的跨行业规则——这一概念对此标准的内容具有决定性影响。
很多用户都希望从此标准中准确获悉使用说明书应包含哪些内容。最常见问题就是“这个或那个应被包含其中吗?”但是 IEC 82079-1 对于这个问题的回答非常有限——因为它更多地是阐述“如何”编制使用说明书,而较少阐述编制时应包含哪些内容:
- 如何编制使用说明书,也就是说怎样才能编制出高品质的使用说明书?
- 技术文档工程师和译员应具备什么资质?
- 使用说明书应采用何种编制格式,应使用哪些字体,在布局和分段时应注意哪些方面,应使用何种语言风格?
- 使用说明书的安全信息应采用什么结构,如何对其进行设计和突出显示?
IEC 82079-1 是按国际标准展示技术信息传播领域当前技术水平的尝试。从德国观点来看,IEC 82079-1 只取得了部分成功。因为,该标准的大部分内容都没有为专业编辑工作带来惊喜,而是老生常谈,并且单薄得有些让人失望。尤其是有关文本易懂性和插图质量及电子媒介使用的规定。但此标准的好处和意义主要在于其存在本身,因为它不是毫无意义的摆设,而将被作为编制使用说明书的最低标准。很多公司的实际操作已经超过了该标准,无需任何改变,而有些公司则必须作出很大努力才能达到该标准。
IEC 82079-1 标准包含七个主要章节,第 4 章到第 6 章是其“核心内容”。下表为内容简介。相对于先前的标准,IEC 82079-1 的内容增加了近一倍。
ISO/IEC 82079-1 的内容 | |
---|---|
章节 | 内容简介 |
1 - 应用范围 | 阐述标准的适用范围及其目标群体 |
2 - 规范性应用文件 | 包含 IEC 82079-1 中所引用标准的列表 |
3 - 概念 | 包含重要概念的定义,其中很多都是新概念 |
4 - 原则 | 包含基本规定,比如 • 使用说明书的提供方式 • 技术文档工程师和译员的资质 • 风险最小化 • 目标群体分析 • 媒介及其可用性 • 适用于不同产品型号的使用说明书 • 术语、语言和译文 |
5 - 使用说明书的内容 | 包含适用于以下几个使用角度(生命阶段)的典型内容列表 • 运行准备工作(运输、存储、安装、调试) • 运行(正常运行、紧急情况、错误查找和故障排除) • 维护、维修 • 拆卸、回收、废物处理 但这个列表只是给出一个粗略框架。此外,需要始终将专门针对该产品的各个标准纳入考虑。按生命阶段确定内容这一明确定位也对说明书内容提出了若干要求: • 产品识别信息和变更信息 • 安全信息和产品一致性 • 随货附送的配件、耗材和备用件信息 • 所需特殊工具或装备的信息 |
6 - 使用说明书的演示 | 包含对以下几点的基本规定: • 易懂性 • 可读性(字体大小) • 插图质量 • 图形符号和安全标志 • 表格设计 • 文档类型和电子媒介 • 突出显示安全信息 • 颜色使用 |
7 - 一致性评估 | 包含检查使用说明书与 ISO/IEC 82079-1 中的要求是否相符的方法建议 |
流程相关规定: “编制使用说明书”这个标题具有误导性,已屡遭诟病。IEC 82079-1 看似包含对使用说明书编制流程的阐述和规定,虽然事实并非如此,但该标准中的确已经加入了几条与流程相关的规定。
标准第 4.3 节要求必须在编制使用说明书之前进行风险评估,且必须在使用说明书中阐明发现的剩余风险。这一条显然与编制流程相关。这条新规则可帮助尚未得到设计和开发风险评估但必须调查安全信息的技术文档工程师索要前期风险评估。
第 4.4 节与 4.8.2 条均要求在编制使用说明书之前进行目标群体分析。目标群体分析是后续语言选择决策 (4.8.3)、必要内容决策 (4.8.2.2)、术语决策 (4.8.2.3) 以及若干使用说明书信息共享决策的基础。此外,目标群体分析还可决定使用说明书的形式,即媒介选择——4.7.3。
质量相关规定: 此标准的目标之一,是为使用说明书编制确定一个可实现且可核查的最低质量标准。因此,它包含大量有关可读性、插图质量、段落和结构划分或者文本易懂性的规定。EN 62079 中也有类似规定。 IEC 82079-1 有两个小节对使用说明书编制参与人员的资质做出了规定。技术文档工程师最低要求参见 4.2 节,他们必须 具备强大的沟通能力,尤其是在技术信息传播方面; 牢固掌握所使用的源语言; 熟悉与所介绍对象相关的专业知识; 具备与使用说明书编制相关的流程组织知识,并且有能力贯彻落实此标准中的要求。
这些要求极为重要,尤其在国际平行标准中;最后还明确指出只有经过技术信息传播培训的专业人员才能编制使用说明书。但是,对于以培训方式还是进修方式取得所要求的知识能力,这里未作要求。但 IEC 82079-1 明令禁止不具备资质的“旁人”参与使用说明书编制。
使用说明书译员资质也需满足类似要求。基本要求参见 4.8.3.3 条,其标题为“翻译质量”。此标题具有一定误导性,因为这原本不是此标准中应包含的主题,因为有关翻译质量和译员资质的标准要么已经具备,要么应另行编订。但这里仍有必要将其列入最低要求。译员必须 具备基本沟通能力,尤其是在技术信息传播方面; 熟悉与所介绍对象相关的专业知识; 流利掌握源语言和目标语言,其母语最好是目标语言。 最后一条标准是经常被讨论的翻译艺术“金砖”定律,在这里首次被放在次要位置。因为,译员熟悉技术信息传播特征似乎更加重要。有些高等院校(比如:科隆高等专科学校)已经开始向译员提供使用说明书语言特色培训。译员专业知识具有不可替代的地位,但往往容易被忽视。上述问题的根本原理是:如果译员不能理解和解释原文,必然无法正确翻译。
下表列出了翻译警告提示和安全提示时技术文档译员应注意哪些章节。
必读 | |||
---|---|---|---|
章节 | 内容关键词 | ||
1 | 适用范围,也指明本标准的目标 | ||
3.19、3.34、3.37、3.43 | 重要的新定义,关于使用说明书、安全提示、专业人员、警告提示 | ||
4.2、 4.8.3.3 | 对技术文档工程师 (4.2) 和译员 (4.8.3.3) 的资质要求 | ||
4.3 | 在编制使用说明书前进行风险评估 | ||
4.4 和 4.8.2 | 在编制使用说明书前进行目标群体分析;受目标群体分析影响的决策 | ||
4.8.1.2 | 介绍若干产品型号的使用说明书 | ||
5.5 和 6.8 | 更新的安全信息编制规定 |
警告提示和安全提示相关规定: 此前,也许大家对于修订警告提示和安全提示编制规定的期望最为迫切。5.5 节以“安全信息”为标题,其中正好包含对警告提示和安全提示编制的系统化规定。同时,“安全信息”也是我们必须习惯的一个总属概念。
安全信息指安全标志,比如产品上的标牌;安全提示,尤其在安全章节中和使用说明书上下文中的警告提示。这三类信息必须满足一些特殊要求。
很遗憾,列表中没有包含用可视、可听或可触方式提供安全信息的信号和警告装置。下一版标准中,需对这一内容进行完善。 安全提示需要合理分类。因此,它们必须出现在使用说明书开头的章节中,并在标题中清楚标明其安全相关性 (5.5.2)。这是首次在国际性标准中专门提出“安全章节”要求。
在内容方面,要求使用说明书中至少包含安全使用相关信息、危险提示、危险避免方法及其可能引发的后果 (5.5.1)。但在选择安全信息时必须以危险评估为基础 (4.3)。
在附录(即各部件的使用说明书)中应该包含单个部件的相关安全信息。如果因为单个部件集成导致组件层面存在新风险,则应该提供相应组件层面的安全信息。
在对单个部件使用说明书进行整合时,安全提示应始终只出现在与所涉风险切实相关的使用说明层面 (5.5.4)。这个条款是首次尝试规定附录层面上的安全指示这一复杂主题。遗憾的是,它提出的问题比给出的答案还多:应如何具体划分使用说明书中的信息?是否可以有多个安全章节?交叉引用是否也可能满足使用说明书其它部分的需要?由于若干个设备零件在功能上相互影响,在操作或维护时某个单个部件上所存在的风险也有可能对设备构成威胁,那么应如何编制相应的警告提示?
简而言之,使用说明书中必须包含与所述操作相关的所有安全信息 (5.5.5)。
警告提示应出现在使用说明书中可能涉及危险的操作说明中,旨在给出相关指示 (5.5.2)。应包含以下内容:
- 一个信号词 – 危险、警告或小心,其含义与 ANSI 和 ISO 3864 中的规定含义相同(5.5.2 未提及,但在 6.8.3 有相关说明)
- 危险
- 可能后果
- 补救措施(5.5.2 未提及,但在 6.8.3 中有相关说明)
6.8.3、6.8.5 和 6.8.6 中有关于警告提示设计的说明。其中最重要的两点是: 并非必须使用安全标注颜色和 三角警示牌应始终出现在信号词前方。 遗憾的是,该标准未将警告提示相关要求归纳在一起,而是分布在不同小节中。此外,很多技术文档工程师对于高度的设计自由感到惊讶,因为有些人原本以为、甚至期待 IEC 82079-1 会有更严格的规定。而那些希望使安全和警告提示(安全信息)设计与其使用说明书布局和排版设计相符且相匹配的人员则对此深感高兴。
我们需要做些什么? 首先,每个人都应仔细理解此标准。我们可以分三步找出 IEC 82079-1 所带来的改变:
- 进行标准/实际对比
- 编订措施目录并确定优先顺序
- 编订实施计划
德国技术信息传播协会 (tekom) 已经编制出了大量评注,它们可协助技术文档工程师理解此标准,并正确解释其中内容。此外,协会大会上还会进行其它专题报告。 目前,互联网上已经可以搜索到大量培训项目和阅读材料。2013 年春,将举办名副其实的“82079 宣传”活动。为取得总体认识,每个人都应该先弄清楚自己的知识缺口有多大。最好的方法就是先通览一遍新标准,并用文本标记工具进行备注。即使是“老手”也能在此过程中取得新的发现:这个新标准并非全是新内容,而是在很多方面有了更深刻、更细致的阐述。
评论 (0)
无评论发表评论