En este artículo, aprenderás cómo documentar adecuadamente tu error de acuerdo con nuestras reglas y estándares. Para comprender un error, los clientes necesitan información suficiente con una documentación de alta calidad. Encontrarás información más detallada sobre nuestras reglas en cada sección de este artículo, pero aquí tienes un resumen rápido de nuestros requisitos para el reporte de errores:
Si estás reportando un error funcional, debes seleccionar una de las Severidades disponibles antes de completar el resto del reporte de error.
El Título debe responder a las preguntas de qué sucedió, dónde ocurrió el error y cuándo se desencadena, reflejando el problema real y evitando describir lo que no sucedió (en su lugar, concéntrate en lo que realmente ocurrió).
La URL debe ser el enlace copiado desde tu navegador de la página donde ocurre el error.
El primer Paso para Reproducir debe contener la URL de la página de inicio o el nombre de la aplicación. Los otros pasos deben describir las acciones que realizaste para desencadenar el problema, siendo el último paso la última acción tomada para provocar el problema (y no "observar").
El Resultado Actual debe estar formado por una o más oraciones que expliquen lo que sucedió después de la última acción. También puedes agregar resultados de acciones anteriores si son necesarios para entender el error. El Resultado Actual no debe ser igual al título.
El Resultado Esperado debe contener información sobre lo que debería haber sucedido después de realizar el último paso para desencadenar el error. No debe ser una copia del resultado actual con cambios menores, ya que esos campos están diseñados para diferentes propósitos.
Si se requiere un Archivo Adjunto para tu reporte, no debes olvidar adjuntarlo.
Finalmente, debes seleccionar el Entorno Utilizado y el navegador correcto (si corresponde) utilizado para la prueba, según el dispositivo con el que te invitaron a realizar la prueba cuando aceptaste el ciclo.
Tu primer paso en el formulario de reporte de error debe ser seleccionar la Función correcta. Si no puedes encontrar la Función correcta en la lista desplegable, vuelve a la página de resumen de la prueba, revisa todas las descripciones de Funciones y márcalas como leídas. Después de eso, puedes volver al formulario de reporte de error y todas las Funciones se presentarán en la lista desplegable.
Formulario de Error
Después de seleccionar la Función, todo el formulario de error estará visible para ti. Un formulario para errores funcionales, por ejemplo, se ve de la siguiente manera:
Debes completar cada campo del formulario de errores con la información específica correcta de acuerdo con nuestros estándares de calidad. Puedes encontrar información más detallada sobre cada campo y sus requisitos a continuación.
Gravedad
Para errores funcionales solamente, verás un campo adicional llamado Gravedad: Baja, Alta, y/o Crítica. La gravedad indica la urgencia de tu reporte y depende de múltiples factores. Para conocer los diferentes niveles de gravedad, por favor visita el siguiente artículo sobre Errores Funcionales.
El campo de Gravedad no será mostrado para otros tipos de errores.
Título
El título del reporte de error debe resumir el problema para que el lector tenga una idea general del error solo leyendo el título. No deberían tener que leer todo el reporte para entender cuál es el problema. Tu título del reporte de error debe ser preciso y no demasiado largo al mismo tiempo. Debe contener información sobre: ¿cuál es el error?, ¿dónde ocurrió el error? y ¿cuándo se desencadena el error? Así que al escribir un título para tu reporte de errores, siempre recuerda: ¿Cuál? ¿Dónde? ¿Cuándo?
Cuando escribas un título para un error, describe lo que está sucediendo en lugar de lo que no está sucediendo. Tu título nunca debe indicar que algo no funciona, de lo contrario, el lector no tendrá idea de lo que está sucediendo en realidad.
Los títulos deben reflejar el problema real. Si el error solo ocurre bajo ciertas condiciones, las condiciones deben incluirse en el título del error. Si, por ejemplo, no puedes reservar un boleto cuando indicas que eres adolescente, esta es información relevante y debe incluirse en tu título.
Para crear un título descriptivo, ponte en el lugar de alguien que nunca haya probado el sitio web/app, que no puede imaginar en qué página estás, cómo es y qué hiciste. Lee tu título desde la perspectiva de esa persona para ver si entenderías el error. Si no lo entiendes, ajusta el título y repite el proceso.
Ejemplos de títulos de errores:
Incorrecto: Se muestra un error en la página del carrito
Correcto: Después de que el usuario hace clic en el botón "Pagar", se mostrará un "Error 500" en la página del carrito.
Incorrecto: El usuario no puede agregar un producto al carrito.
Correcto: Se mostró un "Error Inesperado" en la página de detalles del producto cuando el usuario seleccionó el tamaño y hizo clic en el botón "Agregar al carrito".
Lo que está mal en los ejemplos anteriores: hay muchos escenarios posibles en los que estos títulos encajarían porque son demasiado abstractos. El lector no sabe qué acciones estás realizando y cómo responde el sistema a ellas. Por lo tanto, el evaluador debe leer todo el reporte para entender cuál es el error y no puede distinguir fácilmente este error de otros.
URL
Visita la página donde aparece el error y copia y pega la URL desde la barra de direcciones de tu navegador en el campo de URL del formulario de reporte de errores.
La URL debe ser válida.
Pasos para Reproducir
Los errores deben ser reproducibles y necesitan una guía detallada paso a paso sobre cómo pueden ser reproducidos. Cada paso debe describir una acción por separado.
Ten en cuenta que no es necesario enumerar tus pasos, ya que esto lo hace automáticamente nuestro sistema.
El primer paso debe indicar cómo acceder a la URL de la página de inicio proporcionada por el cliente en la sección de Acceso si estás probando un sitio web, o indicar cómo abrir la aplicación (con su nombre) si estás probando una aplicación móvil. Todos los pasos posteriores deben describir tus acciones desde el paso inicial hasta el punto en que se produce el error: qué botones presionas, qué enlaces sigues y qué ingresas. Tu último paso debe describir la acción que realizas que desencadena el error. Recuerda que "observa" no es una acción tomada por el usuario.
Tus pasos deben ser lo más generales posible. Solo si tu error ocurre bajo condiciones específicas, por ejemplo, solo para una página de descripción de producto específica, un filtro específico o una entrada específica, menciona esta condición en tus pasos. Por ejemplo, en tus pasos, no describas la página de descripción de producto específica que visitaste ni el producto específico que agregaste al carrito si el problema ocurre con cualquier producto. Esto ayudará al lector a entender la idea de tu error y no se distraerá con detalles irrelevantes.
Finalmente, asegúrate de que tus pasos contengan la menor cantidad de acciones posibles para realizar. Después de leer cada paso, la persona que reproduce el error que reportaste debería poder completarlos en el sitio web o la aplicación. No deberían tener que revisar el mismo paso varias veces para recordar qué se debe hacer.
Ejemplo de Pasos (Correcto)
Ingresa cualquier consulta en la barra de búsqueda en la esquina superior derecha (por ejemplo, "San Francisco")
Haz clic en el botón "Buscar ahora"
Desplázate hacia abajo y haz clic en "Ordenar por"
Selecciona la opción "Ordenar por precio: de mayor a menor"
Ejemplo de Pasos (Incorrecto)
Observa
Buscar > Ordenar > De mayor a menor
Observa
Lo que está mal en los ejemplos anteriores: El primer paso debe indicar cómo acceder a la URL de la página de inicio, no solo la URL en sí misma. El tercer paso no está suficientemente detallado y contiene demasiadas acciones en un solo paso. El segundo y cuarto paso son redundantes y no son necesarios para entender el error.
Resultado Actual
El resultado actual es uno de los campos más importantes de un reporte de errores porque aquí se explica cuál es el problema y todos los detalles adicionales que son necesarios para entender el error.
Lo que realmente sucede después de seguir tu guía paso a paso debe describirse con el mayor detalle posible. Intenta ser muy preciso y no seas demasiado general, por ejemplo, al decir que los productos siguen mayormente en el mismo orden después de aplicar el método de clasificación X. En lugar de eso, describe ejemplos específicos de los productos que no están en el orden correcto. Agrega cualquier información en este campo que sea relevante para el error, como ejemplos, condiciones adicionales, excepciones o resultados de otros aspectos importantes si es necesario. Asegúrate simplemente de estructurar tu información para ayudar al lector a entender tu proceso de pensamiento.
Notas importantes: El resultado actual y el esperado nunca deben ser simplemente lo opuesto el uno del otro. La expectativa de lo que debería haber sucedido y lo que realmente sucedió deben diferir considerablemente.
De manera similar, el resultado actual no debe ser igual al título del reporte. Mientras que el título es un resumen del problema, el resultado actual debe ser una descripción detallada del mismo e incluir detalles adicionales como información del escenario, ejemplos y resultados obtenidos durante la ejecución de los pasos para reproducir el error.
Ejemplo de Resultado Actual
Erróneo: Se muestra un error en la página del Carrito después de hacer clic en el botón "Pagar".
Correcto: Cuando el usuario agrega un producto al carrito e intenta proceder a la página de pago, notará que no podrá hacerlo. Aparecerá un "Error 500 - Error interno del servidor - Lo siento, algo salió mal" al hacer clic en el botón "Pagar" en el menú lateral derecho.
Erróneo: El usuario no puede agregar un producto al carrito, se muestra un error.
Correcto: Después de que el usuario abrió la página de detalles de "Test IO - Producto 1", seleccionó Talla: 36 y hizo clic en el botón "Agregar al carrito", experimentará un mensaje de error "Error inesperado" en una pancarta en la esquina superior derecha de la Página de Detalles del Producto, y el producto no se agrega al carrito.
Resultado Esperado
Describe lo que esperas que ocurra después de realizar tu último paso descrito. Como siempre, los detalles son clave. Piensa en lo que debería haber sucedido si no hubieras experimentado el error, si todo funcionara correctamente.
Recuerda que el resultado esperado no es lo mismo que el resultado actual con algunas variaciones leves o palabras negativas, sino un campo diferente diseñado para que puedas explicar todo lo que debería haber sucedido después de que se completara el último paso para reproducir el error.
Resultado esperado ejemplar
Erróneo: El usuario puede proceder al pago.
Correcto: Después de agregar algunos productos al carrito y hacer clic en el botón "Pagar", el usuario debería ser redirigido correctamente a la página de pago, donde debería poder agregar información de envío y pago, y realizar un pedido.
Erróneo: El producto debería agregarse correctamente al carrito.
Correcto: Al seleccionar Talla: 36 para el "Test IO - Producto 1" y hacer clic en el botón "Agregar al carrito", el producto debería agregarse correctamente al carrito. El usuario no debería encontrar ningún error en este proceso.
Archivos adjuntos
Para aprender qué tipo de archivo se debe adjuntar para tu error y qué reglas se aplican, visita el siguiente artículo: Requisitos para los archivos adjuntos en los reportes de errores.
Entorno utilizado
Es importante para nosotros y nuestros clientes saber qué dispositivo utilizaste cuando experimentaste el error. Al probar un sitio web, haz clic en el icono del navegador junto al dispositivo que utilizaste. Al probar una aplicación móvil, selecciona el dispositivo que utilizaste para la prueba y en el que tienes instalada la aplicación.
Solo puedes utilizar los dispositivos para la prueba que están enumerados en esta sección. Además, debes seleccionar solo un dispositivo o navegador cuando reporte el error y cargar solo archivos adjuntos para ese dispositivo. Si puedes reproducir el error en otros dispositivos o navegadores, menciona esto en tu Resultado Actual.
Seleccionar el entorno correcto donde ocurre el error es una acción obligatoria. Cuando envíes tu reporte, asegúrate de seleccionar el entorno correcto. Si seleccionas accidentalmente el entorno incorrecto, puedes corregirlo después de enviarlo. Puedes corregir esta selección cambiando tu elección de entorno antes de que el líder del equipo revise el reporte de error. Si el reporte contiene el entorno incorrecto, el líder del equipo lo rechazará durante la revisión.
¿Te gustaría probar con un dispositivo que no está en la lista de dispositivos disponibles en tu perfil? Simplemente envíanos una solicitud a través del chat de soporte y agregaremos tu dispositivo a tu lista, siempre que sea relevante para nuestros clientes.
Nota: Cuando eliminas el dispositivo para el que te invitaron de tu lista de dispositivos en tu perfil de probador, ya no puedes enviar reportes en esta prueba. La sección del entorno en el formulario de errores estará vacía y no se podrá enviar el reporte. ¡Eliminar un dispositivo en tu perfil no se puede revertir después de aceptar la invitación a una prueba!
Corrige tu reporte
Después de enviar tu reporte, aún puedes editar todos los campos excepto el tipo de error seleccionado. Siempre envía reportes de errores completos que estén listos para ser revisados y solo usa la opción de edición en caso de haber cometido un pequeño error tipográfico o si deseas reformular tus palabras para mejorar la calidad del reporte.
Recuerda que no se permiten reportes de incompletos ("placeholders"), así que no envíes reportes incompletos para editarlos más tarde.
Si tu error solo ocurre con una entrada específica, utiliza términos que usarían los usuarios reales y evita ingresar palabras clave al azar al crear el reporte de error o los archivos adjuntos. Un mal ejemplo sería usar un nombre de usuario al crear una cuenta en la interfaz del cliente, como "asdsdfkg_lajsdh", ya que esto hace que tu reporte luzca poco profesional.