中文博客写作风格指南

Table of Contents

最近经常看以前写的文章,发现写作风格不尽一致,就逐个改了一遍。写作风格和程序编码风格差不多,并没有严格意义上的好坏之分,只有个人偏好。 但是无论哪种风格都应该保持统一。在修改的过程中,总结了一下容易出现歧义地方,于是就有了这篇文章,以后将作为本网站(博客 + wiki)的写作标准。

1. 前提

  • 使用中文写博客,文档,Wiki 等。
  • 使用轻量级标记语言写作,比如:Markdown,reStructuredText,Org-mode,我用 Org-mode。

以下内容更多的是针对 org 设计的标准。

2. 文章结构(合理使用标题)

  • 文章内容标题从一级标题开始。
  • 标题内嵌层级应按照一级、二级、三级逐次递增的顺序,不应出现二级标题之后使用四级标题的情况。
  • 如果是博客层级结构不宜太深,一般到三级即可(层级结构太深无论使用怎样的排版都很难做到清晰,如果内容无法避免层级深,应考虑文章是否可以拆分成几篇子文章)。 但如果是 Wiki 则不应该遵守这样的限制(因为 Wiki 本身就是比较零散的点)。
  • 标题尽可能设置 CUSTOM_ID ,这样能保证每次生成的标题链接都是一样的,而且可以避免链接种出现中文。
  • 超过两级标题的文章应该设置 TOC(Table Of Content)。

3. 行文

  • 确保没有错别字,写完之后应多检查几遍。
  • 中文和英文之间用空格隔开。比如:Python 要比 C 语言入门简单。但如果在句尾,不应该在标点符号前留空格。 比如:年度最佳编程语言 JavaScript。
  • 中文和数字之间用空格隔开。比如:2018 年很快就要结束了。
  • 嵌入链接左右应保留空格。比如(Markdown): 具体请看 [这篇]() 文章
  • 单词大小写务必精准,尤其是术语。比如 Python 而不是 python,MySQL 而不是 Mysql 或者 mysql。
  • 慎用简写,行业内标准自然是可以的,但小众的简写应慎用。比如使用 IDE 表示「集成开发环境」一般不会有歧义,尽管它还有「集成设备电路」的含义。 但使用 sof 表示「stack overflow」网站则是不可取的。
  • 代码:
    • 避免滥用 inline codeinline code 只应该表示代码,不应该引用术语、表示强调等。
    • 代码块的插入最好设置 language。
  • 使用加粗、倾斜等表示强调。

4. 标点符号

  • 中英文混用的文本中,统一使用中文标点,避免中文英符号混用。比如应该使用 ,:() 而不是 ,:()
  • 使用「」、『』代替单双引号,用来表示着重、强调。 使用加粗、斜体等表示强调,「」间距过宽,阅读体验并不好。
  • 非必须的情况下,不要用感叹号。
  • 使用三个点 ... 代替省略号。
  • 列表的结尾符号统一用句号:如果是按照步骤的 1/2/3/4 用分号,相同等级的用句号。

First created: 2018-07-13 17:27:00
Last updated: 2022-12-11 Sun 12:49
Power by Emacs 27.1 (Org mode 9.4.4)