技术写作弘丹21天零基础写作训练营

初入行的技术写作者还需要了解的几件事

2017-09-08  本文已影响54人  叶子写字的地方

这是《技术写作从入门到“转行”》系列文章之一。本系列文章还包括:《技术写作职业入门记》、《技术写作必备软硬技能》、《从技术写作到创意写作,那么远,这么近!》。以上文章可在我的简书文章中查看。说一下这个系列文章的写作初衷吧。

技术写作这一行,一晃就干了七年。回头去看,这段经历居然也有适应期、热恋期、平淡期和七年之痒。当一个周期结束,一切归于平静之后,挺想把这段经历记录下来。一则留作纪念。二则,常常会遇到初入行或者单兵作战的同行。他们其中许多如同我当年一样,有点迷茫,不太清楚努力的方向。的确,在国内,这个职业还是太冷门,无论是从业者还是学习资料都相对少的很。所以,作为过来人,我想我或许可以输出一点东西,虽不是什么高深理论,但至少都是实战经验。希望能给初入行的同行们一点参考一点启发,其中不足之处,也欢迎指正。

这篇文章的关键词依然是“入门”,主要想分享一下除了必备的软硬技能之外,初入行的技术写作者还需要了解的几件事。

三类技术写作者,从你最适合的那一类开始

几年前的一个夏天,我们正在招聘一名中文技术文档工程师。此时,有一名应届生通过微博和QQ群联系上我,表示对我们的职位很感兴趣。经过简单的面谈,我发现这位同学的英文水平不错,查阅英文技术资料肯定没有问题;从简历的写作和谈话过程来看,中文表达也没有问题;她有半年的技术写作实习经历,这属于加分项;她很主动,有强烈的学习愿望;可以通过公司招聘信息中的公司名称从QQ群和微博找到我,说明她具备我在上篇文章中说到的资料获取能力和即将要在这篇文章谈到的走到互联网上去,找到自己的同行圈子的意识。

唯一一点让我感到有些犹豫的是,专业相关的技术知识点基本没回答上来,但考虑到她的专业也属于对口专业,认为她在需要用到相关知识的时候补一下应该问题不大。于是发了offer。试用期的三个月,小姑娘确实表现出来对产品功能知识点理解的吃力,但是她非常认真,也很用功,团队合作的也很愉快。鉴于此,在转正答辩环节,我主动保她通过,领导也尊重了我的意见。可是,在后来的几个月中,作为正式员工,工作量和工作难度的增加,她的困难越发明显。半年后,她提出了离职。我们在最后的面谈中谈到了她的优势——英语,之前的技术写作实习也是以英译汉为主的本地化工作,所以,我们当时以技术为核心的中文技术写作对她来说,不是最合适的选择。

这是我在培养新人的过程中遇到的一个典型的失败案例。犹记得当时因为此事引发的一种挫败感而耿耿于怀了好一阵子。反思后得出结论,提示初入行者——目前,国内技术写作从业者主要有以下三类(其他语种的写作和翻译此处暂且忽略),请结合自身优势和劣势,选择你最适合最擅长的那一类开始。不用拼命去补自己的短板,在当今这个机会多变化快的社会,完全可以避开自己的短板,充分用好自己的长板,发挥自己的长处,让长更长,让优秀更优秀,依然可以有自己的优势。

1,中文技术写作:在国内多数企业中,这类技术写作者都属于必备类别。这类技术写作一般要求从业者具备相关技术专业背景,可以快速学习产品相关的技术知识,具备流畅的中文表达能力,英文水平可以查阅相关技术资料。

2,英文技术写作:这类技术写作者主要任职于国内的外企和第三方专业提供技术文档服务的公司。这类技术写作要求从业者具备流畅的中英文书面表达和口语沟通能力,可以理解产品知识。

3,英文技术翻译:这类技术写作者同样分布在国内的一些企业,一般和中文技术写作者配合工作。一般要求从业者具备流畅的中英文表达能力。

写好技术文档必备五字法则:学问用写改

在初学者中常遇见的一个现象是,收到一个写作任务,打开写作工具,就开始苦思冥想怎么一个字一个字往下写,包括我自己在刚开始实习的时候也进过同样的误区。那么,我们不禁要问,难道一个漂亮的技术文档不是靠“写”出来的吗?我的答案是不是。那又应该靠什么被弄出来的呢?我的答案是我的五字法则——学问用写改。

当我们接到一个文档写作任务时,应遵循“学问用写改”的五字法则来完成技术文档的开发。

学:开始写作之前,我们需要了解文档写作规范、工具使用方法、文档开发流程,还需要了解项目背景、产品功能架构及功能点细节。前者关于规范、工具和流程的信息,我们可以基本了解大概,在工作过程中逐渐熟知细节。后者关于产品知识,需要详细研读相关资料,进行功能点知识的攻克。

