Mantiene tu documentación sincronizada con tu código
La documentación desactualizada es peor que ninguna documentación — engaña activamente. El Revisor de Documentación detecta cuándo los cambios de código hacen que la documentación sea incorrecta.
Los bugs silenciosos — documentación que miente
Documentación que describe comportamiento antiguo — el tipo más peligroso de documentación
Funciones públicas y endpoints sin documentación adecuada
Comentarios que dicen una cosa mientras el código hace otra — peor que ningún comentario
Docs de API que no coinciden con los endpoints reales — causa #1 de fallos de integración
Documentación de Storybook y componentes que no refleja cambios de props
Tipos TypeDoc/JSDoc que mienten sobre interfaces y firmas reales
Cada lugar donde la documentación y el código pueden desincronizarse
Documentación de funciones y métodos
Resúmenes de proyectos y paquetes
Explicaciones de código y TODOs
Descripciones y ejemplos de endpoints
Comentarios de interfaces y tipos
Precisión del historial de versiones
Como la deuda técnica, la deuda de documentación se acumula silenciosamente. Damos a tu base de código una Puntuación de Salud de Documentación — un solo número que muestra cuánto se han desviado tus docs de la realidad.
README.md
Última actualización hace 45 días, código cambió 12 veces
src/api/
3 endpoints sin documentar
CHANGELOG.md
Entradas faltantes para v2.3.0, v2.3.1
src/utils/
8 funciones exportadas sin JSDoc
No solo verificaciones genéricas de docs — entendemos los patrones de documentación de tu framework
Para la función processPayment(amount, currency, options):
/**
* Procesa una transacción de pago
* @param amount - Monto en centavos (entero)
* @param currency - Código de moneda ISO 4217
* @param options - Opciones de procesamiento
* @param options.idempotencyKey - Clave única
* @param options.metadata - Pares clave-valor personalizados
* @returns Promise<PaymentResult>
* @throws PaymentError si rechazado
*/Cuando encontramos documentación faltante o desactualizada, no solo lo reportamos —generamos la corrección. La IA analiza tus firmas de funciones, tipos de retorno y patrones de uso para sugerir documentación precisa.
Crea documentación desde firmas de funciones y tipos
Actualiza documentación desactualizada para coincidir con el código actual
Ejemplos reales de documentación que necesitaba actualización
/**
* Fetches user by ID
* @param id - User ID
* @param includeDeleted - Include soft-deleted users
*/
async function getUser(id: string, options?: GetUserOptions) {
// includeDeleted moved to options object 3 months ago
// but JSDoc still shows old signature
}JSDoc muestra la firma antigua con parámetro posicional
/**
* Fetches user by ID
* @param id - User ID
* @param options - Query options
* @param options.includeDeleted - Include soft-deleted users
* @param options.fields - Fields to select
*/
async function getUser(id: string, options?: GetUserOptions) {
// Documentation matches actual signature
}Actualizar para coincidir con el patrón actual de objeto de opciones
// Retry 3 times with exponential backoff
async function fetchWithRetry(url: string) {
const MAX_RETRIES = 5 // Changed from 3
const response = await fetch(url)
// Actually no retry logic implemented anymore
return response
}El comentario describe lógica de reintentos que no existe
// Simple fetch wrapper, no retry logic
// For retries, use fetchWithRetry from @/lib/http
async function simpleFetch(url: string) {
const response = await fetch(url)
return response
}El comentario refleja el comportamiento real
## Installation
```bash
npm install
npm run setup # This script was removed
```
## Environment Variables
- `DATABASE_URL` - PostgreSQL connection
- `REDIS_URL` - Redis connection # We switched to in-memory cache
El README hace referencia a un script eliminado y configuración antigua de Redis
## Installation
```bash
npm install
```
## Environment Variables
- `DATABASE_URL` - PostgreSQL connection string
- `CACHE_TTL` - Cache duration in seconds (default: 3600)
La documentación refleja el proceso de configuración actual
El Revisor de Documentación no solo verifica si existe la documentación — verifica que coincida con lo que el código realmente hace. Cuando cambias la firma de una función, marca el JSDoc.
Compara lo que dice la documentación vs lo que hace el código
Detecta cuándo los cambios de código invalidan la documentación cercana
Proporciona texto específico para corregir la documentación
Comparar Código y Docs
Verifica si la documentación coincide con la implementación real
Detectar Cambios
Identifica cuándo los cambios de código invalidan la documentación existente
Marcar Discrepancias
Reporta documentación que podría engañar a los desarrolladores
Sugerir Actualizaciones
Proporciona texto específico para actualizar la documentación
La mala documentación cuesta más que ninguna documentación
La documentación precisa significa que los desarrolladores no pierden horas siguiendo pistas falsas
Los nuevos desarrolladores pueden confiar en lo que leen en lugar de adivinar
Los usuarios pueden confiar en la documentación de tu API sin prueba y error
Cada cambio de código es una oportunidad para que la documentación se desvíe.
El Revisor de Documentación lo detecta cada vez.
Estos problemas pasan desapercibidos todos los días — hasta ahora
de archivos README están desactualizados en 6 meses
de comentarios JSDoc no coinciden con firmas de funciones
tiempo promedio perdido depurando por docs incorrectos
de docs de API les falta al menos un campo requerido
Deja que el Revisor de Documentación detecte la desviación antes de que engañe. Gratis durante 14 días, sin tarjeta de crédito requerida.