Google Workspace 插件应与其扩展的托管应用的样式和布局保持一致。它们应使用熟悉的控件和行为自然地扩展界面。此处介绍的指南介绍了以提升优质用户体验为目标,以及如何处理文本、图片、控件和品牌信息。
如果您的插件会打开单独的网页,而这些网页是插件操作不可或缺的一部分(例如插件的设置页面),请确保这些网页也遵循这些样式准则。
文字和图片
本部分将介绍如何在插件中正确使用文字和图片。
插件名称
您必须在插件的项目清单中以及配置插件以供发布时设置插件的名称。该名称出现在许多位置,例如 Google Workspace Marketplace 列表和菜单中。选择名称时:
- 采用词首字母大写。
- 除非是品牌元素的一部分,否则请避免使用标点符号,尤其是括号。
- 尽量简洁明了 - 最好不超过 15 个字符。系统可能会在 Google Workspace Marketplace 产品详情和其他地方自动截断长名称。
- 请勿在插件名称中包含“Google”“Gmail”或其他 Google 产品名称。
- 请勿在插件名称中包含“add-on”一词。
- 省略版本信息。
写作风格
您不需要编写太多内容。大多数操作都应该通过图标、布局和简短的标签而清晰明了。如果您发现插件的某个部分需要比简短标签更详尽的说明,最好创建一个单独的网页来描述您的插件并链接到该网页。
编写界面文本时:
- 句首字母大写(尤其是对于按钮、标签和卡片操作)。
- 最好使用不含行话或首字母缩写词的简短文字。
通用操作和卡片操作
如果您在插件中使用通用操作或卡片操作,它们将在您定义的卡片中显示为菜单项。您可以选择在这些菜单中用于这些操作的文本。选择要使用的文字时:
- 避免菜单文字与插件名称重复。
- 以操作字词开头每个菜单项,例如“Run”“Configure”或“Create”。
- 请描述任务,而不是操作所显示的界面组件。
- 如果您的操作启动了一个工作流,并且没有一个动词来描述它的用途,请将其命名为“Start”。
- 请尽量减少菜单项的数量,以免强制用户滚动浏览大型列表。如果您要实现更多操作,请考虑使用多张卡片,每张卡片上都有不同的操作。
错误消息
出现问题时,请务必使用通俗易懂的语言。从用户的角度说明问题,并建议如何解决问题。
- 不允许用户查看您的代码抛出的任何异常。而应使用
try...catch
语句来拦截异常,然后显示人性化的错误消息。 - 在发布之前,请检查您的插件是否不会在界面中显示调试信息。
帮助内容
您可能希望设计卡片来显示帮助信息或向用户说明插件的操作情况。如果您为插件构建了帮助内容,请记住以下几点:
- 请尽可能以项目符号列表或编号列表的形式显示说明。明确引用已命名的界面元素,引导用户浏览最终结果。
- 确保您的说明清楚地解释了所有要求,例如以某种方式设置电子表格。
- 您可以根据需要链接到外部帮助内容,例如支持性网页。
图片
插件中使用的图片可以是内置图标类型中的一种,也可以是由网址指定的公开托管的图片。使用托管的图片时,请确保所有可能使用您的插件的用户都能访问这些图片。
控件
本部分提供了交互式 widget 的用户体验指南。
按钮
使用按钮来控制界面的主要操作,而不是其他 widget。
- 大多数文本按钮标签都应以动词开头。
- 在大多数情况下,按钮行的按钮应不超过 3 个。
装饰文字
DecoratedText widget 可让您显示带有图标、按钮或开关的文本内容。
- 对文本内容采用句首字母大写形式。
- 如果 DecoratedText widget 的文本无法放入可用空间,会被截断。因此,请始终尝试尽可能缩短文本内容。
用于选择内容的输入
您可以在插件中使用各种选择输入 widget:下拉选择框、复选框和单选按钮。
- 当用户可以选择多个选项或根本不选中任何选项时,使用复选框。 在必须选中一个选项的情况下,使用单选按钮(或选择菜单)。 提供简短的备选选项列表时,可以使用下拉菜单,同时尝试节省界面中的空间。
- 对于分配给每个选项的文本,采用句首字母大写形式。
- 避免使用选择更改来触发难以撤销的重大操作,因为用户在做出选择时经常会犯错。不妨考虑添加一个按钮,用于读取当前选择值,然后触发相应操作。
- 对于下拉菜单,请按字母顺序或按所有用户都能理解的逻辑方案对选项进行排序(例如,从星期日或星期一开始按顺序显示一周中的哪几天)。
- 将给定选择输入 widget 中的选项数量限制为合理的数字。如果选项太多,用户可能很难使用以下 widget。在这种情况下,请考虑将该选项分解为不同的类别和多个 widget。
文本输入
文本输入为用户提供输入字符串数据的位置。
- 不要使用文本输入来让用户输入一组特定的可能条目中的一个。请改用下拉菜单选择。
- 使用提示和建议来帮助用户输入格式和内容正确的文本。
- 如果要输入的文本包含几个字词,请使用多行文本输入。
品牌标示
本部分提供了有关向插件界面添加品牌元素的用户体验指南。
在您的插件中
如果您想在插件界面中添加品牌信息,请确保界面简洁明了。 这有助于用户专注于您的插件功能。
- 插件的所有方面都必须遵循品牌推广指南。
- 请勿包含“Google”“Gmail”或其他 Google 产品名称。
- 请勿添加 Google 产品图标,即使这些图标经过更改也不例外。
- 请勿在品牌文字中包含“插件”一词。
- 品牌宣传文字不应超过几个字。
在 Google Workspace Marketplace 中
配置插件以供发布时,您需要提供一些图形资源和文本资源来构建 Google Workspace Marketplace 产品详情。
商品详情和这些资源的各个方面都必须符合品牌推广指南。