这里是本文档的风格指南,具体作用是约束自己的写作风格。

之前写文档时,想到哪写到哪,完全看当天的心情与状态。

当过了一阵子回头看之前的文章时,大脑的思维已经不复当初了,导致部分文档很难看懂。

也存在很多文档的写作风格不一致,看起来很难受。

当然风格不是一时形成的,之后的文档会不断约束并修正它。

# 标点符号

之前一直是使用半角的标点符号,并且末尾省略句号,并习惯性在标点后增加一个空格(该文档有多少个逗号就修改了几次……),现在开始修正自己,在中文语句中使用全角符号。

# 1. 顿号

顿号是使用错误最多的,所以提前说

语句中的并列词语, 应当使用 分隔,而非全部使用使用逗号。

# 2. 分号

  1. 在并列的分句中使用;

  2. 在分行列举的各项之间。

# 3. 逗号

在语句中停顿时使用。

# 4. 句号

作为一篇文档,尽量使用陈述句,更具有感情的标点符号可以在博客中使用。

当一句话说完后使用句号。

# 5. 冒号

表示语句中提示下文或总结上文的停顿。

# 文档结构

# 1. 文档命名

  1. 文档命名仅允许使用英文;
  2. 文档命名仅允许使用小写字母;
  3. 多个单词时使用 - 来连接;
  4. 文件名不允许含有空格。

# 2. 文档标题

标题层级

  1. 一级标题:用于文章的标题(在该文档中普遍使用 title 进行替代),笔记中禁止有一级标题;
  2. 二级标题:用于文章的目录,作为侧边栏的主要展示部分;
  3. 三级标题:用于目录下的分类,标题前方添加阿拉伯数字便于理解这是一个三级标题;
  4. ** 标题 **:分类中的进一步内容使用加粗标识,避免过多的层级嵌套,该项目前状态应减少使用,默认的 Markdown 解析对该项支持较差。

标题嵌套

仅允许一层层嵌套,如一级标题下方不允许直接出现三级标题。

标题命名

下一层级的标题不能与直属的上一层级标题相同。

# 文本规范

# 1. 行文风格

  1. 全文使用陈述句;
  2. 首先使用简洁的语句提取段落中心句,再以啰里啰嗦的形式展开,最好附以实例。

# 2. 段落

在所有文档中,每一个二级标题定义为一个段落,段落与段落之间断开一行。

# 3. 语句

语句按照结构可以分为三类:简单句、并列句、复合句

  1. 尽量使用简单句和并列句,避免使用复合句;
  2. 尽量使用肯定句,避免使用否定句。

# 4. 文本

中英文混杂:

中文字符与英文字符之间,需要增加半角空格。

中文数字混杂:

中文字符与数字字符之间,需要增加半角空格。

英文数字混杂:

同中文数字混杂。

# 其他

输入法:搜狗输入法。

Markdown 编辑器:Typora,选择原因:好看。

# 参考文章

句子

小学生标点符号使用大全