MDPress

Desarrollo

Plantilla de reporte de errores en Markdown

Un error se corrige más rápido cuando otra persona puede reproducirlo al primer intento. Esta plantilla ordena los datos de forma fija: un resumen de una frase, el entorno, pasos numerados, lo que esperabas, lo que ocurrió y la evidencia. Complétala y exporta un PDF.

Abrir esta plantilla en el editor
Categoría
Desarrollo
Estilo predeterminado
Técnico

Cuándo usarla

Úsala cuando un problema tenga que salir de tu sistema de seguimiento: hacia un proveedor, un cliente, un centro de soporte o una persona responsable que quiere un registro por escrito. Quien lo lee suele ser un desarrollador o probador que no estaba presente cuando ocurrió, así que cada sección responde una pregunta que de otro modo tendría que hacerte.

Qué incluye

  • Un encabezado con campos para completar el proyecto, tu nombre y la fecha, además de una línea de gravedad.
  • Una tabla de entorno para la versión de la app, el navegador y el sistema operativo, y el tipo de dispositivo.
  • Pasos numerados para reproducir el error, comportamiento esperado y actual, evidencia y una sección de solución temporal.

Consejos para un mejor documento

  • Copia el texto exacto del error en lugar de describirlo. Pega los fragmentos de registro en un bloque de código para que conserven su espaciado, y elimina antes las credenciales y los datos personales.
  • Reduce los pasos al mínimo que aún provoca el problema. La plantilla se abre en el estilo Técnico, que mantiene las tablas y el código fáciles de leer.

Vista previa de la plantilla

Reporte de error: Proyecto o tema

Reportado por: Tu nombre · Fecha: Fecha
Gravedad: Baja / Media / Alta

Resumen

Describe el problema en una frase, incluida la acción que lo provoca.

Entorno

DetalleValor
Versión de la appAñadir versión
Navegador / SOAñadir detalles
DispositivoEscritorio / Móvil

Pasos para reproducir

  1. Abre la página correspondiente.
  2. Ingresa los datos mínimos necesarios.
  3. Realiza la acción.

Comportamiento esperado

Describe qué debería suceder.

Comportamiento actual

Describe qué sucede, incluido el texto exacto del error.

Evidencia

Añade una captura de pantalla o un extracto de registro depurado. Elimina credenciales y datos personales.

Solución temporal

Registra una solución temporal si existe.

Los campos por completar, como tu nombre y la fecha, se sustituyen cuando abres la plantilla en el editor.