Instrucciones de mensaje de error

Un mensaje de error es texto que se muestra para describir un problema que se ha producido que impide que el usuario o el sistema completen una tarea. El problema podría dar lugar a daños o pérdidas de datos. Otros tipos de mensajes incluyen confirmaciones, advertencias y notificaciones. Las directrices de este tema están pensadas para ayudarle a escribir mensajes de error claros que sean fáciles de localizar y útiles para los clientes.

Los mensajes de error mal escritos pueden ser una fuente de frustración para los usuarios y pueden aumentar los costos de soporte técnico. Un mensaje de error bien escrito proporciona la siguiente información al usuario:

• ¿Qué pasó y por qué?
• ¿Cuál es el resultado final del usuario?
• ¿Qué puede hacer el usuario para evitar que vuelva a ocurrir?

La longitud del texto no es un problema siempre y cuando el desarrollador controle los tamaños del búfer correctamente. Es importante que el usuario tenga toda la información necesaria para resolver el problema. Si un mensaje tiene varias audiencias, es posible que tenga que proporcionar texto independiente para los administradores, los usuarios finales y los desarrolladores.

Prácticas recomendadas

Las siguientes son formas de mejorar los mensajes de error:

• Evite las condiciones de error. Si puede predecir que se producirá un error cuando un usuario realice una acción específica, vuelva a escribir el código para que el usuario no pueda provocar el error.
• Escriba un mensaje de error independiente para cada causa conocida del error. No use un único mensaje genérico para explicar todas las razones posibles del error a menos que no pueda determinar la causa del error cuando se produzca.
• Indique claramente el problema y, si será útil para el usuario, explique lo que causó el problema. Siempre que sea posible, reemplace los mensajes genéricos de los recursos de la tabla de mensajes del sistema por un mensaje detallado que sea específico del problema.
• Proporcione al usuario una solución al problema. Si la solución tiene más de un paso, consulte un tema de ayuda en el que se explica la tarea con detalle.
• Muestra solo el nombre del producto, componente o asistente en la barra de título del mensaje. Esto ayuda al usuario a determinar dónde está el problema. No resuma el problema en la barra de título ni incluya la palabra "error".
• No use la jerga técnica, use la terminología que entiende el público. No use jerga ni abreviaturas.
• Use los botones de comando adecuados, como Aceptar, Cancelar, Sí, No y Reintentar. Puede usar combinaciones de estos botones. Los botones Sí y No siempre deben usarse en combinación y siempre deben ir precedidos de una pregunta.
  • Para detener una operación y cerrar el cuadro de mensaje, use el botón Cancelar .
  • Para cerrar un cuadro de mensaje, use el botón Cerrar .
  • Para proporcionar más información sobre la causa del error, use el botón Detalles .
  • Para proporcionar más información sobre la solución al problema, use el botón Ayuda .
  • Si se incluye una acción de usuario en el mensaje, use el botón Aceptar para cerrar el cuadro de mensaje.
  • Los botones Sí y No deben usarse en combinación y siempre deben ir precedidos de una pregunta.
• Si el error es un error crítico, escríbalo en el registro de eventos.

Consideraciones de estilo

• Use oraciones completas pero sencillas.
• Use el presente tiempo para describir las condiciones que causaron el problema o un estado que todavía existe. Puede usar el tiempo pasado para describir un evento distinto que se produjo en el pasado.
• Use la voz activa siempre que sea posible. Puede usar voz pasiva para describir la condición de error.
• Evite los puntos de exclamación y texto en mayúsculas.
• No haga que el usuario se sienta defectuoso incluso si el problema es el resultado de un error de usuario.
• No antropórfice. No implique que los programas o hardware puedan pensar o sentirse.
• No use palabras o frases coloquiales. No use términos que puedan ser ofensivos en determinadas culturas.
• No agregue varios sustantivos sin agregar una preposición o subclausa para aclarar el significado. Por ejemplo, "Servidor de directorio ldap del servidor de sitio" debe cambiarse a "Servidor de directorios para el servicio LDAP del servidor de sitio".
• Inserte descriptores antes de un término para aclarar el significado de la oración. Por ejemplo, "Especificar InfID cuando Detect está establecido en No." debe cambiarse a "Especificar el parámetro InfID cuando la opción Detectar está establecida en No".
• Evite la palabra "malo". Use términos más descriptivos para indicar al usuario qué es incorrecto. Por ejemplo, evite mensajes como "Tamaño incorrecto". En su lugar, indique al usuario qué criterios usar al especificar un tamaño.
• Evite la palabra "por favor". Se puede interpretar para significar que una acción necesaria es opcional.
• Coloque palabras que están tanto en el índice como relevantes para el significado central al principio de la cadena del mensaje.