mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
e676b479a7
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
135 lines
9.3 KiB
Plaintext
135 lines
9.3 KiB
Plaintext
---
|
|
title: "Añade el agente a Slack"
|
|
description: "Añade el agente de Mintlify a Slack para crear actualizaciones de documentación a partir de conversaciones, capturar el conocimiento del equipo y mantener los documentos sincronizados."
|
|
keywords: ["Integración con Slack", "Bot de Slack", "Colaboración en equipo", "Integración del agente", "Captura de conocimiento"]
|
|
---
|
|
|
|
<Note>
|
|
Si el propietario de tu 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.
|
|
</Note>
|
|
|
|
<div id="connect-your-slack-workspace">
|
|
## Conecta tu espacio de trabajo de Slack
|
|
</div>
|
|
|
|
1. Ve a la página de [Agent](https://dashboard.mintlify.com/products/agent) en tu dashboard.
|
|
2. En la sección "Agent settings", haz clic en **Install Slack app**.
|
|
<Frame>
|
|
<img src="/images/agent/install-apps-light.png" alt="La sección de configuración de aplicaciones con los botones de instalación de Slack y Notion." className="block dark:hidden" />
|
|
<img src="/images/agent/install-apps-dark.png" alt="La sección de configuración de aplicaciones con los botones de instalación de Slack y Notion." className="hidden dark:block" />
|
|
</Frame>
|
|
3. Sigue las indicaciones de Slack para instalar la app `mintlify` en 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 al agente.
|
|
- Menciones al agente con `@mintlify` en un canal.
|
|
|
|
<Note>
|
|
Cada espacio de trabajo de Slack solo puede conectarse a una organización de Mintlify a la vez. Si intentas instalar el agente en un espacio de trabajo que ya está conectado a otra organización, la instalación fallará con un error de «wrong organization». Desinstala primero la app de la otra organización, o utiliza un espacio de trabajo de Slack diferente.
|
|
|
|
Puedes instalar el agente de Slack incluso si no tienes un despliegue alojado en Mintlify. El agente sigue funcionando para responder preguntas y mantener conversaciones; las funciones que abren pull requests requieren un repositorio conectado.
|
|
</Note>
|
|
|
|
<div id="reconnect-or-reinstall-the-agent">
|
|
### Reconectar o reinstalar el agente
|
|
</div>
|
|
|
|
Si necesitas volver a autorizar el agente —por ejemplo, para otorgarle nuevos permisos tras una actualización de scopes de Slack o para recuperarte de un token revocado— reinstala la app desde tu panel de Mintlify.
|
|
|
|
Cuando reinstalas el agente en un espacio de trabajo que ya está conectado a tu organización, Mintlify actualiza en su lugar el bot token almacenado. Tus canales, hilos e integraciones por usuario existentes se conservan intactos.
|
|
|
|
<Tip>
|
|
Si tu organización tiene múltiples despliegues, el agente te pide que elijas con cuál despliegue trabajar la primera vez que envías una solicitud.
|
|
|
|
Tu despliegue preferido es personal de tu cuenta de Slack y no afecta
|
|
a otros miembros del equipo. Puedes cambiar a un despliegue diferente en cualquier
|
|
momento durante una conversación haciendo clic en el botón **Switch deployment** en
|
|
el mensaje de estado del agente en el hilo. El agente conserva tu historial de
|
|
conversación para que puedas continuar donde lo dejaste con el nuevo despliegue.
|
|
</Tip>
|
|
|
|
<div id="use-the-agent-in-slack">
|
|
## Usar el agente en Slack
|
|
</div>
|
|
|
|
Una vez conectado, puedes:
|
|
|
|
- Enviar mensajes directos al agente para usarlo en privado y actualizar tu documentación.
|
|
- Mencionar `@mintlify` en un canal para usarlo de forma pública y colaborativa.
|
|
- Adjuntar archivos e imágenes directamente a tus mensajes para que el agente los procese y los incluya en tu documentación.
|
|
- Continuar las conversaciones en hilos para iterar sobre los cambios o hacer preguntas de seguimiento. El agente reutiliza los archivos, las imágenes y las reacciones con emoji compartidos previamente en el hilo como contexto para las solicitudes posteriores, por lo que no es necesario que los vuelvas a cargar.
|
|
- Compartir enlaces a solicitudes de extracción con el agente para actualizar la documentación relacionada.
|
|
|
|
<div id="ask-questions-about-your-docs">
|
|
## Haz preguntas sobre tu documentación
|
|
</div>
|
|
|
|
Hazle preguntas al agente sobre tu producto o documentación y recibe respuestas en el hilo.
|
|
|
|
- **Nueva pregunta**: Envía un mensaje directo al agente o menciona `@mintlify` en un canal con tu pregunta.
|
|
- **Hilo existente**: Responde en el hilo y menciona `@mintlify` con una pregunta de seguimiento.
|
|
|
|
Ejemplos de preguntas:
|
|
- «¿Qué páginas mencionan el límite de tasa de la API?»
|
|
- «¿Cómo configuro la autenticación?»
|
|
- «¿Cómo está estructurada nuestra navegación?»
|
|
|
|
<div id="update-documentation">
|
|
## Actualizar la documentación
|
|
</div>
|
|
|
|
Utiliza el agente para actualizar tu documentación mediante una nueva solicitud o en un hilo existente.
|
|
|
|
- **Nueva solicitud**: Envía un mensaje directo al agente o menciona `@mintlify` en un canal con instrucciones sobre qué actualizar.
|
|
- **Hilo existente**: Responde en el hilo y menciona `@mintlify` con instrucciones sobre qué actualizar.
|
|
- **Con archivos adjuntos**: Sube imágenes, diagramas, archivos de código u otros documentos junto con tu mensaje. El agente los procesa automáticamente y los incluye en tu documentación. En un hilo, el agente tiene acceso a las imágenes y archivos compartidos en mensajes anteriores, por lo que puedes hacer referencia a ellos en las solicitudes posteriores sin necesidad de volver a subirlos.
|
|
|
|
El agente lee el contexto de la solicitud o del hilo y crea una solicitud de extracción en tu repositorio conectado con las actualizaciones.
|
|
|
|
<div id="reference-other-repositories">
|
|
## Hacer referencia a otros repositorios
|
|
</div>
|
|
|
|
El agente puede leer el código fuente de cualquier repositorio conectado mediante la [GitHub app](/es/deploy/github) o la [integración con GitLab](/es/deploy/gitlab), incluso si no es tu repositorio de documentación. Esto le permite construir un contexto más profundo para guiar las actualizaciones de la documentación.
|
|
|
|
Cuando mencionas otro repositorio en tu solicitud, el agente lo clona bajo demanda e inspecciona los archivos relevantes antes de redactar los cambios.
|
|
|
|
Ejemplos de prompts:
|
|
|
|
- "Actualiza la guía de autenticación según los cambios en `acme/api-server/src/auth.ts`."
|
|
- "Documenta los nuevos endpoints añadidos en `acme/backend#1234`."
|
|
- "¿A qué repositorios tienes acceso?"
|
|
|
|
Los repositorios clonados son de solo lectura. El agente los utiliza como contexto, pero siempre abre solicitudes de extracción contra tu repositorio de documentación.
|
|
|
|
<div id="track-progress-in-real-time">
|
|
## Sigue el progreso en tiempo real
|
|
</div>
|
|
|
|
Mientras el agente trabaja en tu solicitud, proporciona retroalimentación en vivo en el hilo de Slack.
|
|
|
|
- **Actualizaciones de estado**: Un mensaje que se actualiza en vivo muestra lo que el agente está haciendo, como cuántos archivos ha buscado, leído y editado.
|
|
- **Progreso de las tareas**: Cuando el agente divide tu solicitud en varias tareas, muestra una lista de verificación para que puedas seguir el progreso de cada una.
|
|
- **Preguntas**: Si el agente necesita más información, presenta opciones para que selecciones o respondas en el hilo con una respuesta personalizada.
|
|
- **Solicitudes de permiso**: Antes de que el agente ejecute una acción de terceros que escribe datos, como enviar un correo o crear un ticket, te pide que apruebes o rechaces la acción. La tarjeta de aprobación se envía como un mensaje efímero visible solo para ti, la persona que activó la solicitud, para no interrumpir a otros participantes del hilo. Haz clic en **Approve** para que el agente continúe o en **Deny** para cancelar la acción.
|
|
- **Interrupciones**: Si envías un mensaje de seguimiento mientras el agente aún está trabajando, detiene la tarea actual y comienza con la nueva.
|
|
- **Finalización**: Cuando el agente termina, publica un resumen con un enlace a la solicitud de extracción y un enlace para abrir los cambios en el editor web.
|
|
|
|
<div id="roles-and-permissions">
|
|
## Roles y permisos
|
|
</div>
|
|
|
|
Las capacidades del agente en Slack coinciden con el [rol](/es/dashboard/roles) de la cuenta de Mintlify vinculada:
|
|
|
|
- **Administradores y editores**: Pueden hacer preguntas y aplicar cambios en la documentación. El agente tiene acceso a las herramientas de edición de archivos y de pull requests.
|
|
- **Lectores**: Solo pueden hacer preguntas. El agente se ejecuta en modo de solo lectura, por lo que las herramientas de edición de archivos, de commit y de pull request no están disponibles. Las integraciones de terceros se filtran a acciones de solo lectura. Si un lector le pide al agente que haga un cambio, el agente explica la limitación y sugiere contactar a un compañero editor o administrador.
|
|
|
|
Para cambiar los permisos de un compañero, actualiza su rol desde la página [Members](https://dashboard.mintlify.com/settings/organization/members) de tu dashboard.
|
|
|
|
<div id="best-practices">
|
|
## Mejores prácticas
|
|
</div>
|
|
|
|
- **Sé específico**: Indícale al agente exactamente qué quieres documentar y dónde debe ir.
|
|
- **Añade contexto**: Si un hilo no contiene toda la información necesaria, incluye detalles adicionales en tu mensaje al agente.
|
|
- **Revisa cuidadosamente**: Siempre debes revisar las solicitudes de extracción que genere el agente antes de fusionarlas. |