Guia de estilo da IU para complementos do Google Workspace

Os complementos do Google Workspace precisam ser consistentes com o estilo e o layout do aplicativo host que estendem. Eles precisam estender a IU naturalmente usando controles e comportamentos conhecidos. As diretrizes apresentadas aqui descrevem maneiras de lidar com texto, imagens, controles e branding que promovem uma experiência do usuário de alta qualidade.

Se o complemento abrir páginas da Web separadas que façam parte da operação do complemento (por exemplo, uma página de configurações do complemento), verifique se essas páginas também seguem estas diretrizes de estilo.

Texto e imagens

Esta seção explica como usar corretamente textos e imagens no seu complemento.

Nome do complemento

Defina o nome do complemento no manifesto do projeto e ao configurar o complemento para publicação. O nome aparece em muitos lugares, como na ficha do Google Workspace Marketplace e em menus. Ao escolher um nome:

  • Use letras maiúsculas apenas no título.
  • Evite pontuação, especialmente parênteses, a menos que faça parte da sua marca.
  • Seja breve: o melhor é ter 15 caracteres ou menos. Nomes longos podem ser truncados automaticamente na página de detalhes do Google Workspace Marketplace e em outros lugares.
  • Não inclua as palavras "Google", "Gmail" ou outros nomes de produtos do Google no nome do complemento.
  • Não inclua a palavra "complemento" no nome do complemento.
  • Não inclua as informações da versão.

Estilo de escrita

Você não precisa escrever muito. A maioria das ações precisa ficar clara com iconografia, layout e rótulos curtos. Se você perceber que uma parte do seu complemento precisa de explicações mais extensas do que rótulos curtos podem fornecer, uma prática recomendada é criar uma página da Web separada com a descrição e um link para ela.

Ao escrever o texto da IU:

  • Use letra maiúscula apenas na primeira palavra (especialmente para botões, etiquetas e ações de card).
  • Prefira textos curtos e simples, sem jargões ou siglas.

Ações universais e de cards

Se você usar ações universais ou ações de cards no seu complemento, elas aparecerão como itens de menu nos cards definidos por você. É possível escolher o texto usado nesses menus para essas ações. Ao escolher o texto a ser usado:

  • Evite textos de menu que simplesmente repitam o nome do complemento.
  • Inicie cada item de menu com uma palavra de ação, como "Run", "Configure" ou "Create".
  • Descreva a tarefa, não o componente de IU que a ação mostra.
  • Se a ação iniciar um fluxo de trabalho e não houver um verbo único que descreva o que ela faz, chame-a de "Iniciar".
  • Mantenha o número de itens de menu pequenos para evitar forçar o usuário a rolar uma lista grande. Se você precisa implementar mais ações, use vários cards com ações diferentes em cada um deles.

Mensagens de erro

Quando algo dá errado, é importante usar uma linguagem simples. Explique o problema do ponto de vista do usuário e sugira como corrigi-lo.

  • Não permita que o usuário veja as exceções geradas pelo seu código. Em vez disso, use instruções try...catch para interceptar exceções e exibir uma mensagem de erro simples.
  • Antes de publicar, verifique se o complemento não exibe informações de depuração na IU.

Conteúdo Help

Crie cards que mostrem informações de ajuda ou expliquem a operação do complemento para o usuário. Se você criar conteúdo de ajuda para seu complemento, lembre-se de:

  • Quando possível, mostre as instruções em uma lista numerada ou com marcadores. Guie os usuários até o resultado final, com referências claras a elementos de IU nomeados.
  • Certifique-se de que suas instruções expliquem claramente quaisquer requisitos, como configurar uma planilha de uma determinada maneira.
  • Sinta-se à vontade para criar links para conteúdo de ajuda externo, como páginas da Web de suporte.

Imagens

As imagens usadas no complemento são um dos tipos de ícone integrados ou uma imagem hospedada publicamente especificada por um URL. Ao usar imagens hospedadas, verifique se elas podem ser acessadas por todos que usam seu complemento.

Controles

Esta seção apresenta diretrizes de experiência do usuário para widgets interativos.

Botões

Use botões para controlar as principais ações da interface do usuário em vez de outros widgets.

  • A maioria dos rótulos de botão de texto precisa começar com um verbo.
  • Na maioria dos casos, as linhas dos botões devem ser limitadas a três ou menos botões.

Texto decorado

Os widgets Decorados permitem apresentar conteúdo de texto com ícones, botões ou interruptores.

  • Use letra maiúscula apenas na primeira palavra para o conteúdo do texto.
  • O texto de um widget DecoratedText vai ser truncado se não couber no espaço disponível Por esse motivo, sempre tente manter o conteúdo de texto o mais curto possível.

Entradas de seleção

Você pode usar diversos widgets de entrada de seleção no complemento: caixas de seleção suspensas, botões de opção e caixas de seleção.

  • Use caixas de seleção quando as pessoas puderem selecionar várias opções ou nenhuma opção. Use os botões de opção (ou um menu de seleção) quando exatamente uma opção precisa ser selecionada. Use menus suspensos ao fornecer uma pequena lista de alternativas enquanto tenta economizar espaço na IU.
  • Use a primeira letra maiúscula para o texto atribuído a cada opção.
  • Evite usar mudanças de seleção para acionar ações grandes e difíceis de reverter, porque as pessoas geralmente cometem erros ao fazer seleções. Em vez disso, considere adicionar um botão que leia os valores de seleção atuais e acione a ação.
  • Para menus suspensos, classifique as opções em ordem alfabética ou por um esquema lógico que todos os usuários possam entender (como apresentar os dias da semana em ordem, começando de domingo ou segunda-feira).
  • Restringe o número de opções em um determinado widget de entrada de seleção a um número razoável. Se houver muitas opções, os usuários podem ter dificuldade para usar o widget. Nesses casos, considere dividir a opção em diferentes categorias e vários widgets.

Entradas de texto

As entradas de texto fornecem um lugar para que os usuários insiram dados de string.

  • Não use uma entrada de texto para tornar o tipo de usuário um de um conjunto específico de entradas possíveis. Use uma lista suspensa.
  • Use dicas e sugestões para ajudar o usuário a inserir texto com o formato e o conteúdo corretos.
  • Use entradas de texto com várias linhas se o texto a ser inserido tiver mais de algumas palavras.

Branding

Esta seção apresenta diretrizes de experiência do usuário para adicionar elementos da marca à interface do complemento.

No seu complemento

Se quiser incluir a marca na IU do complemento, mantenha-o breve e leve. Isso ajuda as pessoas a se concentrarem na funcionalidade do complemento.

  • Todos os aspectos do complemento precisam seguir as diretrizes da promoção de marca.
  • Não inclua as palavras "Google", "Gmail" ou outros nomes de produtos do Google.
  • Não inclua ícones de produtos do Google, mesmo que eles estejam alterados.
  • Não inclua a palavra "complemento" no texto da marca.
  • O texto da marca não deve ter mais do que algumas palavras.

no Google Workspace Marketplace;

Ao configurar seu complemento para publicação, você fornece vários recursos gráficos e de texto para criar a página de detalhes do Google Workspace Marketplace.

Todos os aspectos da página "Detalhes do app" e desses recursos precisam seguir as diretrizes da promoção de marca.