En esta página, se describen las prácticas recomendadas para escribir mensajes de error prácticos que le indican al usuario cómo solucionar el problema para que pueda completar su objetivo.
Cuando un usuario está interactuando con una app de Google Chat, recibir mensajes de error puede ser una experiencia frustrante cuando el error no es procesable.
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 a fin de que sean útiles para los usuarios mediante 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. Decir 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 lograr su objetivo. Nunca es suficiente simplemente 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 está atascado, dile cómo puede obtener más ayuda. Podría ser un comando
/helpo 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.
Esta es una versión del mensaje de error accionable y una no accionable al 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 ú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`.
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 un ejemplo de fecha que ayuda a las personas a entender qué escribir.
- Ofrece más ayuda con un comando de barra
/help. Si los usuarios siguen estancados, saben cómo obtener más información.
Error improbable
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 que no es útil y que no es útil:
Enter the correct date format.
No es posible enviar este mensaje de error por los siguientes motivos:
- No indica si se programó la reunión. El usuario podría tener dudas en cuanto a reprogramar la reunión o puede suponer que la reunión está programada.
- No le dice al usuario cómo darle formato a la fecha. En lugar de suponer que los usuarios saben cómo darle 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 procesables, puedes identificar en la siguiente situación cuál de estos errores es viable:
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 la autenticación del usuario. Si no se autenticó a un usuario, la app de Chat responde con un mensaje de error.
/signin. Para obtener más información, escribe /help.- Qué salió mal. La app de Chat requiere autenticación.
- Cómo proceder Escribe
/signinpara autenticarte. - Cómo obtener ayuda Si el usuario desea obtener más información, puede escribir
/help.