Skip to main content
L’agent vous aide dans de nombreuses tâches liées à la documentation. Ces exemples illustrent plusieurs façons d’intégrer l’agent à votre processus de documentation. Essayez une approche qui corresponde à la façon dont votre équipe travaille aujourd’hui, puis adaptez-la à vos besoins spécifiques.

​
Itérer sur un prompt dans un fil Slack

Envoyez un prompt à l’agent, puis continuez à le mentionner avec @mintlify dans le même fil pour affiner et faire évoluer la pull request (demande de fusion) qu’il crée. Par exemple : @mintlify Our quickstart page needs a new section on inviting collaborators. Puis : @mintlify The new section should be called "Inviting collaborators". Puis toute autre itération nécessaire.

​
Commencez avec l’agent, terminez manuellement

Demandez à l’agent de lancer un projet, puis récupérez la branche qu’il crée et terminez la tâche dans votre environnement local ou dans l’éditeur en ligne. L’agent peut vous aider à démarrer, puis vous pouvez prendre le relais pour la mener à bien. Par exemple : @mintlify Update the quickstart page to include information about inviting collaborators puis récupérez la branche pour effectuer des modifications supplémentaires par la méthode de votre choix.

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

Lorsque vous fusionnez une pull request (demande de fusion) de fonctionnalité, partagez le lien de la PR avec l’agent pour mettre à jour la documentation correspondante. Par exemple : @mintlify This PR adds a new authentication method. Update the docs to include the new auth flow: [PR link].

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

Indiquez à l’agent une pull request spécifique pour générer des notes de version ou des mises à jour du journal des modifications à partir de l’historique des commits. Par exemple : @mintlify Generate release notes for this PR: [PR link].

​
Traiter les retours de revue de pull request

Partagez le lien de la pull request avec l’agent pour traiter les commentaires des reviewers et les retours de revue de code sur les pull requests de documentation. Par exemple : @mintlify Address the review comments on 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 toute votre documentation ou sur des pages spécifiques. Par exemple : @mintlify Generate a code example to make the authentication method easier to understand.

​
Ajouter des images ou des fichiers à votre documentation

Joignez des fichiers ou des images directement à votre message Slack lorsque vous envoyez une demande à l’agent. L’agent traite la pièce jointe et l’ajoute à la documentation. Par exemple : @mintlify Add this diagram to the architecture overview page avec l’image jointe au message.

​
Passer en revue le contenu existant

Demandez à l’agent de passer en revue le contenu existant pour vérifier l’exactitude technique, le style, la grammaire ou d’autres problèmes éventuels. Par exemple : @mintlify Review the API rate limiting section. We changed limits last month.

​
Répondre aux retours des utilisateurs

Soumettez à l’agent les retours de vos utilisateurs pour apporter des mises à jour ciblées à votre documentation. Par exemple : @mintlify Users are getting confused by step 3 in the setup guide. What might be making it unclear?.

​
Automatisez avec des workflows

Créez des workflows pour automatiser les tâches récurrentes ainsi que la maintenance réactive, comme la rédaction de journaux des modifications ou la mise à jour du contenu lorsque de nouvelles fonctionnalités sont ajoutées à votre produit. Consultez la page Workflows pour plus d’informations.

​
Automatiser avec l’API

Intégrez l’agent à vos outils d’automatisation existants pour mettre automatiquement à jour la documentation lorsque le code change, déclencher des revues de contenu ou synchroniser les mises à jour de la documentation sur plusieurs dépôts. Utilisez les endpoints de l’agent pour créer des jobs, récupérer un job spécifique et récupérer tous les jobs. Lors de la création de jobs via l’API, vous pouvez contrôler si les pull requests (demandes de fusion) s’ouvrent en mode brouillon à l’aide du paramètre asDraft (valeur par défaut : false). Définissez asDraft: true pour créer des pull requests en mode brouillon, ou conservez la valeur par défaut pour créer des pull requests prêtes pour une revue immédiate et une fusion dans des workflows automatisés. Découvrez comment configurer l’automatisation via l’API dans le tutoriel Mettre automatiquement à jour la documentation lorsque le code est fusionné.