中文寫作排版風格指南

RightCapital發表於2021-01-13

RightCapital 團隊日常需要撰寫一些中文內容,包括技術分享、招聘啟事等。為了讓我們的文章風格統一,表詞達意清晰並專業,我們制定了一份內部的中文的風格指南。
我們已經把這個風格指南在我們的官方 GitHub 賬號開源: github.com/RightCapitalHQ/chinese-s...

本文對中文文章的中英文寫作風格、用語、排版的風格作出規範和建議。

中文

字型

  1. 使用簡體字,推薦遵守《通用規範漢字表》

用語

  1. 使用中國大陸地區通行的詞彙和慣用語,不使用港臺地區詞語。

    正確

    演算法、引數、陣列、回撥

    錯誤

    演演算法、引數、陣列、回呼

  2. 不使用網路語言和網路流行語。

    錯誤

    喜大普奔、不明覺厲、囧、焱暒妏

  3. 不使用帶歧視性的、不雅的語言。

    錯誤

    屌絲、P 事

  4. 使用簡練直白的語言。

    正確

    我們認為人人生而平等。

    錯誤

    我們認為以下真理是不言而喻的:人人生而平等。

  5. 避免錯別字。

    正確

    登入、閾值、重啟

    錯誤

    登陸、閥值、重起

翻譯

  1. 使用中國大陸地區的譯法,不使用港臺地區的譯法。

  2. 當一個英文單詞在沒有廣為接受的漢譯詞語或者使用其漢譯詞語會產生歧義時,可以使用英文單詞本身。

    正確

    在 debug 過程中, 我們發現當引數為 null 時,會觸發另外一個 bug。

    錯誤

    在排障過程中, 我們發現當引數為 時,會觸發另外一個故障。

  3. 當一個英文縮寫為人熟知並廣為接受時,可以使用英文縮寫而不使用其中文翻譯。

    正確

    RightCapital 的 CEO 擁有哥倫比亞大學的 MBA 學位。

    RightCapital 的執行長擁有哥倫比亞大學的的工商管理碩士學位。

  4. 當要表達一個英文詞彙,其中文翻譯尚未被廣為接受或存在歧義時,可以把英文原文寫在括號裡作為註釋。在一篇文章中,同一個詞彙只在其第一次出現的的地方新增註釋。

    正確

    在常見的 HTTP 方法中,POST 和 PATCH 不是冪等(idempotent)的。

    字串字面量(string literal)以 null 字元結束。

中英文混排

  1. 在中文文章標題、段落和句子中出現的英文單詞、短語和句子,其拼寫、用法和風格遵守本指南中的英文部分。

  2. 中文句子獨立出現的英文名詞,無論是表達一個還是多個,都使用該名詞的單數形式。

    正確

    這段程式碼中有好幾個 bug。

    錯誤

    這段程式碼中有好幾個 bugs。

排版格式

  1. 不使用段首縮排(例如段落左空二字)。

空格

  1. 漢字與英文,漢字與阿拉伯數字之間應新增一個空格。

    正確

    世界上有 10 種人,一種是懂二進位制的,另一種是不懂的。

    錯誤

    世界上有10種人,一種是懂二進位制的,另一種是不懂的。

  2. 漢字標點與英文,漢字標點與阿拉伯數字之間不應該新增空格。

    正確

    在《The Hitchhiker’s Guide to the Galaxy》中,生命、宇宙以及一切的終極答案是 42。

    錯誤

    在《 The Hitchhiker’s Guide to the Galaxy 》中,生命、宇宙以及一切的終極答案是 42 。

  3. 漢字與半形標點之間不新增空格。

    正確

    訂閱的價格是 100 美元/月。

    錯誤

    訂閱的價格是 150 美元 / 月。

  4. 漢字中格式化的部分(比如加粗、斜體、顏色、上下角標、超連結等)和未格式化的部分之間不應使用空格。

    正確

    PHP 是世界上最好語言

    錯誤

    PHP 是世界上 最好語言

