Passer au contenu principal
Les automatisations exécutent l’agent automatiquement afin que votre contenu reste précis sans effort manuel. Ce guide explique comment choisir la bonne automatisation, la configurer efficacement et rédiger des instructions qui produisent des résultats cohérents.

​
Quand utiliser les automatisations

Les automatisations conviennent particulièrement aux tâches qui sont :
  • Répétitives : la même tâche s’exécute régulièrement selon un calendrier prévisible ou chaque fois qu’un événement spécifique se produit.
  • Chronophages : des tâches qui prennent du temps à effectuer manuellement mais qui suivent un schéma cohérent.
  • Réactives : des tâches qui doivent se produire automatiquement en réponse à des modifications de code ou de contenu, comme la mise à jour de la documentation après la livraison d’une fonctionnalité.
Pour les tâches ponctuelles ou exploratoires, utilisez l’agent directement dans le dashboard ou depuis Slack.

​
Choisir un déclencheur

Chaque automatisation s’exécute selon l’un des trois types de déclencheurs. Choisissez celui qui correspond au moment où vous avez besoin que le travail soit effectué.
DéclencheurÀ utiliser lorsque
Mise à jour de contenuLa tâche doit s’exécuter chaque fois que le contenu de votre projet change — traduction de nouvelles pages, correction de liens cassés ou audit des métadonnées SEO.
Modification de codeLa tâche doit s’exécuter lorsque le code source change — mise à jour des spécifications d’API ou de la documentation après la fusion d’une PR.
Calendrier personnaliséLa tâche doit s’exécuter à une cadence fixe, quoi qu’il arrive — publication de changelogs hebdomadaires ou vérifications grammaticales périodiques.

​
Automatisations prédéfinies

Mintlify inclut des automatisations prédéfinies pour les tâches de maintenance de contenu les plus courantes. Activez l’une d’elles depuis la page Automations de votre dashboard. Consultez Automatisations prédéfinies pour plus de détails.

​
Automatisations personnalisées

Créez une automatisation personnalisée pour les tâches non couvertes par les options prédéfinies. Les automatisations personnalisées vous donnent un contrôle total sur le déclencheur, les instructions et les dépôts de contexte. Consultez Créer une automatisation personnalisée pour les étapes de configuration.

​
Rédiger des instructions efficaces

Les instructions d’automatisation personnalisée sont des prompts que l’agent suit à chaque exécution. La qualité de vos instructions affecte directement la cohérence des résultats. Décrivez le résultat, pas seulement la tâche. Indiquez à l’agent à quoi ressemble une tâche aboutie. 
Review the API reference pages.
Rédigez une procédure. Les agents suivent les instructions étape par étape plus fiablement que les prompts ouverts.
Exemple de procédure
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.
Restez précis dans la portée. Une automatisation qui fait une chose bien est plus fiable qu’une qui tente d’en faire plusieurs. Divisez les tâches complexes en plusieurs automatisations. Spécifiez les fichiers et les répertoires. Plus vous êtes précis sur l’endroit où l’agent doit chercher, moins il passe de temps à le faire.
Exemple avec des chemins spécifiques
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.

​
Utiliser des dépôts de contexte

Pour les automatisations personnalisées et certaines automatisations prédéfinies, vous pouvez ajouter des dépôts de contexte que l’agent lit lorsque l’automatisation s’exécute. Ajoutez des dépôts de contexte lorsque :
  • Votre contenu fait référence à du code, des API ou des configurations qui résident dans un dépôt distinct.
  • Vous souhaitez que l’agent compare votre contenu au code source pour décider de ce qu’il faut mettre à jour.
  • Le prompt d’automatisation fait référence à des fichiers en dehors de votre dépôt de projet Mintlify.
Vous pouvez ajouter jusqu’à 10 dépôts de contexte par automatisation.

​
Mode de mise à jour

Décidez du niveau de relecture souhaité avant que les modifications soient mises en ligne.
  • Automatique : les modifications sont fusionnées directement dans votre dépôt de projet Mintlify sans relecture. Idéal pour les tâches à faible risque et à fréquence élevée comme la traduction, les vérifications grammaticales et les corrections de liens.
  • Exiger une relecture : l’agent ouvre une pull request et un humain la relit avant la fusion. Idéal pour les tâches qui modifient le sens du contenu, comme la synchronisation avec les modifications de code ou la mise à jour des références d’API.

​
Contrôler l’utilisation des crédits

Chaque exécution d’automatisation consomme des crédits. Par exemple, la plupart des exécutions de l’automatisation update from code changes coûtent entre 40 et 180 crédits. Les exécutions complexes qui mettent à jour de nombreuses pages coûtent davantage. La planification de tâches cron à des moments précis vous donne un contrôle plus fin sur l’utilisation des crédits. Par exemple, exécutez une automatisation une fois par jour ou une fois par semaine pour savoir exactement combien de pull requests elle crée par mois. Les automatisations déclenchées par push peuvent varier davantage d’un mois à l’autre car elles dépendent de la fréquence à laquelle le contenu ou le code change.

​
Examiner et améliorer les résultats d’automatisation

Les automatisations s’exécutent automatiquement, mais elles bénéficient d’un examen périodique.
  1. Ouvrez l’onglet Runs sur la page Automations pour voir l’historique récent et le statut des exécutions.
  2. Cliquez sur une exécution pour lire le résumé de l’agent et examiner les pull requests qu’elle a ouvertes.
  3. Si les résultats sont incohérents, affinez vos instructions : ajoutez des procédures plus spécifiques, réduisez la portée des fichiers ou divisez l’automatisation en tâches plus petites.
Quelques cycles d’examen après l’activation d’une nouvelle automatisation suffisent généralement à affiner les instructions.

Sujets connexes

Créer une automatisation personnaliséeGuidesGérer les automatisations