如何写技术博客

前言:

前段时间在这里提了一个问题——应届生该如何准备今年的秋招? ,很多前辈都建议写技术博客。

这段时间也写了几篇,有的阅读量还行(我现在的要求就是保证每篇博客的阅读量大于100),但是有的阅读量则有点惨淡。

说明了存在不足,我也意识到了几个问题。就拿array_chunk()函数的妙用——分而治之这篇文章来说:

1. 问题一:没有示意图,全靠文字描述。

2. 问题二:并没有把一个问题讲清楚。使用了分而治之的方法,却并没有体现出使用这种方法的优势,没有去分析时间复杂度。老哥在评论区一问就把我噎住了。

3. 问题三:想到用什么标点符号就用什么标点符号,没有遵从一定的规范。

知道要写博客,但也要知道该如何写博客,形成一定的规范。这样在输出时,自己的技能得到提升的同时,读者读的也更轻松。毕竟获得更过的阅读量和赞数,满足自己的那点小虚荣心,形成正反馈,才有更大的写下去的动力。

博客分类:

1. 技术细节型。

2. 干货型。

3. 实践总结型。

4. 杂谈与鸡汤型。

博客组成:

标题、小标题。

我想大多数人在找文章时都是用某个关键词去搜索。

所以,内容中的关键词来命名文章是首选。

内容。

这个就不多说了,博客肯定是内容为王,好文章最重要的是要有好的内容,好的技术文章要让读者有益。

如何写博客

一、清晰的叙事结构。

技术类文章有两种常见的结构:

  • 平铺叙事,逐步推进:适用于介绍排查问题的过程、分享设计思路、介绍项目的迭代进展。

  • 结构化叙事,层层展开:适用于讲规划、做总结、画大图、介绍一整套技术方案。

线性叙事,逐步推进

对于这类文章,读者是应该按顺序一段一段看的,写的时候脑海中模拟读者的视角来写。

这类文章的小技巧就是:模拟读者视角,设定一条主线,有节奏的向前推进。和讲故事差不多,每一步的推进要有逻辑,要保持思路不要断掉。

感觉线性叙事写作需要非常深厚的功力。

结构化叙事,层层展开

除了按顺序看的,还有不按顺序看的文章?

有的,尤其在专业的技术文章里很常见,大部分是“总-分”的结构,先讲整体框架,再分章节介绍各个部分。

比较常见的是那种总结型的文章,比较像一本技术手册,可以通读一遍,也可以只看其中一段,之后遇到相关的问题,根据目录跳着阅读。

对于文思泉涌的人,可以一口气把整篇文章写完。但实际情况是,很多时间被碎片化,可能还要引用一些专业内容,可能需要查资料,写文章的过程会被中断。

这类文章不是一口气写完的,是先搭架子再填充完整的。其实写起来也很简单:先想好标题,再划分好目录结构,再一段一段的填充内容,最后再润色一下连接部分。文章可以不按顺序看,也可以不按顺序写。

线性叙事是个链表,结构化叙事是树。

感觉我现在写博客的叙事方式就是结构化叙事。

二、注意排版和语法细节。

1. 正确使用标点符号。

参考这篇如何正确使用标点符号?的文章。

2. 添加多种展现形式。

  1. 段落排版:如果全是普通的段落,看起来有点平淡,可以适当的加上可以加上无序列表、有序列表、段落引用、表格等等。

  2. 行内排版:行内排版可以加上粗体斜体代码标记等,偶尔还可以用删除线

3. 少即是多:英文喜欢长句,复合从句一层套一层;中文追求言简意赅,错落有致,可以多加标点符号,把长句分隔开。

Laravel

三、提高阅读体验的技巧。

1. 多用图片:一图胜千言,这个不多说。

2. 使用恰当的比喻:我们认识事物的捷径就是:用熟悉的事物做类比。

四、写完之后通读一遍。

写完之后通读一遍,避免错别字和病句(这应该是最基本的要求)。

辅助工具

1. 画图工具:http://draw.io/

待补充:

就先写这么多吧,等以后看到了其他的技巧再更新吧。

参考

1. 程序员怎样才能写出一篇好的博客或者技术文章?1

2. 程序员怎样才能写出一篇好的博客或者技术文章?2

3. 程序员怎样才能写出一篇好的博客或者技术文章?3

4. 程序员怎样才能写出一篇好的博客或者技术文章?4

5. 如何正确使用标点符号?

本作品采用《CC 协议》,转载必须注明作者和本文链接
《L04 微信小程序从零到发布》
从小程序个人账户申请开始,带你一步步进行开发一个微信小程序,直到提交微信控制台上线发布。
《L03 构架 API 服务器》
你将学到如 RESTFul 设计风格、PostMan 的使用、OAuth 流程,JWT 概念及使用 和 API 开发相关的进阶知识。
讨论数量: 5

怎么写都可以,只要你开心 :kissing_heart:

2年前 评论
Moonshadow2333 (楼主) 2年前

写博客分两种,一种是给自己看的知识记录,另一种是给别人看的知识分享。

写第一种的时候要保证自己下一次看的时候能看得懂,站在自己的角度写。
写第二种的时候要保证别人能看懂,站在读者的角度写。

2年前 评论

我不会写就是不会写 :joy:

2年前 评论
Moonshadow2333 (楼主) 2年前

讨论应以学习和精进为目的。请勿发布不友善或者负能量的内容,与人为善,比聪明更重要!