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 solucionar el problema para que pueda lograr su objetivo.

Cuando un usuario interactúa con una app de Google Chat, recibir mensajes de error puede ser una experiencia frustrante cuando no es posible realizar acciones. 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 de modo que sean útiles para los usuarios mediante ejemplos prácticos y no prácticos.

Estructura del mensaje de error

Los mensajes de error prácticos tienen la siguiente estructura:

  • Qué salió mal. Decir 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 puede el usuario avanzar hacia su objetivo. Nunca es suficiente con solo 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 atascado, dile cómo puede obtener más ayuda. Puede ser un comando de /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. Escribieron November 19, 2021, pero la app de Chat espera 2021-11-19.

A continuación, se muestra una versión práctica y otra no viable del mensaje de error con el que responde la app de Chat:

Error de acción

Un usuario le pide a la app de Chat que programe una reunión con otra persona. La app de Chat muestra un mensaje de error útil y práctico:

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 es útil por los siguientes motivos:

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

Error no procesable

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

Enter the correct date format.

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

No es posible enviar este mensaje de error por los siguientes motivos:

  • No indica si se programó la reunión. Es posible que el usuario tenga dudas en cuanto a reprogramar la reunión o suponga que se programó.
  • No le dice al usuario cómo darle 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 proceder y no saben cómo proceder, es posible que dejen de enviar mensajes a la app de Chat.

Probar

Ahora que sabes cómo escribir errores prácticos, ¿puedes identificar en la siguiente situación cuál de estos errores es procesable?

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

¿Qué mensaje de error es accionable?
Para que pueda programar la reunión, debes acceder escribiendo /signin. Para obtener más información, escribe /help.
Este mensaje de error es útil porque indica lo siguiente:
  • Qué salió mal. La app de Chat requiere autenticación.
  • Cómo proceder Escribe /signin para autenticarte.
  • Cómo obtener ayuda Si el usuario desea obtener más información, puede escribir /help.
Debes autenticarte.
No se pueden realizar acciones en este mensaje de error porque no indica cómo realizar la autenticación.
Accede.
No se pueden realizar acciones en este mensaje de error porque no indica cómo acceder e implica que el usuario salió de la cuenta en lugar de decirlo claramente, lo que es confuso.
No se puede programar la reunión.
No se pueden realizar acciones en este mensaje de error porque no le indica al usuario por qué no se puede programar la reunión o cómo puede continuar. No se proporciona ayuda.