|
| 1 | +--- |
| 2 | +title: "Agent" |
| 3 | +description: "El agente te ayuda a redactar y mantener la documentación" |
| 4 | +icon: "pen-line" |
| 5 | +--- |
| 6 | + |
| 7 | +<Info> |
| 8 | + El agente está disponible en los [planes Pro y Custom](https://mintlify.com/pricing?ref=agent) para cualquier persona con acceso a tu dashboard. |
| 9 | +</Info> |
| 10 | + |
| 11 | +El agente crea solicitudes de extracción con cambios propuestos a tu documentación basados en tus indicaciones. Cuando envías una solicitud al agente, este consulta tu documentación, repositorios conectados y mensajes de Slack para generar contenido que siga las mejores prácticas de redacción técnica y se ajuste al esquema de Mintlify. Accede al agente en tu espacio de trabajo de Slack o intégralo en aplicaciones personalizadas con la API. |
| 12 | + |
| 13 | +Usa el agente para: |
| 14 | + |
| 15 | +* Redactar contenido nuevo a partir de tus indicaciones, enlaces a solicitudes de extracción o hilos de Slack |
| 16 | +* Revisar ejemplos de código obsoletos y referencias de API |
| 17 | +* Buscar y actualizar contenido existente |
| 18 | +* Responder preguntas sobre tu documentación y temas de redacción técnica |
| 19 | + |
| 20 | +Para empezar, agrega el agente a tu espacio de trabajo de Slack y menciónalo con `@mintlify` en un canal. |
| 21 | + |
| 22 | +<div id="add-the-agent-to-your-slack-workspace"> |
| 23 | + ## Agrega el agente a tu espacio de trabajo de Slack |
| 24 | +</div> |
| 25 | + |
| 26 | +<Note> |
| 27 | + Si el propietario del espacio de trabajo de Slack requiere aprobación de administrador para instalar aplicaciones, pídele que apruebe la aplicación de Mintlify antes de conectarla. |
| 28 | +</Note> |
| 29 | + |
| 30 | +1. Ve a la página del [agente](https://dashboard.mintlify.com/products/agent) en tu dashboard. |
| 31 | +2. Selecciona el botón **Connect**. |
| 32 | +3. Sigue las indicaciones de Slack para agregar la aplicación `mintlify` a tu espacio de trabajo. |
| 33 | +4. Sigue las indicaciones de Slack para vincular tu cuenta de Mintlify con tu espacio de trabajo de Slack. |
| 34 | +5. Prueba que el agente funciona y responde cuando: |
| 35 | + * Le envías un mensaje directo. |
| 36 | + * Lo mencionas con `@mintlify` en un canal. |
| 37 | + |
| 38 | +<div id="connect-repositories-as-context"> |
| 39 | + ## Conecta repositorios como contexto |
| 40 | +</div> |
| 41 | + |
| 42 | +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](https://github.com/apps/mintlify/installations/new). |
| 43 | + |
| 44 | +<div id="embed-the-agent-via-api"> |
| 45 | + ## Integrar el agente mediante la API |
| 46 | +</div> |
| 47 | + |
| 48 | +Los endpoints del agente pueden usarse para [crear trabajos](/es/api-reference/agent/create-agent-job), [obtener un trabajo específico](/es/api-reference/agent/get-agent-job) y [obtener todos los trabajos](/es/api-reference/agent/get-all-jobs). |
| 49 | + |
| 50 | +<div id="write-effective-prompts"> |
| 51 | + ## Escribe prompts efectivos |
| 52 | +</div> |
| 53 | + |
| 54 | +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 enfocadas son más fáciles de completar, así que divide los proyectos complejos en pasos más pequeños. |
| 55 | + |
| 56 | +Haz que tus prompts sean específicos 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 tenías en mente. |
| 57 | + |
| 58 | +Prueba prompts basados en los resultados que quieres que tus usuarios consigan o en los problemas que encuentran. 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` o `@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`. |
| 59 | + |
| 60 | +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` o `@mintlify change all unordered lists to use * instead of -`. |
| 61 | + |
| 62 | +<div id="agent-workflows"> |
| 63 | + ## Flujos de trabajo del agente |
| 64 | +</div> |
| 65 | + |
| 66 | +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. |
| 67 | + |
| 68 | +<div id="iterate-on-a-prompt-in-a-slack-thread"> |
| 69 | + ### Itera sobre un prompt en un hilo de Slack |
| 70 | +</div> |
| 71 | + |
| 72 | +Haz un prompt al agente y luego sigue mencionándolo con `@mintlify` en el mismo hilo para refinar e iterar la solicitud de extracción que crea. 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. |
| 73 | + |
| 74 | +<div id="start-with-the-agent-finish-manually"> |
| 75 | + ### Comienza con el agente, termina manualmente |
| 76 | +</div> |
| 77 | + |
| 78 | +Pídele al agente que inicie un proyecto, luego cambia a la branch que cree y termina la tarea en tu entorno local o en el editor web. El agente puede ayudarte a empezar; después, puedes tomar el control para completar 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 usando tu método preferido. |
| 79 | + |
| 80 | +<div id="update-docs-when-merging-feature-changes"> |
| 81 | + ### Actualiza la documentación al fusionar cambios de funcionalidades |
| 82 | +</div> |
| 83 | + |
| 84 | +Cuando fusiones una solicitud de extracción de una funcionalidad, comparte el enlace del PR con el agente para actualizar la documentación pertinente. Por ejemplo: `@mintlify Este PR agrega un nuevo método de autenticación. Actualiza la documentación para incluir el nuevo flujo de auth: [enlace al PR]`. |
| 85 | + |
| 86 | +<div id="generate-release-notes-from-commit-history"> |
| 87 | + ### Generar notas de versión a partir del historial de confirmaciones |
| 88 | +</div> |
| 89 | + |
| 90 | +Pídele al agente una solicitud de extracción específica o un período de tiempo 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]` o `@mintlify Generate release notes for the last month`. |
| 91 | + |
| 92 | +<div id="generate-code-examples"> |
| 93 | + ### Generar ejemplos de código |
| 94 | +</div> |
| 95 | + |
| 96 | +Pídele al agente que genere ejemplos de código para funcionalidades a lo largo de 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`. |
| 97 | + |
| 98 | +<div id="review-existing-content"> |
| 99 | + ### Revisar el contenido existente |
| 100 | +</div> |
| 101 | + |
| 102 | +Pídele al agente que revise el contenido existente para verificar la precisión técnica, el estilo, la gramática u otros problemas. Por ejemplo: `@mintlify Revisa la sección de limitación de tasa de la API. Cambiamos los límites el mes pasado`. |
| 103 | + |
| 104 | +<div id="respond-to-user-feedback"> |
| 105 | + ### Responder a los comentarios de los usuarios |
| 106 | +</div> |
| 107 | + |
| 108 | +Proporciona al agente comentarios de tus usuarios para aplicar 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é puede estar generando la confusión?`. |
| 109 | + |
| 110 | +<div id="automate-with-the-api"> |
| 111 | + ### Automatiza con la API |
| 112 | +</div> |
| 113 | + |
| 114 | +Integra el agente en tus herramientas de automatización existentes para actualizar automáticamente la documentación cuando haya cambios en el código, iniciar revisiones de contenido o sincronizar actualizaciones de la documentación en varios repositorios. |
0 commit comments