关于写好技术博客的总结

/ 随笔 / 没有评论 / 90浏览

引言

Learning by teaching,通过教学分享来学习是非常有效的学习进步手段,也是弥补我们学习要点不足的方法。如果能够给一个技术小白,阐明一个技术方法核心,解惑疑问,说明你对这个技术课题理解的非常深刻,足够深入。所以另一方面来讲,写博客是一个学习手段,不仅有利于己,还有利于他人。

写技术博客的要点

核心总结-说明该技术/问题是怎样遇到的,有什么影响,怎样解决

一篇技术博客,应该来说来由有两个方面,

  1. 工作当中我们遇到的某些问题,对我们造成了怎样影响,经过我们调研研究,给出最后解决方案,整个过程归纳起来,可以形成一篇技术解决方案的博客。

  2. 学习过程中,当我们遇到一个新的技术,好的算法,新颖的设计理念,经过我们不断的测试,学习分析源代码,整理各方面的资料,融汇出我们自己的思想,这样也可以归纳出一篇技术博客

所以,最好在技术博客开头中,我们先归纳出我们总结出来的核心内容,给读者最直观的感受,告诉读者这篇文章是为了解决什么问题,怎样解决的,分析什么技术,能够给我们带来什么好处

技术博客的结构

我总结起来的技术博客,最少需要包括以下几点

  1. 引言|前言,精炼覆盖全篇所讲的内容。(文字最好精炼些,我自己的文字水平就不好,所以需要多读呀)
  2. 阐明该技术的重心/解决什么问题。(自己看着来吧~)
  3. 着重分析自己所要表达的技术重心。(分析几个技术要点/解决思路)
  4. 总结/最佳实践。(所有的技术都是为了实际应用产生的,所以必须要告诉读者以后使用方式。)

技术博客的内容

一篇好的技术博客,绝对不能仅仅是一堆文字(除非是论文类的),我们需要用更多的表达手段阐明一个问题。绘图,源码,列表,标题,引用等等都是很好的辅助手段,在分析源码的时候如果能有个uml类图,远远比一堆文字所表达的内容丰富的多。适当插入些源代码可以更好的用作分析,避免读者阅读疲劳。引用一些经典的理论或者他人的博客,可以给读者留下更深的印象。

技术博客的总结/最佳实践

无论文章表达的内容是什么,我们结尾都需要有个完整的总结,给出我们最后的几轮,当然也可以预留一些疑问或者需要进一步探索的内容,让读者自己去研究交流下。

如果是技术内容,最好有个最佳实践的板块,直接告诉读者该怎么用,怎么用最好,当然如果认为有不同的观点,可以让读者留下讨论,世界技术本来就是通过讨论不断进步的,如果一个问题,可以引发更多读者的共鸣和思考,那就非常不错了。

注意事项

写技术博客,我个人感觉,不要在我们分析的技术体系上延伸到更多的领域,以免给读者抓不到重心的感觉,如果遇到其他的技术问题,我们可以直接给出技术答案,如果觉得这个问题也是一个很好的技术课题,那么我们可以预留起来,放在其他的博客上,或者引用其他人的博客。

技术博客文章,我个人觉得不要长篇大论(除非是理论文章),因为大部分的技术人员不并不是理论学家,都是面向实际应用的,所以能用一句话解决的问题,不要反复重复。

由于本人语文水平很差, 所以经常一些词汇无法正确的想出来, 所以博客有的时候显得很low,就很羡慕哪些语文好的同学,同样一篇文章,有些人可以写的行云流水,有些则味同嚼蜡。

我们的技术博客,不仅是给写自己的,同样是写给他人的,不要没有经过反复实验就擅自发表出来,给人错误的答案就不太好了。当然如果自己没有分析对,发表出来被人指出了问题所在,我们也应该即使修改。

技术博客不是写完就放下了,我们需要经常回顾,看看以前的思想或者解决方案有什么问题没有。通过和其他人的讨论,可以从新归纳下以前的内容。

写博客的思路和技巧

思路总结

技术博客的思路不用一蹴而就,文章是需要用时间来打磨的,要有明确的重心思想。

很多时候,我们写技术博客写的内容少是因为没有进行提纲归纳草稿,文章和人一样需要有个骨架,在骨架的基础上添加内容。有的时候写的,但是确实流水账式的文章给人抓不到重点。所以,写作之前打打草稿,是很好的一个习惯。

常用的技巧-

我最常用的一个方式,就是不写内容,先写自己的主副标题。通过标题,纵览出这篇文章的结构。

我们要会一些简单的uml,时序图等,我都是在process做好图。大家可以试试procee这个在线作图软件。

文章博客需要有个良好的排版,一般我采用的markdown的方案,他的排版语法简单,大部分的博客平台都支持解析,而且排版结构也足够清洗。

如果刚写博客不久,自己写出的干货太少,可以先去找一些优秀的博主,通过对他们的文章学习归纳,模仿写一写

核心技巧,就是一个字-写。只有不停的写,才可以自己从中体会出自己的心得,有了自己的心得,以后写完整就会更加的有章法,舒畅了~

结尾-

写文章是一种学习,放慢自己学习的脚步,有意识地减慢学习速度,让自己理解更加的深刻

写文章是一种思考,对技术的思考,对生活的思考,对人生的思考。

写文章可以打开另一扇窗户,让我们可以和更多志同道合的人园交流,学习其他人的思想。