一点历史和说明

在 LeanCloud 合并进 TDS 后,在 LeanCloud 原有的文案指南基础上结合 TDS 的具体情况做了修改。这份文档所确定的规则旨在增强目标用户群(游戏开发者)的认同感,所以不一定适用于 TDS 以外的所有场景。其中一些条目(比如直角引号的使用)不与简体中文的官方标准严格一致(比如在简体中文标准里直角引号主要用于竖排文字),这些差异是为了增强在不同情况下的一致性以及更符合中文圈目标用户的审美和习惯而产生的。

公司及产品名称

请注意正确的产品名称:

  • TapTap
  • TapTap Developer Services
  • TDS
  • LeanCloud

以上名称无论出现在句子的什么位置,大小写都不应该改变。TapTap 和 LeanCloud 是合成词,中间沒有空格(参考:GitHub)。当这些词作为 URL 的一部分出现时,虽然大小写变化通常不影响功能,但为了显示一致也应该使用全小写,如:https://example.com/taptap/https://example.com/tds/

TDS 的全称 TapTap Developer Services 是复数,正如 Amazon Web Services 一样,包含多种服务。

同时也要注意第三方公司和产品名的大小写:Android、iOS、iPhone、macOS、watchOS、tvOS、Google、Apple,无论是否在句首或标题都应该以同样的方式写。

总体风格

一定多检查,确保没有错别字。

即使是流行语中故意的谐音错别字也不要在比较正式的文案中使用,比如「墙裂」、「童鞋」等。

在长期有效的文案中,如产品介绍等,不要使用具有时效性或需要较多背景知识才能理解的网络流行语。

我们崇尚精练的文风。请在检查中把对表达意思没有明显作用的字、词、句删除,在不影响表达效果的前提下把文案长度减到最短。

中文、英文、数字混合时空格的使用

请按照以下规则来处理中英文、数字和空格的使用:

  • 英文与非标点的中文之间需要有一个空格,如「使用 TDS 开发游戏」而不是「使用TDS开发游戏」。1
  • 数字与非标点的中文之间需要有一个空格,如「排行榜前 10 的游戏」而不是「排行榜前10的游戏」。
  • 当前后都是中文并且涉及的数字较小时尽可能使用中文数词。上面的例子写为「排行榜前十的游戏」会更好。
  • 当中文数字会过长以至于影响阅读时,使用阿拉伯数字。如「最长不超过 1024 字节」而不是「最长不超过一千零二十四字节」
  • 数字与单位之间需要有一个空格,如「5 GB」而不是「5GB」,并且单位一律使用单数形式。
  • 在官方文案中尽量使用中文,避免中英文混合的情况。例如「app」一般应写为「应用」。品牌、产品名、人名、地名等特殊名词,如果来自英文,请使用英文以避免在不同译法间选择。

标点相关

只有中文或中英文混排中,一律使用中文/全角标点。

中英文混排中如果出现整句英文,则在这句英文中使用英文/半角标点。

中文标点与其他字符间一律不加空格。

中文文案中使用直角引号「」和『』,其中「」为外层引号。macOS 的官方输入法和百度输入法等都可以方便地输入直角引号。

段落

如果是纯文本,段落之间使用一个空行隔开。如果是 HTML 或其他富文本格式,在样式中使用额外空白作为段落间的分隔。

段落开头不要留出空白字符。

对第三方内容的引用

如果在正文中部分引用第三方内容,请使用恰当的引用格式并给出出处。如:

One man's constant is another man's variable. — Alan Perlis

如果是全篇转载,请在全文开头显著位置注明出处并链接至原文,如:

本文转载自 WikiQuote

如果格式不允许超链接,请以文本方式直接给出原文链接。如果原文链接太长影响美观,可以使用短链接服务。如:

本文转载自 WikiQuote:http://bit.ly/UlHIdN

图片的使用

图片加载缓慢,经常因为被屏蔽或者加载失败而不能正常显示,并且图片上的文字无法自动适应屏幕大小和分辨率,所以在线上媒介上不要将大段文字放在图片上。Logo 等需要使用特殊字体的局部文字除外。作为文章一部分的各级标题也应该使用通用字体和文本形态。

一些具体用词

「你」和「您」:在不是很正式或没有明确的个体指代对象的时候请用「你」,如文档、博客、群发的邮件等;在指代特定个体时请用「您」,如活动邀请函、直接发给特定用户的邮件等。请根据上下文和场景选择最自然的用法。

字体和字号的一致:在富文本格式文档中,特别是 HTML 邮件中,常有人因为从不同来源复制粘贴而导致同一层次的文本字体和字号不一致。这给人不专业的感觉,请避免。

App 是 application 的缩写,发音为 /ˈæp/,在演讲等口头表达里要注意不要把三个字母拆开念。App 是一个普通名词而不是多个单词的首字母缩写,所以不应该用全大写的 APP。和其他词一样,大小写规则取决于是否处于句首、标题、或特殊短语(如 App Store)中。大多数情况下应该使用中文「应用」以避免这样的问题。

不要称呼喜欢我们的用户为「粉丝」,而是使用「用户」。粉丝的说法显得不平等,很多人不喜欢这种称呼,因为它暗示缺乏独立思考。

以下为一些常见的误用词 :

错误 正确 说明
登陆 登录 网站或应用登录界面
其它 其他 「其它」是现代新增的说法,为了一致建议统一用「其他」这个适用范围更广的词。
请稍后 请稍候 请用户等待的界面

推荐阅读

Footnotes

  1. 摘自 github:vinta/pangu.js

    有研究顯示,打字的時候不喜歡在中文和英文之間加空格的人,感情路都走得很辛苦,有七成的比例會在 34 歲的時候跟自己不愛的人結婚,而其餘三成的人最後只能把遺產留給自己的貓。畢竟愛情跟書寫都需要適時地留白。