Ejemplos de uso del agente en tu proceso de documentación.
El agente puede ayudarte con muchas tareas distintas relacionadas con la documentación. Estos flujos de trabajo ilustran algunas de las maneras en que puedes integrar el agente en tu proceso de documentación. Prueba el enfoque que mejor se adapte a la forma en que tu equipo trabaja actualmente y ajústalo a tus necesidades específicas.
Envía un prompt al agente y luego sigue mencionándolo con @mintlify en el mismo hilo para refinar e iterar sobre 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 así con cualquier otra iteración que quieras hacer.
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 y luego tú puedes encargarte de 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 tu método preferido.
Actualizar la documentación al fusionar cambios de funcionalidades
Cuando fusiones una solicitud de extracción de una funcionalidad, comparte el enlace de la PR con el agente para que actualice la documentación relevante.Por ejemplo: @mintlify Esta PR agrega un nuevo método de autenticación. Actualiza la documentación para incluir el nuevo flujo de autenticación: [enlace de la PR].
Generar notas de la versión a partir de una solicitud de extracción
Proporciona al agente una solicitud de extracción específica para generar notas de la versión o actualizaciones del changelog basadas en el historial de confirmaciones.Por ejemplo: @mintlify Generate release notes for this PR: [PR link].
Pídele al agente que genere ejemplos de código para las 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.
Indica al agente que revise el contenido existente para comprobar su exactitud técnica, estilo, gramática u otros posibles problemas.Por ejemplo: @mintlify Review the API rate limiting section. We changed limits last month.
Proporciona indicaciones al agente con los comentarios de tus usuarios para hacer actualizaciones específicas en tu documentación.Por ejemplo: @mintlify Users are getting confused by step 3 in the setup guide. What might be making it unclear?.
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, desencadenar revisiones de contenido o sincronizar actualizaciones de documentación en múltiples repositorios.Usa los endpoints del agente para crear tareas, obtener una tarea específica y obtener todas las tareas.Al crear tareas a través de la API, puedes controlar si las solicitudes de extracción se abren en modo borrador usando el parámetro asDraft (su valor predeterminado es true). Establece asDraft: false para crear solicitudes de extracción que no sean borrador y que estén listas para revisión inmediata y fusión en flujos de trabajo automatizados.Aprende a configurar la automatización de la API en el tutorial Actualizar la documentación automáticamente cuando se fusiona código.
