文档编写及排版规范

如何写好文档？

参见 👉🏻 文档四象限

文案排版规范

规范来源: 中文文案排版指北

统一中文文案、排版的相关用法，降低团队成员之间的沟通成本，增强网站气质。

---

空格

「有研究显示，打字的时候不喜欢在中文和英文之间加空格的人，感情路都走得很辛苦，有七成的比例会在 34 岁的时候跟自己不爱的人结婚，而其余三成的人最后只能把遗产留给自己的猫。毕竟爱情跟书写都需要适时地留白。

与大家共勉之。」——vinta/pangu.js

中英文之间需要增加空格

正确：

在 LeanCloud 上，数据存储是围绕 AVObject 进行的。

错误：

在 LeanCloud 上，数据存储是围绕AVObject进行的。

在 LeanCloud 上，数据存储是围绕AVObject 进行的。

完整的正确用法：

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

例外：「豆瓣 FM」等产品名词，按照官方所定义的格式书写。

中文与数字之间需要增加空格

正确：

今天出去买菜花了 5000 元。

错误：

今天出去买菜花了 5000 元。

今天出去买菜花了 5000 元。

数字与单位之间需要增加空格

正确：

我家的光纤入屋宽带有 10 Gbps，SSD 一共有 20 TB

错误：

我家的光纤入屋宽带有 10Gbps，SSD 一共有 20TB

例外：度数／百分比与数字之间不需要增加空格：

正确：

角度为 90° 的角，就是直角。

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

错误：

角度为 90 ° 的角，就是直角。

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

全角标点与其他字符之间不加空格

正确：

刚刚买了一部 iPhone，好开心！

错误：

刚刚买了一部 iPhone ，好开心！

刚刚买了一部 iPhone， 好开心！

用 text-spacing 来挽救？

CSS Text Module Level 4 的 text-spacing 和 Microsoft 的 -ms-text-autospace 可以实现自动为中英文之间增加空白。不过目前并未普及，另外在其他应用场景，例如 macOS、iOS、Windows 等用户界面目前并不存在这个特性，所以请继续保持随手加空格的习惯。

标点符号

不重复使用标点符号

即使中国大陆的标点符号用法允许重复使用标点符号，但是这么做会破坏句子的美观性。

正确：

德国队竟然战胜了巴西队！

她竟然对你说「喵」？！

错误：

德国队竟然战胜了巴西队！！

德国队竟然战胜了巴西队！！！！！！！！

她竟然对你说「喵」？？！！

她竟然对你说「喵」？！？！？？！！

全角和半角

不明白什么是全角（全形）与半角（半形）符号？请查看维基百科条目『全角和半角』。

使用全角中文标点

正确：

嗨！你知道嘛？今天前台的小妹跟我说「喵」了哎！

核磁共振成像（NMRI）是什么原理都不知道？JFGI！

错误：

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

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

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

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

数字使用半角字符

正确：

这个蛋糕只卖 1000 元。

错误：

这个蛋糕只卖 １０００ 元。

例外：在设计稿、宣传海报中如出现极少量数字的情形时，为方便文字对齐，是可以使用全角数字的。

遇到完整的英文整句、特殊名词，其内容使用半角标点

正确：

乔布斯那句话是怎么说的？「Stay hungry, stay foolish.」

推荐你阅读《Hackers & Painters: Big Ideas from the Computer Age》，非常的有趣。

错误：

乔布斯那句话是怎么说的？「Stay hungry，stay foolish。」

推荐你阅读《Hackers＆Painters：Big Ideas from the Computer Age》，非常的有趣。

名词

专有名词使用正确的大小写

大小写相关用法原属于英文书写范畴，不属于本 wiki 讨论内容，在这里只对部分易错用法进行简述。

正确：

使用 GitHub 登录

我们的客户有 GitHub、Foursquare、Microsoft Corporation、Google、Facebook, Inc.。

错误：

使用 github 登录

使用 GITHUB 登录

使用 Github 登录

使用 gitHub 登录

使用 g ｲん ĤЦ8 登录

我们的客户有 github、foursquare、microsoft corporation、google、facebook, inc.。

我们的客户有 GITHUB、FOURSQUARE、MICROSOFT CORPORATION、GOOGLE、FACEBOOK, INC.。

我们的客户有 Github、FourSquare、MicroSoft Corporation、Google、FaceBook, Inc.。

我们的客户有 gitHub、fourSquare、microSoft Corporation、google、faceBook, Inc.。

我们的客户有 g ｲん ĤЦ8、ｷ ouЯƧqu ﾑ гє、๓เςг๏ร๏Ŧt ς๏гק๏гคtเ๏ภn、900913、ƒ4ᄃëв๏๏к, IПᄃ.。

注意：当网页中需要配合整体视觉风格而出现全部大写／小写的情形，HTML 中请使用标淮的大小写规范进行书写；并通过 text-transform: uppercase;／text-transform: lowercase; 对表现形式进行定义。

不要使用不地道的缩写

正确：

我们需要一位熟悉 TypeScript、HTML5，至少理解一种框架（如 React、Next.js）的前端开发者。

错误：

我们需要一位熟悉 Ts、h5，至少理解一种框架（如 RJS、nextjs）的 FED。

争议

以下用法略带有个人色彩，即：无论是否遵循下述规则，从语法的角度来讲都是正确的。

链接之间增加空格

用法：

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

访问我们网站的最新动态，请 点击这里 进行订阅！

对比用法：

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

访问我们网站的最新动态，请点击这里进行订阅！

简体中文使用直角引号

用法：

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

对比用法：

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

工具

仓库	语言
vinta/pangu.js	JavaScript
serkodev/vue-pangu	Vue.js (Web Converter)
huacnlee/auto-correct	Ruby
huacnlee/autocorrect	Rust, WASM, CLI
huacnlee/go-auto-correct	Go
sparanoid/space-lover	PHP (WordPress)
nauxliu/auto-correct	PHP
jxlwqq/chinese-typesetting	PHP
hotoo/pangu.vim	Vim
sparanoid/grunt-auto-spacing	Node.js (Grunt)
hjiang/scripts/add-space-between-latin-and-cjk	Python
hustcc/hint	Python
studygolang/autocorrect	Go
n0vad3v/Tekorret	Python
VS Code - huacnlee.auto-correct	VS Code Extension

谁在这样做？

网站	文案	UGC
Apple 中国	是	N/A
Apple 香港	是	N/A
Apple 台湾	是	N/A
Microsoft 中国	是	N/A
Microsoft 香港	是	N/A
Microsoft 台湾	是	N/A
LeanCloud	是	N/A
V2EX	是	是
Apple4us	是	N/A
Ruby China	是	是
少数派	是	N/A

参考文献

• Guidelines for Using Capital Letters - ThoughtCo.
• Letter case - Wikipedia
• Punctuation - Oxford Dictionaries
• Punctuation - The Purdue OWL
• How to Use English Punctuation Correctly - wikiHow
• 格式 - openSUSE
• 全形和半形 - 维基百科
• 引号 - 维基百科
• 疑问惊叹号 - 维基百科

Forks

衍生项目的用法可能与本项目存在差异。

• mzlogin/chinese-copywriting-guidelines