Compartilhar via

Guia de estilo de texto e o design de IU de Windows Admin Center

  • Aplica-se a: ✅ Windows Admin Center, ✅ Windows Admin Center Preview

Este tópico descreve a abordagem geral para escrita de texto (UI) da interface de usuário para o Windows Admin Center, bem como alguns convenções específicas e abordagens que estamos aproveitando.

Windows Admin Center e qualquer extensão deve seguir princípios de voz da Microsoft para que a experiência seja fácil de usar e amigável. Este guia de estilo baseia-se nestes princípios de voz, bem como o Guia de estilo de escrita Microsoft, portanto, certifique-se de fazer check-out de ambos desses recursos para informações sobre coisas como acessibilidade, acrônimose Escolha do word , como Por favor,e Desculpe.

Botões

  • Botões devem ser uma palavra sempre que possível, especialmente se você planeja localizar sua ferramenta. Duas ou três tudo bem, mas tente evitar mais. Se você tiver quatro palavras ou mais, seria melhor usar um controle de link.

  • Rótulos de botão devem ser conciso, específicos e auto-explicativos. Em vez de um botão de "Enviar" genérico, use um verbo correspondente à ação de usuário, como "Criar", "Excluir", "Adicionar", "Formatação" etc.

  • Se um botão segue uma pergunta, seu rótulo deve corresponder claramente para a pergunta (geralmente "Yes" ou "Não").

  • Ao iniciar um fluxo de criação, use o rótulo de botão apropriado:

    Botão Uso
    Criar Crie um novo recurso/objeto/etc.
    Adicionar Adicione um recurso/objeto/etc existente à ferramenta.
    Instalar Como instalar software/extensões.

Uso de maiúsculas

Podemos siga o estilo da Microsoft para capitalização - capitalização do estilo sentença de uso para praticamente tudo.

Elemento da interface de usuário Uso de maiúsculas Comentários
Selos (por exemplo, VISUALIZAÇÃO) Todo em maiúsculas
Todo o resto Estilo de frase No entanto, há algumas exceções onde podemos desvendar propriedades do objeto do PowerShell que está fora do nosso controle ou de WMI.

Dois pontos

Use dois pontos para introduzir listas. Por exemplo:

Escolha uma destas opções:

  • Gatos
  • Cães
  • Quokkas

Não use dois pontos no texto da interface do usuário, quando um rótulo estiver em uma linha diferente do que a identificada ou quando houver uma distinção clara entre o rótulo e o que ele está identificando.

Use dois pontos no texto da interface do usuário, quando um rótulo estiver na mesma linha que o texto identificado e você precisar impedir que os dois elementos sejam executados juntos.

Mensagens de confirmação

As caixas de diálogo de confirmação são úteis, quando continuar pode ter resultados inesperados, como perda de dados. Elas devem conter informações úteis e verificáveis com um resultado claro, especialmente para eventos que não podem ser revertidos.

  • Verifique se uma confirmação é necessária. Se não houver novas informações a serem oferecidas (por exemplo, "Tem certeza?"), uma mensagem de confirmação pode não ser necessária.
  • Verifique se o cliente deseja prosseguir com a ação.
  • Verifique se a instrução principal (título) e o texto explicativo (corpo) não são redundantes.
  • No título, defina os possíveis resultados como uma pergunta ou declaração sobre o que acontecerá a seguir. Por exemplo, "Apagar todos os dados nesta unidade? ou "Você está prestes a apagar todos os seus dados".
  • Adicione os detalhes no corpo. Se houver uma variável, como o nome do item que você está prestes a alterar, inclua aqui.
  • Inclua uma pergunta simples (no cabeçalho ou no corpo) que enquadra uma opção clara entre dois botões de ação.
  • Para uma escolha complexa, use botões Sim/Não, que incentivam uma leitura cuidadosa. Para uma opção mais simples, use botões específicos para a ação, como Excluir tudo ou Cancelar.

Telas de apresentação

