¿Qué hace Generador de README?
Crea archivos README.md pulidos y completos para repositorios de código internos/empresariales analizando el código base real y haciendo preguntas aclaratorias específicas.
Por qué existe este skill
Un buen README es la puerta de entrada a un código base. En proyectos internos especialmente, un README faltante o superficial significa que cada nuevo miembro del equipo pierde horas averiguando qué hace un proyecto, cómo ejecutarlo y por dónde empezar. Este skill automatiza el trabajo pesado: lee el código, infiere lo que puede, pregunta sobre lo que no puede y produce un README que hace que los desarrolladores sean productivos rápidamente.
Flujo de trabajo
Paso 1: Analizar el código base
Antes de preguntar al usuario, ejecuta un análisis estructurado en cuatro fases para recopilar la mayor cantidad de contexto posible. Esto reduce la carga sobre el usuario: solo debería llenar vacíos, no describir cosas que ya puedes ver.
Etiqueta cada hecho con un nivel de confianza: [confirmado] (leído de la fuente), [inferido-alto] (evidencia fuerte), [inferido-bajo] (evidencia parcial) o [desconocido]. Los hallazgos de baja confianza y desconocidos se convierten en preguntas aclaratorias en el Paso 2.
Consulta references/analysis-phases.md para acciones de herramientas detalladas, patrones grep, listas de verificación de extracción y plantillas de registro.
Fase 1 — Escaneo de metadatos del proyecto: Busca archivos de gestor de paquetes (pyproject.toml, package.json, etc.), plantillas de entorno, Dockerfiles, configuraciones CI/CD y archivos de cadena de herramientas. Lee cada uno y extrae: nombre/versión del proyecto, lenguaje, dependencias (categorizadas con propósitos), scripts/comandos, variables de entorno (requeridas vs opcionales), etapas CI, licencia.
Fase 2 — Escaneo de arquitectura: Busca todos los archivos fuente para mapear la estructura de directorios. Busca marcadores de punto de entrada (if __name__, main(), etc.) y lee cada punto de entrada. Construye el gráfico de importaciones buscando declaraciones de importación en todos los archivos fuente — clasifica módulos como centrales (alto grado de entrada), hoja u orquestador. Identifica el patrón de arquitectura (tubería, MVC, capas, microservicios, basado en eventos, CLI, monolito) usando la lista de verificación de indicadores. Busca patrones de carga de configuración para encontrar archivos de configuración en tiempo de ejecución.
Fase 3 — Análisis profundo de módulos: Lee cada archivo fuente significativo (priorizado: central → punto de entrada → más grande → resto). Para cada uno, extrae: propósito (una oración), exportaciones clave con firmas, notas de diseño (decisiones no obvias, casos límite, convenciones) y dependencias internas. Rastrea el flujo de trabajo principal de principio a fin a través del gráfico de importaciones, etiquetando qué tipos de datos fluyen entre módulos. Para bases de código con 8+ archivos fuente, despacha subagentes paralelos agrupados por clúster de dependencias.
Fase 4 — Escaneo de infraestructura de soporte: Busca archivos de prueba y fixtures. Lee las primeras 30-50 líneas de cada archivo de prueba para construir un mapeo de prueba a módulo. Busca clases de excepción personalizadas y declaraciones raise para mapear la jerarquía de errores. Escanea plantillas, assets y documentos existentes. Extrae escenarios de error comunes para la tabla de Solución de problemas.
Paso 2: Hacer preguntas aclaratorias
Después del análisis, pregunta al usuario sobre cosas que no pudiste inferir con confianza. Mantén el enfoque — no preguntes sobre cosas que ya sabes. Las brechas comunes incluyen:
- Propósito del proyecto: ¿Qué problema resuelve? ¿Quién lo usa? (si no es obvio desde el código)
- Contratiempos de configuración: ¿Hay requisitos previos no obvios, requisitos de VPN, registros de paquetes internos o pasos de configuración de base de datos?
- Flujos de trabajo clave: ¿Cuáles son las 2-3 cosas que un desarrollador hace más a menudo con este proyecto?
- Despliegue: ¿Cómo/dónde se despliega esto? (si no está claro desde las configuraciones CI/CD)
- Convenciones del equipo: ¿Hay convenciones de nomenclatura, estrategias de ramificación o patrones que mencionar?
- Información de contacto: ¿Quién es dueño/mantiene este proyecto? (nombre + correo electrónico para la sección de Contacto)
Presenta tus preguntas de forma concisa. Si el código base es sencillo y confías en tu análisis, es posible que solo necesites 1-2 preguntas, o incluso ninguna. Usa tu criterio.
Paso 3: Generar el README.md
Escribe el README usando la estructura y pautas a continuación.
Estructura del README
Usa esto como tu plantilla. Incluye todas las secciones, pero escala la profundidad para que coincida con la complejidad del proyecto. Usa reglas horizontales --- entre cada sección principal para dar espacio visual.
# Nombre del Proyecto
  
