Diretrizes de texto da interface do usuário para web parts do SharePoint

Um aspecto da criação de web parts eficazes no SharePoint é usar texto de interface do usuário simples, compreensível e conciso. Ao manter a sua mensagem clara e fácil de compreender, garante que os clientes percorrem rapidamente as suas experiências e conseguem identificar os conteúdos que procuram. Este artigo fornece diretrizes para escrever texto de interface do usuário para áreas-chave nas web parts do SharePoint.

Uso de maiúsculas

Use a primeira letra da sentença em maiúscula (a primeira letra da primeira palavra é maiúscula, e o resto fica todo em minúsculas) para todos os elementos da interface do usuário, inclusive botões, títulos de páginas e rótulos de controle.

Sempre coloque em maiúscula:

• A primeira palavra de uma nova frase.
• A palavra que vem após dois-pontos em um título ou cabeçalho. Por exemplo, "Etapa 1: Comece digitando as informações de sua conta".
• Substantivos próprios, como nomes de pessoas, cidades e assim por diante.

Pontuação

Siga as regras básicas de pontuação para evitar erros gramaticais na experiência. A tabela a seguir fornece diretrizes e lembretes sobre a pontuação a ser usada, quando e por quê.

Pontuação	Orientação	Exemplo
Dois-pontos (:)	Utilize dois pontos se estiver a introduzir uma lista na descrição da peça Web. Não use dois-pontos em rótulos da interface do usuário.	Escolha uma das seguintes opções: Gatos, Cães, Quokkas
Vírgulas (,)	Use vírgulas em séries.	Gosto de gatos, pássaros e cães.
Reticências (…)	Use reticências para mostrar um truncamento e para cadeias de caracteres de indicador de progresso. Não use reticências para indicar que o usuário deve fazer mais escolhas.	Truncamento: última modificação por John Armstr… Indicador de progresso: Carregando...
Pontos (.)	Use pontos como você normalmente faria com descrições. Não use pontos em títulos, cabeçalhos ou rótulos. Não use pontos para botões de opção ou caixas de seleção.	Selecione o conteúdo que deseja realçar e como você deseja que ele seja exibido. Use um filtro para restringir a seleção.

Voz e tom

Criar o tom certo na comunicação de seu produto é essencial para construir um relacionamento forte e duradouro com o público. Tente manter o texto nítido e claro, envolvente, relaxado e acessível. A maneira como você fala com o público influencia como ele se envolve com seu site e conteúdo e o valor que eles agregam.

Fazer

• Adote um tom casual e coloquial na interface do usuário.
• Use contrações. Por exemplo, utilize "não é possível" em vez de "não é possível".
• Leia o texto da interface do usuário em voz alta para testar o tom. Ele soa como linguagem cotidiana?
• Use palavras simples.
• Remova detalhes técnicos se eles não forem relevantes para a experiência do usuário.
• Utilize "Por favor" apenas se estiver a desconveniá-lo. Evite o uso excessivo.
• Use "Desculpe" apenas em mensagens de erro no SharePoint que resultem em sérios problemas para o cliente.

Não fazer

• Não sobrecarregue o texto da interface do usuário com repetições desnecessárias. Faça com que cada palavra seja significativa.

Pronomes

Evite pronomes em elementos de interface do usuário, se possível. Se você pode dizer algo igualmente bem sem usar um pronome, não o utilize.

Se o design justifica o uso de pronomes, aplique as diretrizes a seguir para garantir que você os utilize corretamente.

Fazer

• Use a terceira pessoa ("você" ou "seu") quando estiver apresentando algo que pertence ao usuário. Por exemplo, "Seus rascunhos" ou "Suas imagens".
• Use a primeira pessoa ("eu" ou "meu") para a interface do usuário quando o usuário instrui o serviço a fazer algo. Por exemplo, "Alertar-me quando alguém responder à minha postagem".
• Use "eles" ou "seus" como um modificador possessivo singular para evitar constrangimento ao usar "ele/ela". O ideal é reescrever a sentença no plural, se possível.
• Evite usar "eles". Em vez disso, use palavras como "alguém" ou "pessoas". Por exemplo, "Digite um nome de usuário e domínio para dar permissão a alguém para usar este computador".

Não fazer

• Use referências de terceira pessoa do plural, pois elas parecem impessoais e podem criar uma experiência de cliente desconectada. Em vez de dizer "Os usuários podem alterar o layout", use uma frase como "Você pode alterar o layout".

Mensagens de erro

As condições de erro são inerentes a qualquer software ou serviço. Suas mensagens de erro podem afetar a satisfação geral do usuário com o produto. Uma boa mensagem de erro deve fazer o seguinte:

• Identificar claramente o que aconteceu e por quê.
• Fornecer uma solução alternativa ou sugestões de resolução.
• Mostrar empatia.

A seguir há um exemplo de uma mensagem de erro que ocorre quando um usuário tenta editar uma página da qual outro usuário fez check-out.

Você não pode editar agora
Outro usuário está editando esta página no momento. Tente novamente em alguns minutos.

Links para artigos de ajuda

Faça um esforço para vincular estrategicamente aos artigos de ajuda. Tente antecipar quando o usuário pode precisar de ajuda e inclua um link para o artigo de ajuda perto desse elemento da interface do usuário. A seguir há alguns itens importantes para lembrar quando você inclui links de artigos de ajuda na interface do usuário.

Fazer

• Mantenha os links de ajuda no produto específicos. Garanta que o artigo de destino seja apropriado. Quando o usuário abrir o artigo, ele deverá ser capaz de localizar as informações de que precisa.
• Use linguagem natural para os hiperlinks.

Não fazer

• Coloque um link de artigo de ajuda ao lado de cada elemento da interface do usuário. Isso resulta em interferência visual.
• Inclua vários links que vão para o mesmo destino na mesma interface do usuário.
• Use "clique aqui" para o texto do hiperlink.

Texto de dica

O texto de dica ou texto fantasma é o elemento de texto que você exibe em um elemento da interface do usuário, geralmente uma caixa de texto, para ajudar o usuário a interagir com a interface do usuário. O texto de dica fornece informações sobre o que o usuário deve inserir. Por exemplo, pode mencionar as restrições de campo ou mostrar um exemplo.

Fazer

• Use o texto de dica com moderação, e somente se isso ajudar o usuário. Nem todos os elementos da interface do usuário precisam de um texto de dica. Para alguns campos complexos, o texto de dica pode fornecer mais contexto e clareza. Por exemplo, se você tiver um campo que exija que o usuário digite uma URL segura, o texto de dica https://www.example.com poderá ser mais útil do que o texto Digite a URL segura aqui.

Não fazer

• Repita o rótulo. Por exemplo, se você tiver uma caixa de texto com o rótulo Nome, o texto de dica Digite o nome será redundante e potencialmente confuso.

O texto de dica a seguir é para a web part interna. O campo de texto pode aceitar um endereço de site seguro ou um código de incorporação <iframe> . O texto mostra um exemplo de ambos.

Confira também

• Projetando excelentes experiências do SharePoint