写技术文章的要点

5 minute read

磨刀不误砍柴工,程序员在写代码、写文章之余还是值得去了解重构代码、测试代码、如何写文章等辅助性的技能,虽然有时有点务虚,但从长远看却是实打实地有用。今天讨论的主题是“写技术文章有哪些要点”。

首先,我们需要对技术文章进行一个分类:

  1. 知识总结
    1. 比如你在公司内想要做个什么系统,你不知道,就去 Google 用英文搜一下。把第一页都消化吸收了就能出一篇总结性文章了(也就是老板常说的去调研一下)。业务问题 → Google 搜索 → 消化内容 → 总结
    2. 最近对流式计算感兴趣,我也可以 Google 去搜 “stream processing”,不过搜出来的知识点都比较零散。而我想要更完整的知识体系,那么我就去亚马逊搜书 “stream processing”。大致了解到有哪些关键词后,我们就去更加专业的渠道去阅读它——learning.oreily.com/library,然后就可以输出笔记了。 流式计算感兴趣 → 读书 → 读书笔记。
  2. 项目总结
    1. 公司项目 → 完成之后 → 调研更高级项目 → 复盘总结。
    2. 公司问题提炼。业务脱敏,只把关键技术部分整理出来 → 输出。
  3. 教程指引。翻译官方文档,补充一些在使用时候会遇到的坑。
    1. Yutube 上很好的国外的视频分享 → 怕忘记、感兴趣 → 结合自己的理解记下来。
    2. 内容翻译。medium,lobster,acm 里不错的新论文,acm queue,macm 杂志上的文章,都是不错的翻译目标。

小插曲:注册 ACM 会员再用同样的账号去注册O`reily,能够免费阅读里面大部分的书。价格为 25 刀,可以搞个双币信用卡呀,招行就行,现在学生账号可能不行了,不过用绑了 paypal 的卡就行好像。

如果对电子书不排斥的话,目前比较经济的选择是申请一个国内的 ACM 会员,并且用该会员去注册oreily 在线书店。一年大概 20 美元,可以及时地阅读到大部分出版社的技术出版物。因为现在出版社的网站大多还支持 early preview,所以你甚至可以在书籍还没有上市之前就预先学习内容,第一时间获取整个业界的一线情报,能够帮助你站在时代的潮头。——曹大

其实,说到底,技术文章多是总结性文章,也是我们技术从业者常写的,基本上遍历 Google 前 3 页就能输出为什么XXX、什么是怎么实现的。这种文章对输出的人价值很大,作者学到了很多,但对读者不太友好,因为结论不一定对,但重要的是学习别人学习的思路、方法,就当是开拓思路的文章。因此,我们程序员应该多自己去写总结性文章

平时我们再看技术类公众号、博客的时候,不用太关系里面的内容,但可以主动地想一想,作者是怎样写出来这篇文章的?他有什么疑问?他是怎么查资料的?他在 Google 中搜索什么问题?

最后,写文章还是要自己主动下手,不要畏首畏尾,对自己不会有什么损失,但对于自己的逻辑能力、表达能力、口头能力以及职业生涯会有个全面地提升。

参考链接

[1] 写作的逻辑:从清晰表达到高效沟通, [日]仓岛保美, 2021-04-08

[2]《写作的逻辑》简单读书笔记, 曹春晖

https://xargin.com/notes-on-logic-writing/

[3] 工程师应该怎么学习

https://xargin.com/how-to-learn/

[4]《代码的艺术》- 章淼

http://www.doc88.com/p-0307410081839.html

[5]《代码的艺术 - 章淼讲座笔记》

https://beanlee.github.io/posts/Art-Of-Code/