我们为什么要技术写作

我知道,相对于写字这件事,更多的技术工作者更喜欢写代码,甚至有的同行们觉得写作这件时没有什么意义。但我的亲身经历告诉我不是这样的,如果你不善于总结那么你将永远是个码农,我们去观察高级程序员和低级程序员写代码,你会发现这样的事实,高级程序员总是思考的时间比写代码的时间多,曾经这个行业门槛还比较高的时候程序员的工作都是先画好 UML 图,写好实现文档后再动工写代码的。

但是一波互联网热潮加速了许多事情,包括写文档这件事在有些公司都似乎变的可有可无了,这样的结果你们也许体验过,到一家新公司后没有文档可读,你只能去读代码,而读代码这件事显然比读文档要费劲的多。不写文档的后果在越大的项目中越是灾难一般的事情。

互联网技术工作是最为知识更新迅速的行业之一,知识学习有很多途径,但是是否真正掌握到家是在于你学到的知识是否能给别人讲出来,表述清楚,如果你只是知道,用的时候能够搞定,而讲不出其中的原理那么一般认为这些知识你是掌握的不牢靠的,这点在面试中尤为明显,对于知识只是一知半解,很难自圆其说。

技术写作就提供了这样一个舞台,让你可以仔细的思考提炼那些你学到的重要东西,你可以把它当做就是面试一样去写,你写的字就是你要对面试官说的话,刻意练习就会使得你原本不擅长的事情变得熟练,得心应手。

技术写作不同于其他写作,我们更喜欢有实际的代码,有实际运行数据来证明你的理论和实践,这是与其他不同的地方,还有就是越少的字把事情说明白越好,读代码的时候我们都不喜欢读几千行的代码,也请尽量不要写过长的文章,一次表述一个主题,就和编程的时候一个方法只做一件事一样。

希望你们能够通过技术写作更好的提高自己的技术能力。

讨论数量: 2
Summer

尽量不要写过长的文章,一次表述一个主题,就和编程的时候一个方法只做一件事一样

赞一个

4个月前 评论
arunfung

赞👍

1个月前 评论

请勿发布不友善或者负能量的内容。与人为善,比聪明更重要!