Casos de uso

El agente ayuda con muchas tareas diferentes de documentación. Estos ejemplos muestran algunas de las formas en que puedes integrar el agente en tu proceso de documentación. Prueba un enfoque que encaje con la forma en que tu equipo trabaja actualmente y ajústalo a tus necesidades específicas.

Envía una instrucción al agente y luego continúa mencionándolo con @mintlify en el mismo hilo para refinar e iterar sobre la solicitud de extracción que crea.

Por ejemplo: @mintlify Nuestra guía de inicio rápido necesita una nueva sección sobre cómo invitar colaboradores. Luego: @mintlify La nueva sección debería llamarse "Inviting collaborators". Y después cualquier otra iteración que quieras hacer.

Indícale 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 y luego tú 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 hacer cualquier cambio adicional usando el método que prefieras.

Cuando fusiones una solicitud de extracción de una funcionalidad, comparte el enlace del PR con el agente para actualizar la documentación relevante.

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 del PR].

Indícale al agente una solicitud de extracción específica para que genere notas de lanzamiento o actualizaciones del changelog basadas en el historial de confirmaciones.

Por ejemplo: @mintlify Generate release notes for this PR: [PR link].

Comparte con el agente el enlace de la solicitud de extracción para atender los comentarios de los revisores y los comentarios de revisión de código en las solicitudes de extracción de documentación.

Por ejemplo: @mintlify Address the review comments on this PR: [PR link].

Pídele al agente que genere ejemplos de código para funcionalidades en toda tu documentación o en páginas específicas.

Por ejemplo: @mintlify Generate a code example to make the authentication method easier to understand.

Adjunta archivos o imágenes directamente a tu mensaje de Slack cuando des instrucciones al agente. El agente procesa el archivo adjunto y lo incluye en la documentación. Los archivos adjuntos admitidos incluyen imágenes, PDFs, SVGs y otros documentos.

Por ejemplo: @mintlify Añade este diagrama a la página de visión general de la arquitectura con la imagen adjunta al mensaje.

Pide al agente que revise el contenido existente para comprobar la precisión técnica, el estilo, la gramática u otros posibles problemas.

Por ejemplo: @mintlify Revisa la sección de limitación de tasa de la API. Cambiamos los límites el mes pasado.

Proporciona al agente los comentarios de tus usuarios para realizar actualizaciones puntuales en tu documentación.

Por ejemplo: @mintlify Users are getting confused by step 3 in the setup guide. What might be making it unclear?.

Crea automatizaciones para automatizar tareas recurrentes y tareas de mantenimiento reactivo, como redactar cambios o actualizar contenido cuando agregas nuevas funcionalidades a tu producto.

Consulta Vista general de automatizaciones para obtener más información.

Integra el agente en tus herramientas de automatización existentes para actualizar la documentación automáticamente cuando se produzcan cambios en el código, iniciar revisiones de contenido o sincronizar actualizaciones de documentación entre múltiples repositorios.

Usa los endpoints del agente para crear tareas, obtener el estado de una tarea y enviar mensajes.

Al crear tareas mediante la API, puedes controlar si las solicitudes de extracción se abren en modo borrador usando el parámetro asDraft (su valor predeterminado es false). Establece asDraft: true para crear solicitudes de extracción en modo borrador, o mantén el valor predeterminado para crear solicitudes de extracción listas para revisión inmediata y fusión en flujos de trabajo automatizados.