技术文档标题:层级与写作原则
修订历史
- 版本 1 · 中文技术文档标题:层级与写作原则
来源原文版本。
查看此版本正文
标题
层级
标题分为四级。
- 一级标题:文章的标题
- 二级标题:文章主要部分的大标题
- 三级标题:二级标题下面一级的小标题
- 四级标题:三级标题下面某一方面的小标题
下面是示例。
# 一级标题 ## 二级标题 ### 三级标题 #### 四级标题原则
(1)一级标题下,不能直接出现三级标题。
示例:下面的文章结构,缺少二级标题。
# 一级标题 ### 三级标题(2)标题要避免孤立编号(即同级标题只有一个)。
示例:下面的文章结构,
二级标题 A只包含一个三级标题,完全可以省略三级标题 A。## 二级标题 A ### 三级标题 A ## 二级标题 B(3)下级标题不重复上一级标题的名字。
示例:下面的文章结构,二级标题与下属的三级标题同名,建议避免。
## 概述 ### 概述(4)谨慎使用四级标题,尽量避免出现,保持层级的简单,防止出现过于复杂的章节。
如果三级标题下有并列性的内容,建议只使用项目列表(Item list)。
示例:下面的结构二要好于结构一。结构一适用的场景,主要是较长篇幅的内容。
结构一 ### 三级标题 #### 四级标题 A #### 四级标题 B #### 四级标题 C 结构二 ### 三级标题 **(1)A** **(2)B** **(3)C**
来源与许可
原文:中文技术文档写作规范
归属:ruanyf/document-style-guide; 阮一峰 / Ruan Yifeng
读者评论 0
暂无已公开评论。