來源：阮一峰的 github
標(biāo)題
層級
標(biāo)題分四級。
- 一級標(biāo)題：文章的標(biāo)題
- 二級標(biāo)題：文章主要部分的大標(biāo)題
- 三級標(biāo)題：二級標(biāo)題下面一級的小標(biāo)題
- 四級標(biāo)題：三級標(biāo)題下面某一方面的小標(biāo)題
示例：
# 一級標(biāo)題
## 二級標(biāo)題
### 三級標(biāo)題
#### 四級標(biāo)題
原則
- 一級標(biāo)題下，不能直接出現(xiàn)三級標(biāo)題。
# 一級標(biāo)題
### 三級標(biāo)題
- 標(biāo)題要避免孤立編號（即同級標(biāo)題只有一個）。
## 二級標(biāo)題 A
### 三級標(biāo)題 A
## 二級標(biāo)題 B
- 下級標(biāo)題不重復(fù)上一級標(biāo)題的名字。
## 概述
### 概述
- 謹(jǐn)慎使用四級標(biāo)題，盡量避免出現(xiàn)，保持層級的簡單，防止出現(xiàn)過于復(fù)雜的章節(jié)。`
結(jié)構(gòu)一
### 三級標(biāo)題
#### 四級標(biāo)題 A
#### 四級標(biāo)題 B
#### 四級標(biāo)題 C
結(jié)構(gòu)二
### 三級標(biāo)題
**（1）A**
**（2）B**
**（3）C**
文本
字間距
全角中文字符與半角英文字符之間，應(yīng)有一個半角空格。
錯誤：本文介紹如何快速啟動Windows系統(tǒng)。
正確：本文介紹如何快速啟動 Windows 系統(tǒng)。
全角中文字符與半角阿拉伯?dāng)?shù)字之間，有沒有半角空格都可，但必須保證風(fēng)格統(tǒng)一，不能兩種風(fēng)格混雜。
正確：2011年5月11日，我訂購了5臺筆記本電腦與10臺平板電腦。
正確：2011 年 5 月 15 日，我訂購了 5 臺筆記本電腦與 10 臺平板電腦。
半角的百分號，視同阿拉伯?dāng)?shù)字。
英文單位若不翻譯，單位前的阿拉伯?dāng)?shù)字與單位間不留空格。
錯誤：一部容量為 16 GB 的智能手機(jī)。
正確：一部容量為 16GB 的智能手機(jī)。
半角英文字符和半角阿拉伯?dāng)?shù)字，與全角標(biāo)點符號之間不留空格。
錯誤：他的電腦是 MacBook Air 。
正確：他的電腦是 MacBook Air。
句子
- 避免使用長句。句子內(nèi)部不適用逗號時，總長度不應(yīng)該超過 40 個字；使用逗號時，總長度不應(yīng)該超過 100 字或者正文的 3 行。
- 盡量使用簡單句和并列句，避免使用復(fù)合句。
寫作風(fēng)格
- 盡量不適用被動語態(tài)，改為使用主動語態(tài)。
錯誤：假如此軟件尚未被安裝，
正確：假如尚未安裝這個軟件，
- 不適用非正式的語言風(fēng)格。
錯誤：Lady Gaga 的演唱會真是酷斃了，從沒看過這么給力的表演?。?！
正確：無法參加本次活動，我深感遺憾。
- 不適用冷僻、生造或者文言文的詞語，而要使用現(xiàn)代漢語的常用表達(dá)方式。
錯誤：這是唯二的快速啟動的方法。
正確：這是僅有的兩種快速啟動的方法。
- 用對“的”、“地”、“得”。
她露出了開心的笑容。
（形容詞 + 的 + 名詞）
她開心地笑了
（副詞 + 地 + 動詞）
她笑得很開心
（動詞 + 得 + 副詞）
- 使用代詞時（比如“其”、“該”，“此”，“這”等詞），必須明確指代的內(nèi)容，保證只有一個含義。
錯誤：從管理系統(tǒng)可以監(jiān)視中繼系統(tǒng)和受其直接控制的分配系統(tǒng)。
正確：從管理系統(tǒng)可以監(jiān)視兩個系統(tǒng)：中繼系統(tǒng)和受中繼系統(tǒng)直接控制的分配系統(tǒng)。
- 名詞前不要使用過多的形容詞。
錯誤：此設(shè)備的使用必須在接受過本公司舉辦的正式的設(shè)備培訓(xùn)的技師的指導(dǎo)下進(jìn)行。
正確：此設(shè)備必須在技師的指導(dǎo)下使用，且指導(dǎo)技師必須接受過由本公司舉辦的正式設(shè)備培訓(xùn)。
- 不包含任何標(biāo)點符號的單個句子，或者以逗號分隔的句子構(gòu)件，長度盡量保持在 20 個字以內(nèi)；20~29 個字的句子，可以接受；30~39 個字的句子，語義必須明確，才能接受；多于 40個字的句子，在任何情況下都不能接受。
錯誤：本產(chǎn)品適用于從由一臺服務(wù)器進(jìn)行動作控制的單一節(jié)點結(jié)構(gòu)到由多臺服務(wù)器進(jìn)行動作控制的并行處理程序結(jié)構(gòu)等多種體系結(jié)構(gòu)。
正確：本產(chǎn)品適用于多種體系結(jié)構(gòu)。無論是由一臺服務(wù)器（單一節(jié)點結(jié)構(gòu)），還是由多臺服務(wù)器（并行處理結(jié)構(gòu)）進(jìn)行動作控制，均可以使用本產(chǎn)品。
- 同樣一個意思，盡量使用肯定句表達(dá)，不使用否定句表達(dá)。
錯誤：請確認(rèn)沒有接通裝置的電源。
正確：請確認(rèn)裝置的電源已關(guān)閉。
- 避免使用雙重否定句。
錯誤：沒有刪除權(quán)限的用戶，不能刪除此文件。
正確：用戶必須擁有刪除權(quán)限，才能刪除此文件。
英文處理
英文原文如果使用了復(fù)數(shù)形式，翻譯成中文時，應(yīng)將其還原為單數(shù)形式。
英文：···information stored in random access memory (RAMS)···
中文：……儲存在隨機(jī)存取存儲器（RAM）里
外文縮寫可以使用半角圓點（.）標(biāo)識縮寫
U.S.A.
Apple, Inc.
表示中文時，英文省略號（...）應(yīng)改為中文省略號（……）。
英文：5 minutes later...
中文：5 分鐘過去了……
英文書名或電影名改用中文表達(dá)時，雙引號應(yīng)改為書名號。
英文：He published an article entitled "The Future of the Aviation".
中文：他發(fā)表了一篇名為《航空業(yè)的未來》的文章。
第一次出現(xiàn)英文詞匯時，在括號中給出中文標(biāo)注。此后再次出現(xiàn)時，直接使用英文縮寫即可。
IOC（International Olympic Committee，國際奧林匹克委員會）。這樣定義后，便可以直接使用“IOC”了。
專有名詞中每個詞第一字母均應(yīng)大寫，非專用名詞則不需要大寫。
“American Association of Physicists in Medicine”（美國醫(yī)學(xué)物理學(xué)家協(xié)會）是專有名詞，需要大寫。
“online transaction processing”（在線事務(wù)處理）不是專用名詞，不應(yīng)大寫。
3. 段落
原則
- 一個段落只能有一個主題，或一個中心句子。
- 段落的中心句子放在段首，對全段內(nèi)容進(jìn)行概述。后面陳述的句子為核心句服務(wù)。
- 一個段落的長度不能超過七行，最佳段落長度小于等于四行。
- 段落的句子預(yù)期要使用陳述和肯定語氣，避免使用感嘆語氣。
- 段落之間使用一個空行隔開。
- 段落開頭不要留出空白字符。
引用
引用第三方內(nèi)容時，應(yīng)注明出處。
One man's constant is another man's variable. -- Alan Perlis
如果是全篇轉(zhuǎn)載，請在全文開頭顯著位置注明作者和出處，并連接至原文。
本文轉(zhuǎn)自 WikiQuote
使用外部圖片時，必須在圖片下方或文末標(biāo)明來源。
本文部分圖片來自 Wikipedia
下一篇：技術(shù)文檔寫作指南（2）
