7. 技术博客的开头,中间,结尾都该怎么写?

橡皮擦,一个逗趣的互联网高级网虫,为你带来新职场故事,搬来程序员敲门砖。

已完成文章

本文内容:博客内容与行文框架

技术博客的内容与行文框架

内容怎么写

一篇好的技术博客,一定是人为加工出来的,这里就涉及到了文章框架,文章开头与结尾都如何设计,如何去写。

在文章开始,先给大家提供一些,与内容写作有关的小提示。

  1. 技术博客写作,优先使用 Markdown 格式写作,富文本写作的时代已经过去;
  2. 要学会分段,多分段;
  3. 掌握总分总写作结构;
  4. 每篇博客的字数,控制在 1500~2000 字以内(特殊情况除外);
  5. 写作前,提前准备大纲,例如本系列课程开篇的脑图。

更多的写作细节内容,可以阅读一个神奇的开源项目:中文技术文档的写作规范,必有所得。

开头怎么写

上篇博客,橡皮擦带你简单学习了一下标题的套路,本篇上来带给你如何写好 “套路” 型的开头。

博客的开头,只有一个目的,就是让打开本文的读者,阅读下去,所以开头你可以这样写:

陈述一件事情+提出问题

例如:

今天我碰到了一个缓存 BUG,我是这样解决的。

下班我还没有走,还在处理一个文件读取 BUG,好想知道技术组长是怎么解决的?

MySQL 读取 1W 数据,需要 10 秒,如何才能优化到 1 秒呢?

设置悬念+引发好奇

例如:

要不是处理了这个乐观锁,我可能就离职了!

技术总监在全员大会上,“狠狠” 的夸了我,就因为我完成了一个陈年大 BUG。

直接告诉读者收获

例如:

学完本文你能掌握如下技术。

本文将通过 Python 爬取腾讯动漫数据。

反常理描述

该类型与 设置悬念+引发好奇 殊途同归,为激发读者兴趣。

例如:

为何我把数据库读取速度减慢?

为什么上线前,我把秒杀按钮缩小了?

对话开头

该种形式的文章开头,是上述内容的一个综合应用,目的在于让读者,能感受到一个真实存在的场景。呈现方式可以直接文字展示,也可以微信/QQ 窗口截图。

例如:

小李:总监,我这个并发一直处理不好?
总监:……

一个好的开头,可以让读者顺利从标题,过度到你的文章内容上来,并且可以引导读者继续阅读。
一个好的开头,是文章标题的延伸,甚至是一个点睛的副标题。

结尾怎么写

结尾核心的目的总结全文,如果能激发读者思考,或让读者阅读更多的文章,或者能让读者产生文字交流的欲望,那结尾就发挥了最大价值。

一般结尾按照如下方向写作即可。

  1. 总结文章知识点,并进行扩展;
  2. 提供更多的阅读资料,增加其它文章的曝光率/阅读率;
  3. 提出新问题或其它方案,让大家探讨;
  4. 附录一个源码下载地址,共大家学习;
  5. 也可号召让大家收藏,点赞你的文章。

一定要注意,文章不要突然刹车,即使结尾只有短短的一句话,也要优于

内容怎么写

开头与结尾在一篇博客中,占的篇幅很小,重要的还是主体内容部分。毕竟好内容,才能决定一篇文章的好坏。

在内容部分,橡皮擦给你的建议如下:

  1. 尽量分段;
  2. 减少大段代码,代码越多,阅读体验越差;
  3. 给仅有的代码增加注释,清晰的注释;
  4. 适当增加图示说明;
  5. 使用列表,表格。

好的内容也依托于行文风格,你可以从临摹别人的风格开始。

  1. 漫画型,需要一定的美术基础;
  2. 故事型,让文章从一篇故事开始,以故事 Happy Ending 结尾;
  3. 对话型,通过 A 与 B 的对话,阐述技术点;
  4. 逗趣型,内容,语言搞怪,可通过表情包表述心情;
  5. 纯技术流/学术派,扎实的理论基础;

行文风格,可以不断尝试,最终得到最适合自己的风格,也可以多种进行组合,或者开拓新的写作方式。

有两点需要注意:

全文都是图片,不易被搜索引擎收录。

全篇都是代码,会给读者造成极大的阅读障碍。

写在后面

开头,内容,结尾,总分总,技术博客写作基础框架,希望本文能对即将开始写作的你,有所帮助。

本文完。

2021 年 7 月 4 日 梦想橡皮擦,发布于河北石家庄。
下一篇主题:
技术博客素材收集


今天是持续写作的第 175 / 200 天。可以点赞、评论、收藏啦。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,142评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,298评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,068评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,081评论 1 291
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,099评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,071评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,990评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,832评论 0 273
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,274评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,488评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,649评论 1 347
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,378评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,979评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,625评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,796评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,643评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,545评论 2 352

推荐阅读更多精彩内容