標點符號和排版符號

  1. 中文標點符號的用法,原則上遵守 GB/T 15834

  2. 中文句子中使用漢字標點符號。注意大部分漢字標點符號是全形(full width)的,但也有例外(如分隔號“/”),具體參考下表:

    標點符號 形式 字形 Unicode 註釋
    句號 U+3002 IDEOGRAPHIC FULL STOP 不使用 U+FF0E FULLWIDTH FULL STOP
    逗號 U+FF0C FULLWIDTH COMMA
    頓號 U+3001 IDEOGRAPHIC COMMA
    感嘆號 U+FF01 FULLWIDTH EXCLAMATION MARK
    問號 U+FF1F FULLWIDTH QUESTION MARK
    冒號 U+FF1A FULLWIDTH COLON
    分號 U+FF1B FULLWIDTH SEMICOLON
    引號 U+201C LEFT DOUBLE QUOTATION MARK
    U+201D RIGHT DOUBLE QUOTATION MARK
    書名號 U+300A LEFT DOUBLE ANGLE BRACKET
    U+300B RIGHT DOUBLE ANGLE BRACKET
    括號 U+FF08 FULLWIDTH LEFT PARENTHESIS
    U+FF09 FULLWIDTH RIGHT PARENTHESIS
    破折號 —— 兩個 U+2014 EM DASH 不使用 U+2E3A TWO-EM DASH
    省略號 …… 兩個 U+2026 HORIZONTAL ELLIPSIS
    分隔號 / U+002F SOLIDUS 不使用 U+FF0F FULLWIDTH SOLIDUS
    連線號 短橫線 - U+002D HYPHEN-MINUS
    一字線 U+2014 EM DASH
    波浪號 U+FF5E FULLWIDTH TILDE
  3. 中文段落中的句子中如果出現的英文語段,英文語段中標點符號應遵循本指南本指南中的英文部分。

    正確

    RightCapital 的辦公室文化是“Work smart, play hard, live well”。

    錯誤

    RightCapital 的辦公室文化是“Work smart,play hard,live well”。

  4. 並列的詞語之間如果是“或”的關係,可以使用分隔號“/”。

  5. 並列詞語之間應該使用頓號。

    正確

    RightCapital 的技術部是由前端、後端、運維三個團隊組成。

    錯誤

    RightCapital 的技術部是由前端,後端,運維三個團隊組成。

  6. 並列詞語之間,當最後兩個詞語之間如果使用“和”或者“或”這類連詞,詞語之間不應該仿照英文的牛津逗號使用頓號。

    正確

    RightCapital 的技術部是由前端、後端和運維三個團隊組成。

    錯誤

    RightCapital 的技術部是由前端、後端、和運維三個團隊組成。

  7. 使用彎引號““””,不應使用直角引號“「」”。

  8. 直角引號可以用於分割專有名詞。

    正確

    RightCapital 的內部 IT 系統是基於「零信任」原則構建。

  9. 在中文句子中使用括號註釋句中語段,如果括號中的內容和括號所修飾的內容都是英文,應使用半形括號,否則應使用全形括號。

    正確

    RightCapital (a fintech company) 的手機應用(app)於近日釋出。

    錯誤

    RightCapital(a fintech company)的手機應用 (app) 於近日釋出。

  10. 中文句子中的出現的出版物名稱,無論中文還是英文,都應該使用書名號“《》”。

    正確

    《三體》和《The Hitchhiker’s Guide to the Galaxy》都是值得一讀的科幻小說。

    錯誤

    《三體》和 The Hitchhiker’s Guide to the Galaxy 都是值得一讀的科幻小說。

  11. 漢字的區間和範圍應使用一字線“—”或者波浪號“~”。阿拉伯數字的範圍參考本指南中的英文部分。

    正確

    北京—上海的高鐵最快僅需 4 小時 18 分。

    錯誤

    北京-上海的高鐵最快僅需 4 小時 18 分。

  12. 在分行列舉中,如果並列各項不是完整句子時,除最後一項外,各項都應使用分號結尾;最後一條應使用句號結尾。

    正確

    RightCapital 為每一位開發提供了

     1. 一臺 27 英寸 iMac;<br>
     2. 第二臺 27 英寸 4K 顯示器;<br>
     3. 無限量小食和飲料。
  13. 在分行列舉中,如果並列各項是完整句子時,每項都使用句號結尾。

    正確

    RightCapital 的所有開發都應當

     1. 寫程式碼。<br>
     2. 注重團隊協作。<br>
     3. 尊重彼此。
  14. 使用半形百分號。

    正確

    在引入了新的優化之後,系統的效能得到了 15% 的提升。

  15. 使用半形版本數學符號,包括負號“-”、加號“+”、減號“-”、乘號“*”、除號“/”等。