问:除了针对产品知识的提问之外,我们还应问清文档任务的需求,比如时间节点,发布形式,语言类型等。

用:实际使用产品

写:现在才到了“写”的阶段。先根据已掌握的信息按一定的逻辑确定文档大纲,然后撰写每一个Topic的内容。

改:实际情况中,可能“改”才是你工作的主旋律(不要问我怎么知道的,说多了都是泪)。首先,初稿写完之后的自我Review——改;小组内换一位同行Review——改;项目关键成员评审——改;质量或者测试再Review——改;项目变更——改、改、改!

这五个动作没有严格意义上的先后顺序,可能会相互交叉,反复进行。经过这五个字的摧残(哦No,是锻炼),你终于交付了一套漂亮的文档,像看着自己的孩子一样看着TA们被挂到网站,被印刷成册,被联机到软件……然后开心的去开启你的下一个轮回。

充分利用网络工具,找到同行圈子

开头提到的那个女孩,她在这方面就做的很好。通过招聘网站上的招聘信息,用公司名称在技术写作QQ群中找到我。进而通过我的昵称和头像(我所有平台使用同一昵称和头像)找到我的微博,与我直接联系,然后顺利获得工作职位。不说最终结局,只说她的做法。首先,有没有一点福尔摩斯的感觉?我们在搜集资料的时候,就需要这种福尔摩斯的精神,顺藤摸瓜,不放过任何蛛丝马迹。然后,我主要想说的是,充分利用网络工具,找到同行圈子。

上一篇文章中说到不要孤立自己,更广一层的建议是,走出你的企业,到互联网上去。在我们的企业中,我们通常是只有几个人的小团队,甚至孤零零的一枚单兵,可能存在感稍低一些。然而,在QQ、微博、微信、知乎等网络平台上,有许多我们的同行和前辈。他们有些人在自己的公众号和知乎中分享工作经验,有些人在群里交流、共享资源资料、举办线下活动等。找到他们,扩大我们的圈子,这无疑会正作用于我们的职业成长。网上看到一个段子,或许可以充分说明入同行圈子的直接好处,此处仅用于娱乐——A和B在各自的公司工作3年,均没有涨薪,一天,A把B推荐给A的公司,B把A推荐给B的公司,两人分别成功涨薪30%。

塑造你的个人品牌

最近“个人品牌”这个概念好火热。如果展开来说,这将是个很大的主题,此处我只做简单提示。作为一名技术写作者,我们也应该有塑造我们个人品牌的意识,通过合理的优势定位、持续的优势展示、持续的学习以强化优势,在圈子里形成我们自己的核心竞争力。

无论是商品品牌还是个人品牌,塑造的过程大体上可以从以下几个方面来进行。

1,找到适合你的优势定位:这一点和本文开篇说到的观点相同。找到自身优势,进入合适领域。

2,找到我们的目标受众:包括你企业内部的同事、领导以及与你有工作往来的合作方,另外就是网络上的技术写作圈子。

3,持续展示你的优势:我们需要持续展示的优势包括我们的个人特征标签和我们的内容输出。

特征标签:工作过程中给人留下的印象。比如:你很注重细节、你很有时间观念等等。

内容输出1:工作成果,即我们开发的技术文档。

内容输出2:以“写作”为生的我们,借助各类网络写作平台可以表达我们的观点,分享工作经验,输出工作所感所悟,各类工具某些具体功能的操作方法。

4,收集反馈,持续学习,升级个人品牌

如果爱,请深爱,若不爱,尽快离开

还要说到开头提到的那个女孩。她在那个岗位上很认真很用功的磨炼了半年,依然发现并不是很合适,经过深思熟虑之后,选定自己喜欢并擅长的方向,辞职考研。如今已经毕业,在广东的一所高校任教。

还遇到过一个女孩,计算机专业毕业,上学时也是一枚学霸,潜意识里认为这是一份技术含量低且没有发展的职业。于是,她一边上班一边学习前端开发。不管加班到多晚,回去也要把计划中的书看完,计划中的课听完,然后顺利跳槽成功转行。

这都是很好的例子。从业这些年,我也遇到过一些人,一边抱怨工作不好,一边糊弄工作交差,却从不见行动。作为过来人,我最后只想对初入行的朋友们说一句:如果爱,请深爱,若不爱,尽快离开。请相信一个擅于快刀斩乱麻的女汉子的忠告——永远不要和一个你不爱的或者你都瞧不上的人结婚,更不要委屈自己做一份你不喜欢或者你都瞧不上的工作。世间万物,道法相通!

上一篇下一篇

猜你喜欢

热点阅读