Na primeira vez que um usuário visita uma página, você tem uma oportunidade para ajudá-los a começar a usar a ferramenta. Isso pode ser:

  • Uma sequência de texto em uma página vazia com curtas instruções sobre como começar , por exemplo, "Selecione Adicionar para adicionar um aplicativo."
  • Um link para o controle que obtém o usuário iniciado, por exemplo, "Adicione um aplicativo para começar."
  • Um pequena e curta animação ou vídeo mostrando o usuário como começar

Aqui estão algumas dicas de nosso guia de estilo do Windows:

1. Seja solicito

  • Evite uma linguagem e estilo de marketing.
  • Quando você demonstrar ou sugerir algo, verifique se o resultado final está claro. Apenas mostrar para o cliente como fazer algo não é uma maneira eficaz, caso ele não saiba o que está fazendo.
  • Não apresente dicas se o cliente não precisar delas.

2. Mostre, não fale

Mantenha o texto simples possível (pense em animações pequenas ou vídeos).

3. Não sobrecarregue

  • Limitar pop-ups e dicas para 4 por sessão de uso combinados — incluindo notificações do sistema e notificações do shell.
  • Verifique se que o tempo de pop-ups é útil.
  • Não impede que o cliente fazendo algo.
  • Certifique-se de que os pop-ups pode ser descartados facilmente.

4. Mantenha tudo contextual

  • Momentos de ensino são mais eficazes quando apresentados no momento certo.
  • Se você criar tutoriais ou apresentações de slides, mantenha as informações concretas.
  • Não use marketing "complicado": concentre-se em dicas e truques específicos.
  • Forneça uma maneira dos clientes retornarem ao tutorial depois, caso seja relevante (pessoas geralmente não retêm as informações na primeira vez, mas as instruções de configuração podem ser mais relevantes somente uma vez).
  • Mensagens vazias são um lugar natural para aprendizado e/ou felicidade: mantenha tudo simples e informativo.

5. Minimizar instalações desagradáveis

Quando você precisar que o cliente execute outra ação para experimentar o valor completo (entrar em um serviço online etc.), torne o processo o mais simples possível.

  • As mensagens devem ser curtas e diretas.
  • Evite assustá-los. Se possível, forneça um meio para se conectar a partir de onde estejam.
  • Se possível, habilite a opção de execução posterior e, em seguida, lembre-os para executá-la posteriormente.
  • Caso retire-os da experiência, forneça uma maneira de voltar de forma rápida e fácil.

Aqui estão algumas dicas de nosso guia de estilo do Windows:

Quase nunca. Forneça um link de ajuda somente quando:

  • Há uma pergunta óbvia e importante que os clientes provavelmente farão enquanto estiverem na interface do usuário, cuja resposta os ajudará a ter êxito na tarefa da interface do usuário.
  • Não há espaço suficiente na interface do usuário para fornecer o volume de informações necessário para que os usuários tenham êxito na tarefa de interface do usuário.
  • Os links de texto devem aparecer o mais próximo possível do elemento de interface do usuário ao qual a ajuda é direcionada.
  • Se você precisar fornecer um link de texto que se aplique a uma tela inteira da interface do usuário, coloque-o na parte inferior esquerda da tela.
  • Se você fornecer um link por meio de um botão de Ajuda (?), a dica de ferramenta deverá ser "Ajuda".

Qual URL devemos usar?

Nunca vincule diretamente a um endereço Web. Em vez disso, use um serviço de redirecionamento.

Os desenvolvedores da Microsoft devem usar um FWLink, exceto quando for um link de ajuda que os usuários possam precisar digitar manualmente. Nesse caso, use um link aka.ms (desde que o destino da URL seja um site que reconheça automaticamente a localidade do navegador, como learn.microsoft.com).

Diretrizes de texto

  • Use frases completas.
  • Não inclua pontuação final, exceto pontos de interrogação.
  • Você não precisa usar o mesmo texto que o título da tarefa. Use um texto que faça sentido no contexto da interface do usuário, mas verifique se há uma conexão lógica entre os dois. Por exemplo:
    • Link de ajuda: quais são os riscos de permitir exceções?
    • Título do tópico de ajuda: "como permitir que um programa se comunique por meio do Firewall do Windows"
  • Seja o mais específico possível sobre o conteúdo do tópico de ajuda.
    • Nosso estilo
      • Como o Firewall do Windows ajuda a proteger meu computador?
      • Por que os destaques podem melhorar uma imagem?
    • Não é o nosso estilo
      • Mais informações sobre o Firewall do Windows
      • Saiba mais sobre o gerenciamento de cores
      • Saiba mais
  • Use a frase inteira para o texto do link, não apenas as palavras-chave.
  • Em alguns casos, não há problema em usar um link "Saiba mais", se o contexto estiver claro sobre o que o usuário receberá ao clicar no link.

