中文技術文檔寫作規范

• 使用 markdown 格式書寫文檔
• 只使用一二三級標題，三級標題下面的並列性內容使用列表展示
• 二級標題前使用行分隔符表示分隔
• 段落之間使用一個空行隔開
• 一句話或者以逗號分隔的句子，長度盡量保持在 20 個字以內，20～29 個字的句子，可以接受
• 禁止文字口語化
• 盡量使用肯定句表達，不使用否定句表達（例如：沒有、不能、不可以）
• 不使用“被”
• 第一次出現英文詞匯時，在括號中給出中文標注【例如：IOC（International Olympic Committee，國際奧林匹克委員會）】
• 引號里面還要用引號時，外面一層用雙引號，里面一層用單引號
• 句子末尾用括號加注釋時，句號應在括號后面（例如）。
• 中文字符和英文、數字之間保持一個空格，其他符號無需空格
• 數字和英文單位之間保留一個空格（如 10 kg）
• 對於四位以上的數值，應添加千分號（如 1,200,000 元）
• 數值范圍（例如日期、時間或數字）應該使用波浪連接號（～）或一字號（—），波浪連接號前后兩個值都建議加上單位（如 10 kg~20 kg 或者中文格式 -20 °C 至 -10 °C）
• 使用外部圖片時，必須在圖片下方標明來源（例如：圖片來源 博客園 | 這個殺手冷死了）
• 引用第三方內容時，應在文末標明，並鏈接至原文
• 文件名盡量只使用英文小寫，不得使用大寫字母，除非是某些說明文件，比如 README.md

---

參考鏈接

中文技術文檔的寫作規范 | 阮一峰