一篇完整的技术博客应该有什么?

一篇完整的技术博客应该有什么?

版权声明:

本公众号发布的所有文章,均属于原创,版权归本公众号所有。

未经允许,不得转载。

一、前言

一直有技术博客的总结在输出,本身也是一种坚持。而身为技术人,用博客的形式记录下自己有价值的思考,会带来很多有价值的好处,而无任何明显的坏处。

而如果只是简单的碎碎念、琐事记录这些,都算不上是有价值的思考,这些记录下来,可能时间久了,自己都不愿意回头看了。

而对于文学作品而言,很多思想总结出一句话,可能说出来真的会让人觉得很精辟,而如果在相同的语境和知识体系环境下,也是不会存在歧义而且方便记忆。但是对于技术类文章而言,没有内功总纲,你只能通过细节书写来表达。

技术类文章,细节很重要,而我们程序员每天都在接触新技术、接触新知识、解决新问题,如何将这些内容终结成一篇完整的技术文章,可以让自己回顾的时候跟快速的记忆起来细节,这就是一个需要思考的问题。

二、该怎么做?

那么,我们如何将吸取的知识和自身的思考总结出一篇完整的技术文章?

纵观现在所有的技术博客文章,撇除一些无意义的环境配置,单纯的解决问题而没有深究为何出问题这类文章之外,只要能够阐述清楚所写的技术点,就是一篇好的技术文章。

其实,遇到问题,合理的拆分问题也是一种能力,技术文章推荐参考一种 『5 why 分析法』的方法论来分析问题。

简单来说,5Why 分析法,就是对一个问题连续提5个以上的为什么,来思考这个问题的本质。当然 5Why 分析法可以应用在任何地方,当然 5 是一个虚数,就是指把问题深挖。

举个通用的例子:

遇见一个新的技术点,来试着将这个技术点进行拆分:

  1. 它因何存在,为了解决什么问题?

  2. 它的使用场景是什么,在哪些地方我可以使用它?

  3. 使用它,需要注意些什么?

  4. 它是如何实现的,利用了什么现有的技术?

  5. 它实现的设计思想,有没有什么我可以借鉴的地方?

基本上一篇技术博客,对一个技术知识点,用这些问题来拆分之后,如果能写清楚,让看的人明白,它就是一篇优质的技术文章。

通常来说,我写一篇技术博客,也会有一个大概的大纲,在开始动手写之前,先写好各种大标题小标题,先把框架搭好,然后再慢慢的做『填空题』。

三、结语

可能有人说,这个概念我明白就好了。但是『学』和『教』真的是不一样的。当你把你的理解以文字记录下来之后,思路会更清晰。而本身如果对于一个你已经理解掌握的知识点,总结出来并不会花费你太多的时间,当然如果你将总结思考的时间理解为你学习新技术的时间成本内,就更不用提了。

现在写一篇技术文章,时间大部分会花费在一些语言组织、文章内配图、Demo 等地方,但是这些东西,实际上是可以人为的压缩时间的,会通过熟练度越来越快。本质上思考的结果才是重要的内容,其他只是为了说明它的辅助,都是可以压缩到极致的。

一篇完整的技术博客应该有什么?