写技术文章的一点感悟

前言

最近看到一篇《如何写好一篇技术文章》的推文，有所感悟，所以这里就来总结一下我平时整理技术文章的一些方式。

为什么要写技术文章

每个人写技术文章或多或少有些不同的用处，以笔者为例，仅仅大学时字迹丑陋，想着找一个地方可以将其记录下来方便后续复盘而已，久而久之养成了写博客的习惯。
说起来写技术文章对个人成长也是有帮助的:

写作会帮助你复盘你本次需要记录的内容，让你梳理事件的机构复盘、反思。
因为文章时势必会覆盖你要说明的所有点，所以在复盘期间你会发现自己的不足，从而会查阅更多资料补充自己不理解的点，也就是提升你的学习效果。
提升你的表达能力，写文章肯定是要求写出让读者懂的文章，所以你写作的时候时长会从读者的角度思考，在此期间你的表达能力就会得以提升。
备忘，笔者很多日常学习或者配置都会记录到博客上，这也是一个不错的渠道。

写作原则

明确知识点的去学习

这点是非常重要的，你必须了解自己当前学习到的知识点内容，涉及到的重点和难点，以及底层工作机制。列出学习知识点的学习大纲，然后针对性的去了解、实践、学习。

例如:我要学习mongodb，我就会去网上查阅:mongodb是什么？有什么用？解决什么问题？如何使用？找到所有自己认为不错的学习素材，进行整理学习。对于学习过程中不了解的知识点结合搜索引擎进行进一步了解学习，直到吃透这个技术点为止。这也就是我们常说的:

你的技术水平，永远是决定你写文章的上限。

通透的学习实践之后，就可以对学习的知识点进行一次复盘，以笔者为例，笔者复盘的方式就是写作。笔者会列出博客标题，然后基于markdown不同目录层级按照学习过的知识点编排文章结构。

举个例子，还是以近期突击学习mongoDB的安装和使用教程，在梳理并按需学习完知识点之后，笔者就会在编写博客的markdown文本中按照知识学习的层次编写目录。如下所示，用二级标题概括知识点的内容，结合三级目录展开深入递进的进行介绍。

完成这样的一篇文章编写，我们不仅会对知识点有一个层次性的认识，对于后续的复盘也有帮助。

通俗的讲解

讲人话，这点非常重要，在我之前学习一个叫学习观的讲座中就了解过，归纳学习法永远是比指令学习法更能够帮助人们快速掌握知识。所以我们讲述知识点时尽可能基于通俗的讲解和大量图片示例，让读者快速构建这个知识点的印象。

就例如Java中的栈封闭技术，网上的解释大部分是:

当访问共享数据的可变数据时，通常需要使用同步。一种避免使用同步的方式就是不共享数据。如果仅在单线程内访问数据，就不需要同步。这种技术被称为线程封闭（Thread Confinement）

用这种懂中文都听不懂的总结，能让读者明白难度是非常大的，所以我的解释也是非常明白，因为讲好栈封闭技术涉及的知识点很多例如JVM内存布局、局部变量特点，线程独立区域等信息,所以如果让我来解释这个知识的时候我通常会解释为:

每个线程都有一块独立的本地方法栈，你把变量写在局部方法上，其他线程就改不了你的数据(具体原理后文展开)

保证文章的层次和递进

这点也很重要一个讲好一个知识点需要，对于层次和递进我的理解是抓住主干，然后不断递进深入主干中的每个点，这就像阅读源码一样，先看看核心方法都干了什么事，再去逐个了解方法中实现的细节。
举个例子，就以上文将栈封闭技术，我的做法通常回事:

 1. 用人话讲出这个点，就像上文说的一样每个线程都有一个独立的本地方法栈(我可能会配个通俗的图片)，然后说明所以线程是独立的2. 然后我再去将为什么线程是独立的，用通俗的解释和图片讲解JVM内存区域。3. 说好内存区域后，再讲讲线程在内存区域的样子。4. 最后把一开始说的那句人话套的更加有技术水平的专业解释，配合图片讲清技术本质。

抓住本质的总结

这点就很重要了，说白了就是讲清技术底层原理，就例如Java的volatile关键字，要想说明他的可见性我们就必须了解JMM模型然后了解CPU MESI协议和总线嗅探机制，只有这些知识点的整合才能决定你知识总结的上限。

参考文献

如何写好一篇技术文章？