最新消息:想上头条?没问题,只要你给本站投稿就行啦~

什么是技术文档写作?

原创 ChinaTechWriting 3673浏览 0评论

按照维基百科的定义,技术文档写作(Technical Writing)是技术沟通(Technical Communication)的书面表现形式,后者广泛存在于各种技术行业或领域中,如计算机硬件和软件行业、工程领域、化学行业、航空业、机器人行业、金融业、消费电子产品行业和生物行业等。

如果说维基百科的定义让你觉得太抽象的话,这么讲吧,小到一部手机,大到一架航天飞机,它们一般都带有相应的操作手册,你可以简单认为这些手册就属于技术文档写作的基本范畴。负责撰写这些手册的人,即技术文档工程师(Technical Writer)。

技术文档写作这个职业存在的主要理由在于,多数产品都必须以一种普通用户能够理解的方式来教会大家如何使用。简单来说,产品在交到用户手上时,至少要有使用说明,不然厂家就得疲于应付客户的频繁咨询请求。也许有人会提出疑问:直接让研发产品的工程师包办使用说明的撰写不就行了么,他们就是最了解产品的人群啊?理论上是可以这么做,事实上也有人这么做。如果你的产品并不复杂,也不庞大,也许你可以这么做。但是,所谓术业有专攻,你让研发人员为一个大型ERP系统撰写操作手册,是不太合适的,因为研发人员的关注点和思维方式决定了其更侧重于技术实现原理和细节,而不是将复杂的技术以通俗的方式解释给最终用户。技术文档工程师未必对产品的技术细节非常了解,但他们善于从用户的角度来思考,能够写出最终用户看得懂、用户体验良好的使用说明。

从广义上说,技术文档写作并不仅限于文本的创作,它还包括了产品截图和演示视频等更丰富的形式。所谓一图胜千言,很多时候,一张精美的截图可以省去很多解释的笔墨,说明的效果更好。产品使用说明也不是唯一的写作内容范畴,技术文档工程师往往还要负责撰写产品白皮书、发布说明、产品规格说明书,演示PPT等材料。

技术文档写作的质量要求可以归纳为三点:准确、规范、简要。准确是最重要的一点,想像一下,如果你拿着一本错漏百出的说明书去驾驶航天飞机,会造成什么后果。规范,指的是语言措辞上的表达要清晰,不要写成专家才看得懂的论文,也不要满篇都是口语化的风格。简要,目的是提高用户阅读体验与信息查找效率,太多废话、过多修饰的说明书不是好的说明书。

技术文档写作对从业者技能上的要求可以分为三大方面:基础的书面表达能力,专业领域的知识水平,以及人际沟通能力。顾名思义,既然叫做“写作”了,肯定要对书面表达有一定的要求。如果你没法准确、规范、简要地用文字来介绍一件事物,也许你就不太适合当一名技术文档工程师。另外,不同行业都有自己的专业知识门槛,你让一个非医科背景出身的人去负责撰写各种药品和医疗器械的使用说明,这个风险是很大的。多数行业都倾向于选择文理兼修的人作为技术文档工程师,尤其是欢迎理科出身但又文笔好的人。然而,现实是,技术文档工程师群体中,文科出身(如英语专业)的比例相当高。这个现象其实也很好理解,理科出身的人,更愿意从事技术类的岗位,而不是做写文档这种在他们眼中看起来技术含量不高的工作(当然了,我们必须认识到技术文档写作也是有技术含量的)。人际沟通能力方面,鉴于技术文档工程师在内部需要频繁与研发人员和其他部门人员沟通产品问题,对外有时候还要倾听用户的反馈,因此良好的沟通能力也是一个重要的考量点。

薪酬方面,国内外差距不小。在国外,技术文档写作属于较为成熟的行业,从业者也有自己的行业组织,如STC(全称为Society for Technical Communication)。国外的技术文档工程师薪酬水平是与很多技术性岗位看齐的。美国劳动统计局的数据显示,截至2013年5月份,美国的技术文档工程师年收入中位数为67,900美金。就中国内地而言,月薪从三四千人民币起步,到两万都有,高端收入群体偏少。究其原因,主要是国内多数企业对文档的重视程度还不够高,导致相关从业人员在薪酬上的诉求难以得到满足。另外,国内这个领域的从业群体还非常小,也没有诸如国外STC这样的行业协会,技术文档工程师们难以相互交流学习,共享包括薪酬在内的各种信息。好消息是,随着中国对外开放与交流程度的加深,越来越多的企业认识到文档的重要性,国内技术文档工程师同行的薪酬水平总体上是处于上升的趋势,工作机会数量也在稳步增长中。

中国的技术文档写作工作机会主要集中在一线城市与IT行业(含外包)较为发达的地区。北京、上海、广州、深圳是机会较多的四大城市,此外杭州、南京、天津等城市也有一些,剩余的城市机会就很少了。高端岗位则明显集中在北京和上海。根据百度招聘搜索的数据,截至本文写作时,仅前面提到的这7座城市就占据了全国大约74%的技术文档工程师招聘机会。按照具体行业划分比例的话,IT行业提供了一半以上的技术文档写作工作岗位。如果你想进入这个领域的话,这些数据还是有较高指导意义的。

总体而言,国内的技术文档写作行业还处于起步阶段,潜力巨大。这个行业要想发展壮大,还有赖于各位同行的共同努力。在此,中国技术文档写作资讯网也希望这篇文章能够起一个抛砖引玉的作用,让更多的人意识到技术文档写作领域、技术文档工程师群体的存在,让中国企业的产品文档与内容管理早日达到国际一流水平。


原创文章,版权归作者所有,转载请注明本站以及作者名称,并保留原文链接

本文链接:http://www.chinatechwriting.com/what-is-technical-writing/


The following two tabs change content below.
ChinaTechWriting
中国技术文档写作资讯网官方账号
ChinaTechWriting

Latest posts by ChinaTechWriting (see all)

发表我的评论
取消评论

表情

Hi,您需要填写昵称和邮箱!

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址

网友最新评论 (2)

  1. Monica Xie
    写的真好啊!我又拜读了一遍!
    Monica Xie4年前 (2014-11-07)回复