Rédiger avec GitBook Agent

Utilisez GitBook Agent pour générer et créer du contenu pour votre page

Cette fonctionnalité est disponible sur Offres Pro et Entreprise.

GitBook Agent est un outil puissant pour générer du contenu pour votre documentation dans GitBook.

L’Agent peut tout faire, de la rédaction de courts passages de texte sur votre page à la modification des blocs existants et à la création de nouvelles pages, et bien plus encore, dans une demande de modification.

GitBook Agent suit votre guide de style

Définissez les règles de rédaction de votre équipe dans un guide de style, et l’Agent le considère comme la source de vérité chaque fois que vous lui demandez de vous aider. Il charge la première page de votre guide de style dans le contexte pour chaque tâche, alors gardez-y vos règles principales.

Vous pouvez aussi ajouter de courtes instructions personnalisées au niveau du site.

Que peut faire GitBook Agent ?

GitBook Agent est profondément intégré à l’application GitBook, il comprend donc les blocs que vous pouvez créer dans l’éditeur, ainsi que le contenu plus large de votre section.

Cela signifie que vous pouvez utiliser l’Agent pour :

• Rédiger du nouveau contenu à partir de vos invites
• Rechercher dans les pages existantes et mettre à jour un contenu spécifique
• Reformater le contenu pour tirer le meilleur parti des différents blocs de GitBook
• Mettre à jour des exemples de code
• Déplacer du contenu entre les pages
• Ajouter de nouvelles pages à des emplacements précis

Comment interagir avec GitBook Agent

Il existe plusieurs façons de travailler avec GitBook Agent :

• Ouvrez l’Agent dans une demande de modification existante et dites-lui ce dont vous avez besoin
• Planifiez et mettez en œuvre une nouvelle demande de modification avec GitBook Agent
• Mentionnez l’Agent dans un commentaire sur un bloc
• Créez du nouveau contenu sur une ligne vide de votre page

Passons en revue chacun de ces cas pour voir comment ils fonctionnent.

Ouvrez la fenêtre de chat de GitBook Agent dans n’importe quelle demande de modification

Vous pouvez ouvrir la fenêtre de chat de l’Agent dans une demande de modification à tout moment en cliquant sur le bouton GitBook Agent dans la barre d’en-tête de la section. Cela ouvrira la fenêtre de chat de l’Agent à droite de l’application.

Ouvrez GitBook Agent dans une demande de modification

Ici, vous pouvez rédiger une invite que l’Agent suivra — il expliquera ce qu’il fait au fur et à mesure qu’il suit vos instructions, les modifications apparaissant dans votre section pendant son travail.

Vous pouvez donner des instructions de suivi ou clarifier les étapes, ou modifier directement le contenu de votre section à tout moment, ce qui vous permet de travailler aux côtés de GitBook Agent.

Mettez en œuvre une demande de modification avec GitBook Agent

Cliquez sur le bouton GitBook Agent partie de la Modifier bouton en haut à droite d’une section pour ouvrir une fenêtre modale.

Ici, vous pouvez rédiger une invite pour indiquer à l’Agent ce que vous souhaitez inclure dans votre demande de modification, puis ajouter des pages de référence susceptibles d’être utiles comme contexte pour les changements.

Une fois que vous cliquez sur Démarrer la demande de modification l’Agent ouvrira une demande de modification pour vous et commencera à exécuter vos instructions. À chaque étape, l’Agent vous indiquera ce qu’il fait dans la fenêtre de chat sur le côté droit de l’application.

Une fois terminé, vous pouvez modifier vous-même directement le contenu sur la page, ou donner à l’Agent d’autres instructions pour continuer à affiner vos modifications.

Mentionnez GitBook Agent dans un commentaire

Si vous voulez que l’Agent examine un bloc spécifique sur votre page, vous pouvez le mentionner dans un commentaire et lui dire ce dont vous avez besoin. Cliquez simplement sur Commenter sur le bloc et mentionnez @gitbook pour taguer l’Agent, puis dites-lui ce que vous voulez qu’il fasse.

GitBook Agent mettra à jour le contenu en fonction de votre invite, puis répondra à votre commentaire pour vous dire ce qu’il a fait.

Améliorez le contenu de la page avec GitBook Agent

Le menu Améliorer vous propose une sélection de préréglages qui indiquent à GitBook Agent d’effectuer des actions courantes pour améliorer le contenu de votre page.

