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 completar su objetivo.

Cuando un usuario interactúa con una app de Google Chat, encontrar mensajes de error puede ser una experiencia frustrante cuando el error no es práctico. Por ejemplo, el mensaje de error An error occurred no es útil porque no explica qué salió mal, cómo puede solucionar el problema el usuario 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 no prácticos.

Estructura del mensaje de error

Un mensaje de error práctico tiene la siguiente estructura:

  • Qué salió mal. Indicar por qué la app de Chat no puede completar una solicitud ayuda al usuario a resolver el problema. Explicar por qué ocurrió un error genera confianza.
  • Cómo puede proceder el usuario para alcanzar su objetivo. Nunca es suficiente con decir qué salió mal. Indica a los usuarios cómo pueden superar el error y completar su objetivo.
  • Cómo obtener ayuda. Si el usuario aún no puede avanzar, indícale cómo puede obtener más ayuda. Podría 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.

Aquí tienes una versión práctica y una no práctica del mensaje de error con el que responde la app de Chat:

Error práctico

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 práctico y ú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`.

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 práctico por los siguientes motivos:

  • Indica qué salió mal. La app de Chat no reconoce el formato de fecha.
  • Explica cómo solucionar 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 aún no pueden avanzar, saben cómo obtener más información.

Error no práctico

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 no práctico y poco útil:

Enter the correct date format.

Ejemplo de mensaje de error que no proporciona información útil.

Este mensaje de error no es práctico por los siguientes motivos:

  • No indica si programó la reunión. Es posible que el usuario dude en reprogramar la reunión o que suponga que 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 indicar que espera el formato de fecha yyyy-mm-dd.
  • No ofrece más ayuda. Cuando los usuarios no pueden avanzar 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 práctico?

Una app de Chat crea eventos de calendario cuando los usuarios le envían un mensaje 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 es práctico?
Before I can schedule the meeting, you must sign in by typing /signin. To learn more, type /help.
Este mensaje de error es práctico 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 quiere obtener más información, puede escribir /help.
You must authenticate.
Este mensaje de error no es práctico porque no indica cómo autenticarse.
Accede.
Este mensaje de error no es práctico porque no indica cómo acceder y da a entender que el usuario cerró la sesión en lugar de indicarlo claramente , lo que resulta confuso.
Can't schedule meeting.
Este mensaje de error no es práctico porque no le indica al usuario por qué no se puede programar la reunión ni cómo puede proceder. No se proporciona ayuda.