feat(docs): initial English version

sparanoid · Dec 11, 2015 · a732199 · a732199
1 parent db596b1
commit a732199
Showing 1 changed file with 258 additions and 0 deletions.
diff --git a/README.en.md b/README.en.md
@@ -0,0 +1,258 @@
+# Chinese Copywriting Guidelines
+[![devDependency Status](https://david-dm.org/sparanoid/chinese-copywriting-guidelines/dev-status.svg)](https://david-dm.org/sparanoid/chinese-copywriting-guidelines#info=devDependencies)
+[![Built with Almace Scaffolding](https://d349cztnlupsuf.cloudfront.net/amsf-badge.svg)](http://sparanoid.com/note/chinese-copywriting-guidelines/)
+
+Chinese copywriting guidelines for better written communication.
+
+Other languages: [Chinese Simplifed](https://github.com/mzlogin/chinese-copywriting-guidelines)
+
+-----
+
+## Table of Contents
+
+- [Spacing](#spacing)
+  - [Place one space before/after English words](#place-one-space-before/after-english-words)
+  - [Place one space before/after numbers](#place-one-space-before/after-numbers)
+  - [Place one space between numbers and units](#place-one-space-between-numbers-and-units)
+  - [No additional spaces before/after punctuation in fullwidth form](#no-additional-spaces-before/after-punctuation-in-fullwidth-form)
+  - [`-ms-text-autospace` to the rescue?](#-ms-text-autospace-to-the-rescue)
+- [Punctuation](#punctuation)
+  - [Avoid duplicate punctuation](#avoid-duplicate-punctuation)
+- [Fullwidth and halfwidth](#fullwidth-and-halfwidth)
+  - [Use punctuation in fullwidth form](#use-punctuation-in-fullwidth-form)
+  - [Use numbers in halfwidth form](#use-numbers-in-halfwidth-form)
+  - [Use punctuation in halfwidth form for English sentences](#use-punctuation-in-halfwidth-form-for-english-sentences)
+- [Nouns](#nouns)
+  - [Avoid jargons](#avoid-jargons)
+- [Dispute](#dispute)
+  - [Add extra spaces before/after links](#extra-spaces-before-after-links)
+  - [Use corner brackets for Chinese Simplified](#use-corner-brackets-for-chinese-simplified)
+- [Tools](#tools)
+- [Examples of “Who is doing this?”](#examples)
+- [References](#references)
+
+## Spacing
+
+「有研究顯示，打字的時候不喜歡在中文和英文之間加空格的人，感情路都走得很辛苦，有七成的比例會在 34 歲的時候跟自己不愛的人結婚，而其餘三成的人最後只能把遺產留給自己的貓。畢竟愛情跟書寫都需要適時地留白。
+
+與大家共勉之。」——[vinta/paranoid-auto-spacing](https://github.com/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 ，好開心！
+
+### `-ms-text-autospace` to the rescue?
+
+Microsoft provides a CSS property [`-ms-text-autospace`](http://msdn.microsoft.com/en-us/library/ie/ms531164(v=vs.85).aspx) 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](https://en.wikipedia.org/wiki/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:
+
+> 這件蛋糕只賣 １０００ 元。
+
+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](https://github.com/vinta/paranoid-auto-spacing) | JavaScript
+[huei90/pangu.node](https://github.com/huei90/pangu.node) | Node.js
+[huacnlee/auto-correct](https://github.com/huacnlee/auto-correct) | Ruby
+[sparanoid/space-lover](https://github.com/sparanoid/space-lover) | PHP (WordPress)
+[nauxliu/auto-correct](https://github.com/NauxLiu/auto-correct) | PHP
+[hotoo/pangu.vim](https://github.com/hotoo/pangu.vim) | Vim
+[sparanoid/grunt-auto-spacing](https://github.com/sparanoid/grunt-auto-spacing) | Node.js (Grunt)
+[hjiang/scripts/add-space-between-latin-and-cjk](https://github.com/hjiang/scripts/blob/master/add-space-between-latin-and-cjk) | Python
+
+## Examples of “Who is doing this?”
+
+Website | Copywriting | UGC
+--- | --- | ---
+[Apple China](http://www.apple.com/cn/) | Yes | N/A
+[Apple Hong Kong](http://www.apple.com/hk/) | Yes | N/A
+[Apple Taiwan](http://www.apple.com/tw/) | Yes | N/A
+[Microsoft China](http://www.microsoft.com/zh-cn/) | Yes | N/A
+[Microsoft Hong Kong](http://www.microsoft.com/zh-hk/) | Yes | N/A
+[Microsoft Taiwan](http://www.microsoft.com/zh-tw/) | Yes | N/A
+[LeanCloud](http://leancloud.cn/) | Yes | N/A
+[Zhihu](http://www.zhihu.com/) | Yes | Partial
+[V2EX](http://www.v2ex.com/) | Yes | Yes
+[SegmentFault](http://segmentfault.com/) | Yes | Partial
+[Apple4us](http://apple4us.com/) | Yes | N/A
+[Wandoujia](http://www.wandoujia.com/) | Yes | N/A
+[Ruby China](http://ruby-china.org/) | Yes | Partial
+[PHPHub](http://phphub.org/) | Yes | Partial
+
+## References
+
+- [Guidelines for Using Capital Letters - About.com](http://grammar.about.com/od/punctuationandmechanics/a/Guidelines-For-Using-Capital-Letters.htm)
+- [Letter case - Wikipedia](http://en.wikipedia.org/wiki/Letter_case)
+- [Punctuation - Oxford Dictionaries](http://www.oxforddictionaries.com/us/words/punctuation)
+- [Punctuation - The Purdue OWL](https://owl.english.purdue.edu/owl/section/1/6/)
+- [How to Use English Punctuation Correctly - wikiHow](http://www.wikihow.com/Use-English-Punctuation-Correctly)
+- [格式 - openSUSE](https://zh.opensuse.org/index.php?title=Help:%E6%A0%BC%E5%BC%8F)
+- [全形和半形 - 維基百科](http://zh.wikipedia.org/wiki/%E5%85%A8%E5%BD%A2%E5%92%8C%E5%8D%8A%E5%BD%A2)
+- [引號 - 維基百科](http://zh.wikipedia.org/wiki/%E5%BC%95%E8%99%9F)
+- [疑問驚嘆號 - 維基百科](http://zh.wikipedia.org/wiki/%E7%96%91%E5%95%8F%E9%A9%9A%E5%98%86%E8%99%9F)