數字

  1. 數字的用法原則上遵守 GB/T 15835

  2. 不超過 10 的數字推薦使用中文數字,10 和 10 以上的數字推薦使用阿拉伯數字。

  3. 使用半形版本阿拉伯數字。

  4. “萬”“億”中文單位可以使用阿拉伯數字,其它中文單位只能使用漢字數字。

    正確

    這個程式碼倉庫有 300 萬行程式碼。

    這個程式碼倉庫有三百行程式碼。

    錯誤

    這個程式碼倉庫有 3 百萬行程式碼。

    這個程式碼倉庫有 3 百行程式碼。

  5. 中文句子中出現的阿拉伯數字時,如果數字是四位或者四位以上,應該使用半形逗號按千位分隔。

    正確

    這個程式碼倉庫有 3,000,000 行程式碼。

    錯誤

    這個程式碼倉庫有 3000000 行程式碼。

    這個程式碼倉庫有 300,0000 行程式碼。

電話號碼

  1. 座機號碼應該在局號 (電話號碼的前 3 位或者 4 位)和最後 4 位號碼之間使用短橫線或者空格進行分隔。

    正確

    6123-4567

    123 4567

    錯誤

    61234567

    1234567

  2. 座機號碼當包含區號時,區號需新增長途冠碼 0,區號和號碼之間使用一個空格,區號可以使用括號。

    正確

    010 6123-4567

    (010) 6123-4567

    錯誤

    01061234567

    (010)6123-4567

  3. 手機號應該按照 3-4-4 分組,使用短橫線或空格分隔。

    正確

    139-1234-5678

    錯誤

    1391-234-5678

    (139) 1234-5678

    13912345678

  4. 400 或者 800 號碼按照 3-3-4 分組,使用短橫線或空格分隔。

    正確

    400-123-4567

    錯誤

    (400) 123-4567

    4001234567

  5. 國際冠碼和國際區號的使用參照本指南中的英文部分。

  6. 座機號碼當包含國際區號時,必須同時包含國內區號,且國際區號必須新增國際冠碼,國內區號必須不新增長途冠碼。

    正確

    +86 10 6123-4567

    +86 (10) 6123-4567

    錯誤

    +86 010 6123-4567

日期和時間

  1. 日期和時間的用法原則上遵守 GB/T 15835

  2. 日期應按照年月日順序書寫。

    正確

    2020 年 3 月 31 日

    2020-3-31

    2020-03-31

    錯誤

    3 月 31 日 2020 年

    3-31-2020

    2020/3/31

  3. 年份應該用 4 位數。

    正確

    2020 年 3 月 31 日

    2020-3-31

    錯誤

    20 年 3 月 31 日

    20-3-31

  4. 使用漢字“月”“日”時,不編虛位(即1不編為01)。

    正確

    3 月 31 日

    錯誤

    03 月 31 日

  5. 時間中的時、分、秒使用半形冒號“:”分隔。

    正確

    上午 9:05

    錯誤

    上午 9:05

  6. 關於時間的其它規則參見本指南中的英文部分。

量和單位

  1. 量和單位的用法原則上遵守 GB 3100GB 3101 和 GB 3102(全部)。
  2. 量和單位的用法可以參考《量和單位的名稱、符號及書寫規則》

英文

基本規則

  1. 英文段落和中文段落中的英文單詞、短語和句子,其語法、用法和風格原則上遵守《Chicago Manual of Style》

拼寫

  1. 使用美式英語拼寫。

    正確

    Color, grey, center, canceled

    錯誤

    Colour, gray, centre, cancelled

  2. 商標和品牌名應該遵循其官方拼寫。

    正確

    RightCapital, App Store, AT&T, eBay, Yahoo!, Häagen-Dazs

    錯誤

    Right Capital, AppStore, AT & T, Ebay, Yahoo, Haagen—Dazs

大小寫

  1. 商標和品牌名應該遵循其官方拼寫風格使用大小寫,即使位於段首也不對其首字母大寫。

    正確

    iPhone 在短短數年內就挑戰了 BlackBerry 在企業市場中的地位。

    錯誤

    Iphone 在短短數年內就挑戰了 blackberry 在企業市場中的地位。

  2. 文章的標題(title)、出版物名稱(包括書籍、音樂和影視作品等)應該使用標題大小寫(title case),而非句子大小寫(sentence case)。標題大小寫可以使用這個工具。

  3. 章節的標題(heading)、表格和圖表的標題、表格的表頭應使用句子大小寫。

  4. 在條目列表中,當條目都是包含動詞的完整句子時,所有條目的第一個單詞的首字母都應該大寫。

    正確

    All RightCapital developers

     1. Write code.<br>
     2. Work as a team.<br>
     3. Respect each other.
  5. 避免使用全大寫(all-caps)。

    錯誤

    TALK IS CHEAP. Show me the code.

