没有技术背景,如何做好文档工程师?

在我选专业的那年,过来人告诉我,选英语专业,进可攻退可守,可以当老师,可以当翻译,就业机会大大的有。在我毕业那年见证了就业的残酷后,才发现世界变化太快,还没起跑就被淘汰。


没有技术背景,如何做好文档工程师?_第1张图片
From Pixabay

自己也才正式踏入技术传播这个领域一年,算是个半吊子选手。从技术翻译转到技术写作,经历了阵痛期,迷惘期,现在开始可以带一波节奏。有时候,不免想起那些年我翻译别人写的技术文档时吐过的槽:啰嗦,没逻辑,狗屁不通。现在一轮回,到了我自己写,才发现真是当局者迷。

有人问过我,没有技术背景,可以写文档吗?以前我也怀疑过自己,但自从知道我们公司曾经有过体育专业的文档工程师后,我的自信心油然而生,好歹也算在IT领域浸润了3年之久。其实,在我认识的文档从业人员中,多半是语言背景出身,少数是具有很强的技术专业背景。我私心揣度这个原因是因为语言背景对文字有敏感性,可写中文,也可写英文,真心是企业节省成本的好帮手。

通常情况下,技术写作要求从业人员要有一定的专业知识储备,但是如果已然入行,但是却缺乏相应的经验,该怎么办呢?下面我就自己的经历分享下如何度过踏入这个行业的阵痛期。

动手写作前先做资料收集和研究


只有胸中丘壑,才能下笔如有神。技术写作不像是写小说,可以任想象驰骋千万里。也不需要让客户发出李佳琦般式惊叹:“oh my god!Amazing,盘他!盘他!!盘他!”。这个可以交给市场文案。技术文档首先要保证的是真实,基于技术事实,不能进行杜撰和夸大,以免引起商业纠纷或法律诉讼。

我们公司技术内容主要来源于研发、QA和产品经理。这些人往往都很忙,不可能就你的每个技术细节一一解答。有时候如果问的问题太过于浅显,会让他们觉得你不专业。我想,谁都不愿意处于鄙视链底端吧。不妨试试这样:

以最快的速度摸清公司的产品家族图谱:不必记得每一个性能参数或细节,但是至少在别人提到某一个产品型号的时候,你不会茫然到“我是谁?我在哪里?我要干什么?”。

了解公司的组织架构,知道遇到问题向谁求助可以最快解决问题:例如,入职后我的第一个挑战就是要讲解公司的展区产品。在询问到公司有销售是专门负责展区讲解后,我去向他请教了讲解思路和话术,他也不吝分享了他的讲解资料。通过对公司的三大产品线做了梳理,最终我还是在一周内能够清楚的讲解公司的产品和应用场景。在华为工作的几年,我深刻意识到,单打独斗是行不通的,团队合作才是保证任务质量的利器。

擅用搜索引擎:在互联网时代,遇到问题,先不论百度这些年做的恶,我想大多数人的第一反应都是“百度一下,你就知道”。专业搜索当然是首推谷歌,但是在不能科学上网的情况下,可以用必应国际版或者谷歌镜像网站。以前看过大神分享的搜索技巧,我也只是学到了皮毛,后面会整理学习心得分享给大家。

脸皮要够厚:如果公司的某些黑话或技术在网上也搜不到,那就还需要问下公司的技术专家们。面对忙成狗的他们,我的做法一般是把查证不到的问题统一批注下来,然后先礼后兵,先私信约时间,不回复就直接去工位找。相信我,时间就像海绵,他们挤挤总还是会分给你一点。不去,就意味着自己的工作推进不下去,耽误效率。

学习友商文档和业内写作规范


确定公司的友商。当无从下笔的时候,去友商网站查看/下载类似的文档。参考友商的文档结构,多对比几家,最终确定自己的文档架构。

规范不是死板,而是为了让呈现的内容更加一致。国内而言,华为的Style Guide做的最好,有相应的中文写作和英文翻译规范。国外的话,多数是参考微软、IBM的英文风格规范指南。

目前做的最好的行业组织应该是“TC互联”,他们的群里有很多业界的大咖和高校老师,会分享一些行业里比较领先的写作理念。我个人最喜欢的Bloger是作者“Lilian_Lee和Joy的未来十年”(两位在知乎上也有文章,感兴趣的可以搜搜),从她们的文章里学到了很多干货,希望自己有一天也能这样干货满满,给大家分享。最喜欢的企业公众号强推“中兴文档”,她们的公号里的技术知识传播不是使用干瘪枯燥的文字,有很多漫画,可以拉近人和技术之间的距离感。

总结


最近几个月忙于装修,疏于学习提升自己。和朋友聊天,谈到了30岁女人的职业恐慌。职场、家庭和个人,谁都想实现平衡,但是很难。我也不知道自己在私企的职业生命能够延续几年,但是与其让担忧包围,不如退而结网,好好用能力武装自己。听说立Flag和目标实现更配哦,那就立下来到年底的目标,期待不要被狠狠打脸:

1.精读5本技术传播相关书籍,并输出读书笔记

2.系统学习InDesign,制作新的彩页模板(即使公司决定不更换模板)

3.每月至少更新Blog两篇

4.减肥到110斤


From Giphy

你可能感兴趣的:(没有技术背景,如何做好文档工程师?)