分类: 中文版

当你买了一件新产品,一定会首先打开它的说明书,找到自己熟悉的语言,学习如何安装、如何使用它,但是你一定不会去想它的作者是谁。

当你想了解一个软件产品时,一定会查看它的用户指南或操作教程,但是你只会把它当做某公司的产品,却不会关注是谁写了这些指导文字。

user manual

这些帮助我们快速了解某个产品、掌握如何应用的文档就是技术文档。它们的作者就是技术作者。

随着全球经济信息化、智能化的深入发展,技术文档在产品与服务中扮演着越来越重要的角色。大家对于技术写作的关注度越来越高,但是许多人对于技术写作却一知半解。

那么,到底什么是技术写作?它们的作者又是什么样的人呢?

简单地说,技术写作生成的文档,可以帮助普通读者了解如何使用一个复杂的产品或服务。

技术写作创建的文档有哪些?

• 用户指南

• 说明书

• 白皮书

• 产品规格

• 视频教程

• 图像示例

• 交互文字

• 在线课程

• 其他此类材料

如何把复杂的内容简单化?
 技术写作人员必须清楚文档的目标用户,了解所写文章的主题和目标;
 从已有的文档、自己的研究,与相关专家的研讨,以及操作实践中收集信息;
☑ 熟悉产品公司和行业内的书写规范。

同样是写作,但是技术写作与一般的写作有很大不同,很少有人因为技术写作而声名鹊起,可以说,技术作者是世界上最低调的写作者

许多人认为技术写作更重要的是内容简单、一致、清晰,而不是创造性。然而,正如许多艺术家所指出的,创造力来源于限制。正是由于限制的存在,才能激发出作者的创造力,打破局限。

对于技术写作人员来说,他们不会特别在意受到的约束,而是将这一工作视为与他人沟通、传递信息、增进理解的机会。因此,可以说技术写作搭建起了用户和产品之间的桥梁。

technical writing

一个优秀的技术作者是客观和冷静的。美国著名作家 Kurt Vonnegut 曾说过:“技术作者经过培训后,在他们的作品中几乎不会透露自己的任何思想。这使得他们成为写作领域的怪胎,因为世界上几乎所有其他沾墨水的人都在不遗余力地向读者展示自己。” 然而,他继续说到:“如果你以任何方式表达自己的想法,读者就会觉得你并不关心他们。”

好的技术写作也并不是要完全掩饰自己,而是要与受众建立同理心。因为毕竟,技术作者要把自己置于读者的位置来进行写作,并且低调、巧妙地表明他们关心读者的感受。

technical writing

通常,工程师会被安排为自己的产品编写技术文档。表面上看这很合理,毕竟,谁能比产品的创造者更了解该产品的内部工作原理呢?但事实上,那些最熟悉产品或技术的人并不能最好地向普通人解释它的用途。

从某种意义上说,技术作者的使命是成为一个专业的新手。他们必须像第一次接触每个产品、服务或技术。然而,这其中也存在着矛盾之处:技术文档必须通俗易懂,但同时也要传递出公信力和权威性。技术作者在充分了解相关产品的情况下,也要懂得换位思考,从读者的角度去看问题。这绝不是一件容易的事。

technical writing

技术文档作者通常来自不同的背景——科学、IT、语言学、文学等等——并且拥有多种技能。正如美国科幻作家 Ted Chiang 所说的那样,他们都怀有一种 “想把一件事情解释清楚的渴望”,并且对语言充满热爱。

 

本文由华也国际市场文案 Shirley Guo 编译

Related:  对话北大教授李沉简博士:疫情后的远程教育何去何从?

Leave a Comment

评论

    Webmentions

  1. 如何写出一份可读性好的技术文档? – Simply CSOFT

    […] 前面我们介绍过, 技术写作就是帮助普通读者了解如何使用一个复杂的产品或服务 。如果某个产品的文档信息非常易于理解和使用,那么用户的信息体验自然会提升,也会有利于增加产品在市场上的受欢迎程度,甚至影响一个公司在行业内的形象,所以现在越来越多的企业都非常重视产品的技术文档开发工作。 […]