跳到主要内容

WooCommerce 语法、标点符号和首字母大写指南

遵循语法、标点符号和风格指南有助于保持我们文档的一致性。 如果用户知道他们能得到什么以及在哪里找到他们需要的信息，他们的体验会更好。

基础​

保持开放性。 有些人会阅读每一个字。 有些人会浏览和搜索，或者更喜欢视频。 帮助所有人。

保持重点。 在句子、段落和部分中，以最重要的信息开头。

保持简洁。 使用通俗易懂的语言和简短的句子。

保持一致性。 遵循我们的指南和风格提示。

保持具体性。 清晰地表达。 避免冗余。

指南​

缩写和首字母缩略词​

第一次出现时，完整地写出词语，并在括号中添加缩写或首字母缩略词。 在第二次和后续的出现中，使用简短的版本。

  • 第一次使用：Payment Card Industry Data Security Standard (PCI-DSS)
  • 第二次使用：PCI-DSS

如果缩写或首字母缩略词是广泛使用的，则直接使用它。 例如：API, FAQ, HTML, PHP, SQL, SSL。

主动语态​

在主动语态中，句子的主语执行动作。 在被动语态中，句子的主语是被动接受动作。

  • 主动：Jon 下载了他的扩展文件。
  • 被动：扩展文件是由 Jon 下载的。

首字母大写​

以下情况需要首字母大写：

  • 博客文章和文档文章的标题：第一个单词。
  • 文档标题 (h2)：对于文档标题和子标题，使用句首大写 (而不是标题大写)。
  • 产品名称：每个单词，除了介词和连词。
  • 句子：第一个单词。
  • 无序/项目符号列表 - 每个条目的第一个单词。

以下情况使用小写：

  • "ecommerce" (而不是 "eCommerce")
  • Email 地址 - info@woocommerce.com
  • 网站 URL - developer.woocommerce.com

缩写​

谨慎使用。 缩写，例如 I'm 和 there's，可以使写作更具非正式和对话的风格，但如果内容正在被翻译，则可能不合适。 例如，有时在线翻译器会忽略 don't 中的 "not"。

表情符号​

表情符号可以为您的内容添加微妙的情感和幽默，或者吸引视觉注意力。 很少且有目的地使用。

数字​

在句子的开头，将数字写成文字。 对于所有其他情况，将数字 1 到 9 写成文字。 对于其他数字，使用数字。

  • 将在六月发布十款产品。 不要：10 款产品将在六月发布。
  • Lance 参加了马拉松比赛，并在他的年龄组中获得第三名。
  • 我为建筑项目购买了五把锤子和 21 种类型的钉子。
  • 酒吧里有 18 种啤酒。

对于超过三个数字的数字，使用逗号：41,500, 170,000, 1,000,000 或 1 百万。

货币​

在指定美元时，使用货币代码，而不要只使用符号/标志。 整数金额不需要小数点和两位小数。

  • USD $20
  • CAD $19.99
  • AUD $39.50

在描述其他货币时，使用符号/标志。

  • €995
  • ¥5,000
  • £18.99

日期​

完整地写出星期几和月份，使用以下格式：

  • 星期一，2016年12月12日

小数​

当一个数字难以转换为分数时，使用小数点，例如3.141 或 98.5 或 0.29。

分数​

完整地写出分数，例如：one-fourth (四分之一)。

百分比​

完整地写出单词 "percent"。 除非空间有限，例如在社交媒体上使用，否则不要使用 "%" 符号。

电话号码​

使用连字符 "-" 连接数字，不要使用括号或句点。 对于所有国家/地区，请使用 国家代码。

  • +1-555-867-5309
  • +34-902-1899-00

范围和跨度​

使用连字符 "-" 表示数字的范围，例如：20-30天。

温度​

使用摄氏度符号 "°C" 和华氏度符号 "°F"。

  • 27°C
  • 98°F

时间​

使用数字和 "am" 或 "pm"，中间用空格分隔，不要使用句点。

  • 7:00 am
  • 7:30 pm

使用连字符 "-" 连接时间，表示 am 或 pm 之间的时段。 如果时间跨越 am 和 pm，则使用 "to"。

  • 7:00-9:00 am 和 7:00 am to 10:30 pm

在描述可能涉及全球参与者的活动时，请指定时区。 Automattic 使用协调世界时 (Coordinated Universal Time, UTC)。

缩写美国时区：

  • 华盛顿时间：EDT 或 EST
  • 中部时间：CDT 或 CST
  • 山区时间：MDT 或 MST
  • 太平洋时间：PDT 或 PST

年份​

缩写十年：

  • 80年代和 90年代
  • 1900年代和 1890年代

标点符号​

连接符​

连接符 "&" 仅在公司/品牌名称中使用。 不要用它代替 "and"。

  • Ben & Jerry's
  • Andre, Timo 和 Donny 去 Camp Nou 观看足球比赛。

