En este artículo aprenderás cómo documentar adecuadamente tu bug según nuestras normas y estándares. Para comprender un error, los clientes necesitan información suficiente con documentación de alta calidad. Encontrarás detalles más específicos sobre nuestras reglas en cada sección del artículo, pero aquí tienes un resumen rápido de los requisitos para los informes de bug:

Tu primer paso en el formulario de bug debe ser seleccionar la funcionalidad correcta (Feature). Si no la encuentras en la lista desplegable, vuelve a la página de resumen de la prueba, revisa todas las descripciones de funcionalidades y márcalas como leídas. Luego regresa al formulario y ya deberían aparecer todas las funcionalidades.

Tras seleccionar la funcionalidad, verás todo el formulario para reportar el bug. A continuación, te explicamos cada campo:

Debe rellenar todos los campos del formulario de errores con la información específica correcta, de acuerdo con nuestros estándares de calidad. A continuación encontrará información más detallada sobre cada campo y sus requisitos.

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.

El título del informe de error debe resumir el problema para que el lector se haga una idea general del error con solo leer el título. No debería tener que leer todo el informe para comprender cuál es el problema. El título del informe de error debe ser preciso y, al mismo tiempo, no demasiado largo. Debe contener información sobre qué es el error, dónde se produjo y cuándo se activa. Por lo tanto, cuando escribas el título de tu informe de error, recuerda siempre: ¿Qué? ¿Dónde? ¿Cuándo?

Cuando escribas el título de un error, describe lo que está sucediendo en lugar de lo que no está sucediendo. El título nunca debe indicar que algo no funciona, ya que, de lo contrario, el lector no tendrá idea de lo que realmente está sucediendo.

Los títulos deben reflejar el problema real. Si el error solo se produce en determinadas condiciones, estas deben incluirse en el título del error. Si, por ejemplo, no puedes reservar un billete cuando indicas que eres adolescente, esta es una información relevante y debe incluirse en el título.

Para crear un título descriptivo, ponte en el lugar de alguien que nunca haya probado el sitio web o la aplicación, que no pueda imaginarse en qué página estás, cómo es y qué has hecho. Lee el título desde la perspectiva de esa persona para ver si entenderías el error. Si no te haces una idea clara del error, modifica el título y repite el proceso.

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".

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.

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.

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.

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.

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.

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.

Erróneo: Error en la página del carrito tras hacer clic en Checkout.
​Correcto: Aparece el mensaje "Error 500 – Internal Server Error – Sorry something went wrong" después de intentar ir a la página de Checkout.
​
​Erróneo: El usuario no puede agregar un producto al carrito, aparece error.
​Correcto: Aparece un mensaje "Unexpected Error" en la esquina superior derecha de la página del producto y el producto no se añade al carrito.

Describe lo que esperas que suceda después de realizar el último paso descrito. Como siempre, los detalles son la clave. Piensa en lo que debería haber sucedido si no hubieras experimentado el error, es decir, si todo hubiera funcionado correctamente.

Recuerda que el resultado esperado no es el mismo que el resultado real con algunas ligeras variaciones o palabras negativas, sino un campo diferente diseñado para que puedas explicar todo lo que debería haber sucedido después de completar el último paso para reproducir el error.

Erróneo: El usuario puede proceder al Checkout.
​Correcto: El usuario debería ser redirigido correctamente a la página de Checkout, donde podría añadir el envío, la información de pago y realizar el pedido.

​Erróneo: El producto debería agregarse al carrito.
​Correcto: El producto “Batman T-Shirt” debería añadirse correctamente al carrito. El usuario no debería ver errores como “Error 505” y debería poder completar la compra.

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.

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.

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.

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.