Guia de estilo da IU para complementos do Google Workspace

Os complementos do Google Workspace devem ser consistentes com as estilo e layout do aplicativo host elas se estendem. Eles precisam ampliar a interface naturalmente, usando controles e comportamentos conhecidos. As diretrizes apresentadas descrevem formas de lidar com texto, imagens, controles e branding que promovem uma experiência de usuário de alta qualidade.

Caso seu complemento abra páginas da Web separadas que sejam parte integrante do (como uma página de configurações para o complemento), verifique se essas páginas da Web seguir essas diretrizes de estilo.

Texto e imagens

Nesta seção, explicamos como usar textos e imagens no seu complemento.

Nome do complemento

Você precisa definir o nome do complemento no projeto manifestar e quando você configure o complemento para publicação. O nome aparece em muitos lugares, como no Google Workspace Marketplace. listagem e nos menus. Ao escolher um nome:

  • Use letras maiúsculas no título.
  • Evite pontuação, especialmente parênteses, a menos que faça parte da sua marca.
  • Seja breve. O ideal é ter 15 caracteres ou menos. Nomes longos podem ser truncadas 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.
  • Deixe de fora as informações da versão.

Estilo de escrita

Você não precisa escrever muito. A maioria das ações deve ficar clara iconografia, layout e rótulos curtos. Se você encontrar uma parte do seu complemento precisar de uma explicação mais extensa do que os rótulos curtos podem fornecer, é uma melhor prática para criar uma página da Web separada descrevendo seu complemento e um link para ele.

Ao escrever o texto da interface:

  • Use letras maiúsculas e minúsculas (especialmente para botões, rótulos e ações do cartão).
  • Prefira textos curtos e simples, sem jargões ou siglas.

Ações universais e de card

Se você usar ações universais ou ações do card na sua eles aparecem como itens de menu nos cards definido por você. Você pode escolher o texto usado nesses menus para esses ações. Ao escolher o texto que será usado:

  • Evite usar texto de menu que simplesmente repita o nome do complemento.
  • Inicie cada item de menu com uma palavra de ação, como "Executar", "Configurar" ou "Criar".
  • Descreva a tarefa, não o componente de IU que a ação exibe.
  • Se a ação iniciar um fluxo de trabalho e não houver um único verbo que descreva o que ele faz, chame-o de "Iniciar".
  • Manter o número de itens de menu pequeno para evitar forçar o usuário a rolar a tela em uma grande lista. Se você tiver mais ações para implementar, considere usar vários cards com diferentes ações 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 sugerir como corrigi-lo.

  • Não permitir que o usuário veja as exceções geradas pelo código. Em vez disso, use instruções try...catch para interceptar exceções e exibir uma mensagem de erro fácil de usar.
  • Antes da publicação, verifique se o complemento não exibe informações de depuração na interface.

Conteúdo Help

Você pode criar cards que mostrem informações de ajuda ou que expliquem do complemento para o usuário. Se você cria conteúdo de ajuda para , lembre-se de:

  • Sempre que possível, mostre as instruções em uma lista com marcadores ou numerada. Caminhar com os usuários até o resultado final, com referências claras a elementos da interface nomeados.
  • Certifique-se de que suas instruções expliquem claramente todos os requisitos, como a configuração em uma planilha de uma determinada maneira.
  • Fique à vontade para incluir links de conteúdo de ajuda externo, como páginas da Web de apoio.

Imagens

As imagens usadas no complemento são uma das tipos de ícones integrados ou uma imagem hospedada publicamente especificada por um URL. Ao usar imagens hospedadas, É importante que todos os usuários do complemento tenham acesso a ele.

Controles

Esta seção fornece 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 e outros widgets.

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

DecoratedText

Widgets do DecoratedText permitem apresentar conteúdo de texto com ícones, botões ou interruptores.

  • Use a primeira letra maiúscula para o conteúdo do texto.
  • O texto de um widget DecoratedText será truncado se não caber no disponível. Por essa razão, sempre tente manter o conteúdo do texto como o mais curto possível.

Entradas de seleção

Você pode usar uma variedade widgets de entrada de seleção em seu complemento: caixas de seleção suspensas, caixas de seleção e botões de opção.

  • Use as caixas de seleção quando as pessoas puderem selecionar várias opções ou nenhuma opção. Use botões de opção (ou um menu de seleção) quando exatamente uma opção precisar ser selecionada. Use os menus suspensos ao fornecer uma pequena lista de alternativas enquanto tenta economizar espaço na interface.
  • Use a primeira letra maiúscula no 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 escolhas. Em vez disso, considere adicionando um botão que lê os valores de seleção atuais e aciona 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 (por exemplo, apresentar os dias da semana em ordem, começando no domingo ou na segunda-feira).
  • Restringir o número de opções em uma determinada entrada de seleção a um número razoável. Se houver muitas opções, os usuários podem dificultar o uso do widget. Nesses casos, considere quebrar a opção em diferentes categorias e vários widgets.

Entradas de texto

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

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

Branding

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

No seu complemento

Se quiser incluir a marca na interface do complemento, use uma linguagem breve e leve. Isso ajuda as pessoas a se concentrarem na funcionalidade do complemento.

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

No Google Workspace Marketplace

Ao configurar o complemento para publicação, você fornece uma série de recursos gráficos e de texto para criar a Ficha no Google Workspace Marketplace.

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