技术人员的写作指南

本文约 2000 字,阅读需 4 分钟。

本文详细论述了3个问题:

  • 为什么技术人员需要坚持写作?–动机篇。
  • 需要做哪些准备?–准备篇。
  • 写作的长期实践中应该注意哪些问题?–技巧篇。

一、动机篇

有人说费曼学习法的本质就是:“通过向别人清楚地解说一件事,来确认自己真的弄懂了这件事。”而写作,就是一种典型的费曼学习法。化用一句不知出处的话:

技术人员坚持写作有很多好处,却没有任何明显的坏处。

个人经过长期的实践,认为技术人员长期坚持写作会有以下四点好处,这也是值得大家去尝试的动机。

1.1 沉淀复盘、加深理解

在工作学习中,或多或少会解决一些疑难问题,又或者有一些实践的经验积累。俗话说“好记性不如烂笔头”,如果不通过文字的形式记录,这些思想往往会随着时间慢慢烟消云散,几年后的我们遇到相同问题时,往往是似曾相识却又无法回溯,岂不痛哉。

1.2 打磨思维和文笔

大脑的思维是跳跃性的,而文字是连贯的。通过写作,可以把我们跳跃性的、碎片的思想串联成一个有机的结构,让其中的因果关系、归纳关系、推理关系等逻辑体现出来,打磨思维的严谨性和逻辑的完备性。

文笔亦需要打磨,如果一个很少写文章的人对自己的文笔信心满满,那他大概率连最基本的读者视角都没有。真正清晰的文笔要不断地从“写作-发表-读者反馈”的循环中磨练出来,所以大部分作家都是中年成名。

1.3 积累个人影响力

文章就像日历上的一个个“思想钢印”,同时又像是一张张名片。苏轼《答张文潜书》说:

其为人深不愿人知之,其文如其为人。

对于技术人员来说,好的技术文章会为个人技术口碑带来可观的正面影响,而长期输出好的技术文章,则会积累起深入人心的个人影响力和技术口碑。

1.4 造福他人、创造价值

《荀子·劝学》里面曾说:

吾尝终日而思矣,不如须臾之所学也;吾尝跂而望矣,不如登高之博见也。

可见个人的思考总是有所束缚,站在巨人的肩膀上才会见识到更广阔的领域。文字就是这么一种神奇的载体,通过文字,思想永存,价值永存。我们或多或少受用于他人有价值的文章,因为当我们创作出高质量的文章时,同样也能为他人创造价值。

二、准备篇

2.1 选择题材

很多人觉得,自己的工作普普通通、平淡无奇,根本没有什么值得写的。其实,这里要弄清楚两个问题:

  1. 艺术源于生活又高于生活,技术文章也是如此。好的技术文章不一定标新立异,但要么让人收获新的知识,要么让人在已知情境下有新的启发和思考。
  2. 《百年孤独》有读者,《天龙八部》也有读者,技术文章也是如此。简单的文章有小白看,深刻的文章有专家看。重要的是你能确定自己的目标读者,并创造对应的价值。

总的来说,技术人员的写作主要有以下4个方向:

  1. 踩坑经历:解决一个疑难问题
  2. 经验复盘:总结一个成功方案、某个效果的实现
  3. 学习总结:读书笔记、源码阅读笔记、新技术学习笔记
  4. 思考感悟:对于重构的理解、对于设计模式的理解、对于某一特定技术的理解

2.2 选择工具

对于大部分人来说,Markdown是一个不错的写作格式,主流编辑器和博客平台几乎都有支持这种语法。当然,如果你想创作样式更复杂的文章也有Asciidoc、LaTex等工具。但是,我推荐你循序渐进,从Markdown开始你的写作之路。

2.3 选择平台

初期可以选择一些公共平台,比如CSDN、掘金等,好处是可以获得一些曝光,得到别人的阅读和评论反馈。一些公司有内部的文章平台(比如腾讯的KM),读者质量更高,是一个更好的选择。

2.4 选择频率

持续进行高质量的原创是一件极其困难的事情,为了将写作变成一件愉悦的事情,我推荐你至少一个月写作一篇技术文章。这个频率不会让你的思维枯竭,也不会让你过于松懈,因为有时候我们是需要用输出倒逼输入的。

三、技巧篇

3.1 明确大纲

金字塔结构非常重要,技术文章往往是有层次关系的,因为十分适合金字塔结构,只有结构清晰的文章,才更容易被读者理解和记住。

3.2 读者视角

读者视角即同理心,技术文章是写给别人看的,而不是一种创作者的自嗨,因为要以读者的视角看待问题、拆解题材,这样才能写出让别人拍手叫好的文章。

3.3 干货第一

技术文章的核心永远是内容,不一定要令人耳目一新的成果,但一定要有自己思考和追求,切忌滥竽充数。

3.4 关注反馈

这是最容易被忽视的一环,发表出来不是一篇技术文章的终点,如果不关注发表后读者的评论反馈,并从中汲取经验教训,写作水平就永远难以提升。

3.5 不断优化

不断优化创作流程,让写作变成一件愉悦的事情。比如我最开始写作技术文章的时候,经常会遇到一些格式问题。后来发现了一些开源的文档格式说明,便可以有依据地Review每个格式问题,但依然十分痛苦。最后,我开始寻找一些工具,根据规则自动发现格式问题!!!这个过程可能断断续续持续了一年多,但最后,我的文章可以在“奋笔疾书”后快速地进行半自动化的格式化,大大提高了我对于写作的积极性。

3.6 总结

万事开头难,但只要形成了创作的良性循环,终有一天会做到“文若春华,思若涌泉”。

共勉。

总阅读量次。