Mensagens de erro

Estas são algumas diretrizes adaptadas do Guia de Estilo do Windows:

Escrever uma boa mensagem significa ter equilíbrio entre fornecer a explicação suficiente, mas não ser excessivamente técnico, entre ser casual e elegante, mas não irritante ou ofensivo.

Diretrizes gerais

Use uma mensagem por caso de erro.

Títulos

  • Mantenha o texto breve e explique concisamente qual é o problema ou o ideal é o que fazer.
    Algumas superfícies de interface do usuário podem ter títulos truncados, em vez de agrupados, quando são muito longos. Portanto, fique atento.
  • Use a solução no título, se for uma etapa simples.
  • Verifique se o título está relacionado diretamente ao botão, caso o leitor ignore o texto do corpo.
  • Evite usar "Houve um problema" em títulos, a menos que você não tenha outra opção. Seja mais específico sobre o problema.
  • Evite usar variáveis (como nomes de arquivo, pasta e aplicativo) em títulos. Coloque-os no corpo.

Corpo

  • Se o título explicar suficientemente o problema ou a solução, você não precisará do corpo do texto.

  • Não repita o título na mensagem com palavras um pouco diferentes.

  • Comunique de forma clara e concisa qual é a solução.

  • Concentre-se em fornecer os fatos primeiro.

  • Não culpe os usuários pelo erro.

  • Se houver um código de erro associado ao erro e se você achar que incluir o código de erro pode ajudar o cliente ou o suporte da Microsoft a pesquisar o problema, inclua-o diretamente abaixo do corpo do texto e escreva-o da seguinte maneira:

    Código de erro: ####

    Se o cliente tiver todas as informações necessárias para resolver o erro sem o código, você não precisará incluí-lo.

Botões

  • Escreva o texto do botão de modo que seja uma resposta específica à instrução principal. Se isso não for possível, use "Fechar" para o texto do botão de dispensa (em vez de "Ok" ou "Concluído").
  • Se você tiver mais de um botão, torne o botão mais à esquerda a ação que o usuário é incentivado a executar. Torne o botão mais à direita a ação mais conservadora, como "Cancelar".

Considere os links de Ajuda apenas para mensagens de erro que você não pode tornar específicas e acionáveis.

Texto de estado nulo

Esta é uma ajuda do Guia de Estilo do Windows.

O estado nulo ocorre quando os dados ou o conteúdo do cliente estão ausentes em um aplicativo ou recurso, quando nenhum resultado é retornado após uma pesquisa ou quando as informações necessárias estão ausentes em um formulário, como informações de cobrança de uma transação.

Diretrizes

  • Se possível, use situações de estado nulo como uma oportunidade para instruir as pessoas sobre como usar o recurso (por exemplo, como adicionar música, onde encontrar imagens etc.)
    • Se você tiver um título na interface do usuário, explique a ação a ser tomada para "corrigir" o estado nulo (por exemplo, "Adicionar algumas músicas")
    • Divirta-se com o texto. Esse espaço pode ser uma oportunidade de descontração, pois provavelmente não será vista várias vezes.
    • Evite “Aqui é solitário”. É triste e foi usado demais.
    • Evite perguntas como "Você não conectou sua impressora?" Tudo bem usar uma vez, mas esse formato tende a ser usado em excesso, e as perguntas colocam uma sobrecarga/pressão adicional no cliente. Também pode parecer condescendente.
    • É bom ter variedade no texto de estado nulo.

