Usar automatizaciones

Automatiza el mantenimiento recurrente de la documentación con Mintlify: elige el activador adecuado y escribe instrucciones eficaces para el agente.

Las automatizaciones ejecutan el agente automáticamente para que tu contenido se mantenga preciso sin esfuerzo manual. Esta guía explica cómo elegir la automatización adecuada, configurarla con eficacia y escribir instrucciones que produzcan resultados consistentes.

​

Cuándo usar automatizaciones

Las automatizaciones son ideales para tareas que son:

• Repetitivas: la misma tarea se ejecuta con regularidad según una programación previsible o cada vez que ocurre un evento concreto.
• Que consumen tiempo: tareas que llevan tiempo si se hacen manualmente, pero siguen un patrón consistente.
• Reactivas: tareas que deben suceder automáticamente en respuesta a cambios de código o de contenido, como actualizar la documentación después de lanzar una funcionalidad.

Para tareas puntuales o exploratorias, usa el agente directamente en el dashboard o desde Slack.

​

Elige un activador

Cada automatización se ejecuta con uno de tres tipos de activadores. Elige el que se ajuste a cuándo necesitas que se realice el trabajo.

Activador	Úsalo cuando
Actualización de contenido	La tarea debe ejecutarse siempre que cambie el contenido de tu proyecto: traducir nuevas páginas, corregir enlaces rotos o auditar metadatos de SEO.
Cambio de código	La tarea debe ejecutarse cuando cambia el código fuente: actualizar especificaciones de API o documentación después de fusionar una PR.
Programación personalizada	La tarea debe ejecutarse con una cadencia fija independientemente de otros eventos: publicar registros de cambios semanales o ejecutar comprobaciones gramaticales periódicas.

​

Automatizaciones predefinidas

Mintlify incluye automatizaciones predefinidas para las tareas de mantenimiento de contenido más comunes. Activa cualquiera de ellas desde la página Automatizaciones de tu dashboard.

Consulta Automatizaciones predefinidas para más detalles.

​

Automatizaciones personalizadas

Crea una automatización personalizada para tareas que no cubran las opciones predefinidas. Las automatizaciones personalizadas te dan control total sobre el activador, las instrucciones y los repositorios de contexto.

Consulta Crear una automatización personalizada para los pasos de configuración.

​

Escribir instrucciones eficaces

Las instrucciones de las automatizaciones personalizadas son prompts que el agente sigue en cada ejecución. La calidad de tus instrucciones afecta directamente a la consistencia de los resultados.

Describe el resultado, no solo la tarea. Dile al agente cómo se ve “terminado”.

Menos eficaz

Review the API reference pages.

Review every page in the /api-reference directory. For each endpoint, confirm that the request parameters, response fields, and example payloads match the OpenAPI spec in the api/openapi.yaml file. Open a pull request with corrections for any discrepancies you find.

Escribe un procedimiento. Los agentes siguen las instrucciones paso a paso con más fiabilidad que los prompts abiertos.

Procedimiento de ejemplo

1. Read the merged pull request diff from the trigger repository.
2. Identify any changed API endpoints, parameters, or response shapes.
3. Search the documentation for pages that reference those endpoints.
4. Update the affected pages to match the changes in the pull request.
5. Open a pull request with a summary of the pages you changed and why.

Mantén un alcance acotado. Una automatización que hace una sola cosa bien es más fiable que una que intenta hacer muchas cosas. Divide las tareas complejas entre varias automatizaciones.

Especifica archivos y directorios. Cuanto más preciso seas sobre dónde debe mirar el agente, menos tiempo dedicará a buscar.

Ejemplo con rutas específicas

Check every MDX file in the /content directory for broken internal links (links beginning with /). 
For each broken link, either fix the path or remove the link if no replacement exists.

​

Usar repositorios de contexto

Para automatizaciones personalizadas y algunas automatizaciones predefinidas, puedes añadir repositorios de contexto que el agente lee cuando se ejecuta la automatización.

Añade repositorios de contexto cuando:

• Tu contenido haga referencia a código, APIs o configuración que vive en un repositorio separado.
• Quieras que el agente compare tu contenido con el código fuente al decidir qué actualizar.
• El prompt de la automatización haga referencia a archivos fuera del repositorio de tu proyecto de Mintlify.

Puedes añadir hasta 10 repositorios de contexto por automatización.

​

Modo de actualización

Decide cuánta revisión deseas antes de que los cambios se publiquen.

• Automático: los cambios se fusionan directamente en el repositorio de tu proyecto de Mintlify sin revisión. Ideal para tareas de bajo riesgo y alta frecuencia, como traducciones, comprobaciones gramaticales y correcciones de enlaces.
• Requiere revisión: el agente abre una pull request y una persona la revisa antes de fusionarla. Ideal para tareas que cambian el significado del contenido, como sincronizar con cambios de código o actualizar referencias de API.

​

Controlar el uso de créditos

Cada ejecución de una automatización consume créditos. Por ejemplo, la mayoría de las ejecuciones de la automatización update from code changes cuestan entre 40 y 180 créditos. Las ejecuciones complejas que actualizan muchas páginas cuestan más.

Programar tareas cron para que se ejecuten en momentos específicos te da un control más preciso sobre el uso de créditos. Por ejemplo, ejecuta una automatización una vez al día o una vez a la semana para saber exactamente cuántas pull requests crea al mes. Las automatizaciones activadas por push pueden variar más de un mes a otro porque dependen de la frecuencia con la que cambian el contenido o el código.

​

Revisar y mejorar los resultados de las automatizaciones

Las automatizaciones se ejecutan automáticamente, pero se benefician de revisiones periódicas.

1. Abre la pestaña Runs en la página Automatizaciones para ver el historial reciente de ejecuciones y su estado.
2. Haz clic en una ejecución para leer el resumen del agente y revisar las pull requests que haya abierto.
3. Si los resultados son inconsistentes, refina tus instrucciones: añade procedimientos más específicos, acota el ámbito de archivos o divide la automatización en tareas más pequeñas.

Unos pocos ciclos de revisión tras habilitar una nueva automatización suelen ser suficientes para ajustar las instrucciones.