如何写好一篇技术博客?

       在学习计算机技术的过程中,我们经常会发现对很多知识及应用都一知半解。这时我们应该有这样的意识,那就是要写一篇好的技术博客。在巩固基础,理清思路的同时,发现自己的潜在问题,并及时对一阶段的学习予以总结。

       那么,如何才能写好一篇技术博客呢?我在浏览阅读了大佬的博文后,理解总结了以下几点:

  1、带着明确的目的写博客
  写一篇技术博客,首先是要明确该博客的目的,通常是学习了一项技术、解决了一个技术问题。当遇到某一个新技术的时候,或者说项目中需要引入一个新技术的时候,肯定需要对技术做调研,在调研的过程中,一般会写一些相关的demo来研究体验,可以将这个过程写下来,方便自己深入理解,也可以作为团队项目的总结。

       入门类的文章写作的思路,首先描述一下技术背景,对比有那些类似技术,各有那些优势,为什么选择此技术?基础环境介绍,此技术的依赖环境是什么?需要做哪些技术准备,可以写写搭建环境的步骤,搭建完成之后,用一个最简单的hello world验证环境是否搭建成功。

       到了快速上手的阶段,先写一两篇非常简单但可以突出其巨大优势的demo,让读者用以最低的成本来了解此技术的优势,比如spring boot最大的特别是完全注解快速集成;这些内容写完之后,需要对此技术进行进一步的研究,可以写一些解决特定问题的demo。

  2、写自己的博客
  不轻易转载别人的帖子,要尽可能写自己的博客。同样一个问题,自己和他人的理解的程度很可能是不一样的,轻易转载别人的博客,可能意味着一次自我学习机会的放弃。或许有些问题的答案看似比较唯一,但对过程中的基础原理每个人的理解不同,过程步骤也会有着相应的细微差别。

  写自己的博客也并不是意味着完全不转载别人的,有些纯粹记录知识点的博客,或者有时看了一篇博客,并且经过实验,如果自己写的话也会与博客里面写的几乎完全一致,那就不必再花费时间了。

  绝对不能把别人的好的博客作为自己的原创。如果在博客中参考了别人的博客,可以在参考资料里面提及,如果是完全转载,也应注明转载出处。

  3、博客是总结,不是过程
  写博客有时候是一个解决问题的过程。为了解决一个问题,我们会采用多种方法,然而通常只有最后一个方法才是正确的。那么博客就应该记录正确的方法,而错误的方法可以作为博客的素材一笔带过进行适当记录。

  有这样一个较为合适的博客编写过程:

  • 先自己分析问题,基于已有的现象,思考,记录问题与可能的思路。
  • 从外界获取经验或者知识,记录关键点。
  • 在实际中用学来的方法去解决问题,做好记录,同时捋顺思路。
  • 将以上过程总结成一篇博客。

       在写一篇文章之前,最重要的是就是先理清楚文章的思路和概要,可以先在笔记本上记录文章的大纲,写作过程中按照大纲的思路去执行;文章结构要清晰,根据大纲或者思路分为不同的段落,每个段落有重点描述内容;文中涉及到代码,尽量使用code的样式来展示,只展示核心代码片段,在文章末尾给出完整代码地址,最好是github地址方便大家关注和跟踪。

  4、分清主次、落脚关键点
  凡是和博客的主题有联系的问题,全部描述出来是不现实的,也是没必要的。一篇技术博客应该不超过两个主题。如果有许多次要问题,一定要分清除优先级,和主题关系比较大的,应首先解决,关系小的,应其次解决,甚至不在博客中解决。对于没有解决的问题,可以列在”遗留问题“中,对于在其他博客中讨论的问题,给予链接。

  根据自己的能力,达到合适的层次。掌握一项技术划分为如下层次,在博客中通常应该达到第三个层次:

  • 听说过该技术,了解该技术解决什么问题;
  • 使用过该技术,熟悉该技术的使用方法;
  • 解构过该技术,熟悉该技术的架构、原理;
  • 贯通过该技术,将该技术与自己的以有知识完全融合,可以利用该技术架构或解决其他问题。

       5、技术博客的风格
       技术博客不是论文,技术博客由其实用性。一篇技术博客可以是小到的一个编程技巧,可以写该技巧的原理、实现方法、好处,但不要写前500后300年的历史介绍和展望未来。技术博客通常关心技术的实用性,而非技术背后理论的复杂性。技术博客也不应该过分求全责备,把文章写的大而全,而应该追求小而精。
       技术博客应以陈述语气,个人感情色彩应该过滤掉。
       图片胜过文字。图片配文字比单纯的文字更加方便理解,甚至一张图就可以省略文字了,多画图,少写字是个原则。
       考虑时间成本。博客基本上是以时间换知识,因此记录时间也很必要。
       简洁大方颜值高的文章,会给读者如沐春风一样的感觉,写完一篇文章的时候,首先想一想,如果你自己看到这篇文章自己会喜欢吗?如果自己都不喜欢,那肯定还有优化的空间。

2020-03-08

posted @ 2020-03-08 20:51  wyt03  阅读(811)  评论(0)    收藏  举报