Reescribir el README de un proyecto tras cambiar su arquitectura

A quién le sirve. Equipos de desarrollo que han cambiado la arquitectura de un proyecto y tienen la documentación desactualizada, en un caso de programadores.

Qué hicieron

Tras un gran cambio de arquitectura, el autor le dio a Devin el repositorio y una petición paso a paso. Devin analizó el código, leyó el README antiguo y propuso un esquema de títulos. Luego esperó la orden «CONFIRMED, PROCEED». Después se le dijo que olvidara el repositorio, siguiera sus propias instrucciones de instalación como un desarrollador nuevo e informara de los huecos. Por último abrió una propuesta de cambios (pull request) desde una rama creada a partir de develop.

Cómo salió

El README tenía pasos de instalación correctos, descripciones claras de los puntos de entrada de la API y ejemplos deducidos del código. Le costó explicar el porqué del diseño y el propósito general del proyecto, que el código no contiene.

Conviene saber

El autor no da tiempos y sugiere que darle documentos internos o diagramas de arquitectura junto al código podría arreglar la falta de motivos y de propósito.

Qué necesitas

• Devin, el agente de programación, con acceso a tu repositorio
• El README antiguo y el código nuevo
• Opcional: documentos internos o diagramas de arquitectura, que aportan los motivos del diseño
• Una persona que sepa por qué se hizo el cambio y pueda escribir el propósito del proyecto

Cómo hacerlo tú, paso a paso

1. Dale a Devin acceso al repositorio e indícale desde qué rama debe trabajar.
2. Pega el prompt de la ficha: que analice el código y reescriba el README con instalación, configuración y API correctas, y con marcadores para los motivos y el propósito.
3. Pídele que antes proponga un esquema de títulos y espere tu orden de confirmación.
4. Cuando lo apruebes, que escriba el README completo.
5. Pídele una prueba: que olvide el repositorio, siga las instrucciones de instalación como un desarrollador nuevo e informe de los huecos.
6. Rellena tú los marcadores con los motivos del diseño y el propósito del proyecto.
7. Revisa las diferencias y abre la propuesta de cambios cuando estés conforme.

Mi proyecto en [ruta del repositorio] se ha rediseñado hace poco. Analiza el código y reescribe el README con pasos de instalación, configuración y detalles de la API correctos, comprobando cada comando con el código real. Deja marcadores claramente señalados para los motivos del diseño y el propósito del proyecto, que rellenaré yo. Pon el cambio en una rama nueva. Habrás terminado cuando me enseñes las diferencias, antes de abrir ninguna propuesta de cambios.

Consejos

• Dale documentos internos o diagramas de arquitectura junto con el código. Es lo que le falta para explicar el porqué.
• La prueba de seguir la instalación como alguien nuevo es lo que más valor aporta. No te la saltes.
• Deja para ti los marcadores del propósito. El código no contiene el motivo del proyecto.

Preguntas frecuentes

Fuentes

• @universe3523 en Medium ↗

En el directorio desde el 3 de octubre de 2026.