1.標(biāo)題
1.1層級(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)題
1.2原則
(1)一級(jí)標(biāo)題下嚼锄,不能直接出現(xiàn)三級(jí)標(biāo)題沟饥。
示例:下面的文章結(jié)構(gòu),缺少二級(jí)標(biāo)題瞒渠。
# 一級(jí)標(biāo)題
### 三級(jí)標(biāo)題
(2)標(biāo)題要避免孤立編號(hào)(即同級(jí)標(biāo)題只有一個(gè))技潘。
示例:下面的文章結(jié)構(gòu),二級(jí)標(biāo)題 A
只包含一個(gè)三級(jí)標(biāo)題分飞,完全可以省略三級(jí)標(biāo)題 A
悴务。
## 二級(jí)標(biāo)題 A
### 三級(jí)標(biāo)題 A
## 二級(jí)標(biāo)題 B
(3)下級(jí)標(biāo)題不重復(fù)上一級(jí)標(biāo)題的名字。
示例:下面的文章結(jié)構(gòu)譬猫,二級(jí)標(biāo)題與下屬的三級(jí)標(biāo)題同名讯檐,建議避免。
## 概述
### 概述
(4)謹(jǐn)慎使用四級(jí)標(biāo)題染服,盡量避免出現(xiàn)别洪,保持層級(jí)的簡(jiǎn)單,防止出現(xiàn)過于復(fù)雜的章節(jié)柳刮。
如果三級(jí)標(biāo)題下有并列性的內(nèi)容挖垛,建議只使用項(xiàng)目列表(Item list)。
示例:下面的結(jié)構(gòu)二要好于結(jié)構(gòu)一秉颗。后者適用的場(chǎng)景痢毒,主要是較長(zhǎng)篇幅的內(nèi)容。
結(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**
2.文本
2.1字間距
全角中文字符與半角英文字符之間站宗,應(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月15日摸袁,我訂購(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隙咸。
2.2 句子
- 避免使用長(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ù)合句。
2.3寫作風(fēng)格
1遥椿、盡量不使用被動(dòng)語(yǔ)態(tài)误证,改為使用主動(dòng)語(yǔ)態(tài)。
錯(cuò)誤:假如此軟件尚未被安裝修壕,
正確:假如尚未安裝這個(gè)軟件愈捅,
2、不使用非正式的語(yǔ)言風(fēng)格慈鸠。
錯(cuò)誤:Lady Gaga 的演唱會(huì)真是酷斃了蓝谨,從沒看過這么給力的表演!G嗤拧譬巫!
正確:無(wú)法參加本次活動(dòng),我深感遺憾督笆。
3芦昔、不使用冷僻、生造或者文言文的詞語(yǔ)娃肿,而要使用現(xiàn)代漢語(yǔ)的常用表達(dá)方式咕缎。
錯(cuò)誤:這是唯二的快速啟動(dòng)的方法。
正確:這是僅有的兩種快速啟動(dòng)的方法料扰。
4凭豪、用對(duì)“的”、“地”晒杈、“得”嫂伞。
她露出了開心的笑容。
(形容詞+的+名詞)
她開心地笑了。
(副詞+地+動(dòng)詞)
她笑得很開心帖努。
(動(dòng)詞+得+副詞)
5撰豺、使用代詞時(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)舅柜。
6梭纹、名詞前不要使用過多的形容詞。
錯(cuò)誤:此設(shè)備的使用必須在接受過本公司舉辦的正式的設(shè)備培訓(xùn)的技師的指導(dǎo)下進(jìn)行致份。
正確:此設(shè)備必須在技師的指導(dǎo)下使用变抽,且指導(dǎo)技師必須接受過由本公司舉辦的正式設(shè)備培訓(xùn)。
7氮块、不包含任何標(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)吊洼。無(wú)論是由一臺(tái)服務(wù)器(單一節(jié)點(diǎn)結(jié)構(gòu))训貌,還是由多臺(tái)服務(wù)器(并行處理結(jié)構(gòu))進(jìn)行動(dòng)作控制,均可以使用本產(chǎn)品冒窍。
8递沪、同樣一個(gè)意思,盡量使用肯定句表達(dá)超燃,不使用否定句表達(dá)区拳。
錯(cuò)誤:請(qǐng)確認(rèn)沒有接通裝置的電源拘领。
正確:請(qǐng)確認(rèn)裝置的電源已關(guān)閉意乓。
9、避免使用雙重否定句。
錯(cuò)誤:沒有刪除權(quán)限的用戶届良,不能刪除此文件笆凌。
正確:用戶必須擁有刪除權(quán)限,才能刪除此文件士葫。
2.4英文處理
英文原文如果使用了復(fù)數(shù)形式乞而,翻譯成中文時(shí),應(yīng)該將其還原為單數(shù)形式慢显。
英文:?information stored in random access memory (RAMs)?
中文:……存儲(chǔ)在隨機(jī)存取存儲(chǔ)器(RAM)里的信息……
外文縮寫可以使用半角圓點(diǎn)(.
)表示縮寫爪模。
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è)詞第一個(gè)字母均應(yīng)大寫璃岳,非專有名詞則不需要大寫龙考。
“American Association of Physicists in Medicine”(美國(guó)醫(yī)學(xué)物理學(xué)家協(xié)會(huì))是專有名詞,需要大寫矾睦。
“online transaction processing”(在線事務(wù)處理)不是專有名詞晦款,不應(yīng)大寫。
3.段落
3.1原則
- 一個(gè)段落只能有一個(gè)主題枚冗,或一個(gè)中心句子缓溅。
- 段落的中心句子放在段首,對(duì)全段內(nèi)容進(jìn)行概述赁温。后面陳述的句子為核心句服務(wù)坛怪。
- 一個(gè)段落的長(zhǎng)度不能超過七行,最佳段落長(zhǎng)度小于等于四行股囊。
- 段落的句子語(yǔ)氣要使用陳述和肯定語(yǔ)氣袜匿,避免使用感嘆語(yǔ)氣。
- 段落之間使用一個(gè)空行隔開稚疹。
- 段落開頭不要留出空白字符居灯。
3.2引用
引用第三方內(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
4.數(shù)值
4.1半角數(shù)字
數(shù)字一律使用半角形式,不得使用全角形式噪径。
錯(cuò)誤: 這件商品的價(jià)格是1000元柱恤。
正確: 這件商品的價(jià)格是 1000 元。
4.2千分號(hào)
數(shù)值為千位以上找爱,應(yīng)添加千分號(hào)(半角逗號(hào))膨更。
XXX 公司的實(shí)收資本為 RMB1,258,000。
對(duì)于 4 ~ 6 位的數(shù)值缴允,千分號(hào)是選用的荚守,比如1000
和1,000
都可以接受。對(duì)于7位及以上的數(shù)值练般,千分號(hào)是必須的矗漾。
多位小數(shù)要從小數(shù)點(diǎn)后從左向右添加千分號(hào),比如4.234,345
薄料。
4.3貨幣
貨幣應(yīng)為阿拉伯?dāng)?shù)字敞贡,并在數(shù)字前寫出貨幣符號(hào),或在數(shù)字后寫出貨幣中文名稱摄职。
$1,000
1,000 美元
4.4數(shù)值范圍
表示數(shù)值范圍時(shí)誊役,用~
連接。參見《標(biāo)點(diǎn)符號(hào)》一節(jié)的“連接號(hào)”部分谷市。
帶有單位或百分號(hào)時(shí)蛔垢,兩個(gè)數(shù)字都要加上單位或百分號(hào),不能只加后面一個(gè)迫悠。
錯(cuò)誤:132~234kg
正確:132kg~234kg
錯(cuò)誤:67~89%
正確:67%~89%
4.5變化程度的表示法
數(shù)字的增加要使用“增加了”鹏漆、“增加到”〈葱梗“了”表示增量艺玲,“到”表示定量。
增加到過去的兩倍
(過去為一鞠抑,現(xiàn)在為二)
增加了兩倍
(過去為一饭聚,現(xiàn)在為三)
數(shù)字的減少要使用“降低了”、“降低到”搁拙∶胧幔“了”表示增量法绵,“到”表示定量。
降低到百分之八十
(定額是一百端幼,現(xiàn)在是八十)
降低了百分之八十
(原來是一百礼烈,現(xiàn)在是二十)
不能用“降低N倍”或“減少N倍”的表示法弧满,要用“降低百分之幾”或“減少百分之幾”婆跑。因?yàn)闇p少(或降低)一倍表示數(shù)值原來為一百,現(xiàn)在等于零庭呜。
5.標(biāo)點(diǎn)符號(hào)
5.1原則
- 中文語(yǔ)句的標(biāo)點(diǎn)符號(hào)滑进,均應(yīng)該采取全角符號(hào),這樣可以保證視覺的一致募谎。
- 如果整句為英文扶关,則該句使用英文/半角標(biāo)點(diǎn)。
- 句號(hào)数冬、問號(hào)节槐、嘆號(hào)、逗號(hào)拐纱、頓號(hào)铜异、分號(hào)和冒號(hào)不得出現(xiàn)在一行之首。
5.2句號(hào)
中文語(yǔ)句中的結(jié)尾處應(yīng)該用全角句號(hào)(秸架。
)揍庄。
句子末尾用括號(hào)加注時(shí),句號(hào)應(yīng)在括號(hào)之外东抹。
錯(cuò)誤:關(guān)于文件的輸出蚂子,請(qǐng)參照第 1.3 節(jié)(見第 26 頁(yè)。)
正確:關(guān)于文件的輸出缭黔,請(qǐng)參照第 1.3 節(jié)(見第 26 頁(yè))食茎。
5.3逗號(hào)
逗號(hào),
表示句子內(nèi)部的一般性停頓馏谨。
注意避免“一逗到底”董瞻,即整個(gè)段落除了結(jié)尾,全部停頓都使用逗號(hào)田巴。
5.4頓號(hào)
句子內(nèi)部的并列詞钠糊,應(yīng)該用全角頓號(hào)(、
) 分隔壹哺,而不用逗號(hào)抄伍,即使并列詞是英語(yǔ)也是如此。
錯(cuò)誤:我最欣賞的科技公司有 Google, Facebook, 騰訊, 阿里和百度等管宵。
正確:我最欣賞的科技公司有 Google截珍、Facebook攀甚、騰訊、阿里和百度等岗喉。
英文句子中秋度,并列詞語(yǔ)之間使用半角逗號(hào)(,
)分隔。
例句:Microsoft Office includes Word, Excel, PowerPoint, Outlook and other components.
5.5分號(hào)
分號(hào)钱床;
表示復(fù)句內(nèi)部并列分句之間的停頓荚斯。
5.6引號(hào)
引用時(shí),應(yīng)該使用全角雙引號(hào)(“ ”
)查牌,注意前后雙引號(hào)不同事期。
例句:許多人都認(rèn)為客戶服務(wù)的核心是“友好”和“專業(yè)”。
引號(hào)里面還要用引號(hào)時(shí)纸颜,外面一層用雙引號(hào)兽泣,里面一層用單引號(hào)(‘ ’
),注意前后單引號(hào)不同胁孙。
例句:鮑勃解釋道:“我要放音樂唠倦,可薩利說,‘不行涮较!’稠鼻。”
5.7圓括號(hào)
補(bǔ)充說明時(shí)法希,使用全角圓括號(hào)()
枷餐,括號(hào)前后不加空格哨坪。
例句:請(qǐng)確認(rèn)所有的連接(電纜和接插件)均安裝牢固且轨。
5.8冒號(hào)
全角冒號(hào)(:
)常用在需要解釋的詞語(yǔ)后邊,引出解釋和說明乏矾。
例句:請(qǐng)確認(rèn)以下幾項(xiàng)內(nèi)容:時(shí)間屋剑、地點(diǎn)润匙、活動(dòng)名稱,以及來賓數(shù)量唉匾。
表示時(shí)間時(shí)孕讳,應(yīng)使用半角冒號(hào)(:
)。
例句:早上 8:00
5.9省略號(hào)
省略號(hào)……
表示語(yǔ)句未完巍膘、或者語(yǔ)氣的不連續(xù)厂财。它占兩個(gè)漢字空間、包含六個(gè)省略點(diǎn)峡懈,不要使用璃饱。。肪康。
或...
等非標(biāo)準(zhǔn)形式荚恶。
省略號(hào)不應(yīng)與“等”這個(gè)詞一起使用撩穿。
錯(cuò)誤:我們?yōu)闀?huì)餐準(zhǔn)備了香蕉、蘋果谒撼、梨…等各色水果食寡。
正確:我們?yōu)闀?huì)餐準(zhǔn)備了各色水果,有香蕉廓潜、蘋果抵皱、梨……
正確:我們?yōu)闀?huì)餐準(zhǔn)備了香蕉、蘋果茉帅、梨等各色水果叨叙。
5.10感嘆號(hào)
應(yīng)該使用平靜的語(yǔ)氣敘述锭弊,盡量避免使用感嘆號(hào)堪澎!
。
不得多個(gè)感嘆號(hào)連用味滞,比如S8颉!
和!!!
剑鞍。
5.11破折號(hào)
破折號(hào)————
一般用于進(jìn)一步解釋昨凡。
破折號(hào)應(yīng)占兩個(gè)漢字的位置。如果破折號(hào)本身只占一個(gè)漢字的位置蚁署,那么前后應(yīng)該留出一個(gè)半角空格便脊。
例句:直覺————盡管它并不總是可靠的————告訴我,這事可能出了些問題光戈。
例句:直覺 —— 盡管它并不總是可靠的 —— 告訴我哪痰,這事可能出了些問題。
5.12連接號(hào)
連接號(hào)用于連接兩個(gè)類似的詞久妆。
以下場(chǎng)合應(yīng)該使用直線連接號(hào)(-
)晌杰,占一個(gè)半角字符的位置。
- 兩個(gè)名詞的復(fù)合
- 圖表編號(hào)
例句:氧化-還原反應(yīng)
例句:圖 1-1
以下場(chǎng)合應(yīng)該使用波浪連接號(hào)(~
)筷弦,占一個(gè)全角字符的位置肋演。
- 數(shù)值范圍(例如日期、時(shí)間或數(shù)字)
例句:2009 年~2011 年
注意烂琴,波浪連接號(hào)前后兩個(gè)值都應(yīng)該加上單位爹殊。
波浪連接號(hào)也可以用漢字“至”代替。
例句:周圍溫度:-20°C 至 -10°C
6.文檔體系
6.1結(jié)構(gòu)
軟件手冊(cè)是一部完整的書奸绷,建議采用下面的結(jié)構(gòu)梗夸。
- 簡(jiǎn)介(Introduction): [必備] [文件] 提供對(duì)產(chǎn)品和文檔本身的總體的、扼要的說明
- 快速上手(Getting Started):[可選] [文件] 如何最快速地使用產(chǎn)品
-
入門篇(Basics): [必備] [目錄] 又稱”使用篇“健盒,提供初級(jí)的使用教程
- 環(huán)境準(zhǔn)備(Prerequisite):[必備] [文件] 軟件使用需要滿足的前置條件
- 安裝(Installation):[可選] [文件] 軟件的安裝方法
- 設(shè)置(Configuration):[必備] [文件] 軟件的設(shè)置
- 進(jìn)階篇(Advanced):[可選] [目錄] 又稱”開發(fā)篇“绒瘦,提供中高級(jí)的開發(fā)教程
- API(Reference):[可選] [目錄|文件] 軟件 API 的逐一介紹
- FAQ:[可選] [文件] 常見問題解答
-
附錄(Appendix):[可選] [目錄] 不屬于教程本身称簿、但對(duì)閱讀教程有幫助的內(nèi)容
- Glossary:[可選] [文件] 名詞解釋
- Recipes:[可選] [文件] 最佳實(shí)踐
- Troubleshooting:[可選] [文件] 故障處理
- ChangeLog:[可選] [文件] 版本說明
- Feedback:[可選] [文件] 反饋方式
下面是兩個(gè)真實(shí)范例,可參考惰帽。
6.2文件名
文檔的文件名不得含有空格憨降。
文件名必須使用半角字符,不得使用全角字符该酗。這也意味著授药,中文不能用于文件名。
錯(cuò)誤: 名詞解釋.md
正確: glossary.md
文件名建議只使用小寫字母呜魄,不使用大寫字母悔叽。
錯(cuò)誤:TroubleShooting.md
正確:troubleshooting.md
為了醒目,某些說明文件的文件名爵嗅,可以使用大寫字母娇澎,比如README
、LICENSE
睹晒。
文件名包含多個(gè)單詞時(shí)趟庄,單詞之間建議使用半角的連詞線(-
)分隔。
不佳:advanced_usage.md
正確:advanced-usage.md
7.參考鏈接
- 產(chǎn)品手冊(cè)中文寫作規(guī)范, by 華為
- 寫作規(guī)范和格式規(guī)范, by DaoCloud
- 技術(shù)寫作技巧在日漢翻譯中的應(yīng)用, by 劉方
- 簡(jiǎn)體中文規(guī)范指南, by lengoo
- 文檔風(fēng)格指南, by LeanCloud
- 豌豆莢文案風(fēng)格指南, by 豌豆莢
- 中文文案排版指北, by sparanoid
- 中文排版需求, by W3C
- 為什么文件名要小寫伪很?, by 阮一峰
- Google Developer Documentation Style Guide, by Google