01 什么是技术文档?
技术文档是企业内容管理和知识管理的重要组成部分。在工程领域,技术文档是指包含对使用者有用的、与产品或服务数据和信息相关的任何类型的文档。技术文档的主要目的是为内外部的使用者提供足够的信息,以了解产品的内外部依赖关系,并将概念、流程、技术和产品与使用者以“用户友好”的方式联系起来。
技术文档是一个比用户文档范围更广的术语,包括产品定义、结构和功能的描述、开发、生产、质量保证、使用维护等产品生命周期各阶段使用的文档,典型的技术文档有需求说明书、概要设计文档、硬件详细设计文档、软件详细设计文档、使用指导文档、故障处理文档、各类研究报告、建议书、图表、备忘录、手册、白皮书、技术规范等。
过程文档描述了产品的定义、开发、生产和测试过程,由内部使用者如市场营销人员、工程师、生产人员、测试人员使用,这些文档一般使用行业专用术语和技术专业术语。这类文档的例子包括各类开发文档、测试用例等。
用户文档是为最终用户创建的,是交付给客户的整个产品的一部分,通常是以使用说明书、维修手册、用户指南、指导手册或在线帮助的形式为不同水平的使用者提供关于特定产品或服务的清晰易懂的信息。与技术文档相比,用户文档的根本要求是通俗易懂,是以用户能够理解所提供的信息为前提。
02 技术文档的合规性挑战(CE认证)
一、法律、指令的强制要求
对于拟将产品进行CE认证或在欧盟市场销售的机械制造商,其机械产品一般适用于欧盟的机械指令2006/42/EC。机械指令要求机械制造商必须编制使用说明书,即所谓的“原始使用说明书”。Annex I 的1.7.4条款要求所有机械必须提供以欧共体官方语言编写的说明书,或者以其投放市场或投入使用的成员国语言编写的说明书(还要附带原始版本)。
二、标准要求
标准是有关各方(政府、职业安全健康管理部门、检测机构、用户和制造商)之间达成的约定。标准不一定具有强制性,但正确选择并遵从适用的标准可有助于并可认定机械制造商遵守了法律要求。如果使用者在使用机械的过程中发生了人身伤害,机械制造商很有可能会陷入产品责任诉讼,不符合适用的标准更有可能在法庭上被质疑为产品“不遵守”法律和指令要求。
与使用信息、使用说明书相关的A类和B类标准有:
ISO 12100:2010 Safety of machinery - General principles for design - Risk assessment and risk reduction
IEC 60204-1:2016 Safety of machinery - Electrical equipment of machines - Part 1:General requirements
IEC 82079-1:2019 Preparation of information for use (instruction for use) of products - Part 1: Principles and general requirements
其中,IEC 82079-1是使用信息领域最重要、最基础的国际标准,它规定了技术信息编制的原则、流程、内容、结构、媒介和格式及人员资质等,适用于各种类型的产品—从简单的一罐油漆到复杂的大型工业成套设备。
这些标准对使用信息、使用说明书等做了明确要求和规定。其中,合规性要求如下:
使用信息(含使用说明书)是机械必不可少的一个组成部分,应给予与机械的其他部分同样的关注和重视;
使用信息的合规性被视为机械合规性的一部分;
使用信息应促进机械的安全操作和维护,应有助于减少人或动物受伤或生病,以及产品损坏、故障或低效操作的风险;
如果使用信息存在缺陷(例如,不符合要求),作为一个整体,机械也是有缺陷的;
不充分的使用信息可能导致产品安全和责任风险。
三、挑战
国内不少科技类企业存在重开发、轻安全、轻文档的现象,一方面工程师更愿意进行产品研发等有创造性的工作,另一方面他们也很少能接受到技术文档、使用信息等方面的专业培训,对于相关标准中使用信息的合规、安全、内容等要求的研究不够深入、细致,因此造成文档管理及质量远滞后于产品提升。
更大的挑战是当企业在推进国际化发展、将产品销售到国际高端市场或产品做CE认证时需要根据客户或检测机构的要求反复修改文档,不仅额外增加了企业的运营成本和内外部沟通成本,甚至还可能影响到国际高端客户的信任,更为严重的是可能引起产品法律纠纷。
Safeguard的专业技术团队愿和您一起迎接这些挑战,为您提供使用信息、使用说明书有关的培训、编写、翻译、排版等服务。
上一篇: “他们”眼里的CE认证
下一篇: 可靠性的重要性