Skip to content

Latest commit

 

History

History
261 lines (158 loc) · 9.01 KB

README.en.md

File metadata and controls

261 lines (158 loc) · 9.01 KB

Chinese Copywriting Guidelines

devDependency Status

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 一共有 10TB。

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 ,好开心!

-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