來源：阮一峰的 github
標(biāo)題
層級(jí)
標(biāo)題分四級(jí)讲坎。
- 一級(jí)標(biāo)題：文章的標(biāo)題
- 二級(jí)標(biāo)題：文章主要部分的大標(biāo)題
- 三級(jí)標(biāo)題：二級(jí)標(biāo)題下面一級(jí)的小標(biāo)題
- 四級(jí)標(biāo)題：三級(jí)標(biāo)題下面某一方面的小標(biāo)題
示例：
# 一級(jí)標(biāo)題
## 二級(jí)標(biāo)題
### 三級(jí)標(biāo)題
#### 四級(jí)標(biāo)題
原則
- 一級(jí)標(biāo)題下，不能直接出現(xiàn)三級(jí)標(biāo)題塞祈。
# 一級(jí)標(biāo)題
### 三級(jí)標(biāo)題
- 標(biāo)題要避免孤立編號(hào)（即同級(jí)標(biāo)題只有一個(gè)）。
## 二級(jí)標(biāo)題 A
### 三級(jí)標(biāo)題 A
## 二級(jí)標(biāo)題 B
- 下級(jí)標(biāo)題不重復(fù)上一級(jí)標(biāo)題的名字图谷。
## 概述
### 概述
- 謹(jǐn)慎使用四級(jí)標(biāo)題蔗崎，盡量避免出現(xiàn)，保持層級(jí)的簡(jiǎn)單促绵，防止出現(xiàn)過于復(fù)雜的章節(jié)。`
結(jié)構(gòu)一
### 三級(jí)標(biāo)題
#### 四級(jí)標(biāo)題 A
#### 四級(jí)標(biāo)題 B
#### 四級(jí)標(biāo)題 C
結(jié)構(gòu)二
### 三級(jí)標(biāo)題
**（1）A**
**（2）B**
**（3）C**
文本
字間距
全角中文字符與半角英文字符之間嘴纺，應(yīng)有一個(gè)半角空格败晴。
錯(cuò)誤：本文介紹如何快速啟動(dòng)Windows系統(tǒng)。
正確：本文介紹如何快速啟動(dòng) Windows 系統(tǒng)栽渴。
全角中文字符與半角阿拉伯?dāng)?shù)字之間尖坤，有沒有半角空格都可，但必須保證風(fēng)格統(tǒng)一闲擦，不能兩種風(fēng)格混雜慢味。
正確：2011年5月11日，我訂購(gòu)了5臺(tái)筆記本電腦與10臺(tái)平板電腦墅冷。
正確：2011 年 5 月 15 日纯路，我訂購(gòu)了 5 臺(tái)筆記本電腦與 10 臺(tái)平板電腦。
半角的百分號(hào)寞忿，視同阿拉伯?dāng)?shù)字驰唬。
英文單位若不翻譯，單位前的阿拉伯?dāng)?shù)字與單位間不留空格腔彰。
錯(cuò)誤：一部容量為 16 GB 的智能手機(jī)定嗓。
正確：一部容量為 16GB 的智能手機(jī)蜕琴。
半角英文字符和半角阿拉伯?dāng)?shù)字萍桌，與全角標(biāo)點(diǎn)符號(hào)之間不留空格宵溅。
錯(cuò)誤：他的電腦是 MacBook Air 。
正確：他的電腦是 MacBook Air上炎。
句子
- 避免使用長(zhǎng)句恃逻。句子內(nèi)部不適用逗號(hào)時(shí)，總長(zhǎng)度不應(yīng)該超過 40 個(gè)字藕施；使用逗號(hào)時(shí)寇损，總長(zhǎng)度不應(yīng)該超過 100 字或者正文的 3 行。
- 盡量使用簡(jiǎn)單句和并列句裳食，避免使用復(fù)合句矛市。
寫作風(fēng)格
- 盡量不適用被動(dòng)語(yǔ)態(tài)，改為使用主動(dòng)語(yǔ)態(tài)诲祸。
錯(cuò)誤：假如此軟件尚未被安裝浊吏，
正確：假如尚未安裝這個(gè)軟件，
- 不適用非正式的語(yǔ)言風(fēng)格救氯。
錯(cuò)誤：Lady Gaga 的演唱會(huì)真是酷斃了找田，從沒看過這么給力的表演！Ｗ藕墩衙！
正確：無法參加本次活動(dòng)，我深感遺憾甲抖。
- 不適用冷僻漆改、生造或者文言文的詞語(yǔ)，而要使用現(xiàn)代漢語(yǔ)的常用表達(dá)方式准谚。
錯(cuò)誤：這是唯二的快速啟動(dòng)的方法挫剑。
正確：這是僅有的兩種快速啟動(dòng)的方法。
- 用對(duì)“的”氛魁、“地”暮顺、“得”。
她露出了開心的笑容秀存。
（形容詞 + 的 + 名詞）
她開心地笑了
（副詞 + 地 + 動(dòng)詞）
她笑得很開心
（動(dòng)詞 + 得 + 副詞）
- 使用代詞時(shí)（比如“其”捶码、“該”，“此”或链，“這”等詞）惫恼，必須明確指代的內(nèi)容，保證只有一個(gè)含義澳盐。
錯(cuò)誤：從管理系統(tǒng)可以監(jiān)視中繼系統(tǒng)和受其直接控制的分配系統(tǒng)祈纯。
正確：從管理系統(tǒng)可以監(jiān)視兩個(gè)系統(tǒng)：中繼系統(tǒng)和受中繼系統(tǒng)直接控制的分配系統(tǒng)令宿。
- 名詞前不要使用過多的形容詞。
錯(cuò)誤：此設(shè)備的使用必須在接受過本公司舉辦的正式的設(shè)備培訓(xùn)的技師的指導(dǎo)下進(jìn)行腕窥。
正確：此設(shè)備必須在技師的指導(dǎo)下使用粒没，且指導(dǎo)技師必須接受過由本公司舉辦的正式設(shè)備培訓(xùn)。
- 不包含任何標(biāo)點(diǎn)符號(hào)的單個(gè)句子簇爆，或者以逗號(hào)分隔的句子構(gòu)件癞松，長(zhǎng)度盡量保持在 20 個(gè)字以內(nèi)；20~29 個(gè)字的句子入蛆，可以接受响蓉；30~39 個(gè)字的句子，語(yǔ)義必須明確哨毁，才能接受枫甲；多于 40個(gè)字的句子，在任何情況下都不能接受扼褪。
錯(cuò)誤：本產(chǎn)品適用于從由一臺(tái)服務(wù)器進(jìn)行動(dòng)作控制的單一節(jié)點(diǎn)結(jié)構(gòu)到由多臺(tái)服務(wù)器進(jìn)行動(dòng)作控制的并行處理程序結(jié)構(gòu)等多種體系結(jié)構(gòu)想幻。
正確：本產(chǎn)品適用于多種體系結(jié)構(gòu)。無論是由一臺(tái)服務(wù)器（單一節(jié)點(diǎn)結(jié)構(gòu)）迎捺，還是由多臺(tái)服務(wù)器（并行處理結(jié)構(gòu)）進(jìn)行動(dòng)作控制举畸，均可以使用本產(chǎn)品。
- 同樣一個(gè)意思凳枝，盡量使用肯定句表達(dá)抄沮，不使用否定句表達(dá)。
錯(cuò)誤：請(qǐng)確認(rèn)沒有接通裝置的電源岖瑰。
正確：請(qǐng)確認(rèn)裝置的電源已關(guān)閉叛买。
- 避免使用雙重否定句。
錯(cuò)誤：沒有刪除權(quán)限的用戶蹋订，不能刪除此文件率挣。
正確：用戶必須擁有刪除權(quán)限，才能刪除此文件露戒。
英文處理
英文原文如果使用了復(fù)數(shù)形式椒功，翻譯成中文時(shí)，應(yīng)將其還原為單數(shù)形式智什。
英文：···information stored in random access memory (RAMS)···
中文：……儲(chǔ)存在隨機(jī)存取存儲(chǔ)器（RAM）里
外文縮寫可以使用半角圓點(diǎn)（.）標(biāo)識(shí)縮寫
U.S.A.
Apple, Inc.
表示中文時(shí)动漾，英文省略號(hào)（...）應(yīng)改為中文省略號(hào)（……）。
英文：5 minutes later...
中文：5 分鐘過去了……
英文書名或電影名改用中文表達(dá)時(shí)荠锭，雙引號(hào)應(yīng)改為書名號(hào)旱眯。
英文：He published an article entitled "The Future of the Aviation".
中文：他發(fā)表了一篇名為《航空業(yè)的未來》的文章。
第一次出現(xiàn)英文詞匯時(shí)，在括號(hào)中給出中文標(biāo)注删豺。此后再次出現(xiàn)時(shí)共虑，直接使用英文縮寫即可。
IOC（International Olympic Committee呀页，國(guó)際奧林匹克委員會(huì)）妈拌。這樣定義后，便可以直接使用“IOC”了赔桌。
專有名詞中每個(gè)詞第一字母均應(yīng)大寫供炎，非專用名詞則不需要大寫。
“American Association of Physicists in Medicine”（美國(guó)醫(yī)學(xué)物理學(xué)家協(xié)會(huì)）是專有名詞疾党，需要大寫。
“online transaction processing”（在線事務(wù)處理）不是專用名詞惨奕，不應(yīng)大寫雪位。
3. 段落
原則
- 一個(gè)段落只能有一個(gè)主題，或一個(gè)中心句子梨撞。
- 段落的中心句子放在段首雹洗，對(duì)全段內(nèi)容進(jìn)行概述。后面陳述的句子為核心句服務(wù)卧波。
- 一個(gè)段落的長(zhǎng)度不能超過七行时肿，最佳段落長(zhǎng)度小于等于四行。
- 段落的句子預(yù)期要使用陳述和肯定語(yǔ)氣港粱，避免使用感嘆語(yǔ)氣螃成。
- 段落之間使用一個(gè)空行隔開。
- 段落開頭不要留出空白字符查坪。
引用
引用第三方內(nèi)容時(shí)寸宏，應(yīng)注明出處。
One man's constant is another man's variable. -- Alan Perlis
如果是全篇轉(zhuǎn)載偿曙，請(qǐng)?jiān)谌拈_頭顯著位置注明作者和出處氮凝，并連接至原文。
本文轉(zhuǎn)自 WikiQuote
使用外部圖片時(shí)望忆，必須在圖片下方或文末標(biāo)明來源罩阵。
本文部分圖片來自 Wikipedia
下一篇：技術(shù)文檔寫作指南（2）