排版格式

  1. 不使用段首縮排。

  2. 出版物名稱使用斜體。

    正確

    The Hitchhiker’s Guide to the Galaxy is a comedy science fiction series created by Douglas Adams.

空格

  1. 數字和單位之間通常使用空格,百分號“%”、溫度單位(攝氏度“°C”、華氏度“°F”)、和角度單位(度“°”、分“′”、秒“″”)除外。

    正確

    5.0 cm, 45 kg, 32°C, 50%, 45°

    錯誤

    5.0cm, 45kg, 32 °C, 50 %, 45 °

  2. 數字和倍數符號(multiples symbol)之間,倍數符號和單位之間都不使用空格。出於歷史原因,cm、km、kg 等按照單位處理,而不按照帶倍數符號的單位處理。

    正確

    128GB, 40Gb, 5GHz

    錯誤

    128 GB, 40 Gb, 5 GHz

標點符號和排印符號

  1. 英文句子使用英文標點,不應使用漢字標點。英文標點應使用以下字元:

    標點符號 形式 字形 Unicode 註釋
    撇號 U+2019 RIGHT SINGLE QUOTATION MARK 不使用 U+0027 APOSTROPHE
    引號 U+201C LEFT DOUBLE QUOTATION MARK 不使用 U+0022 QUOTATION MARK
    U+201D RIGHT DOUBLE QUOTATION MARK 不使用 U+0022 QUOTATION MARK
    省略號 三個 U+002E FULL STOP 不使用 U+2026 HORIZONTAL ELLIPSIS
    連字元 - U+002D HYPHEN-MINUS
    En dash U+2013 EN DASH
    Em dash U+2014 EM DASH
  2. 英文句子中最後一個單詞如果以點“.”結尾,則該句不再使用句號。

    正確

    The company’s name is RightCapital Inc.

    There are apples, oranges, etcs.

    錯誤

    The company’s name is RightCapital Inc..

    There are apples, oranges, etcs..

  3. 括號的外側需要保留一個空格。

    正確

    RightCapital (a fintech company) is based in Shelton, Connecticut.

    錯誤

    RightCapital(a fintech company)is based in Shelton, Connecticut.

  4. 在三個或三個以上並列片語之間,在連詞(例如“and”或者“or”)之前應該使用牛津逗號。

    正確

    RightCapital’s engineering department consists of front-end, back-end, and DevOps teams.

    錯誤

    RightCapital’s engineering department consists of front-end, back-end and DevOps teams.

  5. 破折號應使用 em dash “—”,不能使用連字元(hyphen)“-”。破折號左右不要留空格,也不要連續使用兩個 em dash “——”。

    正確

    RightCapital’s web development teams—front-end and back-end—are working together to make it happen.

  6. 表示區間時推薦使用 en dash “–”,不推薦使用連字元。

    正確

    Financial Highlights for Fiscal Year 2018–2019

  7. 在條目列表中,當條目都是短語或者分句時,除最後一項使用句號結尾外,其餘各項使用逗號結尾。

    正確

    Every RightCapital developer is offered

     1. an 27-inch iMac,<br>
     2. a second 27-inch 4K screen, and<br>
     3. unlimited snacks and beverage.
  8. 在條目列表中,當條目都是帶動詞的完整句子時,各項都應該用句號結尾。

    正確

    All RightCapital developers

     1. Write code.<br>
     2. Work as a team.<br>
     3. Respect each other.
  9. 在文章正文中不建議使用 ampersand “&”,應該展開為“and”,但專有名詞(例如品牌名)不受此限。

    正確

    Abercrombie & Fitch is an American lifestyle retailer. It operates two other brands: Abercrombie Kids and Hollister Co.

    錯誤

    Abercrombie and Fitch is an American lifestyle retailer. It operates two other brands: Abercrombie Kids & Hollister Co.

  10. 商標符號使用“™”,註冊商標符號使用“®”,版權符號使用“©”。

    正確

    Copyright © RightCapital Inc. 2015–2020

    錯誤

    Copyright (c) RightCapital Inc. 2015–2020

  11. 腳標所註釋的內容,在同一頁面內,應該依次使用星號“*”、劍標“†”、和雙劍標“‡”、分節符“§”、雙豎線“||”、井號“#”,這些符號應該以上角標(superscript)形式出現在所註釋的內容結尾處,與所註釋的內容之間不使用空格。

    正確

    RightCapital’s financial planning software, launched in 2015*, is top-rated†.

