如何写好技术博客

本文主要介绍如何写好技术博客,主要涉及博客文章排版及博客写作心得。

文章排版

这部分内容主要参考 《中文文案排版指北》《少数派写作排版指南》写给大家看的中文排版指南

空格

1.行文时,请在中文与英文、中文与数字、英文与数字之间增加空格。例如:

  • 推荐:苹果公司在 2015 年 9 月 9 日发布了 iPhone 6s。
  • 不推荐:苹果公司在2015年9月9日发布了iPhone 6s。

2.一段文字中有超链接的部分,在超链接的前后使用空格。例如:

3.英文、数字前后接全角标点符号或者表示单位的角标符号时,不需要加空格。例如:

  • 正确:新款屏幕的可视角度为 125°,相比旧款提升了 25%。
  • 错误:新款屏幕的可视角度为 125 °,相比旧款提升了 25 %。

4.对于有特殊用法的专有名词,如 4K、1080p、iOS 10 等,英文和数字之间是否空格以官方标准为准。

5.每段文字的开头不需要空两格。

标点符号

1.引号请使用直角引号「」,而不是弯引号 “”。

2.引号中再引号使用双直角引号『』。

3.当引号表示讽刺、反语暗示时,使用弯引号。

示例:说真的,我也很 “喜欢”「苹果表」哦。

4.省略号请使用 …… 标准用法,正确输入方法是 shift + 6。不要使用三个句号。。。,也不要使用三个英文句点 …。

5.不重复使用标点符号。

6.破折号占两个汉字空间。

示例:中国设计还有太长路要走————加油罢。

中文和西文符号

1.一般情况下,一个中文句子中出现了英文部分,仍然使用中文标点,即全角符号。例如:

  • 正确:我常用的电子设备是 Kindle、iPad Pro、iPhone。
  • 错误:我常用的电子设备是 Kindle, iPad Pro, iPhone.

2.如果引用一段完整的英文句子,或是出现在专有名词中的标点,则不需要更改标点符号。例如:

  • 正确:乔布斯说「Stay hungry, Stay foolish.」
  • 错误:乔布斯说「Stay hungry,Stay foolish。」
  • 正确:我最喜欢的手机游戏是 Lifeline: Silent Night。
  • 错误:我最喜欢的手机游戏是 Lifeline:Silent Night。

注明引用来源

1.文中有使用外站或外部内容的,务必在引用最后部分注明来源。

2.文中有使用外站图片,必须在文末标明。来源如果来自外站必须添加链接。例如:

  • 本文部分图片来自 The Verge
  • 题图来自电影《春娇与志明》截图

3.若文章为全文翻译,必须在文中注明原作者及原文地址,并添加原文链接。

博客风格

1.用主动语态,不要用被动语态。一般情况下,主动语态比被动语态更有力。

  • 主动语态:I read the book.
  • 被动语态:The book is read by me.

2.一图胜千言!

3.使用具体、明确、展示细节的词汇,能激发想象,使读者自己代入情境。「把硬币放进口袋里,他咧开嘴笑了」,远远强过「他满意地拿走了辛苦挣来的奖赏」。

4.减少形容词的使用,少用 「的」。

5.忌罗列代码。

如何写好技术博客

这里主要摘录一些网络博主的高见,我也要在写作过程中慢慢体会。

目的明确

明确博客目的,通常是学习一项技术、解决一个问题、记录一些过程。博客主题要明确,分清主次,不要毕其功于一役。次要问题可单独成篇。

博客是总结,不是过程

参考如下步骤写博客:

  • 碰到问题,决定是否有价值写为博客,若有则进行记录,作为一篇博客的开篇。
  • 首先,先自己分析问题,基于已有的现象,思考,在笔记本上记录问题与可能的思路。
  • 其次,从外界获取经验或者知识,比如请教别人,Google等,学习他们,在笔记本上记录关键点。
  • 然后,在实际中用学来的方法去解决问题,笔记本做好记录,要像水流过水渠一样流淌前面记录的思路。
  • 最后,拿过笔记本,将以上过程再总结成一篇博客。将解决问题的思路进行深化或拓展,也可引出新的博客篇章。

知识开始学习的时候,经常是只见树木,不见森林。俗话说:”孤木不成林“,弄上三五棵树,才会有”森林“的感觉。

尽量拒绝三手技术

以官方文档、实验验证为主。

博客的知识层次

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

引用

1.中文文案排版指北

2.少数派写作排版指南

3.写给大家看的中文排版指南

4.如何写一篇好的技术博客