Technical Document Title: Hierarchy and Writing Principles
Revision history
- Version 1 · EnglishTechnical Document Title: Hierarchy and Writing Principles
Machine translation edition.
Read this revision
title
LEVEL
The title is divided into four levels.
- First level title: the title of the article
- Secondary title: the main title of the main part of the article
- Tertiary Heading: Subheading of the first level below the secondary heading
- Four-level heading: Subheading of an aspect below the three-level heading
Here's an example.
# 一级标题 ## 二级标题 ### 三级标题 #### 四级标题principles.
(1) Under the first-level heading, the third-level heading cannot appear directly.
Example: The following article structure, missing a secondary title.
# 一级标题 ### 三级标题(2) Titles should not be numbered in isolation (i.e. there is only one title of the same level).
Example: The following article structure,
二级标题 AContains only one tertiary title and can be completely omitted三级标题 A。## 二级标题 A ### 三级标题 A ## 二级标题 B(3) The subordinate title does not repeat the name of the parent title.
Example: The following article structure, the secondary title has the same name as the subordinate's tertiary title, which is recommended to avoid.
## 概述 ### 概述(4) Use the four-level heading with caution, try to avoid appearing, keep the level simple, and prevent overly complex chapters.
If there is something juxtaposed under the tertiary heading, it is recommended to use only the Item list.
Example: Structure Two below is better than Structure One. Structure 1 Applicable scenarios are mainly long content.
结构一 ### 三级标题 #### 四级标题 A #### 四级标题 B #### 四级标题 C 结构二 ### 三级标题 **(1)A** **(2)B** **(3)C**
Source and license
Original: 中文技术文档写作规范
Attribution: ruanyf/document-style-guide; 阮一峰 / Ruan Yifeng
License: Public domain
Reader comments 0
No published comments yet.