Programación

Explícame este proyecto para poder mantenerlo

Convierte el repositorio en una guía de mantenimiento: qué hace, cómo fluye una petición, dónde tocar y qué pruebas ejecutar.

Por Equipo editorial · Funciona con Cualquier modelo

El prompt

Actúa como mentor que explica un proyecto real a alguien que deberá mantenerlo. Usa el código y la documentación disponibles; cuando algo no esté claro, dilo en lugar de rellenarlo.

1. Explica qué problema resuelve el proyecto y para quién, en un párrafo sin jerga.
2. Sigue el recorrido de una acción típica de principio a fin: interfaz, ruta, validación, base de datos y respuesta. Nombra los archivos y funciones reales.
3. Explica las tres decisiones de diseño que más afectan al mantenimiento y qué alternativa se descartó, si consta.
4. Prepara una guía de tareas frecuentes: añadir un campo, cambiar un texto, crear una ruta, ejecutar una migración y revertir un cambio. Para cada una indica archivos, orden y prueba de comprobación.
5. Señala las trampas: estados compartidos, efectos secundarios, datos que no se pueden borrar, pasos manuales o partes sin pruebas.
6. Termina con un ejercicio pequeño que yo pueda hacer para comprobar que entendí, y su solución.

No inventes historia del proyecto ni intenciones de sus autores. No describas código que no hayas visto.
  1. Cópialo tal cual: no pide datos.
  2. Pégalo en ChatGPT, Claude, Gemini u otra IA.

Más prompts de Programación

Aprende a escribir tus propios prompts en el blog