中文文案排版規范
論排版的重要性
對于技術人來講,技術文章就是我們的門面。想了解一個技術人的能力,或者潛力,可以從他的博客文章中開始。撇去內容不講,掃一眼排版是否干凈清爽,直接就可以告訴你關于作者的很多信息:做事是否用心、思維是否清晰、對自己是否有高要求。
社區里許多內推崗位,都是由技術負責人或者 CTO 親自跟進,技術博客作為簡歷的一部分,很多時候都會是他們對應聘者的第一印象。排版混亂的博客,給到招聘方就是一副邋遢不堪的形象,這個時候技術博客是減分的。
另外社區里充斥著排版雜亂的內容,也會影響整個社區的品質,讓人感覺不專業,在這里混的人也會覺得沒有面子。正如某個偉人所說的:
作為技術人,連個文章排版都整不好,何以碼代碼呢?
一、空格
有研究顯示,打字的時候不喜歡在中文和英文之間加空格的人,感情路都走得很辛苦,有七成的比例會在 34 歲的時候跟自己不愛的人結婚,而其余三成的人最后只能把遺產留給自己的貓。 畢竟愛情跟書寫都需要適時地留白。與大家共勉之。
1. 中英文之間需要增加空格
正確:
Laravel 是一套簡潔、優雅的 PHP Web 開發框架。
錯誤:
Laravel是一套簡潔、優雅的PHP Web開發框架。
Laravel 是一套簡潔、優雅的PHP Web 開發框架。
完整的正確例子:
Laravel 天生就具有測試的基因。事實上,Laravel 默認就支持用 PHPUnit 來做測試,并為你的應用程序配置好了
phpunit.xml文件。框架還提供了一些便利的輔助函數,讓你可以更直觀的測試你的應用程序。默認情況,你的應用tests目錄中將會包含兩個子目錄:Feature和Unit。
例外:「豆瓣FM」等產品名詞,按照官方所定義的格式書寫。
2. 中文與數字之間需要增加空格
正確:
今天出去買菜花了 5000 元。
錯誤:
今天出去買菜花了5000元。
今天出去買菜花了 5000元。
3. 數字與單位之間需要增加空格
正確:
我家的光纖入屋寬頻有 10 Gbps,SSD 一共有 20 TB
錯誤:
我家的光纖入屋寬頻有 10Gbps,SSD 一共有 20TB
例外:度 / 百分比與數字之間不需要增加空格:
正確:
今天是 233° 的高溫。
新 MacBook Pro 有 15% 的 CPU 性能提升。
錯誤:
今天是 233 ° 的高溫。
新 MacBook Pro 有 15 % 的 CPU 性能提升。
4. 全角標點與其他字符之間不加空格
正確:
剛剛買了一部 iPhone,好開心!
錯誤:
剛剛買了一部 iPhone ,好開心!
剛剛買了一部 iPhone, 好開心!
二、標點符號
不重復使用標點符號
正確:
德國隊竟然戰勝了巴西隊!
她竟然對你說「喵」?!
錯誤:
德國隊竟然戰勝了巴西隊!!
德國隊竟然戰勝了巴西隊!!!!!!!!
她竟然對你說「喵」??!!
她竟然對你說「喵」?!?!??!!
三、全角和半角
不明白什么是全角(全形)與半角(半形)符號?請閱讀以下鏈接:
1. 使用全角中文標點
正確:
嗨!你知道嘛?今天前臺的小妹跟我說「喵」了哎!
核磁共振成像(NMRI)是什么原理都不知道?JFGI!
錯誤:
嗨! 你知道嘛? 今天前臺的小妹跟我說 "喵" 了哎!
嗨!你知道嘛?今天前臺的小妹跟我說"喵"了哎!
核磁共振成像 (NMRI) 是什么原理都不知道? JFGI!
核磁共振成像(NMRI)是什么原理都不知道?JFGI!
2. 數字使用半角字符
正確:
這件蛋糕只賣 1000 元。
錯誤:
這件蛋糕只賣 1000 元。
例外:在設計稿、宣傳海報中如出現極少量數字的情形時,為方便文字對齊,是可以使用全形數字的。
3. 遇到完整的英文整句、特殊名詞,其內容使用半角標點
正確:
賈伯斯那句話是怎么說的?「Stay hungry, stay foolish.」
推薦你閱讀《Hackers & Painters: Big Ideas from the Computer Age》,非常的有趣。
錯誤:
賈伯斯那句話是怎么說的?「Stay hungry,stay foolish。」
推薦你閱讀《Hackers&Painters:Big Ideas from the Computer Age》,非常的有趣。
四、名詞
1. 專有名詞使用正確的大小寫
大小寫相關用法原屬于英文書寫范疇,不屬于本文討論內容,在這里只對部分易錯用法進行簡述。
正確:
使用 GitHub 登錄
我們的客戶有 GitHub、Foursquare、Microsoft Corporation、Google、Facebook, Inc.。
錯誤:
使用 github 登錄
使用 GITHUB 登錄
使用 Github 登錄
使用 gitHub 登錄
使用 g?ん?Ц8 登錄
我們的客戶有 github、foursquare、microsoft corporation、google、facebook, inc.。
我們的客戶有 GITHUB、FOURSQUARE、MICROSOFT CORPORATION、GOOGLE、FACEBOOK, INC.。
我們的客戶有 Github、FourSquare、MicroSoft Corporation、Google、FaceBook, Inc.。
我們的客戶有 gitHub、fourSquare、microSoft Corporation、google、faceBook, Inc.。
我們的客戶有 g?ん?Ц8、?ouЯ?qu?г?、???г????t ??г??г?t???n、900913、?4??в??к, IП?.。
2. 不要使用不地道的縮寫
正確:
我們需要一位熟悉 JavaScript、HTML5,至少理解一種框架(如 Backbone.js、AngularJS、React 等)的前端開發者。
錯誤:
我們需要一位熟悉 Js、h5,至少理解一種框架(如 backbone、angular、RJS 等)的 FED。
五、雜項
以下用法略帶有個人色彩,即:無論是否遵循下述規則,從語法的角度來講都是正確的。
1. 鏈接之間增加空格
用法:
請 提交一個 issue 并分配給相關同事。
訪問我們網站的最新動態,請 點擊這里 進行訂閱!
對比用法:
請提交一個 issue并分配給相關同事。
訪問我們網站的最新動態,請點擊這里進行訂閱!
2. 簡體中文使用直角引號
用法:
「老師,『有條不紊』的『紊』是什么意思?」
對比用法:
"老師,'有條不紊'的'紊'是什么意思?"
附錄:工具
| 倉庫 | 語言 |
|---|---|
| vinta/paranoid-auto-spacing | JavaScript |
| huei90/pangu.node | Node.js |
| huacnlee/auto-correct | Ruby |
| sparanoid/space-lover | PHP (WordPress) |
| nauxliu/auto-correct | PHP |
| jxlwqq/chinese-typesetting | PHP |
| hotoo/pangu.vim | Vim |
| sparanoid/grunt-auto-spacing | Node.js (Grunt) |
| hjiang/scripts/add-space-between-latin-and-cjk | Python |
| hustcc/hint | Python |
附錄:誰在這樣做?
| 網站 | 文案 | UGC |
|---|---|---|
| Apple 中國 | 是 | N/A |
| Apple 香港 | 是 | N/A |
| Apple 臺灣 | 是 | N/A |
| Microsoft 中國 | 是 | N/A |
| Microsoft 香港 | 是 | N/A |
| Microsoft 臺灣 | 是 | N/A |
| LeanCloud | 是 | N/A |
| V2EX | 是 | 是 |
| Apple4us | 是 | N/A |
| Ruby China | 是 | 標題達成 |
| LearnKu | 是 | 標題達成 |
| 少數派 | 是 | N/A |
社區文檔撰寫指南