Mensagens de erro bem elaboradas ajudam os usuários a entender o que deu errado e como corrigir — reduzindo frustração e pedidos de suporte. Este guia estabelece padrões para escrever mensagens de erro claras, consistentes e empáticas em toda a interface.
Princípios Fundamentais
| Princípio | O que isso significa |
|---|---|
| Clareza | Use uma linguagem simples e cotidiana. Evite jargões e descrições vagas. |
| Acionabilidade | Diga ao usuário exatamente o que fazer a seguir. Se não for necessária nenhuma ação, diga. |
| Empatia | Nunca culpe o usuário. Use uma expressão de apoio e neutra. |
| Consistência | Use o mesmo tom, estrutura e terminologia em todas as mensagens (por exemplo, não misture "erro de servidor" e "erro do sistema" para o mesmo problema). |
| Brevidade | Seja breve — contexto suficiente para ser útil, nada mais. |
| Acessibilidade | Siga as diretrizes do WCAG para que as mensagens sejam compreensíveis para usuários de todas as habilidades. |
Anatomia de uma Mensagem de Erro
Cada mensagem de erro deve responder até três perguntas:
- O que aconteceu? Explique o problema claramente.
- Por que isso aconteceu? (opcional) Adicione uma breve razão se isso ajudar o usuário a entender.
- O que o usuário deve fazer a seguir? Dê uma ação ou ponto específico para ajudar mais.
Estrutura:
| Componente | Exemplo |
|---|---|
| Cabeçalho | "Incapaz de processar o pedido" |
| Descrição | "Tivemos um problema ao processar seu pedido. Por favor, tente novamente." |
| Ação/Ajuda | "Se o problema persistir, entre em contato com o suporte na support@document360.com." |
Diretrizes de Escrita
| Diretriz | ✅ Do | ❌ Não faça isso |
|---|---|---|
| Use linguagem simples | "O tamanho do arquivo excede o limite permitido." | "O upload do arquivo falhou devido a restrições de tamanho." |
| Seja específico | "Endereço de e-mail inválido. Por favor, insira um formato válido (por exemplo, name@domain.com)." | "Erro de entrada." |
| Fornecer uma solução | "O nome de usuário já está tomado. Tente outro nome de usuário." | "Este nome de usuário não está disponível." |
| Evite jargão técnico | "Não conseguimos nos conectar ao servidor. Verifique sua conexão com a internet e tente novamente." | "Erro do servidor 503 detectado." |
| Use uma linguagem educada e positiva | "Algo deu errado. Por favor, tente novamente em alguns minutos." | "Erro! Tente de novo." |
| Alinhe-se com o contexto | "Não conseguimos salvar isso. Por favor, tente novamente." | "Erro de salvamento! Ação bloqueada!" |
| Use voz ativa | "Não conseguimos encontrar o artigo solicitado." | "O artigo solicitado não foi encontrado." |
| Evite palavras negativas | "Não conseguimos completar seu pedido." | "Falhou em processar seu pedido." |
Códigos de erro: Inclua-os apenas para erros complexos ou técnicos que ajudem na solução de problemas.
Exemplo: "A solicitação não pôde ser processada (Código de Erro: 403). Entre em contato com o suporte para obter ajuda."
Cenários de Erro Comuns
| Cenário | Mensagem de erro |
|---|---|
| Entrada inválida | "Senha inválida. A senha deve ter pelo menos 8 caracteres e incluir um número." |
| Campo necessário faltando | "Endereço de e-mail é necessário. Por favor, insira seu e-mail para prosseguir." |
| Tempo limite do servidor | "Estamos tendo dificuldade para conectar ao servidor. Por favor, tente novamente mais tarde." |
| Erro de upload do arquivo | "Upload do arquivo falhou. Certifique-se de que o arquivo tenha menos de 5 MB e esteja em um formato suportado." |
| Acesso negado | "Você não tem permissão para ver esta página. Entre em contato com seu administrador." |
| Falha no pagamento | "O pagamento não pôde ser processado. Verifique os dados do seu cartão ou tente outro método." |
| Entrada duplicada | "Esse nome de categoria já existe. Por favor, escolha outro nome." |
| Sessão encerrada | "Sua sessão expirou. Por favor, faça login novamente para continuar." |
Lista de Verificação Pré-Publicação
- A mensagem é clara e concisa?
- Isso explica o que deu errado?
- Isso oferece um próximo passo concreto?
- Está livre de jargão técnico?
- O tom é educado e profissional?
- Isso é consistente com outras mensagens de erro no produto?
Manutenção
Revise todas as mensagens de erro periodicamente conforme os recursos do produto evoluem e atualize-as rapidamente para evitar orientações desatualizadas ou confusas.