Cómo escribir mensajes de error prácticos

En esta página, se describen las prácticas recomendadas para escribir mensajes de error prácticos que le indiquen al usuario cómo corregir el problema para que pueda completar su objetivo.

Cuando un usuario interactúa con una app de Google Chat, encontrar mensajes de error puede ser una experiencia frustrante si no se puede hacer nada al respecto. Por ejemplo, el mensaje de error An error occurred no es útil porque no explica qué salió mal, cómo el usuario puede solucionar el problema ni cómo puede obtener ayuda. En esta página, se describe cómo estructurar los mensajes de error para que sean útiles para los usuarios, mostrando ejemplos prácticos y que no se pueden implementar.

Estructura del mensaje de error

Un mensaje de error que se puede corregir tiene la siguiente estructura:

  • Qué salió mal. Explicar por qué la app de Chat no puede completar una solicitud ayuda al usuario a resolver el problema. Explicar por qué se produjo un error genera confianza.
  • Cómo el usuario puede avanzar hacia su objetivo. No es suficiente con decir qué salió mal. Diles a los usuarios cómo pueden superar el error y completar su objetivo.
  • Cómo obtener ayuda. Si el usuario sigue teniendo problemas, cuéntale cómo puede obtener más ayuda. Puede ser un comando /help o un vínculo a la documentación de tu app de Chat.

Ejemplo de mensaje de error: Formato de fecha incorrecto

En este ejemplo, el usuario ingresó una fecha en un formato que la app de Chat no esperaba. Escribió November 19, 2021, pero la app de Chat espera 2021-11-19.

A continuación, se incluyen una versión que se puede abordar y una que no se puede abordar del mensaje de error que responde la app de Chat:

Error con diálogo de acción

Un usuario le pide a la app de Chat que programe una reunión con otra persona. La app de Chat responde con un mensaje de error correcto y que se puede implementar:

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

Ejemplo de mensaje de error que le indica al usuario qué salió mal, cómo proceder y cómo obtener ayuda.

Este mensaje de error se puede corregir por los siguientes motivos:

  • Indica qué salió mal. La app de Chat no reconoce el formato de fecha.
  • Explica cómo corregir el error indicándole al usuario el formato de fecha esperado y proporciona una fecha de ejemplo que ayuda a las personas a comprender qué escribir.
  • Ofrece más ayuda con un comando de barra /help. Si los usuarios siguen con problemas, saben cómo obtener más información.

Error que no se puede corregir

Un usuario le pide a la app de Chat que programe una reunión con otra persona. La app de Chat responde con un mensaje de error poco útil y que no se puede corregir:

Enter the correct date format.

Ejemplo de mensaje de error que no proporciona información procesable.

No se puede realizar ninguna acción en función de este mensaje de error por los siguientes motivos:

  • No indica si se programó la reunión. Es posible que el usuario tenga dudas para reprogramar la reunión o que dé por sentado que ya se programó.
  • No le indica al usuario cómo dar formato a la fecha. En lugar de suponer que los usuarios saben cómo dar formato a la fecha, debería decir que espera el formato de fecha yyyy-mm-dd.
  • No ofrece más ayuda. Cuando los usuarios no saben cómo continuar, es posible que dejen de enviar mensajes a la app de Chat.

Probar

Ahora que sabes cómo escribir errores con diálogo de acción, ¿puedes identificar en la siguiente situación cuál de estos errores es accionable?

Una app de Chat crea eventos de calendario cuando los usuarios le envían un mensaje a la app de Chat con la palabra clave schedule. Para crear un evento de calendario, la app de Chat requiere la autenticación del usuario. Si un usuario no se autenticó, la app de Chat responde con un mensaje de error.

¿Qué mensaje de error se puede corregir?
Para que pueda programar la reunión, debes acceder a tu cuenta. Para ello, escribe /signin. Para obtener más información, escribe /help.
Este mensaje de error se puede abordar porque dice lo siguiente:
  • Qué salió mal La app de Chat requiere autenticación.
  • Qué hacer a continuación Escribe /signin para autenticarte.
  • Cómo obtener ayuda Si el usuario quiere obtener más información, puede escribir /help.
Debes autenticarte.
No se puede realizar ninguna acción en función de este mensaje de error porque no indica cómo autenticarse.
Accede.
Este mensaje de error no se puede resolver porque no indica cómo acceder y da a entender que el usuario salió de su cuenta en lugar de decirlo claramente, lo que es confuso.
No se puede programar la reunión.
Este mensaje de error no se puede abordar porque no le indica al usuario por qué no se puede programar la reunión ni cómo puede continuar. No se proporciona ayuda.