Este guia de estilo foca em criar descrições eficazes de páginas e dicas para a interface do usuário de um produto. Ambos os elementos são cruciais para fornecer clareza e contexto, ajudando os usuários a navegar e interagir com a plataforma de forma eficiente.
Princípios Fundamentais
| Princípio | O que isso significa |
|---|---|
| Clareza e simplicidade | Use uma linguagem direta, livre de jargão e complexidade técnica. Mantenha as mensagens curtas e diretas. |
| Consistência | Use terminologia consistente em todas as descrições e dicas de ferramenta. Siga o mesmo tom, tensão e estilo ao longo da plataforma. |
| Linguagem centrada no usuário | Escreva a partir da perspectiva do usuário, enfatizando ações ou benefícios. Evite termos internos do sistema, a menos que sejam voltados para o usuário. |
| Acessibilidade | Garanta que o texto seja compreensível para todos os usuários, incluindo falantes não nativos. Use o caso da frase para legibilidade. |
Descrições das Páginas
Uma descrição da página fornece uma breve explicação do propósito da página e ajuda os usuários a entender as principais ações que podem realizar ali.
Melhores Práticas
| Diretriz | O que fazer |
|---|---|
| Resuma o propósito da página | Foque no que os usuários podem realizar na página. |
| Comprimento limite | Atenha 1 a 2 frases. Evite descrições excessivamente detalhadas. |
| Use linguagem orientada a ações | Comece com verbos ou frases que descrevam o que o usuário pode fazer. |
| Evite repetição | Não repita o título da página nem duplique outros elementos da interface. |
Exemplos
| Page | Descrição |
|---|---|
| Página de gerenciamento de categorias | "Organize e gerencie suas categorias de base de conhecimento para estruturar seu conteúdo de forma eficaz." |
| Página de upload do arquivo | "Envie arquivos para anexá-los a artigos ou compartilhar com sua equipe." |
| Página de configurações de permissão | "Defina permissões de acesso para grupos de leitores controlarem a visibilidade do conteúdo." |
Dicas de ferramenta
Uma dica de ferramenta fornece contexto adicional ou esclarecimento sobre um elemento específico da interface quando os usuários passam o mouse sobre ele.
Melhores Práticas
| Diretriz | O que fazer |
|---|---|
| Seja conciso | Limite as dicas de ferramentas a uma frase curta (menos de 15 palavras). |
| Valor agregado | Forneça informações que não sejam imediatamente visíveis na interface. Não repita rótulos ou descrições que já estão claras. |
| Use o tempo presente | Foque no estado atual ou na ação disponível para o usuário. |
| Seja específico | Adapte as dicas de ferramenta para a funcionalidade do elemento. Evite frases vagas ou genéricas. |
Exemplos
| Elemento | Dica de ferramenta |
|---|---|
| Campo de domínios permitidos | "Insira domínios para permitir que usuários com endereços de e-mail correspondentes se registrem." |
| Botão de exportação | "Baixe os dados atuais como um arquivo CSV." |
| Configurações de SEO | "Otimize seu artigo para mecanismos de busca adicionando uma meta-descrição e palavras-chave." |
Descrições de Páginas vs. Dicas de Ferramentas
| Aspecto | Descrições das páginas | Dicas de ferramenta |
|---|---|---|
| Propósito | Forneça um resumo do propósito da página. | Ofereça orientações adicionais para elementos específicos da interface. |
| Colocação | Abaixo do título ou cabeçalho da página. | Aparece ao passar o mouse sobre um elemento específico. |
| Duração | 1–2 frases. | Uma frase curta ou uma única frase. |
| Tone | Neutro e explicativo. | Contextual e instrucional. |
Checklist: Descrições das Páginas
- Isso explica claramente o propósito da página?
- É curto e fácil de ler?
- Ele orienta o usuário sobre o que ele pode alcançar na página?
- Isso evita redundância com outros elementos da interface?
Checklist: Dicas de ferramentas
- Isso traz valor além do que é visível na interface?
- É conciso e específico para o elemento, sem ser esmagador?
- Usa o tempo presente?
- Isso evita repetir o rótulo ou título do elemento?
- Está livre de jargão ou terminologia complexa?
- Está gramaticalmente correto e pontuado corretamente?