686f6c61/readme-review
skills/documentacion/readme-review/SKILL.md
Auditar y mejorar el README del proyecto: estructura, completitud y claridad. Activar ante: mejorar README, auditar README, primera impresion del proyecto, readme incompleto
$ install --global
skillsauthnpx skillsauth add 686f6c61/alfred-dev readme-reviewInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
Security Scan Results
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
3
Scanners Passed
9
Scanners in report
Clean
TrivyContainer and dependency vulnerability scanner
95%
Clean
SemgrepStatic code analysis for vulnerabilities
95%
Clean
mcp-scan (Snyk)Model Context Protocol security validation
95%
Error
VirusTotalMulti-engine malware detection
70%
Skipped
Snyk (dep)Open source security scanning
50%
Skipped
Socket.devSupply chain security analysis
50%
Skipped
CrowdStrikeAdvanced threat intelligence
50%
Skipped
OSV-ScannerOpen Source Vulnerability database check
50%
Skipped
OWASP Dep-Check
50%
Last scanned: Mar 25, 2026, 8:30 PM42.3s1 file scanned
SKILL.md
- name:
- readme-review
- description:
- Auditar y mejorar el README del proyecto: estructura, completitud y claridad. Activar ante: mejorar README, auditar README, primera impresion del proyecto, readme incompleto
Revisión del README
Resumen
Este skill audita el README del proyecto de forma sistemática. El README es la primera impresión del proyecto: si está vacío, desactualizado o confuso, el visitante se va. Un buen README responde en menos de 30 segundos a las preguntas: qué es esto, para qué sirve y cómo lo uso.
Proceso
Paso 1: leer el README actual
- Si no existe, crearlo desde cero con la estructura base.
- Si existe, leerlo completo y evaluar cada sección.
Paso 2: verificar secciones obligatorias
Comprobar que el README tiene, como mínimo:
- Título y descripción: qué es el proyecto, en una frase.
- Instalación: cómo instalarlo paso a paso. Probarlo desde cero.
- Uso rápido: ejemplo mínimo de cómo usarlo (código o comando).
- Requisitos: dependencias, versiones mínimas, sistema operativo.
- Licencia: qué licencia tiene y dónde leerla.
Paso 3: verificar secciones recomendadas
Evaluar si faltan y si serían útiles:
- Contribución: cómo contribuir al proyecto.
- Configuración: variables de entorno, ficheros de configuración.
- Tests: cómo ejecutar los tests.
- Arquitectura: enlace a documentación detallada si existe.
- Changelog: enlace al changelog o sección con cambios recientes.
Paso 4: revisar calidad del contenido
- Actualizado: la información refleja el estado actual del código?
- Completo: un desarrollador nuevo puede arrancar solo con el README?
- Claro: se entiende sin conocimiento previo del proyecto?
- Ortografía: tildes, concordancia, sin erratas.
- Formateo: markdown correcto, bloques de código con lenguaje, enlaces que funcionen.
Paso 5: entregar informe y correcciones
- Lista de hallazgos con severidad (falta sección crítica, texto desactualizado, error menor).
- Correcciones directas para los problemas encontrados.
- Sugerencias de mejora para las secciones que existen pero podrían ser mejores.
Qué NO hacer
- No añadir badges innecesarios solo por estética.
- No escribir párrafos largos en el README. Preferir listas y ejemplos de código.
- No duplicar documentación extensa: el README enlaza a docs/, no lo reemplaza.
Related Skills
686f6c61/style-direction
testing
VerifiedTrustedCommunity
Abrir y operar el companion visual de Selina para elegir una direccion de estilo en proyectos con interfaz. Skill manual: levanta un servidor local y escribe artefactos visuales.
48SKILL.mdUpdated May 2, 2026
686f6c61/repo-setup
tools
VerifiedTrustedCommunity
Configurar un repositorio GitHub con branch protection, templates y labels
48SKILL.mdUpdated Mar 25, 2026
686f6c61/release
tools
VerifiedTrustedCommunity
Crear releases con versionado semantico, notas y artefactos
48SKILL.mdUpdated Mar 25, 2026
686f6c61/pr-workflow
testing
VerifiedTrustedCommunity
Crear pull requests completas con descripcion, labels y reviewers
48SKILL.mdUpdated Mar 25, 2026