椒图科技书写风格指南,本文同时适用于团队博客、技术文档、产品手册、项目方案等。

专有名词

公司全称

  • 中文:浙江椒图物联网科技有限公司
  • 英文:Zhejiang Jootu Technology Co., Ltd.

JootuJ 必须大写,如作为 URL 的一部分则使用全小写的 jootu,下同。

公司简称

  • 中文:浙江椒图椒图科技,当与北京椒图科技有限公司无明显冲突时,应使用 椒图科技
  • 英文:JootuJootu Tech. ,注意后者末尾带点号表示缩写。

团队名称

Jootu Team,注意两个单词中间加一个半角空格,首字母均大写。

常用网址

文案风格

通用

  • 确保没有错别字,应特别注意「的」、「地」、「得」的用法。
  • 不使用流行语中故意的谐音别字,比如「墙裂」、「童鞋」等。
  • 文案应尽量简洁易懂。应删除不能完整表达意思的字、词、句,同时在不影响表达效果的前提下把文案长度减到最短。
  • 若为该文案为中英双语,则需要另外考虑翻译后的英文字符长度与中文字符长度差别不能过大。
  • 「你」和「您」:在不是很正式或没有明确的个体指代对象的时候请用「你」,如文档、博客、群发的邮件等;在指代特定个体时请用「您」,如活动邀请函等。

英文大小写

  • 英文与非标点的中文之间需要有一个空格,如「使用 Markdown 编写文档」而不是「使用Markdown编写文档」。
  • 数字与非标点的中文之间需要有一个空格,如「我们发布了 5 个产品」而不是「我们发布了5个产品」。
  • 尽可能使用中文数词,特别是当前后都是中文时。上面的例子写为「我们发布了五个产品」会更好。
  • 数字与单位之间需要有一个空格,如「5 GB」而不是「5GB」。
  • 注意特殊名词的大小写:Android、iOS、iPhone、Google、GitHub,无论是否在句首都应该以同样的方式写。
  • 在官方文案中尽量使用中文,避免中英文混合的情况。例如「app」一般应写为「应用」或「移动应用」。品牌、产品名、人名、地名等特殊名词,如果来自英文,请使用英文以避免在不同译法间选择。
  • 表示设计规范的单词首字母需要大写,例如 Material Design 。
  • 仅有在高层级使用的时候(例如导航、菜单和按钮),英文词组才可每个单词大写。一般情况下(尤其是已成句或有完整的谓宾结构的情况),仅首字母大写。

标点

  • 只有中文或中英文混排中,一律使用中文/全角标点。
  • 中英文混排中如果出现整句英文,则在这句英文中使用英文/半角标点。
  • 中文标点与其他字符间一律不加空格。
  • 中文文案中使用中文引号「」和『』,其中「」为外层引号。Mac 上如「简体拼音输入法」可以方便地输入中文引号。
  • 英文文案中不能出现尖引号「」,应使用半角标点。

段落

  • 如果是纯文本,段落之间使用一个空行隔开。如果是 HTML 或其他富文本格式,使用额外空白作为段落间的分隔。
  • 段落开头不要留出空白字符。

对第三方内容的引用

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

People don’t know what they want until you show it to them. - Steve Jobs

消费者并不知道自己想要什么,直到我们拿出自己的产品。——史蒂夫·乔布斯

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

本文转载自 浙江椒图技术团队

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

本文转载自 浙江椒图技术团队:https://jootu.org/post/55.html

常见错误

  • 「账号」而非「帐号」,「登录」而非「登陆」。
  • 登录、登出统一使用 Sign In / Sign Out,避免使用 Log In / Log Out。
  • 字体和字号的一致:在富文本格式文档中,特别是 HTML 邮件中,常有人因为从不同来源复制粘贴而导致同一层次的文本字体和字号不一致。这给人不专业的感觉,请避免。
  • App 是一个普通名词而不是多个单词的首字母缩写,所以不应该用全大写的 APP。和其他词一样,大小写规则取决于是否处于句首、标题、或特殊短语(如 App Store)中。大多数情况下应该使用中文「应用」以避免这样的问题。

其它