mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
f99123ca26
* docs: fix Vale warnings from PRs merged in the last week * docs: mirror Vale style fixes into es, fr, and zh translations * Apply suggestions from code review Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
127 lines
7.3 KiB
Plaintext
127 lines
7.3 KiB
Plaintext
---
|
|
title: "Usar workflows"
|
|
description: "Aprende a usar los workflows de Mintlify para automatizar tareas recurrentes de mantenimiento de contenido, elige el tipo de trigger adecuado, escribe instrucciones efectivas y obtén resultados consistentes."
|
|
keywords: ["workflows", "automatización", "automatizar", "guía de workflows", "instrucciones de workflow", "automatización del agente", "autoactualizable"]
|
|
---
|
|
|
|
Los workflows ejecutan el agente automáticamente para que tu contenido se mantenga preciso sin esfuerzo manual. Esta guía cubre cómo elegir el workflow adecuado, configurarlo de forma efectiva y escribir instrucciones que produzcan resultados consistentes.
|
|
|
|
<div id="when-to-use-workflows">
|
|
## Cuándo usar workflows
|
|
</div>
|
|
|
|
Los workflows son ideales para tareas que son:
|
|
|
|
- **Repetitivas**—La misma tarea se ejecuta con regularidad según una programación predecible o cada vez que ocurre un evento específico.
|
|
- **Lentas**—Tareas que llevan tiempo realizar manualmente pero siguen un patrón consistente.
|
|
- **Reactivas**—Tareas que deben ocurrir automáticamente en respuesta a cambios de código o contenido, como actualizar la documentación tras el lanzamiento de una funcionalidad.
|
|
|
|
Para tareas puntuales o exploratorias, usa el agente directamente en el [panel](https://app.mintlify.com) o desde Slack.
|
|
|
|
<div id="choose-a-trigger">
|
|
## Elegir un trigger
|
|
</div>
|
|
|
|
Cada workflow se ejecuta con uno de tres tipos de trigger. Elige el que coincida con cuándo necesitas que se realice el trabajo.
|
|
|
|
| Trigger | Cuándo usarlo |
|
|
|---|---|
|
|
| Actualización de contenido | La tarea debe ejecutarse cada vez que cambie el contenido de tu proyecto: traducir páginas nuevas, reparar 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 tras el merge de una PR. |
|
|
| Programación personalizada | La tarea debe ejecutarse con una cadencia fija sin importar lo demás: publicar changelogs semanales o ejecutar verificaciones gramaticales periódicas. |
|
|
|
|
<div id="predefined-workflows">
|
|
## Workflows predefinidos
|
|
</div>
|
|
|
|
Mintlify incluye workflows predefinidos para las tareas más comunes de mantenimiento de contenido. Activa cualquiera de ellos desde la página [Workflows](https://app.mintlify.com/products/workflows?tab=workflows) de tu panel.
|
|
|
|
Consulta [Workflows predefinidos](/es/workflows/reference) para más detalles.
|
|
|
|
<div id="custom-workflows">
|
|
## Workflows personalizados
|
|
</div>
|
|
|
|
Crea un workflow personalizado para tareas que no están cubiertas por las opciones predefinidas. Los workflows personalizados te dan control total sobre el trigger, las instrucciones y los repositorios de contexto.
|
|
|
|
Consulta [Crear un workflow personalizado](/es/workflows/create) para los pasos de configuración.
|
|
|
|
<div id="write-effective-instructions">
|
|
### Escribir instrucciones efectivas
|
|
</div>
|
|
|
|
Las instrucciones de un workflow personalizado 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.** Indica al agente cómo debe verse el resultado final.
|
|
|
|
<CodeGroup>
|
|
```text Menos efectivo
|
|
Revisa las páginas de referencia de la API.
|
|
```
|
|
|
|
```text Más efectivo
|
|
Revisa cada página del directorio /api-reference. Para cada endpoint, confirma que los parámetros de la solicitud, los campos de respuesta y los payloads de ejemplo coincidan con la especificación OpenAPI en el archivo api/openapi.yaml. Abre una pull request con correcciones para cualquier discrepancia que encuentres.
|
|
```
|
|
</CodeGroup>
|
|
|
|
**Escribe un procedimiento.** Los agentes siguen instrucciones paso a paso de forma más fiable que prompts abiertos.
|
|
|
|
```text Ejemplo de procedimiento
|
|
1. Lee el diff de la pull request mergeada del repositorio de origen.
|
|
2. Identifica los endpoints, parámetros o formas de respuesta de la API que cambiaron.
|
|
3. Busca en la documentación las páginas que hacen referencia a esos endpoints.
|
|
4. Actualiza las páginas afectadas para que coincidan con los cambios de la pull request.
|
|
5. Abre una pull request con un resumen de las páginas que cambiaste y por qué.
|
|
```
|
|
|
|
**Mantén el alcance acotado.** Un workflow que hace una cosa bien es más fiable que uno que intenta hacer muchas. Divide las tareas complejas en varios workflows.
|
|
|
|
**Especifica archivos y directorios.** Cuanto más preciso seas sobre dónde debe mirar el agente, menos tiempo dedicará a buscar.
|
|
|
|
```text Ejemplo con rutas específicas
|
|
Revisa cada archivo MDX en el directorio /content para detectar enlaces internos rotos (enlaces que comienzan con /).
|
|
Para cada enlace roto, corrige la ruta o elimina el enlace si no existe sustitución.
|
|
```
|
|
|
|
<div id="use-context-repositories">
|
|
### Usar repositorios de contexto
|
|
</div>
|
|
|
|
Para workflows personalizados y algunos workflows predefinidos, puedes añadir repositorios de contexto que el agente lee cuando se ejecuta el workflow.
|
|
|
|
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 del workflow se refiera a archivos fuera del repositorio de tu proyecto de Mintlify.
|
|
|
|
Puedes añadir hasta 10 repositorios de contexto por workflow.
|
|
|
|
<div id="update-mode">
|
|
### Modo de actualización
|
|
</div>
|
|
|
|
Decide cuánta revisión quieres antes de que los cambios se publiquen.
|
|
|
|
- **Automático**: Los cambios se mergean directamente en el repositorio de tu proyecto de Mintlify sin revisión. Mejor para tareas de bajo riesgo y alta frecuencia como traducción, verificaciones gramaticales y reparación de enlaces.
|
|
- **Requiere revisión**: El agente abre una pull request y una persona la revisa antes de mergearla. Mejor para tareas que cambian el significado del contenido, como sincronizaciones con cambios de código o actualizaciones de referencias de API.
|
|
|
|
<div id="control-credit-usage">
|
|
## Controlar el uso de créditos
|
|
</div>
|
|
|
|
Cada ejecución de workflow consume créditos. Por ejemplo, la mayoría de las ejecuciones del workflow **actualizar desde cambios de código** cuestan entre 40 y 180 créditos. Las ejecuciones complejas que actualizan muchas páginas cuestan más.
|
|
|
|
Programar trabajos cron para que se ejecuten en momentos concretos te permite controlar con mayor precisión el uso de créditos. Por ejemplo, puedes ejecutar un workflow una vez al día o una vez a la semana para saber exactamente cuántas pull requests crea un workflow al mes, en lugar de que dependa de cambios de contenido o de código que varían de un mes a otro.
|
|
|
|
<div id="review-and-improve-workflow-results">
|
|
## Revisar y mejorar los resultados de los workflows
|
|
</div>
|
|
|
|
Los workflows se ejecutan automáticamente, pero se benefician de una revisión periódica.
|
|
|
|
1. Abre la pestaña **Runs** en la página [Workflows](https://app.mintlify.com/products/workflows) para ver el historial de ejecuciones recientes y su estado.
|
|
2. Haz clic en una ejecución para leer el resumen del agente y revisar las pull requests que abrió.
|
|
3. Si los resultados son inconsistentes, refina tus instrucciones: añade procedimientos más específicos, reduce el alcance de los archivos o divide el workflow en tareas más pequeñas.
|
|
|
|
Unos cuantos ciclos de revisión tras activar un nuevo workflow suelen ser suficientes para ajustar las instrucciones.
|