ReadMe

ReadMe es una herramienta de IA (de ReadMe) que ayuda a equipos de producto y de ingeniería a publicar y mantener documentación de APIs y portales para desarrolladores. Combina un editor visual con sincronización bidireccional con Git y una capa de funciones de IA que redactan, revisan y responden preguntas sobre la propia documentación.

¿Qué aporta la IA a la documentación en ReadMe?

El ReadMe Agent edita y revisa páginas a petición, mientras que el AI Linter aplica tu guía de estilo y detecta enlaces rotos. Docs Audit señala contenido mejorable y AI Writer prepara borradores de actualización a partir de pull requests o hilos de Slack y los deja en una rama para revisarlos. Para los lectores, Ask AI responde dudas con el contenido publicado, y hay traducciones automáticas, un archivo LLMs.txt y un servidor MCP para que los asistentes de código consulten tu API.

¿Cómo se construye la referencia de API?

Subes un archivo OpenAPI o Swagger y ReadMe genera una referencia interactiva donde se pueden probar llamadas reales. El resto del portal se completa con guías, componentes MDX reutilizables, changelog, recetas paso a paso y foros.

• Sincronización con GitHub, GitHub Enterprise Server y GitLab, con ramas y revisiones.
• Edición multijugador para varios autores a la vez.
• Integraciones con Google Analytics, Intercom, Segment, Slack, Zendesk y Statuspage.
• API propia, CLI rdme y SSO con SAML.

Ventajas y limitaciones de ReadMe

Destaca por unir en un mismo producto el portal, la referencia interactiva, la analítica de uso y las herramientas de IA, y por su adopción en empresas como NVIDIA, Amazon o PagerDuty. Las integraciones con Localize, Transifex y Smartling facilitan publicar en varios idiomas. Entre las limitaciones, Ask AI es un complemento aparte, algunas funciones avanzadas se reservan a las ediciones superiores y la interfaz de edición está en inglés, aunque el contenido puede escribirse en español.