13 Commits

Author SHA1 Message Date
Tunghsiao Liu
d879493928 chore: release v0.0.8 2015-12-11 10:58:10 +08:00
Tunghsiao Liu
c8e29afe1c feat(package): update contributors 2015-12-11 10:58:10 +08:00
Tunghsiao Liu
3e89ab395c chore(docs): add language list 2015-12-11 10:11:04 +08:00
Tunghsiao Liu
61a43f4496 feat(docs): add language list 2015-12-11 10:10:11 +08:00
Tunghsiao Liu
585e71e282 fix(docs): wrong TOC anchors 2015-12-11 10:05:53 +08:00
Tunghsiao Liu
a7321991f3 feat(docs): initial English version 2015-12-11 09:59:01 +08:00
Tunghsiao Liu
db596b189f feat(docs): use original titles for references 2015-12-11 09:59:01 +08:00
Tunghsiao Liu
039ed42f40 Merge pull request #25 from sparanoid/greenkeeper-grunt-bump-0.7.0
Update grunt-bump to version 0.7.0 🚀
2015-12-11 09:05:00 +08:00
greenkeeperio-bot
d49302bfd1 chore(package): update grunt-bump to version 0.7.0 2015-12-11 05:00:37 +08:00
Tunghsiao Liu
a2569b3310 feat(docs): update spacing rule for links 2015-12-09 14:09:45 +08:00
Tunghsiao Liu
200eb493a5 feat(docs): re-evaluate V2EX 2015-12-09 13:48:15 +08:00
Tunghsiao Liu
1104e24cdc feat(docs): add Python library from hjiang/scripts 2015-12-09 13:47:17 +08:00
Tunghsiao Liu
d42d646874 fix(docs): avoid slangs 2015-12-08 10:51:53 +08:00
4 changed files with 305 additions and 17 deletions

View File

