Agent

L’agent vous aide à rédiger et à maintenir la documentation

L’agent est disponible avec les offres Pro et Custom pour toute personne ayant accès à votre Dashboard.

L’agent crée des pull requests avec des propositions de modification de votre documentation, à partir de vos instructions. Lorsque vous lui envoyez une demande, il s’appuie sur votre documentation, vos dépôts connectés et vos messages Slack pour produire un contenu conforme aux bonnes pratiques de rédaction technique et au schéma Mintlify. Accédez à l’agent dans votre espace de travail Slack ou intégrez‑le à des applications personnalisées via l’API.

Utilisez l’agent pour :

• Rédiger de nouveaux contenus à partir de vos instructions, de liens vers des pull requests ou de fils Slack
• Mettre à jour des exemples de code obsolètes et des références d’API
• Rechercher et actualiser le contenu existant
• Répondre aux questions sur votre documentation et la rédaction technique

Pour commencer, ajoutez l’agent à votre espace de travail Slack et mentionnez‑le avec @mintlify dans un canal.

​

Ajouter l’agent à votre espace de travail Slack

Si le propriétaire de votre espace de travail Slack exige une approbation d’un administrateur pour installer des applications, demandez-lui d’approuver l’application Mintlify avant de la connecter.

1. Accédez à la page agent de votre Dashboard.
2. Cliquez sur le bouton Connect.
3. Suivez les instructions Slack pour ajouter l’application mintlify à votre espace de travail.
4. Suivez les instructions Slack pour lier votre compte Mintlify à votre espace de travail Slack.
5. Vérifiez que l’agent fonctionne et répond lorsque vous :
   • lui envoyez un message direct ;
   • le mentionnez avec @mintlify dans un canal.

​

Connecter des dépôts comme contexte

L’agent ne peut accéder qu’aux dépôts que vous connectez via la GitHub App de Mintlify. Modifiez les dépôts auxquels l’agent peut accéder dans les paramètres de la GitHub App.

​

Intégrer l’agent via l’API

Utilisez les points de terminaison de l’agent pour créer des tâches, récupérer une tâche spécifique et récupérer toutes les tâches.

​

Rédiger des prompts efficaces

Considérez l’agent comme un Assistant utile qui a besoin de vos indications pour accomplir des tâches. Donnez-lui des instructions claires et du contexte. Les tâches plus ciblées sont plus faciles à réaliser : décomposez donc les projets complexes en étapes plus petites.

Formulez des prompts spécifiques et orientés vers le résultat. Des prompts génériques comme @mintlify Improve the onboarding page appliquent des bonnes pratiques générales, mais peuvent ne pas améliorer le contenu de la manière précise que vous aviez en tête.

Essayez des prompts basés sur les résultats que vous souhaitez que vos utilisateurs atteignent ou sur les problèmes qu’ils rencontrent. Par exemple :

• @mintlify A lot of users have trouble installing the CLI. Review the onboarding page and update the docs so that users can easily install the CLI
• @mintlify Developers keep getting 401 errors when following our authentication guide. Review the auth docs and add clearer examples showing how to properly format the API key

Utilisez des prompts plus larges pour la maintenance générale du contenu, comme corriger les fautes de frappe, mettre à jour les redirections ou renommer une fonctionnalité dans l’ensemble de votre documentation. Par exemple :

• @mintlify Find and fix all typos in the docs
• @mintlify change all unordered lists to use * instead of -

​

Workflows de l’agent

L’agent prend en charge de nombreuses tâches liées à la documentation. Ces workflows illustrent différentes manières d’intégrer l’agent à votre processus de documentation. Adoptez une approche qui correspond au fonctionnement actuel de votre équipe et adaptez-la à vos besoins spécifiques.

​

Itérer sur une invite dans un fil Slack

Envoyez une invite à l’agent, puis continuez à le mentionner avec @mintlify dans le même fil pour affiner et itérer sur la pull request (demande de fusion) qu’il crée.

Par exemple : @mintlify Notre page de démarrage rapide a besoin d’une nouvelle section sur l’invitation de collaborateurs. Puis : @mintlify La nouvelle section devrait s’appeler "Inviter des collaborateurs". Suivi de toute autre itération.

​

Commencez avec l’agent, terminez manuellement

Demandez à l’agent de lancer un projet, puis basculez vers la branche qu’il crée et terminez la tâche dans votre environnement local ou dans l’éditeur web. L’agent peut vous aider à démarrer, puis vous pouvez prendre le relais pour finaliser la tâche.

Par exemple : @mintlify Update the quickstart page to include information about inviting collaborators puis basculez sur la branche pour apporter des modifications supplémentaires avec votre méthode préférée.

​

Mettre à jour la documentation lors de la fusion de changements de fonctionnalité

Lorsque vous fusionnez une pull request de fonctionnalité, partagez le lien de la PR avec l’agent pour mettre à jour la documentation concernée.

Par exemple : @mintlify Cette PR ajoute une nouvelle méthode d’authentification. Mettez à jour la doc pour inclure le nouveau flux d’authentification : [lien de la PR].

​

Générer des notes de version à partir d’une pull request (demande de fusion)

Demandez à l’agent, à partir d’une pull request précise, de générer des notes de version ou de mettre à jour le journal des modifications en se basant sur l’historique des commits.

Par exemple : @mintlify Generate release notes for this PR: [PR link].

​

Générer des exemples de code

Demandez à l’agent de générer des exemples de code pour des fonctionnalités dans l’ensemble de votre documentation ou sur des pages spécifiques.

Par exemple : @mintlify Génère un exemple de code pour rendre la méthode d’authentification plus facile à comprendre.

​

Passer en revue le contenu existant

Demandez à l’agent de vérifier le contenu existant pour en évaluer l’exactitude technique, le style, la grammaire ou d’autres problèmes.

Par exemple : @mintlify Review the API rate limiting section. We changed limits last month.

​

Répondre aux retours des utilisateurs

Transmettez à l’agent les retours de vos utilisateurs pour apporter des mises à jour ciblées à votre documentation.

Par exemple : @mintlify Les utilisateurs se perdent à l’étape 3 du guide d’installation. Qu’est-ce qui pourrait la rendre peu claire ?.

​

Automatiser avec l’API

Intégrez l’agent à vos outils d’automatisation existants pour mettre automatiquement à jour la documentation lors des modifications de code, déclencher des revues de contenu ou synchroniser les mises à jour de documentation entre plusieurs dépôts.