Foreword
2018 年 3 月 28 日的时候,我和 Queeny 一起回北京大学软件与微电子学院给在读的学弟学妹们做了一个分享。
之后一个学妹找我咨询论文相关的事情,因为她写的论文是关于技术写作的。我根据自己从事技术写作的一些经验和积累的知识,回答了她几个问题。然后她跟我说,“一般的人都以为咱技术写作就是写说明书的,学姐有时间了可以专门写一篇推送”。
当别人让你解释 Technical Writer 是干嘛的时,回答说写说明书的或许可以让对方快速理解。但那只是一个方面而已,并不能涵盖 Technical Writer 的所有工作。
Technical Writer 可能遭遇的尴尬
你有没有遇到过不知该如何给别人解释清楚 Technical Writer 到底是做什么的尴尬境地?尤其是当父母或其他长辈们问起的时候……
说的多了吧,他们可能理解不了,也不想理解;说的少了吧,他们可能觉得你的工作就是干这么点儿事儿啊。最后想想,算了,佛系回答吧~
之前跟大家分享过两分钟趣味解读 Technical Writer 的一个小视频,还附上了一个 Technical Writer 怎么跟别人解释自己的工作的漫画版。
最近还在网上看到一个用 DITA 写技术文档的 Technical Communicator 跟别人解释自己工作的对话,好奇的小伙伴可以去看一下。地址:https://techwhirl.com/integrated-technical-communications-a-map-to-better-understanding/
你以为的不一定是真的
很多尚未进入或者刚刚进入 Technical Writer 这一行的小伙伴可能对技术写作的种类仍然存在认知偏差,认为技术写作就只是写产品说明书的。同时,对 Technical Writer 这一职业本身的认识也有待刷新。
或许,用另外一个表达可以在某种程度上减轻这种认知偏差,即 Technical Communicator。
业内对这类岗位的叫法不一,Technical Writer 是相对来讲比较普遍的叫法,中文叫法一般为“技术文档工程师”,也有叫 Information Developer 或 Content Strategist 的,这样听起来就高大上多了有木有~
另外,这个岗位在有些公司是设立在研发部门中的。
这里所说的技术写作的种类 (Technical Writing Categories) 即 Technical Writer 可提供的 deliverables 的种类。
在分工很细的大外企里,Technical Writer 或许只负责某个技术写作种类中特定部分的工作,轻易不会改变。相比之下,在其它企业尤其是创业公司里,Technical Writer 这个名称就完全不能涵盖实际承担的工作了,已不能从传统的认知去理解。
有的外企 Technical Writer 或许工作几年也只接触到一种类型而已;而在快速发展的技术型创业公司里,Technical Writer 就会快速接触到多种技术写作的类型,虽然承担的工作内容多了,但有利于个人快速成长。
Technical Writer 到底在写些什么文档
如果细数起来,Technical Writer 写的文档包括许多种类,这里先跟大家分享一些常见的,你如果进入 Technical Writer 这一行很可能会接触到的文档类型。如下所示:
- User Guide
- Administrator Guide
- Troubleshooting
- FAQs
- How To Guide
- Release Notes
- Weekly
- White Paper
- Case Study
- Knowledge Base Articles
- Training Course Materials
只看上面这些词,或许有点一知半解。没关系,我会在稍后的文章中对这些文档类型做一个具体而直观的分享。
Afterword
时代在变化,行业和岗位也在变化,所以我们要经常地刷新一下自己的认知。
很好奇 Technical Writer 小伙伴们有没有这样的经历呀,觉得自己很机智地跟别人解释了自己的工作?
欢迎留言交流哦~
你可能想读:
技术文档诞生记 | 完整的技术写作流程是怎样的?
Technical Writer 日常工作中好用的小工具
技术翻译需要有 Technical Writer 的 sense
深度解析关于技术翻译的六个认知误区
如何让你的内容输出更加专业更有设计感?
书单 | 有哪些技术传播从业者必知必看的书籍?
有哪些适合技术传播从业者关注的优质博客?(一)
有哪些适合技术传播从业者关注的优质博客?(二)
经验分享 | 来自 11 位 Technical Writer 前辈的职业发展建议(上篇)
经验分享 | 来自 11 位 Technical Writer 前辈的职业发展建议(下篇)
英语技术文档的标题到底该大写还是小写?
如何使用正则表达式批量添加和删除字符?
Markdown:写技术文档、个人博客和读书笔记都很好用的轻量级标记语言
如何为 Markdown 文件自动生成目录?
技术写作实例解析 | 简洁即是美
两分钟趣味解读 Technical Writer
若脱离理解,直译得再正确又有何意?
优质译文不应止于正确,还要 Well-Organized
写在入职技术型创业公司 PingCAP 一个月之后
揭秘 Technical Writer 的工作环境 | 加入 PingCAP 五个月的员工体验记
-END-