标准的格式是优质内容的基础,制定本规范的目的是统一文档内容中的中英文文字规范,提升内容的严谨度和美观度。
空格
中英文之间需要增加空格
正确:
在 LeanCloud 上,数据存储是围绕
AVObject
进行的。
错误:
在LeanCloud上,数据存储是围绕
AVObject
进行的。在 LeanCloud上,数据存储是围绕
AVObject
进行的。
完整的正确用法:
在 LeanCloud 上,数据存储是围绕
AVObject
进行的。每个AVObject
都包含了与 JSON 兼容的 key-value 对应的数据。数据是 schema-free 的,你不需要在每个AVObject
上提前指定存在哪些键,只要直接设定对应的 key-value 即可。
例外:「豆瓣FM」等产品名词,按照官方所定义的格式书写。
中文与数字之间需要增加空格
正确:
今天出去买菜花了 5000 元。
错误:
今天出去买菜花了 5000元。
今天出去买菜花了5000元。
数字与单位之间无需增加空格
正确:
我家的光纤入户宽带有 10Gbps,SSD 一共有 10TB。
错误:
我家的光纤入户宽带有 10 Gbps,SSD 一共有 20 TB。
另外,度/百分比与数字之间不需要增加空格。 正确:
今天是 233° 的高温。**新 MacBook Pro 有 15% 的 CPU 性能提升。
错误:
今天是 233 ° 的高温。**新 MacBook Pro 有 15 % 的 CPU 性能提升。
全角标点与其他字符之间不加空格
正确:
刚刚买了一部 iPhone,好开心!
错误:
刚刚买了一部 iPhone ,好开心!
英文书写中标点符号后加空格
正确:
Try Git commands right from your web browser. Featuring some of your soon-to-be favorites: branch, add, commit, merge, revert, cherry-pick, rebase!
错误:
Try Git commands right from your web browser.Featuring some of your soon-to-be favorites:branch,add,commit,merge,revert,cherry-pick,rebase!
链接前后需增加空格
正确:
此文档遵循 开源指北编写规范 要求。
错误:
此文档遵循开源指北编写规范 要求。
此文档遵循 开源指北编写规范要求。
此文档遵循开源指北编写规范要求。
标点符号
不重复使用标点符号
正确:
德国队竟然战胜了巴西队!*
她竟然对你说「喵」?!*
错误:
德国队竟然战胜了巴西队!!
德国队竟然战胜了巴西队!!!!!!!!
她竟然对你说「喵」??!!
她竟然对你说「喵」?!?!??!!
全角和半角
在中文中使用全角标点
正确:
嗨!你知道嘛?今天前台的小妹跟我说「喵」了哎!
核磁共振成像(NMRI)是什么原理都不知道?JFGI!
错误:
嗨! 你知道嘛? 今天前台的小妹跟我说 “喵” 了哎!
嗨!你知道嘛?今天前台的小妹跟我说”喵”了哎!
核磁共振成像 (NMRI) 是什么原理都不知道? JFGI!
核磁共振成像(NMRI)是什么原理都不知道?JFGI!
数字使用半角字符
正确:
这件蛋糕只卖 1000 元。
错误:
这件蛋糕只卖 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》,非常的有趣。
全英文编辑环境中没有顿号(、),使用半角逗号代替
正确:
branch, add, commit, merge, revert, cherry-pick, rebase!
错误:
branch、add、commit、merge、revert、cherry-pick、rebase!
名词
专有名词使用正确的大小写
正确:
使用 Gitee 登录
我们的客户有 GitHub、Foursquare、Microsoft Corporation、Google、Facebook, Inc.。
错误:
使用 gitee 登录
使用 GITEE 登录
我们的客户有 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.。
不要使用不地道的缩写
正确:
我们需要一位熟悉 JavaScript、HTML5,至少理解一种框架(如 Backbone.js、AngularJS、React 等)的前端开发者。
错误:
我们需要一位熟悉 Js、h5,至少理解一种框架(如 backbone、angular、RJS 等)的 FED。
有序列表
在有序列表中, 汉语数字后使用顿号,阿拉伯数字后使用半角句号。
正确:
一、xxxxxx
二、xxxxx
或
1.xxxxxx
2.xxxxxx
错误:
1、xxxxxxx
2、xxxxxx
或
一。xxxxxx
二。xxxxxx
或
一.xxxxxx
二.xxxxxxx
参考资料
中文文案排版指北:https://mazhuang.org/wiki/chinese-copywriting-guidelines/
中文技术文档的写作规范:https://github.com/ruanyf/document-style-guide
中华人民共和国国家标准《党政机关公文格式》(GB/T 9704-2012)[7.3.3]