Nesta página, descrevemos as práticas recomendadas para escrever mensagens de erro acionáveis que informam ao usuário como corrigir o problema para que ele possa concluir o objetivo.
Quando um usuário interage com um app do Google Chat, encontrar
mensagens de erro pode 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 a
mensagem não explica o que deu errado, como o usuário pode corrigir o problema ou como
pode receber ajuda. Nesta página, descrevemos como estruturar mensagens de erro para
que elas sejam ú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. Dizer por que o app do Chat não consegue concluir uma solicitação ajuda o usuário a resolver o problema. Explicar por que um erro ocorre gera confiança.
- Como o usuário pode proceder para atingir a meta. Nunca é suficiente apenas dizer o que deu errado. Diga aos usuários como eles podem superar o erro e concluir o objetivo.
- Como receber ajuda. Se o usuário ainda estiver com dúvidas, diga como ele pode
receber mais ajuda. Pode ser um comando
/help
ou um link para a documentação do 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
o app Chat não esperava. Ele escreveu
November 19, 2021
, mas o app do Chat espera
2021-11-19
.
Veja uma versão acionável e uma inacionável da mensagem de erro com a qual o app do Chat responde:
Erro acionável
Um usuário pede ao app do Chat para agendar uma reunião com outra pessoa. O app do Chat responde com uma mensagem de erro boa e útil:
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 resolvida pelos seguintes motivos:
- Ele diz o que deu errado. O app do Chat não reconhece o formato de data.
- explica como corrigir o erro informando ao usuário o formato de data esperado e dá um exemplo de data que ajuda as pessoas a entender o que escrever.
- Oferece mais ajuda com um comando de barra
/help
. Se os usuários ainda estiverem presos, eles saberão como aprender mais.
Erro inacionável
Um usuário pede ao app do Chat para agendar uma reunião com outra pessoa. O app do Chat responde com uma mensagem de erro inútil e inacionável:
Enter the correct date format.
Não é possível usar essa mensagem de erro pelos seguintes motivos:
- Não diz se a reunião foi agendada. O usuário pode hesitar em reagendar a reunião ou pode presumir que ela foi agendada.
- Não informa ao usuário como formatar a data. Em vez de presumir que
os usuários sabem como formatar a data, ele deve informar que está esperando o
formato de data
yyyy-mm-dd
. - Não oferece mais ajuda. Quando os usuários estão presos e não sabem como proceder, eles podem parar de enviar mensagens para o app do Chat.
Testar
Agora que você sabe como escrever erros acionáveis, é possível identificar no cenário a seguir quais desses erros podem ser transformados em ações:
Um app do Chat cria eventos da agenda quando os usuários enviam mensagens
para ele com a palavra-chave schedule
. Para criar um evento da agenda, o app do Chat requer a autenticação do usuário. Se um usuário não tiver sido autenticado, o
app do Chat responderá com uma mensagem de erro.
/signin
. Para saber mais, digite /help
.- O que deu errado. O app do Chat requer autenticação.
- Como proceder. Digite
/signin
para autenticar. - Como receber ajuda. Se o usuário quiser mais informações, ele pode digitar
/help
.