Qué hace

La skill readme-gen automatiza la creación de documentación README profesional y de alta calidad mediante un análisis exhaustivo de tu base de código. En lugar de escribir manualmente las estructuras de carpetas o buscar versiones de dependencias, esta skill lee los manifiestos de tu proyecto (como package.json, pyproject.toml o cargo.toml) y los archivos fuente para construir un documento técnico estructurado y preciso.

Cómo funciona

La skill sigue un proceso de descubrimiento en múltiples pasos para garantizar la precisión:

• Extracción de metadatos: Identifica el nombre del proyecto, la versión y la licencia a partir de los manifiestos del sistema.
• Detección de stack: Utiliza patrones glob para identificar lenguajes (TS, Python, Go, Rust) y frameworks (Next.js, Vite, Docker).
• Mapeo de API: Lee los puntos de entrada para documentar automáticamente las funciones y clases exportadas.
• Descubrimiento de entorno: Detecta las variables de entorno requeridas mediante fragmentos .env y documentación.

¿Por qué usar esta skill?

Escribir documentación suele ser lo último que los desarrolladores quieren hacer. Crear un README de alto nivel de forma manual es propenso a quedar desactualizado. Como esta skill analiza el código real y la estructura de archivos, refleja el estado verdadero de tu proyecto. Es significativamente más rápida que el prompting manual, ya que sabe exactamente qué archivos auditar y cómo formatear los badges de shields.io y las tablas de scripts para darle al repositorio un aspecto estándar y profesional.