Google Workspace 插件的界面样式指南

Google Workspace 加载项应与所扩展的宿主应用的样式和布局保持一致。他们应使用熟悉的控件和行为自然地扩展界面。本文档中介绍的准则描述了如何处理文字、图片、控件和品牌推广,以打造优质的用户体验。

如果您的插件会打开作为插件运行不可或缺的一部分的单独网页(例如插件的设置页面),请确保这些网页也遵循这些样式指南。

文字和图片

本部分将介绍如何在插件中正确使用文字和图片。

加购项名称

您必须在插件的项目清单中以及配置插件以进行发布时设置插件的名称。该名称会显示在许多位置,例如 Google Workspace Marketplace 中的商品详情和菜单中。选择名称时,应注意以下几点:

  • 采用词首字母大写形式。
  • 避免使用标点符号,尤其是英文圆括号,除非它们是品牌名称的一部分。
  • 尽量简短,最好不超过 15 个字符。在 Google Workspace Marketplace 详情和其他位置,过长的名称可能会自动截断。
  • 请勿在插件名称中包含“Google”“Gmail”字样或其他 Google 产品名称。
  • 请勿在附加服务名称中包含“附加服务”一词。
  • 省略版本信息。

写作风格

您无需撰写太多内容。大多数操作都应通过图标、布局和简短的标签清晰地呈现出来。如果您发现插件的某个部分需要比简短标签更详尽的说明,最好创建一个单独的网页来描述您的插件,并链接到该网页。

撰写界面文字时:

  • 使用句首字母大写格式(尤其是对于按钮、标签和卡片操作)。
  • 最好使用简短明了的文字,避免使用行话或缩写。

通用操作和卡片操作

如果您在插件中使用通用操作卡片操作,这些操作会显示为您定义的卡片中的菜单项。您可以选择这些菜单中用于执行相应操作的文字。选择要使用的文本时:

  • 避免使用仅重复插件名称的菜单文字。
  • 以“运行”“配置”或“创建”等操作字词开头。
  • 描述任务,而不是显示操作的界面组件。
  • 如果您的操作会启动工作流,但没有单个动词来描述其功能,请将其命名为“开始”。
  • 尽量减少菜单项的数量,以免用户不得不滚动浏览长长的列表。如果您需要实现更多操作,可以考虑使用多个卡片,每个卡片上都有不同的操作。

错误消息

当出现问题时,请务必使用简单明了的语言。从用户的角度解释问题,并建议如何解决问题。

  • 不允许用户看到代码抛出的任何异常。而应使用 try...catch 语句来拦截异常,然后显示便于理解的错误消息。
  • 在发布之前,请检查您的插件是否会在界面中显示调试信息。

帮助内容

您可能希望设计用于向用户显示帮助信息或说明插件操作的卡片。如果您确实要为插件构建帮助内容,请务必:

  • 尽可能以项目符号列表或编号列表的形式显示说明。引导用户完成整个流程,并明确提及界面元素的名称。
  • 请确保您的说明清楚地解释了所有要求,例如以某种方式设置电子表格。
  • 您可以随意链接到外部帮助内容,例如支持网页。

图片

插件中使用的图片可以是内置图标类型之一,也可以是网址指定的公开托管的图片。使用托管图片时,请确保所有可能会使用您的插件的用户都可以访问这些图片。

控件

本部分针对互动 widget 提供用户体验指南。

按钮

使用按钮来控制用户界面的主要操作,而不是使用其他 widget。

  • 大多数文本按钮标签都应以动词开头。
  • 在大多数情况下,按钮行应限制为最多三个按钮。

DecoratedText

借助 DecoratedText widget,您可以显示带有图标、按钮或开关的文本内容。

  • 对文本内容采用句首字母大写形式。
  • 如果 DecoratedText widget 的文本无法放入可用空间,则会被截断。因此,请始终尽量缩短文字内容。

选择输入源

您可以在插件中使用各种选择输入微件:下拉选择框、复选框和单选按钮。

  • 当用户可以选择多个选项或不选择任何选项时,请使用复选框。 如果必须选择一个选项,请使用单选按钮(或选择菜单)。 当您提供简短的替代方案列表,同时又想节省界面空间时,请使用下拉菜单。
  • 为分配给每个选项的文本使用句首字母大写格式。
  • 避免使用选择变更来触发难以撤消的重大操作,因为人们在进行选择时经常会出错。不妨考虑添加一个可读取当前所选值并触发相应操作的按钮。
  • 对于下拉菜单,请按字母顺序或所有用户都能理解的逻辑方案对选项进行排序(例如,按顺序显示星期几,从星期日或星期一开始)。
  • 将给定选择输入 widget 中的选项数量限制在合理范围内。如果选项过多,用户可能会发现该 widget 难以使用。在这种情况下,请考虑将选项分为不同的类别和多个 widget。

文本输入内容

文本输入框可让用户输入字符串数据。

  • 请勿使用文本输入让用户输入一组特定可能条目中的一个。请改用下拉选择。
  • 使用提示和建议来帮助用户输入格式和内容正确的文本。
  • 如果要输入的文字超过几个字,请使用多行文本输入。

品牌

本部分提供了有关向插件界面添加品牌元素的指南。

在插件中

如果您想在插件界面中添加品牌推广信息,请务必简明扼要。这有助于用户专注于您的插件功能。

  • 插件的各个方面都必须遵守品牌推广指南
  • 不得包含“Google”“Gmail”或其他 Google 产品名称。
  • 请勿包含 Google 产品图标,即使经过修改也不行。
  • 请勿在品牌宣传文字中包含“加购项”字样。
  • 品牌宣传文字不应超过几个字。

在 Google Workspace Marketplace 中

在配置要发布的插件时,您需要提供一些图形和文字资源来构建 Google Workspace Marketplace 商品详情。

商品详情和这些素材资源的所有方面都必须遵循品牌推广指南