前言：規(guī)范文檔的好處，其一增加文檔易讀性，其二體現(xiàn)個(gè)人專業(yè)性

• 只使用一二三級(jí)標(biāo)題，三級(jí)標(biāo)題下面的并列性內(nèi)容使用列表展示
• 二級(jí)標(biāo)題前使用行分隔符表示分隔
• 段落之間使用一個(gè)空行隔開
• 一句話或者以逗號(hào)分隔的句子，長(zhǎng)度盡量保持在 20 個(gè)字以內(nèi)，20～29 個(gè)字的句子，可以接受
• 禁止文字口語(yǔ)化
• 盡量使用肯定句表達(dá)，不使用否定句表達(dá)（例如：沒(méi)有、不能、不可以）
• 不使用“被”
• 技術(shù)名詞大小寫拼寫正確，比如正確的拼寫：Java、JavaScript、MySQL
• 第一次出現(xiàn)英文詞匯時(shí)，在括號(hào)中給出中文標(biāo)注【例如：IOC（International Olympic Committee，國(guó)際奧林匹克委員會(huì)）】
• 引號(hào)里面還要用引號(hào)時(shí)，外面一層用雙引號(hào)，里面一層用單引號(hào)
• 句子末尾用括號(hào)加注釋時(shí)，句號(hào)應(yīng)在括號(hào)后面（例如）。
• 中文字符和英文、數(shù)字之間保持一個(gè)空格，其他符號(hào)無(wú)需空格
• 數(shù)字和英文單位之間保留一個(gè)空格（如 10 kg）
• 對(duì)于四位以上的數(shù)值，應(yīng)添加千分號(hào)（如 1,200,000 元）
• 數(shù)值范圍（例如日期、時(shí)間或數(shù)字）應(yīng)該使用波浪連接號(hào)（～）或一字號(hào)（—），波浪連接號(hào)前后兩個(gè)值都建議加上單位（如 10 kg~20 kg 或者中文格式 -20 °C 至 -10 °C）
• 使用外部圖片時(shí)，必須在圖片下方標(biāo)明來(lái)源（例如：圖片來(lái)源 CSDN | PANDA）
• 引用第三方內(nèi)容時(shí)，應(yīng)在文末標(biāo)明，并鏈接至原文
• 文件名盡量只使用英文小寫，不得使用大寫字母，除非是某些說(shuō)明文件，比如 README.md

---

參考鏈接

中文技術(shù)文檔的寫作規(guī)范 | 阮一峰

總結(jié)

以上是生活随笔為你收集整理的中文技术文档写作规范（汇总整理版）的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。

如果覺(jué)得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。