← Todas las notas

Método / Guía de documentación

Documentar un diagnóstico sin perder el contexto

Una guía de registro para separar síntomas, hipótesis y comprobaciones.

Un registro que permita volver al problema

Esta nota propone un método de documentación; no relata una intervención realizada.

Antes de modificar una configuración, conviene anotar el comportamiento esperado, el observado y las condiciones de la prueba. Una captura aislada rara vez explica todo el contexto.

Separar observación e interpretación

  • Síntoma: lo que puede observarse o reproducirse.
  • Hipótesis: una posible explicación que todavía necesita prueba.
  • Comprobación: un procedimiento delimitado y su resultado.
  • Conclusión: lo que la evidencia permite afirmar, con sus límites.

Publicar solo lo necesario

Una versión pública debe conservar el razonamiento sin revelar usuarios, direcciones, rutas internas o credenciales. Si se reemplazan valores por ejemplos, hay que indicarlo expresamente.

Cerrar con una pregunta verificable

¿Qué prueba permitiría a otra persona comprobar la conclusión? Si falta esa respuesta, el registro necesita más evidencia antes de presentar una resolución.