Doctective
Doctective · Programación
Doctective es una herramienta de documentación con IA que mantiene tu README y tu documentación interna sincronizados con el código, y trata la documentación automatizada como algo que se ejecuta en cada commit y no como un proyecto que agendes una vez por trimestre. Se conecta a GitHub, lee cada pull request y determina qué documentación acaba de quedar desactualizada por tu cambio. En lugar de atosigarte con una advertencia, abre un PR complementario con correcciones sugeridas por IA que puedes revisar y fusionar. Ese análisis de pull requests es justo lo que casi ningún equipo saca tiempo para hacer a mano. La propuesta es sencilla: lo instalas una vez, y el mantenimiento de la documentación deja de ser esa tarea que olvidas hasta que se queja alguien nuevo.
Acerca de Doctective
Qué es Doctective
Doctective es una herramienta para desarrolladores construida alrededor de un problema terco: el código cambia todo el tiempo y la documentación no. Cuando alguien renombra una función, cambia una bandera de configuración o reescribe un endpoint, los documentos que describen ese comportamiento quedan obsoletos sin avisar. Nadie lo nota hasta que le cuesta a alguien una tarde entera.
Doctective vigila esa deriva. Indexa tu base de código y tu documentación, y luego traza vínculos semánticos entre ambas. Cuando una pull request toca código al que hace referencia un documento, la herramienta marca las páginas afectadas y redacta un PR complementario con las actualizaciones sugeridas. Tú sigues aprobando todo, pero la primera pasada ya está hecha.
Conviene ser claro con el alcance. Doctective lee código fuente y documentación, así que vive en flujos de trabajo de desarrollo y no en sitios de marketing o wikis de clientes. Si tu equipo no usa GitHub, seguramente no eres su público.
¿Eso significa que solo ayuda a quien tiene documentación desordenada? No exactamente, porque incluso los equipos disciplinados dejan que un solo refactor deje tres páginas describiendo el comportamiento viejo.
Cómo empezar
- Entra en doctective.app y haz clic en Get Started, lo que inicia una conexión con GitHub.
- Instala la GitHub App de Doctective y dale acceso a los repositorios que quieras vigilar.
- Elige qué repos indexar. Doctective empieza a construir vínculos semánticos entre tu código y tu documentación de inmediato.
- Abre una pull request como siempre. Cuando toque código documentado, Doctective comenta en el PR y abre un PR complementario con ediciones sugeridas para los documentos.
- Revisa los cambios sugeridos, ajusta la redacción si hace falta y fusiona lo que quieras conservar.
Información del producto
Un vistazo rápido a los precios, las plataformas compatibles y el rendimiento de Doctective.
Ideal para
Los usuarios, tareas y casos de uso en los que esta herramienta encaja mejor.
Usuarios
- Desarrolladores de backend y plataforma
- Equipos de ingeniería de startups
- Mantenedores de código abierto
- Líderes técnicos y revisores
Tareas
- Detectar documentación obsoleta después de un cambio de código
- Redactar actualizaciones de documentación
- Auditar la cobertura de la documentación
- Preparar revisiones de incorporación
Casos de uso
- Publicar un cambio incompatible en una API
- Renombrar o refactorizar una función central
- Limpieza de documentación al final del sprint
- Adoptar la documentación como código
Funciones clave
Detección del impacto de una PR
Doctective analiza las pull requests para determinar qué documentación afecta un cambio de código. Traza vínculos semánticos entre tus archivos fuente y tus documentos, así que cuando cambia una función o una bandera, sabe qué páginas dependen de ello. Obtienes una lista clara de los documentos afectados en vez de adivinar, y la revisión ocurre mientras el razonamiento detrás del cambio sigue fresco en la cabeza de todos.
Generación de PR complementario
En lugar de solo advertirte, Doctective abre una segunda pull request con actualizaciones sugeridas para la documentación. Los cambios se quedan en tu flujo normal de revisión, lo que significa que puedes editarlos, rechazarlos o fusionarlos como cualquier otro diff, y todo el intercambio se mantiene dentro de la pull request donde ya vive el cambio original. Elimina el problema de la página en blanco del mantenimiento de documentos, que suele ser la verdadera razón por la que el trabajo de documentación se estanca.
Actualizaciones de documentos con IA
Las ediciones sugeridas vienen de un LLM que lee el cambio de código y la documentación que lo rodea como contexto. Redacta una redacción nueva que coincide con lo que el código hace ahora. Trata el resultado como un buen primer borrador, no como una respuesta terminada. Seguirás queriendo un ojo humano en todo lo que vea el usuario.
Soporte multilingüe
Doctective maneja TypeScript, JavaScript, Python, Java, Go, Rust, SQL y más. Del lado de la documentación lee Markdown, MDX, JSDoc y docstrings, así que funciona en la mayoría de los stacks modernos sin migrar de formato.
Integración con GitHub
La configuración pasa por la GitHub App de Doctective. La autorizas, eliges los repositorios que quieres vigilar y empieza a indexar. No hay pipeline de CI que cablear a mano, lo que mantiene ligera la adopción para los equipos que no quieren otro archivo de configuración.
Ventajas y desventajas
Ventajas
- Atrapa la documentación obsoleta dentro de la pull request, mientras el cambio sigue fresco en contexto.
- Abre un PR complementario con ediciones sugeridas, así revisas un borrador en vez de escribir desde cero.
- Soporta muchos lenguajes y formatos de documentación, incluidos Markdown, MDX, JSDoc y docstrings.
- Encaja en un flujo de revisión de GitHub ya existente, así que hay poco que aprender.
- Indexa código y documentación juntos, lo que también saca a la luz huecos donde falta documentación por completo.
Desventajas
- No hay plan gratuito. Todos los niveles son de pago, desde $9.99/mo, así que no puedes probarlo en un proyecto de hobby sin gastar.
- Es solo para GitHub. Los equipos en GitLab, Bitbucket o con una instalación propia no pueden usarlo.
- Las ediciones sugeridas por IA aún necesitan revisión. En cambios de comportamiento sutiles, un párrafo de documento generado puede leerse con seguridad y estar levemente equivocado.
- Los límites de repositorios y puestos muerden en equipos grandes. El plan Team tope en 10 repos y 10 puestos, y el precio de Enterprise no se publica.
Preguntas frecuentes
Vigila tus pull requests de GitHub, detecta cuándo un cambio de código deja obsoleta la documentación existente y abre un PR complementario con actualizaciones sugeridas para los documentos. Tú revisas y fusionas las que quieras.
Contenido relacionado
Explora herramientas, habilidades y artículos relacionados con Doctective.
Alternativas a Doctective
Base Code
Base44 (Wix) · Programación · ProductividadBase Code es un entorno de desarrollo en la nube compartido de Base44. El equipo describe cambios sobre un repositorio de GitHub en el chat, los ve en una vista previa y los envía como pull requests.
Google EmbeddingGemma 2
Google DeepMind · Escritura · Imagen · ProgramaciónGoogle EmbeddingGemma 2 es un modelo abierto de 740 millones de parámetros que convierte texto, código, imágenes, audio y fotogramas de vídeo en vectores de un mismo espacio de 768 dimensiones, y funciona en móviles y portátiles.
GitGlow
GitGlow · Programación · ProductividadGitGlow es un cliente Git de escritorio que reúne tu código y los cambios de tus agentes de IA en una sola revisión, para que sepas qué va a salir de tu máquina antes de publicarlo.