mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
locadex-agent[bot]
d7096d55cd
Co-authored-by: locadex-agent[bot] <217277504+locadex-agent[bot]@users.noreply.github.com>
75 lines
4.6 KiB
Plaintext
75 lines
4.6 KiB
Plaintext
---
|
||
title: "Workflows"
|
||
description: "Exemples d’utilisation de l’agent dans votre processus de documentation."
|
||
keywords: ["workflows d’agent", "workflows de documentation", "exemples d’automatisation"]
|
||
---
|
||
|
||
L’agent peut vous aider dans de nombreuses tâches de documentation. Ces workflows présentent plusieurs façons d’intégrer l’agent à votre processus de documentation. Choisissez une approche qui correspond à la façon dont votre équipe travaille actuellement, puis adaptez-la à vos besoins spécifiques.
|
||
|
||
<div id="iterate-on-a-prompt-in-a-slack-thread">
|
||
## Itérer sur un prompt dans un fil Slack
|
||
</div>
|
||
|
||
Envoyez un prompt à 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"`. Et ainsi de suite pour les autres itérations.
|
||
|
||
<div id="start-with-the-agent-finish-manually">
|
||
## Commencer avec l’agent, terminer manuellement
|
||
</div>
|
||
|
||
Demandez à l’agent de démarrer 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 web. L’agent peut vous aider à démarrer, puis vous prenez le relais pour terminer la tâche.
|
||
|
||
Par exemple : `@mintlify Update the quickstart page to include information about inviting collaborators` puis basculez sur la branche pour apporter toutes les modifications supplémentaires avec la méthode de votre choix.
|
||
|
||
<div id="update-docs-when-merging-feature-changes">
|
||
## Mettre à jour la documentation lors de la fusion de modifications de fonctionnalités
|
||
</div>
|
||
|
||
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 concernée.
|
||
|
||
Par exemple : `@mintlify This PR adds a new authentication method. Update the docs to include the new auth flow: [PR link]`.
|
||
|
||
<div id="generate-release-notes-from-a-pull-request">
|
||
## Générer des notes de version à partir d'une pull request
|
||
</div>
|
||
|
||
Fournissez à l'agent une pull request (demande de fusion) 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]`.
|
||
|
||
<div id="generate-code-examples">
|
||
## Générer des exemples de code
|
||
</div>
|
||
|
||
Demandez à l’agent de générer des exemples de code pour des fonctionnalités présentes dans l’ensemble de votre documentation ou sur des pages spécifiques.
|
||
|
||
Par exemple : `@mintlify Generate a code example to make the authentication method easier to understand`.
|
||
|
||
<div id="review-existing-content">
|
||
## Passer en revue le contenu existant
|
||
</div>
|
||
|
||
Demandez à l'agent de passer en revue le contenu existant pour vérifier l'exactitude technique, le style, la grammaire ou d'autres aspects.
|
||
|
||
Par exemple : `@mintlify Review the API rate limiting section. We changed limits last month`.
|
||
|
||
<div id="respond-to-user-feedback">
|
||
## Répondre aux retours des utilisateurs
|
||
</div>
|
||
|
||
Fournissez à l’agent les retours de vos utilisateurs pour qu’il puisse mettre à jour votre documentation de manière ciblée.
|
||
|
||
Par exemple : `@mintlify Users are getting confused by step 3 in the setup guide. What might be making it unclear?`.
|
||
|
||
<div id="automate-with-the-api">
|
||
## Automatiser avec l'API
|
||
</div>
|
||
|
||
Intégrez l'agent dans 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 entre plusieurs dépôts.
|
||
|
||
Utilisez les endpoints de l'agent pour [créer des tâches](/fr/api-reference/agent/create-agent-job), [récupérer une tâche spécifique](/fr/api-reference/agent/get-agent-job) et [récupérer toutes les tâches](/fr/api-reference/agent/get-all-jobs).
|
||
|
||
Lors de la création de tâches via l'API, vous pouvez contrôler si les pull requests s'ouvrent en mode brouillon à l'aide du paramètre `asDraft` (dont la valeur par défaut est `true`). Définissez `asDraft: false` pour créer des pull requests non brouillon, prêtes pour une revue et une fusion immédiates 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é](/fr/guides/automate-agent). |