Revision de Documentacion

El Problema

La documentacion se descompone mas rapido que el codigo. Un README escrito hace 6 meses referencia pasos de instalacion para un gestor de paquetes que el equipo abandono. Los docs de API muestran parametros que fueron renombrados. Los ejemplos de codigo usan metodos deprecados. Documentacion desactualizada es peor que no tener docs — desperdicia horas cuando los desarrolladores siguen instrucciones que llevan a errores.

El Prompt

Revisa la siguiente documentacion por precision y completitud. Actua como un nuevo desarrollador que nunca ha visto este proyecto, intentando seguir cada instruccion literalmente.

TIPO DE DOCUMENTACION: [README / referencia API / guia de onboarding / docs de arquitectura]
PROYECTO: [breve descripcion de lo que hace el proyecto]

DOCUMENTACION:
[pegar contenido de la documentacion]

CODIGO FUENTE (para verificacion):
[pegar codigo relevante que los docs describen]

Evalua en estas dimensiones:

1. **Precision**
   - Los ejemplos de codigo compilan y corren sin modificaciones?
   - Las descripciones de API coinciden con las firmas reales de funciones?
   - Los pasos de instalacion son actuales?

2. **Completitud**
   - Un nuevo desarrollador puede ir de cero a proyecto corriendo solo con estos docs?
   - Los prerrequisitos estan listados (version de Node, dependencias del sistema)?
   - Los escenarios de error estan documentados ("si ves error X, haz Y")?
   - Todas las APIs publicas estan documentadas?

3. **Organizacion**
   - Hay estructura clara (quick start → guias detalladas → referencia API)?
   - Los encabezados son descriptivos y escaneables?

4. **Ejemplos de Codigo**
   - Cada metodo de API tiene al menos un ejemplo de uso?
   - Los ejemplos son copy-paste (completos, no fragmentos)?
   - Se incluyen salidas/respuestas de ejemplo?

5. **Mantenimiento**
   - Hay indicador de "ultima actualizacion"?
   - Las funcionalidades deprecadas estan claramente marcadas?

Para cada problema, proporciona:
- **Seccion**: Donde en los docs
- **Severidad**: Enganoso / Incompleto / Desactualizado / Mejora
- **Problema**: Que experimentaria un nuevo lector
- **Fix**: Texto de documentacion corregido

Ejemplo de Salida

## Revision de Documentacion: 5 problemas encontrados

### Enganoso: Comando de Instalacion Incorrecto
Seccion: Getting Started, paso 2
Doc dice: `npm install` — pero el proyecto usa pnpm (pnpm-lock.yaml presente).
Fix: `pnpm install`

### Incompleto: Falta Configuracion de Entorno
Seccion: Getting Started
Salta de "clonar el repo" a "ejecutar el dev server" — sin mencion de:
- Crear .env.local desde .env.example
- API keys requeridas
- Setup de base de datos
Fix: Agregar seccion "Configuracion de Entorno" entre clonar y ejecutar.

### Desactualizado: Ejemplo de API Usa Metodo Deprecado
Seccion: Authentication API
Doc muestra: `auth.login(email, password)` — codigo actual requiere `auth.signIn({ email, password })`

Cuando Usar

Ejecutar al incorporar nuevos miembros al equipo, despues de refactorizaciones grandes, o antes de publicar un proyecto open-source. Particularmente valioso cuando la documentacion fue escrita durante el desarrollo inicial y no se ha actualizado desde entonces.

Tips Pro

• Incluir codigo fuente — la precision de la documentacion solo puede verificarse contra la implementacion real.
• Probar el quick start literalmente — “Recorre la guia de setup paso a paso y marca cada instruccion que fallaria.”
• Generar desde codigo — “Genera comentarios JSDoc/TSDoc para todas las funciones exportadas, luego genera documentacion de referencia API.”