Saltar al contenido principal
El agente está disponible en los planes Pro y Custom para cualquier persona con acceso a tu dashboard.
El agente crea solicitudes de extracción con cambios propuestos para tu documentación a partir de tus indicaciones. Cuando envías una solicitud al agente, este consulta tu documentación, los repositorios conectados y los mensajes de Slack para generar contenido que siga las mejores prácticas de redacción técnica y cumpla con el esquema de Mintlify. Accede al agente desde tu espacio de trabajo de Slack o intégralo en aplicaciones personalizadas con la API. Usa el agente para:
  • Escribir contenido nuevo a partir de tus indicaciones, enlaces a solicitudes de extracción o hilos de Slack
  • Revisar ejemplos de código desactualizados y referencias de API
  • Buscar y actualizar contenido existente
  • Responder preguntas sobre tu documentación y temas de redacción técnica
Para empezar, añade el agente a tu espacio de trabajo de Slack y menciónalo con @mintlify en un canal.

​
Agrega el agente a tu espacio de trabajo de Slack

Si el propietario del espacio de trabajo de Slack requiere aprobación de un administrador para instalar aplicaciones, pídeles que aprueben la aplicación de Mintlify antes de conectarla.
  1. Ve a la página del agent en tu dashboard.
  2. Selecciona el botón Connect.
  3. Sigue las indicaciones de Slack para agregar la aplicación mintlify a tu espacio de trabajo.
  4. Sigue las indicaciones de Slack para vincular tu cuenta de Mintlify con tu espacio de trabajo de Slack.
  5. Verifica que el agente esté funcionando y responda cuando:
    • Le envíes un mensaje directo.
    • Lo menciones con @mintlify en un canal.

​
Conecta repositorios como contexto

El agente solo puede acceder a los repositorios que conectes mediante la Aplicación de GitHub de Mintlify. Modifica qué repositorios puede acceder el agente en la configuración de la Aplicación de GitHub.

​
Integra el agente mediante la API

Usa los endpoints del agente para crear tareas, obtener una tarea específica y obtener todas las tareas.

​
Escribe prompts efectivos

Piensa en el agente como un assistant útil que necesita tu guía para completar tareas. Dale instrucciones claras y contexto. Las tareas más específicas son más fáciles de completar, así que divide los proyectos complejos en pasos más pequeños. Haz que tus prompts sean concretos y orientados a resultados. Prompts genéricos como @mintlify Improve the onboarding page aplican buenas prácticas generales, pero puede que no mejoren el contenido exactamente como lo imaginabas. Prueba prompts basados en los resultados que quieres que tus usuarios alcancen o en los problemas que enfrentan. Por ejemplo:
  • @mintlify A lot of users have trouble installing the CLI. Review the onboarding page and update the docs so that users can easily install the CLI
  • @mintlify Developers keep getting 401 errors when following our authentication guide. Review the auth docs and add clearer examples showing how to properly format the API key
Usa prompts amplios para el mantenimiento general del contenido, como corregir errores tipográficos, actualizar redirecciones o renombrar una función en toda tu documentación. Por ejemplo:
  • @mintlify Find and fix all typos in the docs
  • @mintlify change all unordered lists to use * instead of -

​
Especificar un subdomain

Si tienes varios sitios de documentación con sus propios subdomains, incluye el parámetro subdomain en tu mensaje para especificar en qué subdomain debe trabajar el agente. Usa el formato @mintlify subdomain=<your-subdomain> <your-prompt> para indicar al agente que trabaje en un subdomain específico. Ejemplos:
  • @mintlify subdomain=public-docs Add a new section to the quickstart about inviting collaborators based on this PR: Indica al agente que actualice el quickstart solo en el subdomain public-docs.
  • @mintlify subdomain=customer-docs Update the auth docs for the new authentication method: Indica al agente que actualice la documentación de auth solo en el subdomain customer-docs.

​
Flujos de trabajo del agente

El agente ayuda con muchas tareas de documentación. Estos flujos de trabajo muestran algunas de las maneras en que puedes integrar al agente en tu proceso de documentación. Prueba un enfoque que se adapte a la forma en que trabaja tu equipo actualmente y ajústalo a tus necesidades específicas.

​
Iterar un prompt en un hilo de Slack

Envía un prompt al agente y sigue mencionándolo con @mintlify en el mismo hilo para refinar e iterar la solicitud de extracción que cree. Por ejemplo: @mintlify Nuestra página de inicio rápido necesita una nueva sección sobre cómo invitar colaboradores. Luego: @mintlify La nueva sección debería llamarse "Invitar colaboradores". Y continúa con cualquier otra iteración.

​
Empieza con el agente y termina manualmente

Pídele al agente que inicie un proyecto, luego cambia a la branch que cree y completa la tarea en tu entorno local o en el editor web. El agente puede ayudarte a comenzar; después, puedes retomar para finalizar la tarea. Por ejemplo: @mintlify Update the quickstart page to include information about inviting collaborators, y luego cambia a la branch para realizar cualquier cambio adicional con tu método preferido.

​
Actualiza la documentación al fusionar cambios de funcionalidades

Cuando fusiones una solicitud de extracción de una funcionalidad, comparte el enlace del PR con el agente para actualizar la documentación correspondiente. Por ejemplo: @mintlify Este PR agrega un nuevo método de autenticación. Actualiza la documentación para incluir el nuevo flujo de autenticación: [enlace al PR].

​
Generar notas de versión a partir de una solicitud de extracción

Pídele al agente una solicitud de extracción específica para generar notas de versión o actualizaciones del changelog basadas en el historial de confirmaciones. Por ejemplo: @mintlify Generate release notes for this PR: [PR link].

​
Generar ejemplos de código

Pídele al agente que genere ejemplos de código para funciones en toda tu documentación o en páginas específicas. Por ejemplo: @mintlify Genera un ejemplo de código para que el método de Autenticación sea más fácil de entender.

​
Revisar el contenido existente

Pídele al agente que revise el contenido existente para verificar la precisión técnica, el estilo, la gramática u otros aspectos. Por ejemplo: @mintlify Revisa la sección de limitación de tasa de la API. Cambiamos los límites el mes pasado.

​
Responder a los comentarios de los usuarios

Proporciona al agente comentarios de tus usuarios para realizar actualizaciones específicas en tu documentación. Por ejemplo: @mintlify Los usuarios se están confundiendo con el paso 3 de la guía de configuración. ¿Qué podría estar causando la falta de claridad?.

​
Automatiza con la API

Integra el agente en tus herramientas de automatización para actualizar la documentación automáticamente cuando haya cambios en el código, desencadenar revisiones de contenido o sincronizar actualizaciones de la documentación en varios repositorios. Aprende cómo en el tutorial Actualiza automáticamente la documentación cuando se hace merge del código.