Advertising:
Prompt proyecto existente
Actúa como un Arquitecto de Software Senior especializado en ingeniería inversa y configuración de entornos para Claude Code. Tu objetivo es analizar en profundidad este repositorio —que hasta ahora no ha estado bajo tu control— para comprenderlo por completo y generar la base de memoria y documentación necesaria para que tú y futuros agentes podáis trabajar sobre él con precisión, sin repetir contexto y sin contradecir reglas, patrones o funcionalidades ya existentes.
Sigue estrictamente estas fases y reglas.
REGLAS DE ORO (OBLIGATORIAS)
- No modifiques código funcional: En esta tarea NO debes alterar lógica de negocio, configuraciones de producción ni código fuente ejecutable. Solo crearás o actualizarás ficheros de documentación y memoria.
- El código es la fuente de verdad: Si la documentación preexistente contradice al código actual, prevalece el código. Registra explícitamente cualquier discrepancia encontrada.
- Cero suposiciones silenciosas: Si algo no puede deducirse con certeza del repositorio (reglas de negocio implícitas, integraciones externas no documentadas, etc.), márcalo explícitamente como
[POR CONFIRMAR]. - Higiene de seguridad: NUNCA copies secretos, contraseñas, tokens, claves API ni valores reales de ficheros
.enven ningún documento. Documenta únicamente los nombres de las variables y su propósito. - Optimización de contexto (Progressive Disclosure):
CLAUDE.mdse carga en cada sesión. Mantenlo conciso, denso en valor y orientado a la acción (idealmente < 200 líneas), delegando los detalles extensos a ficheros específicos dentro dedocs/y enlazándolos desdeCLAUDE.md.
FASE 1: DESCUBRIMIENTO Y ANÁLISIS PROFUNDO (SOLO LECTURA)
Antes de escribir o modificar ningún fichero, explora el repositorio de forma sistemática:
- Inventario y estructura: Mapea el árbol de directorios, identifica el stack tecnológico, gestores de dependencias, ficheros de infraestructura (Docker, CI/CD, IaC, Makefiles, scripts) y puntos de entrada (
main,index,app, CLI, etc.). - Historial reciente: Revisa el
git logreciente (últimos 20-30 commits si existe repositorio Git) para detectar áreas activas, estilo de commits y decisiones recientes. - Flujos de datos y comunicación: Traza los flujos principales de principio a fin:
- Entradas (HTTP/API, CLI, colas, webhooks, ficheros, cron, eventos).
- Procesamiento y transformaciones clave.
- Salidas y persistencia (bases de datos, APIs externas, sistemas de ficheros, notificaciones).
- Comunicación entre módulos internos.
- Componentes y variables: Identifica cómo se interrelacionan los módulos/clases/servicios, cómo fluye el estado, qué variables de entorno y ficheros de configuración controlan el comportamiento y qué dependencias críticas existen.
- Convenciones internas e invariantes: Detecta patrones de diseño, convenciones de nombres, gestión de errores, logging, estructura de tests y reglas críticas que no deben romperse (invariantes).
- Documentación preexistente: Lee cualquier
README,CHANGELOG,docs/, comentarios de arquitectura o wikis internas para integrarlos y detectar qué está vigente y qué está obsoleto.
PUNTO DE CONTROL (OBLIGATORIO)
Al terminar la Fase 1, detente y preséntame:
- Un resumen breve de lo que has entendido del proyecto.
- La lista exacta de ficheros que vas a crear o actualizar.
- Cualquier duda crítica (
[POR CONFIRMAR]) que convenga aclarar antes de escribir.
Espera mi confirmación antes de ejecutar las Fases 2 a 5.
FASE 2: MEMORIA PARA CLAUDE Y AGENTES
Crea la estructura de memoria siguiendo las mejores prácticas de Claude Code:
-
CLAUDE.md(en la raíz del proyecto):- Resumen del proyecto: Qué hace y cuál es su propósito en 3-5 líneas.
- Comandos verificados: Comandos exactos para instalar, compilar, ejecutar en local, lanzar tests, linters y desplegar (solo los que hayas verificado en el repo).
- Mapa de arquitectura: Vista rápida de directorios y responsabilidades.
- Invariantes y reglas de no-contradicción: Qué decisiones de diseño, contratos de API, formatos de datos o comportamientos NO deben alterarse sin aprobación explícita.
- Convenciones obligatorias: Reglas de estilo, naming, manejo de errores y testing que cualquier agente debe respetar.
- Índice de contexto bajo demanda: Punteros claros a los ficheros en
docs/indicando cuándo debe leerlos un agente (ej. "Leerdocs/FLUJOS.mdantes de modificar endpoints o colas"). - (Si el proyecto es un monorepo o tiene subproyectos muy independientes, evalúa crear
CLAUDE.mdlocales en subdirectorios específicos solo si aportan reglas propias).
-
Memoria detallada en
docs/(carga bajo demanda):docs/ARQUITECTURA.md: Diseño de componentes, interrelación entre módulos, gestión de estado, variables de entorno/configuración y diagramas en Mermaid (arquitectura y dependencias).docs/FLUJOS.md: Flujos de entrada, procesamiento, salida y comunicación interna/externa, incluyendo diagramas de secuencia en Mermaid para los flujos críticos y manejo de errores.docs/CONVENCIONES.md: Patrones internos detectados, estructura de código, estándares de commits/PRs, deuda técnica conocida y "trampas" (gotchas) que un agente debe evitar.
FASE 3: DOCUMENTACIÓN GENERAL (README.md)
Crea o actualiza el README.md en la raíz (si ya existe, preserva la información válida y actualiza lo obsoleto). Debe cubrir de forma clara y orientada a humanos:
- Contexto del proyecto, objetivos y alcance (qué incluye y qué queda fuera de alcance).
- Funcionalidades principales.
- Requisitos previos y dependencias.
- Instalación, configuración (tabla de variables de entorno sin valores sensibles) y puesta en marcha.
- Uso básico y ejemplos.
- Estructura general del proyecto y enlaces a la documentación detallada en
docs/.
FASE 4: DOCUMENTACIÓN PARTICULAR DE CADA FICHERO
Crea un catálogo estructurado en docs/REFERENCIA_FICHEROS.md (o una carpeta docs/ficheros/ organizada por módulo si el proyecto supera los ~30 ficheros de código relevantes) que documente cada fichero significativo del proyecto (excluyendo archivos generados, node_modules, vendor, binarios o lockfiles):
- Ruta y propósito: Qué responsabilidad única cumple el fichero.
- Entradas y salidas: Parámetros, eventos, endpoints o datos que recibe y devuelve.
- Dependencias e interrelaciones: Qué módulos/servicios importa y quién depende de él.
- Variables, constantes y configuración: Variables de entorno, flags o estado relevante que utiliza.
- Efectos secundarios y notas críticas: Escrituras en BBDD, llamadas externas, mutaciones de estado o precauciones al editarlo.
FASE 5: VERIFICACIÓN FINAL
Antes de dar la tarea por terminada:
- Verifica que todas las rutas de ficheros, símbolos y comandos citados en
CLAUDE.md,README.mdydocs/existen realmente en el repositorio. - Comprueba que no se ha filtrado ningún secreto ni credencial.
- Entrega un resumen final con:
- Ficheros creados/actualizados.
- Discrepancias detectadas entre la documentación antigua y el código real.
- Lista consolidada de puntos
[POR CONFIRMAR]para que pueda validarlos.