中文博客写作风格指南

Table of Contents

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


适用范围:

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

  • 一级标题对应文章的标题,文章内容中的标题从二级标题开始;
  • 标题内嵌层级应按照一级、二级、三级逐次递增的顺序,不应出现二级标题之后使用四级标题的情况;
  • 标题层级结构不宜太深,一般到三级即可(层级结构太深无论使用怎样的排版都很难做到清晰,如果内容无法避免层级深,应考虑文章是否可以拆分成几篇子文章);

2 行文

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

3 标点符号

  • 中英文混用的文本中,统一使用中文标点,避免中文英符号混用。比如应该使用 ,:() 而不是 =,:()=;
  • 使用「」、『』代替单双引号,用来表示着重、强调;
  • 非必须的情况下,不要用感叹号;
  • 使用 ······ 代替省略号(shift + 6),在网页预览上有更好的效果;
  • 列表的结尾符号统一用分号;

Date: 2018-07-13 17:27:00

Author: JerryZhang