Skip to content

Latest commit

 

History

History
264 lines (160 loc) · 9.22 KB

README.en.md

File metadata and controls

264 lines (160 loc) · 9.22 KB

Chinese Copywriting Guidelines

devDependency Status Built with Almace Scaffolding

Chinese copywriting guidelines for better written communication.

Other languages:


Table of Contents

Spacing

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

與大家共勉之。」——vinta/paranoid-auto-spacing

Place one space before/after English words

Good:

在 LeanCloud 上,數據存儲是圍繞 AVObject 進行的。

Bad:

在LeanCloud上,數據存儲是圍繞AVObject進行的。

在 LeanCloud上,數據存儲是圍繞AVObject 進行的。

An example of complete and correct usage:

在 LeanCloud 上,数据存储是围绕 AVObject 进行的。每个 AVObject 都包含了与 JSON 兼容的 key-value 对应的数据。数据是 schema-free 的,你不需要在每个 AVObject 上提前指定存在哪些键,只要直接设定对应的 key-value 即可。

Exceptions: For product and brand names, please refer to the writing format of the official definition. For example, use “豆瓣FM” instead of “豆瓣 FM”.

Place one space before/after numbers

Good:

今天出去買菜花了 5000 元。

Bad:

今天出去買菜花了 5000元。

今天出去買菜花了5000元。

Place one space between numbers and units

Good:

我家的光纖入屋寬頻有 10 Gbps,SSD 一共有 20 TB。

Bad:

我家的光纖入屋寬頻有 10Gbps,SSD 一共有 20TB。

Exceptions: There should not be any spacing between numbers and degrees/percentages.

Good:

今天是 233° 的高溫。

新 MacBook Pro 有 15% 的 CPU 性能提升。

Bad:

今天是 233 ° 的高溫。

新 MacBook Pro 有 15 % 的 CPU 性能提升。

No additional spaces before/after punctuation in fullwidth form

Good:

剛剛買了一部 iPhone,好開心!

Bad:

剛剛買了一部 iPhone ,好開心!

剛剛買了一部 iPhone, 好開心!

-ms-text-autospace to the rescue?

Microsoft provides a CSS property -ms-text-autospace that can specify the autospacing and narrow space width adjustment of text. However it's not popular, and on other platforms such as OS X and iOS we can not use this feature. So it's better for you to keep up the habit.

Punctuation

Avoid duplicate punctuation

Good:

德國隊竟然戰勝了巴西隊!

她竟然對你說「喵」?!

Bad:

德國隊竟然戰勝了巴西隊!!

德國隊竟然戰勝了巴西隊!!!!!!!!

她竟然對你說「喵」??!!

她竟然對你說「喵」?!?!??!!

Fullwidth and halfwidth

If you’re not familiar with fullwidth and halfwidth forms please refer to Halfwidth and fullwidth forms on Wikipedia.

Use punctuation in fullwidth form

Good:

嗨!你知道嘛?今天前台的小妹跟我說「喵」了哎!

核磁共振成像(NMRI)是什麼原理都不知道?JFGI!

Bad:

嗨! 你知道嘛? 今天前台的小妹跟我說 "喵" 了哎!

嗨!你知道嘛?今天前台的小妹跟我說"喵"了哎!

核磁共振成像 (NMRI) 是什麼原理都不知道? JFGI!

核磁共振成像(NMRI)是什麼原理都不知道?JFGI!

Use numbers in halfwidth form

Good:

這件蛋糕只賣 1000 元。

Bad:

這件蛋糕只賣 1000 元。

Exceptions: fullwidth numbers are acceptable for better visual alignment in graphic design.

Use punctuation in halfwidth form for English sentences

Good:

賈伯斯那句話是怎麼說的?「Stay hungry, stay foolish.」

推薦你閱讀《Hackers & Painters: Big Ideas from the Computer Age》,非常的有趣。

Bad:

賈伯斯那句話是怎麼說的?「Stay hungry,stay foolish。」

推薦你閱讀《Hackers&Painters:Big Ideas from the Computer Age》,非常的有趣。

Nouns

Avoid jargons

Good:

我們需要一位熟悉 JavaScript、HTML5,至少理解一种框架(如 Backbone.js、AngularJS、React 等)的前端開發者。

Bad:

我們需要一位熟悉 Js、h5,至少理解一种框架(如 backbone、angular、RJS 等)的 FED。

Dispute

The following usages comprise of personal characteristics. As such, from the perspective of copywriting guidelines, they are still correct regardless of whether they comply with the following rules.

Add extra spaces before/after links

Usage:

提交一个 issue 并分配给相关同事。

訪問我們網站的最新動態,請 點擊這裡 進行訂閱!

compared with:

提交一个 issue 并分配给相关同事。

訪問我們網站的最新動態,請點擊這裡進行訂閱!

Use corner brackets for Chinese Simplified

Usage:

「老师,『有条不紊』的『紊』是什么意思?」

compared with:

“老师,‘有条不紊’的‘紊’是什么意思?”

Tools

Repository Language
vinta/paranoid-auto-spacing JavaScript
huei90/pangu.node Node.js
huacnlee/auto-correct Ruby
sparanoid/space-lover PHP (WordPress)
nauxliu/auto-correct PHP
hotoo/pangu.vim Vim
sparanoid/grunt-auto-spacing Node.js (Grunt)
hjiang/scripts/add-space-between-latin-and-cjk Python

Examples of “Who is doing this?”

Website Copywriting UGC
Apple China Yes N/A
Apple Hong Kong Yes N/A
Apple Taiwan Yes N/A
Microsoft China Yes N/A
Microsoft Hong Kong Yes N/A
Microsoft Taiwan Yes N/A
LeanCloud Yes N/A
Zhihu Yes Partial
V2EX Yes Yes
SegmentFault Yes Partial
Apple4us Yes N/A
Wandoujia Yes N/A
Ruby China Yes Partial
PHPHub Yes Partial

References