Table of Contents:

 技术文档的写作规范

 标题

标题分为四级。

 一级标题:文章的标题
 二级标题:文章主要部分的大标题
 三级标题:二级标题下面一级的小标题
 四级标题:三级标题下面某一方面的小标题

下面是示例。

# 一级标题
## 二级标题
### 三级标题
#### 四级标题

谨慎使用四级标题,尽量避免出现,保持层级的简单,防止出现过于复杂的章节。
如果三级标题下有并列性的内容,建议只使用项目列表(Item list)。
示例:下面的结构二要好于结构一。结构一适用的场景,主要是较长篇幅的内容。

结构一


### 三级标题


#### 四级标题 A


#### 四级标题 B


#### 四级标题 C


结构二


### 三级标题


**(1)A**


**(2)B**


**(3)C**

 文本

 段落

 数值

 标点符号

 文档体系

 文件名

 文档的文件名不得含有空格。
 文件名必须使用半角字符,不得使用全角字符。这也意味着,中文不能用于文件名。
 文件名建议只使用小写字母,不使用大写字母。
 为了醒目,某些说明文件的文件名,可以使用大写字母,比如README、LICENSE。
* 文件名包含多个单词时,单词之间建议使用半角的连词线(-)分隔。
    + 不佳:advanced_usage.md
    + 正确:advanced-usage.md

 参考链接

 参考链接

中文技术文档的写作规范?, by 阮一峰
Markdown 简体中文与西文混排要点, by 李笑来