反思--技术博客的写作应该是怎样的?

最近在用$LaTeX$写论文,中间碰到了许多问题,就去网上查找解答方案,好多问题都通过别人的博文解决了,心怀感激之余,也想记录一下自己总结的一些常见问题和解决方法。但是博客写出来发了,回头看看发现连自己都看不下去......于是就在思考到底该怎样写一篇合格的博客,才能使阅读者在最短的时间内获得有用的信息,同时又不会读起来很无聊。百度了一下搜到一篇很好的文章,讲的是怎么写技术博客的,其中一些想法与我总结的不谋而合 http://rock3.info/blog/2013/11/26/ 

首先要明白博客,尤其是技术博客的目的是为了阐述如何解决一个实际问题,因此不必像学术论文那样介绍太多背景,我相信凡是需要解决这个问题的人都是由一定的知识背景的。如果为了说明$LaTeX$代码中的一个小问题而先花大把文字介绍这个软件,那还不如去找本参考书看看。对于最新的技术或一些不常用的代码,教科书难以面面俱到,因此我们去博客上寻找的东西,往往是书本中没有的。

但是对于一个技术博客的组成部分,以我之拙见,应包括以下几个部分:

1、问题的阐述

通过清晰易懂的方式(最好有图片)阐明遇到的问题,这跟论文中的Introduction类似,却要写的更简单易懂,而且精炼

2、内容不宜过多

每篇博客应限于解决一个主要问题,一气写上好几页纸好像显得自己很专业肚子里墨水很多(我之前就是这么写的。。。),但信息量太大反而让读者抓不住重点。读者往往是通过百度等搜索引擎直接搜到博文的,他们的目标只有一个:用最短的时间解决当前的问题,而非来听你长篇大论。如果遇到复杂的问题也可以把它分成几部分来完成,分成几篇博客来叙述。

3、标题突出重点

上一条说大多数人是通过搜索引擎来寻找问题的解决方案的,所以文章的标题要直插问题核心,可以非常通俗不必太过讲究,尽量能跟百度搜索栏的一样最好。这也要求我们在一篇博客中不要写太多的内容,否则标题就难以体现所有的内容。

4、解决问题方案及效果

很多博文在说明问题的解决方案时只给出了一堆堆的代码跟叙述,其实图片才是最直观的表达方式,正所谓“无图无真相”。通过代码解决了一个具体问题,解决之后效果是如何的?最好来一张图片展示一下,这样一目了然,有可能读者没能明白你文字阐述的意思,但是一看图可能就恍然大悟:这不就是我遇到的问题嘛!

5、参考文献

在解决问题之后,最好列出你参考的一些源链接,如一些公司官网、代码站、别人的博客地址、或者宏包及软件等的下载地址等等,这样读者在遇到类似的问题时也能够通过这些渠道去解决,正是:授人以鱼不如授人以渔!

谨以此文作为督促自己写博客的戒尺,希望能写出更有意义的博文,记录自己的经验,同时帮助别人解决问题!

原文地址:https://www.cnblogs.com/oucsheep/p/4203644.html