Technical Writer

俗称,技术写手;融合写作技巧和沟通技巧,将复杂技术问题逐步拆解成容易理解的系列文档,这在企业级互联网公司中显得尤为重要,一个好的技术文档系统,能够帮助客户更快理解业务,上手工具使用,从而提升产品整体使用体验。

对于热爱分享的Programmer来说,这是散播影响力的重要方式,所以学习如何做一个好的Technical Writer对于技术人员生涯来说,是一个非常不错的选择。

在这篇文章中,我将大家介绍:什么是Technical Writer?如何成为一个Technical Writer?


什么是Technical Writer

概念

Technical Writer 是一个专业的活,负责简化复杂的技术系统,所以具体要做什么呢?

  • 系统介绍手册:比如:Rasa
  • 用户手册,比如:开源项目技术文档
  • 期刊文章,比如:知乎博文
  • 快速参考指南,比如:Quick Start
  • 白皮书,这个就比较复杂

对于技术人员来说,会为开源项目编写用户手册,期刊文章等,放开发者能够从多方面了解该项目的细节,从而快速上手,提高该项目的知名度(例如:Github star),此时会给自己一个正向的反馈,从而更有信心来继续完善该项目。这个也是快速积攒人气,宣传自己的方式。

Technical Writer 的目的

相信所有的技术人员都想成为大佬,这个必须依赖你的能力。尤雨溪在《怎么才能有尤雨溪一半强,该怎么学习?》中的回答提到,其实强并没有很明确的分界线,可是在大众眼光中看来,强可由在影响力体现,而编写优秀的技术博客就是一个产生影响力的方式。

不过回过头来,我们并不能抱着产生影响力的初衷来写技术博客,而是抱着钻研技术的态度来编写每一篇博客,这样才能让自己对每一个问题都有独特的见解,从而逐步提升自己的能力。

一定要成为Technical Writer

最好的学习方法

相信很多技术人员都在感叹,日新月异的技术根本学不完,这个月出的技术下个月就被颠覆了,如果过了三十该何去何从。可这是由于对技术不热爱,技术也是艺术的一种,而且这种艺术还能够改变世界,是一件非常酷的事情。纵观国外的技术氛围,有很多白发苍苍的技术大佬在各种论坛上分享这段时间工作的成果,我们也都在钦佩他们的之外在感叹30岁的危机。

发布高质量博客获得知名度,而知名度是继续学习发布博客最大的动力,良心循环是学习最好的现象。如果你是一个技术人员,快去尝试通过博客提升技术底蕴和知名度吧,相信你不会后悔。

行动力

有很多小伙伴,一开始说要学着写博客,可是很多都会卡在博客的搭建这个环节。会纠结到底是发布到哪个平台上比较合适,用什么主题比较合适,写博客的时间规划是多久比价合适等一系列的问题,曾经的我也被这些问题所困扰,迟迟没有开始。或许这都是需要有一个过程吧。

当你想要实现某个想法的时候,此时此刻是最好的开始,一定不要delay到某个特殊时期,大数据告诉我们,这很可能会夭折,行动力就是当你有某个想法时,just do it.

可能性

技术人员只做技术并不是一个好的方向,因为这样以后就只能做技术。技术人员以后可以有很多发展方向,比如技术管理层、架构师、咨询师以及资深技术人员,甚至在生涯当中有机会编写一本技术书籍,而这些方向一切的基础都是拥有足够的技术底蕴以及了解新技术现状。

而技术博客能够让技术人员探索当前热门技术的底层原理,结合自己的经验来剖析技术原理,让开发者能够从多个维度理解相关技术,这些都是能够给自己积攒知名度,对于以后找工作,公司提升基于来说都是一个非常不错的指标。坚持做好技术分享能够拓宽技术路线,给自己多个选择,消解国内的30岁危机。

所以啊,坚持初衷,坚持写技术分享博客可以拓宽技术人员未来可能性,让未来的我们走的更加悠然。

自制力

坚持 意见事情真的挺难的,至少对于普通人来说是这个样子。

相信有很多小伙伴都存在这样的苦恼,曾经制定过无数计划,都被遗忘在某个角落,等尝试过失败后却后悔莫及,为什么当初没有坚持下来。

我不想再这个样子了,管理好自己的时间,充分利用好一分一秒,做自己不会后悔的事情。我想,这件事情能够坚持下来,那什么事情我不能坚持下来呢?


如何成为一个Technical Writer?

之前跟一个出版过书籍的朋友聊过,如何写技术博客?他只给我说了一句话:先别管写的如何,写出来就是最大的成就。

所以,要成为一个优秀的Technical Writer,首先第一个就是要成为一个Writer,无论是不是优秀的。这也是为什么,我想要开始写,不想被周边琐碎的事情拖延开始的时间。

写就完事了

系统性

写文章和学习类似,都需要系统性。

如果你要开始写文章,我相信你肯定是写学习过程中的感悟,技术经验,而这些我相信都是应该高内聚的:在某一个领域内。如果能够在某个领域内坚持写下去,我相信未来的文章肯定会越来愈深入,逐步达到专家级的水平,而这个往往是与自己的实力相匹配。

学习要有系统性,写文章也需要系统性,让自己专注在某个领域内,不断的探索其中的难题,分享解决方案。

少点拘束

不同阶段拥有不同的表现,在写作上也是如此。

刚开始写博文,写出来便是最大的进步,其后不断的积累,经验会促使自己调整其结构以及叙述的方式,从而提升技术博文的可阅读性。

写作是一个螺旋式上升的过程,不要太在意当下写的不好,而是要在意当下哪里写的不好,从而可以调整,这样才能解决主要矛盾,提升自我。

博文不是一蹴而就

在工作和学习过程中,对于某个知识点的理解会不断纠错和加深的过程。

我把博文当成自己的知识库,是一个不断更新的过程。比如我对Bert的理解会随着学习和工作加深对其的理解,于是回头来重新调整内容,加深对应知识点的理解。

这是一个良性循环的过程,是一个系统性的活儿,是一个长期的活儿,需要坚持下来才会有爆发式的效益增长。

给自己的话

路走了很多遍,很多条,可是我一直在纠结哪一条是最好的。

其实选择一条路,坚定的走下去,这条路肯定是最好的路。


目录