Cualquier herramienta de documentación puede alojar un artículo. Ninguna sabe cuándo un PR fusionado acaba de dejarlo mal. Ellie Docs se conecta a tu repositorio de GitHub, sigue el código del que depende realmente cada artículo y, en cuanto queda obsoleto, lo marca y redacta la corrección.
Sin tarjeta · Regístrate con Google, Microsoft, GitHub o correo
Se renombra un campo de la API. Se depreca un endpoint. Se rediseña un flujo de la interfaz. El PR se fusiona sin problemas, las pruebas pasan, y el artículo de ayuda que describe el comportamiento antiguo sigue ahí, con buena pinta pero equivocado en silencio, hasta que lo detecta un cliente o un ticket de soporte.
Cada artículo puede vincularse al código, a los endpoints o a la especificación de API que documenta, para que Ellie Docs sepa exactamente qué vigilar.
Una GitHub App vigila los PR fusionados, juzga si afectan a un artículo vinculado y lo marca, con una revisión ya redactada lista para revisar, no solo un aviso en rojo.
¿Tienes una especificación OpenAPI? Ellie mantiene la referencia sincronizada con ella y detecta los cambios incompatibles en cada versión. ¿No la tienes? La deriva de tus rutas y de los validadores de solicitudes, citando el código que respalda cada campo.
Instala la GitHub App de Ellie Docs en los repositorios de los que depende la documentación de tu producto. No conservamos una copia de tu repositorio: el código se obtiene cuando Ellie necesita leerlo y se vuelve a obtener por commit más adelante.
Trae la documentación que ya tienes mediante importación por rastreo, o empieza de cero: Ellie Docs redacta los artículos y vincula cada uno al código, a los endpoints o a la especificación de los que depende.
Cuando una fusión afecta a un artículo vinculado, Ellie lo marca y redacta la revisión. Tu equipo revisa una cola de correcciones propuestas en lugar de buscar qué se rompió.
Una GitHub App limitada a los repositorios que elijas. No conservamos una copia de tu repositorio: Ellie obtiene el árbol cuando necesita leerlo y lo vuelve a obtener por commit después. Lo que sí se conserva es el material derivado en el que se apoya un artículo: los fragmentos y las citas que respaldan cada afirmación, de modo que cualquier enunciado de tu documentación se pueda rastrear hasta el código que lo justifica. Los secretos que aparezcan en los archivos se censuran antes de almacenarse, y tu código nunca se usa para entrenar modelos.
Sí, esa es la idea: Ellie Docs aloja y muestra directamente el centro de ayuda público, incluidos los dominios propios, así que no tienes que mantener dos sistemas en paralelo.
Sí. Si apuntas Ellie Docs a una especificación, mantiene la referencia a partir de ella y la compara con cada nueva versión a medida que evoluciona tu API. Si no la tienes, Ellie deriva la especificación de tu código: los endpoints de tu router, los tipos de campo de tus validadores de solicitudes y, para todo lo que el código no dice de forma explícita, una investigación que debe citar las líneas de las que sacó cada campo. Los endpoints derivados quedan privados hasta que los revises, así que las rutas internas no se filtran a tu referencia pública.
Combina Ellie Docs con Ellie Desk (en acceso anticipado): los tickets de soporte resueltos pueden convertirse en nuevos artículos con un clic, y los borradores de IA de Desk se basan automáticamente en tu documentación publicada.
Plan gratis y, después, desde $65 al mes con facturación anual. Ver precios →