引号​

引号使单词变为所有格。 如果一个单词以 "s" 结尾且为单数，则添加一个 "s"。 如果一个单词以 "s" 结尾且为复数，则添加一个撇号。

  • 同一个队友借用了 Sam 的自行车。
  • 同一个队友借用了 Chris 的自行车。
  • 员工藏起了办公室经理的笔。

以下是所有格：FAQ's questions, HE's weekly rotation。 以下是复数：FAQs 和 HEs。

冒号​

使用冒号创建列表。

  • Aaron 订购了三种甜甜圈：糖霜、巧克力和南瓜。

逗号​

在列出项目时，使用逗号（也称为牛津逗号）。

  • Jinny 喜欢向日葵、雏菊和牡丹。

在其他情况下，请使用常识。 大声朗读句子，并在需要清晰或停顿的地方使用逗号。

破折号和连字符​

使用连字符 "-"（两侧没有空格）连接单词，或表示跨度或范围。

  • first-time user (首次用户)
  • Monday-Friday (周一至周五)

使用长破折号 "-"（两侧没有空格）表示日记或补充说明。

使用真正的长破折号，而不是连字符。

  • 多元测试，这是我们新的专业版功能之一，可以帮助您发展业务。
  • Austin 认为 Brad 偷了甜甜圈，但他是错的，是 Lain 偷的。

省略号​

省略号 "..." 可以用来表示句子的未定义结尾，或者表示省略了单词（用方括号 [...] 表示）。 很少使用。

感叹号​

很少使用感叹号，并且只使用一个。

感叹号的用法遵循与句号相同的规则，具体请参考“句号”部分。

句号​

句号应该：

  • 位于引号内
  • 位于括号外，当括号内的内容是较大句子的一部分时
  • 位于括号内，当括号内的内容可以独立存在时

示例

  • Jake 说：“我度过了最棒的一天。”
  • 她去了超市（也去了美甲店）。
  • 我妈妈喜欢披萨和啤酒。（啤酒需要冰镇且颜色深。）

问号​

问号的用法遵循与句号相同的规则，具体请参考“句号”部分。

引号​

句号和逗号位于引号内。引号内的问号遵循逻辑：如果问号是引号的一部分，则位于引号内。如果您要提问，且问题以引号结尾，则问号位于引号外。

在引号内使用单引号。

  • 谁唱着“All These Things That I've Done”？
  • The Killers 乐队的 Brandon Flowers 说：“当我写 'I got soul, but I'm not a soldier' 时，我感到受到启发并充满灵感。”

分号​

分号可以用来连接两个相关的短语。

  • 他们的首张个人专辑在 20 个国家进入前 10 名；它在英国排名第一。

人物、地点和事物​

公司名称和产品​

使用公司名称和产品在官方网站上所写的名称。

  • Pull&Bear
  • UE Boom

将公司或产品称为 "it"（而不是 "they"）。

  • WooCommerce 是，而不是 WooCommerce 是。

文件扩展名​

文件扩展名应全部大写，不带句点。为了表示复数，添加一个小写字母 "s"。

  • HTML
  • JPEG
  • PDF

特定文件的扩展名应为小写：

  • dancingcat.gif
  • SalesReport2016.pdf
  • firethatcannon.mp3

姓名和职称​

首次提到某人时，应包括他们的名和姓。后续提及可以使用名。

对职称、团队名称和部门名称进行大写处理。

  • Happiness Engineers 或 HEs
  • Team Apollo
  • Legal

代词​

根据情况使用 he/him/his 和 she/her/her。不要使用 "one" 作为代词。如果性别未知或指代一个群体，请使用 they/them/their。

引用​

引用某人的话时，使用现在时。

  • Brent Jamison 说：“我喜欢 WooCommerce 是免费且灵活的。”

学校​

首次提到一所学校、学院或大学时，使用其完整的官方名称。在后续提及时，使用其更常见的简称。

  • Georgia Institute of Technology, Georgia Tech
  • Georgia State University, GSU

州、城市和国家​

完整拼写所有城市和州名称。不要缩写城市名称。

首次提到时，写出 United States。在后续提及时，使用 U.S.。对于其他具有常用缩写的国家或联邦，也适用相同的规则，例如 European Union (EU) 和 United Kingdom (UK)。

网址和网站​

将网站和网络出版物的名称首字母大写。不要使用斜体。

避免完整书写网址；在必要时省略 http://www。

俚语和行话​

使用简洁的英语。文本应具有普遍的可理解性，并具有翻译的潜力。在需要时，简要定义技术术语。

文本格式化​

使用斜体来表示书籍、电影或专辑的标题。

  • Oren Klaff 的书籍 Pitch Anything 正在以 5.99 美元的价格出售。

避免：

  • 使用下划线
  • 混合使用斜体、粗体、大写字母和下划线

将文本左对齐，不要居中或右对齐。

句子之间留一个空格，不要留两个。