Exemplos

  • "Adicione alguém como favorito e será exibido aqui."
  • "Você tem conquistas ou clipes de jogo dos quais se orgulha? Adicione-os à sua demonstração."
  • "Ninguém fez festa ainda. Comece uma!"
  • "Quando alguém te adicionar como amigo, será exibido aqui."
  • "Quando você faz coisas como desbloquear conquistas, gravar clipes de jogos e adicionar amigos, tudo isso será exibido aqui."
  • "Seus amigos favoritos serão exibidos aqui, para que você possa ver quando estiverem online e o que eles estão fazendo."

Pontuação

  • Sem pontuação final (pontos e interrogação) para títulos ou frases incompletas. Uma exceção é uma caixa de diálogo de confirmação onde o título faz a pergunta
  • Use as instruções do guia de estilo doa Microsoft sobre pontos e pontos de interrogação.

Mensagens de status

Mensagens de status consistem em notificações e mensagens de janela pop-up (proposta).

Tipo de cadeia de caracteres Observações
Notificação do sistema Frases com a mensagem de pontuação - idealmente com uma variável de objeto para que os usuários podem entender qual o objeto de final se aplica ao caso eles tenham navegado para longe do objeto
Título da notificação (título) Frases sem pontuação final (é um título), o ideal é com uma variável de objeto
Detalhes da notificação Sentenças completos, idealmente com um link para a interface do usuário que exibe o objeto

Aqui estão algumas recomendações detalhadas para mensagens de notificação:

Tipo de cadeia de caracteres Observações
Iniciado Omita quando possível: geralmente pule apenas a mensagem em andamento para minimizar o número de distrações.
Em Andamento Comece com o verbo da ação que você estiver realizando e terminarem com reticências para indicar uma operação em andamento. Veja um exemplo:
Como criar o volume de "Dados do cliente"...

Quando houver várias variáveis, use este padrão:
Como excluir a seguinte máquina virtual: {0}; Host: {1}
Êxito Comece com "Com êxito" e termine com o software que acabamos de fazer. Veja um exemplo:
O volume "Dados do cliente" foi criado.
Falha Comece com "Não pôde" e termine com o que o software não conseguiu realizar. Veja um exemplo:
Não foi possível criar o volume "Dados do cliente".

Dicas de ferramenta

Boas dicas de ferramenta descrevem brevemente os controles não identificados ou fornecem algumas informações adicionais para os controles identificados, quando isso é útil. Elas também podem ajudar os clientes a navegar na interface do usuário oferecendo informações adicionais, não redundantes, sobre rótulos de controle, ícones, links etc.

As dicas de ferramenta devem ser usadas com moderação ou nem devem ser usadas. Elas podem ser uma interrupção para o cliente. Portanto, não inclua uma dica de ferramenta que simplesmente repita um rótulo ou declare o óbvio. Elas sempre devem adicionar informações importantes.

Contexto Como escrever as dicas de ferramenta
Quando um controle ou elemento de interface do usuário não é identificado... Use uma frase nominal simples e descritiva. Por exemplo:
Caneta de realce
Quando um elemento de interface do usuário é identificado, mas sua finalidade precisa de esclarecimento...
  • Descreva brevemente o que você pode fazer com esse elemento de interface do usuário.
  • Use a forma verbal imperativa. Por exemplo, "Localizar texto neste arquivo" (não "Localiza texto neste arquivo").
  • Não inclua pontuação final, a menos que haja várias frases completas.
Quando um rótulo de texto é truncado ou provavelmente truncado em alguns idiomas...
  • Forneça o rótulo não truncado na dica de ferramenta.
  • Opcional: em outra linha, forneça uma descrição esclarecedora, mas somente se necessário.
  • Não forneça uma dica de ferramenta, se as informações não truncadas forem fornecidas em outro lugar na página ou no fluxo.
Se teclas de atalho estiver disponível...
  • Opcional: forneça as teclas de atalho entre parênteses depois do rótulo ou da frase descritiva, por exemplo, "Imprimir (Ctrl+P)" ou "Localizar texto neste arquivo (Ctrl+F)"
  • Não há problema em adicionar teclas de atalho úteis a uma dica de ferramenta esclarecedora, mas evite adicionar uma dica de ferramenta apenas para mostrar teclas de atalho.