貨幣

  1. 貨幣字首和數字之間不使用空格。

    正確

    $12.34

    US$1,234.56

    錯誤

    $ 1,234.56

    US$ 1,234.56

  2. 在財務/會計語境中,負數用括號(而不是負號)表示。貨幣符號置於括號之外。

    正確

    $(12.34)

    錯誤

    $-12.34

數字

  1. 四位和四位以上的數字應使用逗號作為千位分隔符。

    正確

    This repo has 3,000,000 lines of code.

    錯誤

    This repo has 3000000 lines of code.

    This repo has 3.000.000 lines of code.

  2. 序數(ordinal number)中的字母不應該以上角標出現。

    正確

    1st, 2nd, 3rd

    錯誤

    1st, 2nd, 3rd

電話號碼

  1. 區號可以使用括號,當使用括號時區號和 7 位的電話號碼之間使用空格;區號不用括號時,用連字元和電話號碼分隔。電話號碼中的前 3 位中心局(central office)號和最後 4 位用連字元分隔。

    正確

    (212) 123-4567

    212-123-4567

    錯誤

    (212)123-4567

    212 123-4567

    212 123 4567

  2. 國際電話號碼應使用加號“+”作為國際冠碼(IDD prefix),國際冠碼和國際區號之間不使用空格,國際區號和區號使用空格分隔。

    正確

    +1 (212) 123-4567

    +1 212-123-4567

    錯誤

    011 (212) 123-4567

    +1(212) 123-4567

    +1-212-123-4567

    + 1 (212) 123-4567

日期和時間

  1. 使用美式風格的日期,按照月日年順序書寫。

    正確

    Sunday, January 31, 2021

    January 31, 2021

    Jan. 31, 2021

    1/31/2021

    01/31/2021

    錯誤

    Sunday, 31 January, 2021

    31 January 2021

    31/1/2021

    2021-1-31

  2. 日期中的日不使用序數。

    正確

    January 31

    錯誤

    January 31st

  3. 12 小時制的時間,a.m./p.m. 使用小寫;其中的點“.”可以省略;時間和 a.m./p.m. 之間使用一個空格。

    正確

    9:30 a.m., 9:30 am

    錯誤

    9:30a.m., 9:30am 9:30 A.M., 9:30 AM

  4. 午夜和正午 12 點應分別使用“12:00 midnight”和“12:00 noon”,“midnight”和“noon”使用小寫。

    正確

    12:00 midnight, 12:00 noon

    錯誤

    12:00 Midnight, 12:00 Noon

    12:00 a.m., 12:00 p.m., 0:00 a.m., 0:00 p.m.

  5. 12 小時制的時間,小時部分必須不編虛位,24 小時制的時間,小時部分必須使用虛位保持兩位數字。分和秒的部分必須使用虛位保持兩位數字。

    正確

    9:05 am, 09:05

    錯誤

    09:05 am, 9:05, 9:5 am

程式碼

  1. 變數型別,資料庫欄位型別,類、方法、函式、變數的名字,字面量(literal),在句子中應該格式化為程式碼。

    正確

    這個函式會把 $id 引數儲存到資料庫中一個 TINYINT UNSIGNED 型別的欄位中。所以當其取值超出 255 的時候,這個函式會丟擲 InvalidArgumentException 異常。

  2. 字串字面量(string literal)當格式化為程式碼時,如果在句中不引起歧義,可以不加引號。

    正確

    $color 引數為 transparent 的時候,函式會丟擲 InvalidArgumentException 異常。

    $color 引數為 "transparent" 的時候,函式會丟擲 InvalidArgumentException 異常。


請關注我們的微信公眾號「rightcapital」

本作品採用《CC 協議》,轉載必須註明作者和本文連結
歡迎關注我們的微信公眾號「RightCapital」

相關文章