中文文案排版指南：提升開源項目文檔質(zhì)量

統(tǒng)一中文文案、排版的相關(guān)用法，降低團隊成員之間的溝通成本，增強項目專業(yè)性和可讀性。

?? 為什么需要文案排版規(guī)范？

在開源項目中，良好的文案排版不僅能夠：

• 提升可讀性：讓讀者更容易理解和閱讀
• 增強專業(yè)性：體現(xiàn)項目的專業(yè)水準
• 降低溝通成本：減少因排版問題產(chǎn)生的誤解
• 統(tǒng)一團隊風格：保持項目文檔的一致性

?? 空格使用規(guī)范

「有研究顯示，打字的時候不喜歡在中文和英文之間加空格的人，感情路都走得很辛苦，有七成的比例會在 34 歲的時候跟自己不愛的人結(jié)婚，而其余三成的人最后只能把遺產(chǎn)留給自己的貓。畢竟愛情跟書寫都需要適時地留白。

與大家共勉之?！埂?/span>vinta/paranoid-auto-spacing^[1]

核心原則

• 中英文之間必須加空格
• 中文與數(shù)字之間必須加空格
• 數(shù)字與單位之間必須加空格
• 全角標點與其他字符之間不加空格

1. 中英文之間需要增加空格

正確示例：

在 GitCode 上，代碼托管是圍繞 Git 進行的。

錯誤示例：

在 GitCode 上，代碼托管是圍繞Git進行的。

在 GitCode 上，代碼托管是圍繞Git 進行的。

完整正確用法：

在 GitCode 上，代碼托管是圍繞 Git 進行的。每個 Repository 都包含了與 JSON 兼容的配置文件。代碼是版本控制的，你不需要在每個 Commit 上提前指定存在哪些文件，只要直接提交對應(yīng)的代碼即可。

例外情況：「開源中國」等產(chǎn)品名詞，按照官方所定義的格式書寫。

2. 中文與數(shù)字之間需要增加空格

正確示例：

這個開源項目已經(jīng)獲得了 5000 個 Star。

錯誤示例：

這個開源項目已經(jīng)獲得了 5000 個 Star。

這個開源項目已經(jīng)獲得了 5000 個 Star。

3. 數(shù)字與單位之間需要增加空格

正確示例：

這個 API 的響應(yīng)時間只有 10 ms，數(shù)據(jù)庫查詢需要 20 ms

錯誤示例：

這個 API 的響應(yīng)時間只有 10ms，數(shù)據(jù)庫查詢需要 20ms

例外情況：度數(shù)／百分比與數(shù)字之間不需要增加空格

正確示例：

代碼覆蓋率達到了 90%，性能提升了 15%。

錯誤示例：

代碼覆蓋率達到了 90 %，性能提升了 15 %。

4. 全角標點與其他字符之間不加空格

正確示例：

剛剛提交了一個 Pull Request，好開心！

錯誤示例：

剛剛提交了一個 Pull Request ，好開心！

剛剛提交了一個 Pull Request， 好開心！

?? 標點符號使用規(guī)范

1. 不重復使用標點符號

雖然中國大陸的標點符號用法允許重復使用標點符號，但是這么做會破壞句子的美觀性和專業(yè)性。

正確示例：

這個 Bug 終于修復了！

你竟然說這個代碼「完美」？！

錯誤示例：

這個 Bug 終于修復了！！

這個 Bug 終于修復了?。。。。。。?！

你竟然說這個代碼「完美」？？??！

你竟然說這個代碼「完美」？?。浚?？？！！

?? 全角和半角使用規(guī)范

不明白什么是全角（全形）與半角（半形）符號？請查看維基百科條目『全角和半角^[2]』。

1. 使用全角中文標點

正確示例：

嗨！你知道嘛？今天代碼審查通過了「完美」了哎！

什么是 Git 版本控制都不知道？Google it！

錯誤示例：

嗨! 你知道嘛? 今天代碼審查通過了 "完美" 了哎！

嗨!你知道嘛?今天代碼審查通過了"完美"了哎！

什么是 Git 版本控制都不知道? Google it!

什么是 Git 版本控制都不知道?Google it!

例外情況：中文句子內(nèi)夾有英文書籍名、報刊名時，不應(yīng)借用中文書名號，應(yīng)以英文斜體表示。

2. 數(shù)字使用半角字符

正確示例：

這個項目已經(jīng)運行了 1000 天。

錯誤示例：

這個項目已經(jīng)運行了 １０００ 天。

例外情況：在設(shè)計稿、宣傳海報中如出現(xiàn)極少量數(shù)字的情形時，為方便文字對齊，是可以使用全角數(shù)字的。

3. 英文整句使用半角標點

正確示例：

Linus 那句話是怎么說的？「Talk is cheap. Show me the code.」

推薦你閱讀 _The Pragmatic Programmer: Your Journey to Mastery_，非常地有趣。

錯誤示例：

Linus 那句話是怎么說的？「Talk is cheap，show me the code。」

推薦你閱讀《The Pragmatic Programmer：Your Journey to Mastery》，非常的有趣。

?? 名詞使用規(guī)范

1. 專有名詞使用正確的大小寫

大小寫相關(guān)用法原屬于英文書寫范疇，不屬于本 wiki 討論內(nèi)容，在這里只對部分易錯用法進行簡述。

正確示例：

使用 GitCode 登錄

我們的開源項目有 React、Flutter、倉頡。

2. 不要使用不地道的縮寫

正確示例：

我們需要一位熟悉 TypeScript、ArkTS，至少理解一種框架（如 React、Flutter）的大前端開發(fā)者。

錯誤示例：

我們需要一位熟悉 Ts、arkts，至少理解一種框架（如 RJS、flutter）的 FED。

?? 爭議性用法

以下用法略帶有個人色彩，即：無論是否遵循下述規(guī)則，從語法的角度來講都是正確的。

1. 鏈接之間增加空格

推薦用法：

請 提交一個 Pull Request^[3] 并分配給相關(guān)維護者。

查看項目的最新更新，請 點擊這里^[4] 進行關(guān)注！

對比用法：

請提交一個 Pull Request^[5]并分配給相關(guān)維護者。

查看項目的最新更新，請點擊這里^[6]進行關(guān)注！

2. 簡體中文使用直角引號

推薦用法：

「開發(fā)者，『有條不紊』的『紊』是什么意思？」

對比用法：

"開發(fā)者，'有條不紊'的'紊'是什么意思？"

??? 實用工具推薦

自動排版工具

• Pangu.js：自動在中英文之間添加空格
• Typora：Markdown 編輯器，支持自動排版
• VS Code 插件：Chinese (Simplified) Language Pack

檢查清單

• [ ] 中英文之間是否有空格
• [ ] 數(shù)字與單位之間是否有空格
• [ ] 是否使用了全角中文標點
• [ ] 專有名詞大小寫是否正確
• [ ] 是否避免了不地道的縮寫

?? 總結(jié)

遵循這些排版規(guī)范，可以讓您的開源項目文檔：

• 更加專業(yè)和易讀
• 提升用戶體驗
• 體現(xiàn)團隊的專業(yè)素養(yǎng)
• 降低溝通成本

記住：好的排版是尊重讀者的表現(xiàn)！