From Lilian:目前就职于 BAT、有十年从业经历的 Renee 分享她认为的一个合格的、优秀的 Technical Writer 最重要的四个硬本领和软实力。
From Emma:在技术文档领域,Renee 是难得的跨领域人才。首先在华为,是通讯设备和 ICT 领域;然后是 Splunk,是大数据分析软件领域;目前在 BAT,互联网领域。跨域既是挑战,也是资历。看 Renee 描述自身体验,如何成为一名优秀的 Technical writer 或 Info Architect...
作者:Renee
在 Splunk 工作的时候,有一次在美国参加部门团建,我们的高级总监说到,我有个习惯,每次我面试一个 Technical Writer 或者 Information Architect,都会问这个问题,你为什么选择这个职业?或者是什么契机,让你主动或者被动的做了这样一个选择?
这确实是一个好问题。Technical Writer 作为一个职业,并不像 Software Engineer、Designer 或者 Program Manager 那么广为人知。
在这篇文章里,我想通过这十年工作的观察,分析一下 Technical Writer 这个职位在企业中的作用,以及对这个岗位的素质要求。
职责范围
简单理解,这个职位负责输出公司官方技术文档。这个职位广泛存在于医药、电信企业、大型机械、企业软件等公司。
工作范围在不同的公司也有一些区别,在分工粒度相对粗的公司,Technical Writer 可能还负责比如 Copy writing 或者 UX writing 相关的工作。
但是在比较主流的互联网公司中,Technical Writer 基本都只负责售后文档或者部分界面文本的内容,很少涉及售前或者 Marketing。
职业技能要求
作为一个合格的 Technical Writer,我觉得最重要的是四个“硬本领”和“软实力”。
- 技术能力
专业能力是一个优秀的 Technical Writer 最重要的技能要求,也是与产品、开发和测试人员对话的基础。专业度越高的领域,对于入门的专业要求越高,比如航空、医药行业。
以我所在的互联网行业为例,Google 在面试 Technical Writer 时最基本的要求是要熟悉一门主流的编程语言并能读懂代码,在面试中,会拿出一段代码让面试者理解意思并描述这个功能。特别是涉及开发者文档的写作,熟悉一门编程语言,对 Linux 系统的了解,数据库的使用,都是必备的技能。
2. 信息结构设计及语言能力
Technical Writer 通过信息来帮助用户了解产品,这就需要具备文字表达及信息架构的能力。
业界有很多这方面的书籍和 Style Guide 可以借鉴。比较推荐 IBM 的大作 Developing Quality Technical Information,最小化以及结构化的理论,微软以及 Google 的风格手册。最近苹果也发布了最新的 Style Guide,是非常好的学习素材。
3. 以用户为中心的写作
作为产品的第一手使用者,写作人员往往是最先使用产品并发现用户在使用中容易出现哪些问题的人。
特别是一个新产品、或者新特性的写作时,作为写作者,搭建环境、反复体验产品使用中用户可能遇到的问题,在关键点以及用户需要时提供引导。
在 Splunk,我经常与 Developer 们在一处工作,给界面设计提供建议和写作支持,他们都觉得Writer就是开发部门的一份子。
4. 沟通能力
良好的沟通是 Technical Writer 很重要的一个软实力。Technical Writer 经常需要沟通的角色包括产品经理、产品开发、测试、服务人员、项目经理等等。
要向产品经理了解某个特性的完整功能、与开发了解实现手段、与测试沟通在使用过程中可能出现的问题、与服务了解用户最关心的问题以及与项目经理沟通交付时间。
更多时候要面临各方的 PK,需要付出巨大的工作热情,也可能伴随泪水......
在项目中,锻炼自己前后端沟通的能力,一个需求一个需求的理解,让自己在项目组中的作用发挥出来。
总结
技术文档工程师常常开玩笑说自己是万能的。
技术能力和写作能力双赢,有用户视角,又乐于沟通,这其实就是通往强者之路啊,万能也不是空话!
--END--
猜你想读:
征稿启事 | 技术传播圈故事征集
什么样的人适合做 Technical Writer?
英语专业的同学可以做技术文档写作吗?
技术文档诞生记 | 完整的技术写作流程是怎样的?
Technical Writer 可提供的交付物有哪些?
免费学习资源推荐 | Google 面向工程师的技术写作课程
Write the Docs:连接技术文档人的全球社区,附海量学习资源
GitHub + Markdown 的新轻型技术写作模式速览
GitHub + Markdown 的技术文档方案深度解析
Technical Writer 日常工作中好用的小工具
技术传播人士应该知道的色彩搭配常识
如何使用颜色来提高技术文档的可读性?
Technical Writer 如何 Review 技术文档?| 重细节+全局观
技术翻译需要有 Technical Writer 的 sense
深度解析关于技术翻译的六个认知误区
如何让你的内容输出更加专业更有设计感?
书单 | 有哪些技术传播从业者必知必看的书籍?
有哪些适合技术传播从业者关注的优质博客?(一)
有哪些适合技术传播从业者关注的优质博客?(二)
行业动态 | 国内有哪些高校开设了技术传播或技术写作课程?
IEEE ProComm 2019 国际传播大会上,中国代表团有哪些精彩分享?
行业动态 | 2019 中国技术传播论坛上,大家都在谈论什么?
优质免费资源推荐 | 9 期技术写作短视频教程带你从入门到进阶
经验分享 | 来自 11 位 Technical Writer 前辈的职业发展建议(上篇)
经验分享 | 来自 11 位 Technical Writer 前辈的职业发展建议(下篇)
Technical Writer 想参与开源项目为文档做贡献,需提前掌握哪些知识?
Technical Writer 如何参与开源项目的文档,以不断提升专业技能?
为什么 Technical Writer 也要学编程?荐书《译者编程入门指南》
技术传播沙龙精彩分享 | 高校老师与行业大牛谈“互联网技术写作”
经验分享 | 对用户文档进行伤筋动骨式的重构是怎样一种体验?
英语技术文档的标题到底该大写还是小写?
不同阶段如何应对 Technical Writer 的职业顾虑或烦恼?
如何使用正则表达式批量添加和删除字符?
如何使用正则表达式批量删除多个 Markdown 文件的指定行?
英语技术文档中如何正确使用时态?
英语技术文档中如何正确使用人称?
英语技术文档中如何正确使用无序列表和有序列表?
Markdown:写技术文档、个人博客和读书笔记都很好用的轻量级标记语言
如何为 Markdown 文件自动生成目录?
技术写作实例解析 | 简洁即是美
两分钟趣味解读 Technical Writer
若脱离理解,直译得再正确又有何意?
技术文档翻译实例解析:始于翻译,经于沟通,终于易用
优质译文不应止于正确,还要 Well-Organized
Technical Writer 处理技术文档时,如何避免内容理解问题?
Technical Writer 需要 Technical 到会写代码吗?
如何利用 GitHub Pages 和 Hugo 轻松搭建个人博客?
写在入职技术型创业公司 PingCAP 一个月之后
揭秘 Technical Writer 的工作环境 | 加入 PingCAP 五个月的员工体验记