Descripción breve y clara. Usa **negrita** para resaltar la tecnología clave o el tipo de producto.
---
## Tabla de Contenidos
Genera una tabla de contenidos exhaustiva y anidada que incluya TODOS los encabezados ## y ###. Sangra las subsecciones debajo de sus padres para que los lectores puedan ver la estructura completa de un vistazo. Esto es especialmente importante para README largos: la TOC sirve tanto como herramienta de navegación como un esquema de todo el documento.
Ejemplo de la profundidad esperada:
- [Descripción General](#descripción-general)
- [Arquitectura](#arquitectura)
- [Arquitectura de Alto Nivel](#arquitectura-de-alto-nivel)
- [Estructura de Carpetas](#estructura-de-carpetas)
- [Gráfico de Dependencias de Módulos](#gráfico-de-dependencias-de-módulos)
- [Primeros Pasos](#primeros-pasos)
- [Requisitos Previos](#requisitos-previos)
- [Instalación](#instalación)
- [Ejecutar Pruebas](#ejecutar-pruebas)
- [Variables de Entorno](#variables-de-entorno)
- [Uso](#uso)
- [Ejemplo: Caso de Uso Principal](#ejemplo-caso-de-uso-principal)
- [Ejemplo: Caso de Uso Secundario](#ejemplo-caso-de-uso-secundario)
- [Referencia de API](#referencia-de-api)
- [Recurso A](#recurso-a)
- [Recurso B](#recurso-b)
- [Solución de Problemas](#solución-de-problemas)
- [Contacto](#contacto)
- [Licencia](#licencia)
Cada encabezado ### en el documento debe aparecer como una entrada con sangría debajo de su encabezado ## padre. No omitas subsecciones; el objetivo de una TOC exhaustiva es que los lectores puedan saltar directamente a cualquier parte del documento.
---
## Descripción General
Expande la descripción. Usa negrita para términos clave. Usa listas numeradas para procesos de varios pasos.
---
## Arquitectura
### Arquitectura de Alto Nivel
```mermaid
graph TD
...
```
Estructura de Carpetas
raiz-del-proyecto/
├── src/ # Breve anotación
├── tests/ # Breve anotación
└── ...
[Flujo de Datos / Tubería / Dependencias de Módulos — diagramas adicionales]
...
Primeros Pasos
Requisitos Previos
Instalación
Ejecutar Pruebas
Variables de Entorno
| Variable | Requerida | Descripción |
|---|---|---|
DB_URL | Sí | Cadena de conexión PostgreSQL |
Uso
Ejemplos de código real para las 2-3 operaciones más comunes.
Referencia de API
Solución de Problemas
| Síntoma | Causa Probable | Solución |
|---|---|---|
mensaje de error | Qué está mal | Cómo solucionarlo |
Contacto
Para preguntas o soporte, contacta a:
- Nombre — [email protected]
Licencia
Solo para Uso Interno – Nombre de la Empresa Software propietario. © [Año] [Empresa]. Todos los derechos reservados.
## Insignias Shields.io
Incluye siempre insignias shields.io justo después del encabezado `# Título` (3-6 insignias que cubran lenguaje, framework, biblioteca clave, gestor de paquetes, base de datos, infraestructura). Consulta [references/badge-reference.md](references/badge-reference.md) para formato, ejemplos y sugerencias de color por categoría.
## Pautas para Diagramas Mermaid
Usa diagramas Mermaid generosamente: hacen que la arquitectura, los flujos de datos y los procesos sean inmediatamente comprensibles. Un README típico debe tener **3-6 diagramas**; proyectos complejos (tuberías de datos, sistemas multiservicio) podrían tener **6-10+**. Consulta [references/mermaid-guidelines.md](references/mermaid-guidelines.md) para saber cuándo usar cada tipo de diagrama, mejores prácticas y recomendaciones específicas por tipo de proyecto.
## Pautas de Escritura
- **Sé específico en lugar de genérico.** "Ejecuta `npm run dev`" es mejor que "Inicia el servidor de desarrollo." Incluye comandos reales, rutas de archivo y nombres de variables.
- **Escribe para el nuevo miembro del equipo.** Asume habilidades generales de ingeniería pero cero contexto del proyecto.
- **Usa negrita para términos clave y nombres de productos** en la primera mención y en las descripciones generales. Esto ayuda a los lectores a escanear.
- **Usa listas numeradas para procesos secuenciales.** "1. **Extrae** datos de X. 2. **Transforma** los datos. 3. **Carga** en Y." — pon el verbo en negrita.
- **Los ejemplos de código deben ser ejecutables.** Copia del código base real cuando sea posible.
- **Las tablas de variables de entorno son obligatorias.** Enumera cada una.
- **Solución de problemas en formato de tabla** (Síntoma | Causa Probable | Solución) — escaneable y consistente.
- **Las anotaciones de estructura de carpetas deben ser breves.** Una frase corta por directorio.
- **Incluye siempre una sección de Contacto.** Pregunta al usuario quién mantiene el proyecto. Formato: `**Nombre** — [email protected]`.
- **Usa reglas horizontales `---`** entre todas las secciones principales para estructura visual.
## Salida
Guarda el README como `README.md` en la raíz del repositorio (o en el directorio de trabajo actual si no se puede identificar una raíz de repositorio). Si ya existe un README.md, confirma con el usuario antes de sobrescribir; es posible que quiera conservar partes del mismo.