@@ -1,3 +1,24 @@
<a name="0.0.8"></a>
## [0.0.8](https://github.com/sparanoid/chinese-copywriting-guidelines/compare/v0.0.7...v0.0.8) (2015-12-11)
### Bug Fixes
* **docs:** avoid slangs ([d42d646](https://github.com/sparanoid/chinese-copywriting-guidelines/commit/d42d646))
* **docs:** wrong TOC anchors ([585e71e](https://github.com/sparanoid/chinese-copywriting-guidelines/commit/585e71e))
### Features
* **docs:** add language list ([61a43f4](https://github.com/sparanoid/chinese-copywriting-guidelines/commit/61a43f4))
* **docs:** add Python library from hjiang/scripts ([1104e24](https://github.com/sparanoid/chinese-copywriting-guidelines/commit/1104e24))
* **docs:** initial English version ([a732199](https://github.com/sparanoid/chinese-copywriting-guidelines/commit/a732199))
* **docs:** re-evaluate V2EX ([200eb49](https://github.com/sparanoid/chinese-copywriting-guidelines/commit/200eb49))
* **docs:** update spacing rule for links ([a2569b3](https://github.com/sparanoid/chinese-copywriting-guidelines/commit/a2569b3))
* **docs:** use original titles for references ([db596b1](https://github.com/sparanoid/chinese-copywriting-guidelines/commit/db596b1))
* **package:** update contributors ([c8e29af](https://github.com/sparanoid/chinese-copywriting-guidelines/commit/c8e29af))
<a name="0.0.7"></a> <a name="0.0.7"></a>
## [0.0.7](https://github.com/sparanoid/chinese-copywriting-guidelines/compare/v0.0.6...v0.0.7) (2015-10-25) ## [0.0.7](https://github.com/sparanoid/chinese-copywriting-guidelines/compare/v0.0.6...v0.0.7) (2015-10-25)

262
README.en.md Normal file
View File

@@ -0,0 +1,262 @@
# 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:
- [English](README.en.md)
- [Chinese Traditional](README.md)
- [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](#add-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-of-who-is-doing-this)
- [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 GbpsSSD 一共有 20 TB。
Bad:
> 我家的光纖入屋寬頻有 10GbpsSSD 一共有 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 youre 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 hungrystay foolish。」。
> 推薦你閱讀『HackersPaintersBig 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)

View File

@@ -4,7 +4,11 @@
統一中文文案、排版的相關用法,降低團隊成員之間的溝通成本,增強網站氣質。 統一中文文案、排版的相關用法,降低團隊成員之間的溝通成本,增強網站氣質。
Other languages: [简体中文](https://github.com/mzlogin/chinese-copywriting-guidelines) Other languages:
- [English](README.en.md)
- [Chinese Traditional](README.md)
- [Chinese Simplifed](https://github.com/mzlogin/chinese-copywriting-guidelines)
----- -----
@@ -26,7 +30,7 @@ Other languages: [简体中文](https://github.com/mzlogin/chinese-copywriting-g
- [專有名詞使用正確的大小寫](#專有名詞使用正確的大小寫) - [專有名詞使用正確的大小寫](#專有名詞使用正確的大小寫)
- [不要使用不地道的縮寫](#不要使用不地道的縮寫) - [不要使用不地道的縮寫](#不要使用不地道的縮寫)
- [爭議](#爭議) - [爭議](#爭議)
- [中文鏈接之間增加空格](#中文鏈接之間增加空格) - [鏈接之間增加空格](#鏈接之間增加空格)
- [簡體中文使用直角引號](#簡體中文使用直角引號) - [簡體中文使用直角引號](#簡體中文使用直角引號)
- [工具](#工具) - [工具](#工具)
- [誰在這樣做?](#誰在這樣做) - [誰在這樣做?](#誰在這樣做)
@@ -164,13 +168,13 @@ Microsoft 有個 [`-ms-text-autospace`](http://msdn.microsoft.com/en-us/library/
正確: 正確:
> 喬幫主那句話是怎麼說的「Stay hungry, stay foolish.」。 > 賈伯斯那句話是怎麼說的「Stay hungry, stay foolish.」。
> 推薦你閱讀『Hackers & Painters: Big Ideas from the Computer Age』非常的有趣。 > 推薦你閱讀『Hackers & Painters: Big Ideas from the Computer Age』非常的有趣。
錯誤: 錯誤:
> 喬幫主那句話是怎麼說的「Stay hungrystay foolish。」。 > 賈伯斯那句話是怎麼說的「Stay hungrystay foolish。」。
> 推薦你閱讀『HackersPaintersBig Ideas from the Computer Age』非常的有趣。 > 推薦你閱讀『HackersPaintersBig Ideas from the Computer Age』非常的有趣。
@@ -224,7 +228,7 @@ Microsoft 有個 [`-ms-text-autospace`](http://msdn.microsoft.com/en-us/library/
以下用法略帶有個人色彩,既:無論是否遵循下述規則,從語法的角度來講都是**正確**的。 以下用法略帶有個人色彩,既:無論是否遵循下述規則,從語法的角度來講都是**正確**的。
### 中文鏈接之間增加空格 ### 鏈接之間增加空格
用法: 用法:
@@ -259,6 +263,7 @@ Microsoft 有個 [`-ms-text-autospace`](http://msdn.microsoft.com/en-us/library/
[nauxliu/auto-correct](https://github.com/NauxLiu/auto-correct) | PHP [nauxliu/auto-correct](https://github.com/NauxLiu/auto-correct) | PHP
[hotoo/pangu.vim](https://github.com/hotoo/pangu.vim) | Vim [hotoo/pangu.vim](https://github.com/hotoo/pangu.vim) | Vim
[sparanoid/grunt-auto-spacing](https://github.com/sparanoid/grunt-auto-spacing) | Node.js (Grunt) [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
## 誰在這樣做? ## 誰在這樣做?
@@ -272,7 +277,7 @@ Microsoft 有個 [`-ms-text-autospace`](http://msdn.microsoft.com/en-us/library/
[Microsoft 台灣](http://www.microsoft.com/zh-tw/) | Yes | N/A [Microsoft 台灣](http://www.microsoft.com/zh-tw/) | Yes | N/A
[LeanCloud](http://leancloud.cn/) | Yes | N/A [LeanCloud](http://leancloud.cn/) | Yes | N/A
[知乎](http://www.zhihu.com/) | Yes | 部分用戶達成 [知乎](http://www.zhihu.com/) | Yes | 部分用戶達成
[V2EX](http://www.v2ex.com/) | Yes | 標題達成 [V2EX](http://www.v2ex.com/) | Yes | Yes
[SegmentFault](http://segmentfault.com/) | Yes | 部分用戶達成 [SegmentFault](http://segmentfault.com/) | Yes | 部分用戶達成
[Apple4us](http://apple4us.com/) | Yes | N/A [Apple4us](http://apple4us.com/) | Yes | N/A
[豌豆荚](http://www.wandoujia.com/) | Yes | N/A [豌豆荚](http://www.wandoujia.com/) | Yes | N/A
@@ -281,12 +286,12 @@ Microsoft 有個 [`-ms-text-autospace`](http://msdn.microsoft.com/en-us/library/
## 參考文獻 ## 參考文獻
- [來自 About.com 的大小寫用法(英文)](http://grammar.about.com/od/punctuationandmechanics/a/Guidelines-For-Using-Capital-Letters.htm) - [Guidelines for Using Capital Letters - About.com](http://grammar.about.com/od/punctuationandmechanics/a/Guidelines-For-Using-Capital-Letters.htm)
- [來自維基百科的關於大小寫字符的相關條目(英文)](http://en.wikipedia.org/wiki/Letter_case) - [Letter case - Wikipedia](http://en.wikipedia.org/wiki/Letter_case)
- [來自 Oxford Dictionaries 的標點相關用法(英文)](http://www.oxforddictionaries.com/us/words/punctuation) - [Punctuation - Oxford Dictionaries](http://www.oxforddictionaries.com/us/words/punctuation)
- [來自普渡大學的標點符號用法(英文)](https://owl.english.purdue.edu/owl/section/1/6/) - [Punctuation - The Purdue OWL](https://owl.english.purdue.edu/owl/section/1/6/)
- [來自 wikiHow 的英文標點符號用法 wiki(英文)](http://www.wikihow.com/Use-English-Punctuation-Correctly) - [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) - [格式 - 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%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/%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) - [疑問驚嘆號 - 維基百科](http://zh.wikipedia.org/wiki/%E7%96%91%E5%95%8F%E9%A9%9A%E5%98%86%E8%99%9F)

View File

@@ -1,6 +1,6 @@
{ {
"name": "chinese-copywriting-guidelines", "name": "chinese-copywriting-guidelines",
"version": "0.0.7", "version": "0.0.8",
"description": "Chinese Copywriting Guidelines", "description": "Chinese Copywriting Guidelines",
"author": "Tunghsiao Liu", "author": "Tunghsiao Liu",
"homepage": "http://github.com/sparanoid/chinese-copywriting-guidelines", "homepage": "http://github.com/sparanoid/chinese-copywriting-guidelines",
@@ -24,20 +24,20 @@
"readmeFilename": "README.md", "readmeFilename": "README.md",
"devDependencies": { "devDependencies": {
"grunt": "^0.4.5", "grunt": "^0.4.5",
"grunt-bump": "^0.6.0", "grunt-bump": "^0.7.0",
"grunt-conventional-changelog": "^5.0.0", "grunt-conventional-changelog": "^5.0.0",
"grunt-npm": "0.0.2", "grunt-npm": "0.0.2",
"matchdep": "^1.0.0" "matchdep": "^1.0.0"
}, },
"contributors": [ "contributors": [
"Jason Lee <huacnlee@gmail.com>", "Jason Lee <huacnlee@gmail.com>",
"Huei Tan <huei90@users.noreply.github.com>",
"Yang Li <idealhack@gmail.com>",
"greenkeeperio-bot <support@greenkeeper.io>", "greenkeeperio-bot <support@greenkeeper.io>",
"Yang Li <idealhack@gmail.com>",
"tzx <district10@users.noreply.github.com>", "tzx <district10@users.noreply.github.com>",
"NauxLiu@users.noreply.github.com>", "NauxLiu@users.noreply.github.com>",
"Charlie Jade <summer.alex07@gmail.com>", "Charlie Jade <summer.alex07@gmail.com>",
"hotoo@users.noreply.github.com>", "hotoo@users.noreply.github.com>",
"Elethom Hunter <elethomhunter@gmail.com>" "Elethom Hunter <elethomhunter@gmail.com>",
"Huei Tan <huei90@users.noreply.github.com>"
] ]
} }