Criar mensagens de erro acionáveis

Esta página descreve as práticas recomendadas para escrever mensagens de erro acionáveis que dizem ao usuário como corrigir o problema para que possa concluir seu objetivo.

Quando um usuário interage com um app do Google Chat, se deparar com mensagens de erro podem ser uma experiência frustrante quando o erro não é acionável. Por exemplo, a mensagem de erro An error occurred não é útil porque o não explica o que deu errado, como o usuário pode corrigir o problema ou como o usuário possa obter ajuda. Esta página descreve como estruturar mensagens de erro para que que são úteis para os usuários, mostrando exemplos acionáveis e não acionáveis.

Estrutura da mensagem de erro

Uma mensagem de erro acionável tem a seguinte estrutura:

• O que deu errado? Explicar por que o app do Chat não pode concluir uma solicitação ajuda o usuário a resolver o problema. Explicação do motivo de um erro gerou confiança.
• Como o usuário pode prosseguir em direção ao objetivo. Nunca é suficiente apenas diga o que deu errado. Diga aos usuários como eles podem passar do erro e concluir para atingir o objetivo.
• Como receber ajuda. Se o usuário ainda estiver preso, diga a ele como ele pode mais ajuda. Pode ser um comando /help ou um link para a documentação de seu app do Chat.

Exemplo de mensagem de erro: formato de data incorreto

Neste exemplo, o usuário inseriu uma data em um formato que que o app do Chat não esperava. Eles escreveram November 19, 2021, mas o app do Chat espera 2021-11-19.

Aqui está uma versão acionável e uma não acionável da mensagem de erro que o O app do Chat responde com:

Erro acionável

Um usuário pede ao app do Chat para agendar uma reunião com de outra pessoa. O app do Chat responde com um mensagem de erro acionável:

I don't recognize the date format you entered. Write dates as `yyyy-mm-dd`; for example, `2000-01-31`. For help, type `/help`.

Essa mensagem de erro pode ser acionada pelos seguintes motivos:

• Informa o que deu errado. O app Chat não reconhecer o formato da data.
• Explica como corrigir o erro informando ao usuário o formato de data esperado e dê um exemplo de data que ajude as pessoas a entender o que escrever.
• Oferece mais ajuda com um comando de barra /help. Se os usuários ainda estiverem paralisados, eles sabem como aprender mais.

Erro inacionável

Um usuário pede ao app do Chat para agendar uma reunião com de outra pessoa. O app do Chat responde com uma mensagem de erro inútil e inacionável:

Enter the correct date format.

Essa mensagem de erro não pode ser acionada pelos seguintes motivos:

• Não diz se programou a reunião. O usuário pode estar hesitante em reprogramar a reunião ou poderão presumir que ela foi agendada.
• Não diz ao usuário como formatar a data. Em vez de presumir que que os usuários sabem como formatar a data, ele deve informar que espera formato de data yyyy-mm-dd.
• Não oferece mais ajuda. Quando os usuários estão travados e não sabem como proceder, ele poderá parar de enviar mensagens para o app do Chat.

Faça um teste

Agora que você sabe como escrever erros acionáveis, pode identificar nos cenário a seguir, qual desses erros é acionável:

Um app do Chat cria eventos da agenda quando os usuários enviam mensagens o app do Chat com a palavra-chave schedule. Para criar um evento da agenda, o app do Chat exige que o usuário autenticação. Se um usuário não tiver sido autenticado, o O app do Chat responde com uma mensagem de erro.