標題分為四個層級
下面是示例
# 一級標題
## 二級標題
### **標題
#### 四級標題
(1)一級標題下,不能直接出現**標題。
# 一級標題
### **標題
(2)標題要避免孤立編號(即同級標題只有乙個)。
## 二級標題 a
### **標題 a
## 二級標題 b
(3)下級標題不重複上一級標題的名字。
## 概述
### 概述
(4)謹慎使用四級標題,盡量避免出現,保持層級的簡單,防止出現過於複雜的章節。
如果**標題下有並列性的內容,建議只使用專案列表(item list)。
示例:下面的結構二要好於結構一。結構一適用的場景,主要是較長篇幅的內容。
結構一
### **標題
#### 四級標題 a
#### 四級標題 b
#### 四級標題 c
結構二### **標題
**(1)a**
**(2)b**
**(3)c**
中文技術文件的寫作規範
很多人說,不知道怎麼寫文件,都是憑著感覺寫。網上也很少有資料,教你寫文件。這已經影響了中文軟體的發展。我就動手,參考上面的規範,也結合自己的實踐,總結了乙份簡單的 中文技術文件的寫作規範 標題 文字段落 數值標點符號 章節結構 下面是關於寫作風格的乙個片段。歡迎提交 issue 和 pr 補充。摘自...
中文技術文件的規範 標點符號
1 中文語句的標點符號,均應該採取全形符號,這樣可以與全形文字保持視覺的一致。2 如果整句為英文,則該句使用英文 半形標點。3 句號 問號 嘆號 逗號 頓號 分號和冒號不得出現在一行之首。1 中文語句的結尾處應該用全形句號 2 句子末尾用括號加註時,句號應在括號之外。錯誤 關於檔案的輸出,請參照第 ...
阮一峰 中文技術文件的寫作規範
很多人說,不知道怎麼寫文件,都是憑著感覺寫。網上也很少有資料,教你寫文件。這已經影響了中文軟體的發展。我就動手,參考上面的規範,也結合自己的實踐,總結了乙份簡單的 中文技術文件的寫作規範 標題文字 段落數值 標點符號 章節結構 下面是關於寫作風格的乙個片段。歡迎提交 issue 和 pr 補充。寫作...