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 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, encuentra los mensajes de error pueden ser una experiencia frustrante cuando el error no es procesable. Por ejemplo, el mensaje de error, An error occurred, no es útil porque el mensaje no explica qué salió mal, cómo el usuario puede solucionar el problema o cómo el usuario puede obtener ayuda. En esta página, se describe cómo estructurar los mensajes de error para que que son útiles para los usuarios, ya que muestran ejemplos prácticos e inaccionables.

Estructura de mensajes de error

Un mensaje de error práctico tiene 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é un error o genera confianza.
• Cómo puede proceder el usuario hacia su objetivo. Nunca es suficiente decir lo que salió mal. Informa 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 más ayuda. Podría ser un comando /help o un vínculo a documentación de la app de Chat.

Ejemplo de mensaje de error: Formato de fecha incorrecto

En este ejemplo, el usuario ingresó una fecha en un formato que 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 accionable e inaccionable del mensaje de error que La app de Chat responde con lo siguiente:

Error de acción

Un usuario le pide a la app de Chat que programe una reunión de otra persona. La app de Chat responde mensaje de error 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`.

Este mensaje de error es procesable por los siguientes motivos:

• Dice lo que salió mal. La app de Chat no reconocen el formato de fecha.
• Explica cómo corregir el error indicándole al usuario el formato de fecha esperado. y da un ejemplo de fecha para ayudar a las personas a entender qué escribir.
• Ofrece más ayuda con un comando de barra /help. Si los usuarios siguen atascados, ellos saben cómo aprender más.

Error no accionable

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

Enter the correct date format.

Este mensaje de error no se puede realizar por los siguientes motivos:

• No indica si se programó la reunión. El usuario puede tener dudas sobre reprogramar la reunión o dar por sentado que la reunión estaba programada.
• No le indica al usuario cómo darle formato a la fecha. En lugar de suponer que el usuario sabe cómo dar formato a la fecha, debe decir que espera el formato de fecha yyyy-mm-dd.
• No ofrece más ayuda. Cuando los usuarios están atascados y no saben cómo proceder, podría dejar de enviar mensajes a la app de Chat.

Probar

Ahora que sabes cómo escribir errores procesables, ¿puedes identificar en el siguiente situación, cuál de estos errores es procesable:

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