Vous pouvez accéder au menu Améliorer menu depuis l’éditeur en survolant le titre de la page, ou en ouvrant le menu Actions .

Depuis le menu Améliorer, vous pouvez demander à l’Agent de :

• Ajouter une icône pour la page
• Générer une description de la page à partir de son contenu
• Corriger l’orthographe et la grammaire
• Réécrire pour assurer la cohérence avec les autres pages
• Optimiser pour le SEO
• Ajouter une section de résumé et d’étapes suivantes
• Lier des sujets et des pages associés
• Diviser la page unique en plusieurs pages

Les deux premières options sont conditionnelles — elles changent en fonction du contenu de votre page. Donc si votre page a déjà une icône et une description, vous ne verrez pas ces choix dans le menu.

Cliquez sur n’importe quelle option et l’Agent se mettra immédiatement au travail sur votre tâche.

Créer du nouveau contenu dans un bloc vide

Vous pouvez utiliser GitBook Agent pour créer du contenu sur n’importe quelle ligne vide de votre page. Il peut créer toutes sortes de contenu — mis en forme en Markdown — y compris des exemples de code, des modèles, des résumés de page et bien plus encore.

Appuyez sur Espace sur n’importe quelle ligne vide, ou tapez / et choisissez Écrire avec l’IA pour lancer GitBook Agent.

Vous pouvez commencer à taper instantanément n’importe quelle invite de votre choix. GitBook Agent analysera l’invite et générera du contenu en fonction de celle-ci. Par exemple :

Rédigez-moi un aperçu de deux paragraphes expliquant pourquoi la documentation est importante pour les équipes produit.

Vous pouvez aussi choisir parmi l’une des invites suggérées ou des amorces d’invite :

• Continuer à écrire – GitBook Agent analysera le contenu de votre page actuelle puis générera davantage de contenu à partir de celui-ci.
• Expliquer… – Choisissez cette option, puis dites à GitBook Agent ce que vous voulez qu’il explique. Cela n’est pas limité par le contenu de votre page, vous pouvez donc lui demander d’expliquer n’importe quoi.
• Résumer – Résume tout le contenu de votre page. C’est idéal pour rédiger un TL;DR au bas d’un document détaillé, ou ajouter un résumé rapide en haut pour les personnes qui ne font qu’un passage.
• Expliquer ceci – Cela expliquera les informations complexes de votre page dans un langage plus simple — y compris les acronymes et autres jargon. C’est parfait si la page que vous lisez contient beaucoup d’informations complexes, ou si vous souhaitez ajouter une explication pour les personnes moins techniques.
• Traduire – Traduisez votre page actuelle dans l’une des langues disponibles. Si vous souhaitez traduire dans une langue qui ne figure pas dans la liste, tapez-la simplement dans la zone d’invite.

Rédiger des invites efficaces pour GitBook Agent

GitBook Agent est comme un coéquipier qui excelle à suivre les directives. Vous devez lui donner des instructions et un contexte clairs pour obtenir les meilleurs résultats.

Voici quelques conseils rapides pour rédiger de bonnes invites :

• Décomposer – L’Agent est particulièrement efficace pour mener à bien des tâches ciblées. Décomposez les projets complexes en étapes plus petites et demandez à l’Agent de les accomplir une par une.
• Être précis – Les invites génériques comme @gitbook améliore cette page appliqueront les bonnes pratiques générales, mais sans conseils plus spécifiques, l’Agent risque de ne pas atteindre l’objectif que vous aviez en tête.
• Se concentrer sur les résultats – Si vous entendez parler d’un problème spécifique rencontré par des clients, parlez-en à l’Agent — ou décrivez les résultats que vous souhaitez obtenir. Il vous proposera des améliorations basées sur ces résultats.
• Donner des instructions directes – Si vous voulez que l’Agent utilise un bloc d’étapes pour un guide étape par étape, ou ajoute une section FAQ avec plusieurs blocs extensibles, dites-lui précisément quoi faire pour obtenir du premier coup les bons résultats.
• Utiliser des invites larges pour des améliorations plus globales – Pour les tâches de maintenance comme corriger des fautes de frappe, mettre à jour le nom d’une fonctionnalité sur plusieurs pages ou supprimer des types de blocs spécifiques de votre documentation, vous pouvez utiliser des commandes comme @gitbook remplace toutes les occurrences de v2.3.9 par v2.4.0.