根据维基百科，技术写作的定义是“撰写或起草用于技术和职业领域的技术交流[...]”。 技术写作可应用于计算机编程应用、复杂工业机械的精确操作或用户手册等广泛领域。 用简单的英语来说：技术手册写作以简洁、明确和全面的书面格式总结了制作装配说明和/或产品功能文档的过程。 除了硬拷贝格式之外，用户越来越多地通过数字媒体访问技术手册和用户指南。 YouTube 上的讲解视频正在蓬勃发展，越来越多的品牌开始创建虚拟或 3D 用户手册。
1. 用户研究：了解谁在购买产品、谁在设置产品以及将在什么情况下使用该产品？
在开始编写客户手册之前，我们会问自己：该产品的用户是谁？ 除了实际用户之外，是否还有其他相关受众（例如，产品是否由专业人员安装？）。 了解使用上下文将有助于创建更好的手册。 宜家以一种非常微妙的方式做到了这一点：
这家瑞典家具巨头知道，其客户可能会在晚上（白天购买的商品）或周末组装新家具。 此外，许多宜家产品需要许多组装步骤。 新手用户可能需要相当多的时间来整理他们的生活空间的最新补充。 基于这个简单的洞察，宜家决定展示最终一件家具的图纸，作为其手册的第一步。 您可以在下图中看到这一点。
来源：宜家
“比利”书柜的新主人首先看到的就是完全组装好的产品。 下一步，宜家将提供有关如何拆包和布置不同组件的指南。 宜家这样做是有目的的：想象一下您上次打开 500 块拼图时的挫败感吗？ 无论您多么期待完成拼图，当您打开拼图的塑料袋时，您可能会感到有点不知所措。 通过以突出最终结果的方式构建手册，宜家增加了印刷成本，但减轻了对失败的恐惧。 通过提醒他们面前的所有松散部件将很快变成“比利”书柜，“比利”的新主人将感受到动力并专注于目标，而不是担心所有松散部件。
一个基本因素是使用正确和适当的语言。 手册的书写语法是否正确并且易于理解？ 考虑到产品的背景以及首次用户预期的技术理解水平，是否使用了适当的术语？ 尤其是在制作多种语言的手册时，这可能是一个挑战。 我们都有过阅读一本似乎直接来自谷歌翻译的手册的挫败感。 向用户提供技术复杂、措辞不当或语法错误的文档，往好里说可能会让客户感到困惑，往坏里说可能会损害您品牌的声誉。
编写有效的技术手册的另一个障碍是优秀的语言和写作技能往往是不够的。 作家确实还需要具备技术背景才能完全掌握复杂机械的操作原理。 因此，虽然您的文案撰稿人可能擅长“文字创作”，但他或她可能不是您产品技术方面的专家。 在编写真空吸尘器手册时，不知道空气瓦数 (AW) 的定义，或者一定量的空气瓦数转化为什么吸力水平将是一个问题。 为了避免这方面的缺陷，在 Impala，我们特别向所有客户索取详细的产品规格，并且只与接受过技术培训的撰稿人合作：我们 75% 的全职技术撰稿人拥有大学技术学位。 沟通。
经常被忽视的一个方面是真正本地化产品手册的重要性。 尝试以目标受众使用的格式提供测量单位。 对于大多数国家/地区，使用公制系统（米和克），但在为英国、美国和其他用于测量英尺、英寸和磅的国家/地区创建文档时，使用英制系统。 如果您不确定哪个国家/地区使用哪个计量单位，您可以参考此概述以确保您的选择正确。
在 Impala，我们相信最佳实践本地化只能从转换测量单位开始。 当我们为客户本地化用户手册时，我们试图了解文化因素如何影响产品的使用。 例如，搅拌机将用于制备清爽的冰沙，还是制作美味的热汤？ 提示：在后一种情况下，在用户指南中包含有关搅拌机可承受的最高温度的信息至关重要。
此类细节可以对用户体验产生重大影响，并有助于营造积极的品牌情绪。 由于消费者的购买决定通常受到个人推荐和/或评论的影响，这也将间接有助于增加销量。 根据最近的一项研究，67% 的消费者受到在线评论的影响。 因此，权衡品牌的营销预算与“客户体验”预算非常重要！
我们 Impala Services 的跨国团队在质量保证和测试方面拥有丰富的经验，并且始终关注我们的客户，帮助他们发现需要包含在产品手册和组装说明中的关键本地化要求。 请与我们联系，了解我们的翻译和本地化团队如何帮助缓解为多个国家/地区制作技术手册时的可用性问题。
图标、标签、符号、插图和标注可帮助用户浏览技术文档。 下面的示例显示了 Tesla 手册的一页。 所显示的触摸屏图像标有数字，以便读者更容易理解触摸屏上显示的哪些元素在手册的哪个部分中进行了解释。 特斯拉还使用直观的图标（即锁）来让用户更容易浏览。
人们还可以注意到第一段中使用了“警告”标签。 规范手册和产品包装上正确使用警告和能源标签。 准确标签的显示取决于产品销售国家的行业或法律框架。 在 Impala，我们有严格的流程来确保技术文档符合这些合规标准。 我们的合规团队就正确使用警告和能源标签向客户提供建议。 这听起来似乎是一个微不足道的技术程序，但实际上，如果出现错误，品牌和进口商可能会付出高昂的代价，因为产品召回甚至法律诉讼的成本可能会很高。
来源：特斯拉
