Écrire avec l’Agent GitBook

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

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 petites sections de texte sur votre page à la modification de blocs existants et à la création de nouvelles pages, sections et plus encore dans une demande de modification.

GitBook Agent suit votre guide de style

Vous pouvez ajouter votre propre guide de style et des instructions personnalisées au niveau du site — ainsi, l’Agent correspondra toujours à votre ton et à votre style chaque fois que vous lui demanderez de vous aider.

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 global de votre espace.

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 spécifiques

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 indiquez-lui ce dont vous avez besoin

• Planifier et mettre en œuvre une nouvelle demande de modification avec GitBook Agent

• Taguer l’Agent dans un commentaire sur un bloc

• Créer du nouveau contenu sur une ligne vide de votre page

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

Ouvrir la fenêtre de discussion GitBook Agent dans n’importe quelle demande de modification

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

Ouvrir GitBook Agent dans une demande de modification

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

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

Mettre en œuvre une demande de modification avec GitBook Agent

Cliquez sur le GitBook Agent section du Modifier bouton en haut à droite d’un espace pour ouvrir une fenêtre modale.

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

Une fois que vous avez cliqué 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 discussion à droite de l’application.

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

Taguer GitBook Agent dans un commentaire

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

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

Améliorer le contenu de la page avec GitBook Agent

Le Améliorer menu vous propose des 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 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 indiquer à l’Agent de :

• Ajouter une icône à la page

• Générer une description de 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 des prochaines étapes

• Ajouter des liens vers des sujets et des pages connexes

• 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 comporte déjà une icône et une description, vous ne verrez pas ces choix dans le menu.

Sélectionnez 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 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 immédiatement à saisir n’importe quelle invite. GitBook Agent analysera l’invite et générera du contenu à partir de celle-ci. Par exemple :

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

Sinon, vous pouvez choisir l’une des invites suggérées ou l’un des débuts 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 indiquez à GitBook Agent ce que vous voulez qu’il explique. Cela n’est pas limité au contenu de votre page, donc vous pouvez 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 pour ajouter un bref résumé en haut pour les lecteurs qui ne font que jeter un coup d’œil.

• Explique ceci – Cela expliquera les informations complexes de votre page dans un langage plus simple — y compris les acronymes et autres termes techniques. 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 d’un nombre défini de langues. Si vous souhaitez traduire vers une langue qui ne figure pas dans la liste, saisissez-la simplement dans la zone d’invite.

Rédiger des invites efficaces pour GitBook Agent

GitBook Agent est comme un coéquipier très doué pour suivre des consignes. Vous devez lui donner des instructions claires et du contexte pour obtenir les meilleurs résultats.

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

• Décomposez la tâche – L’Agent est plus efficace pour accomplir des tâches ciblées. Décomposez les projets complexes en étapes plus petites et demandez à l’Agent de les réaliser une par une.

• Soyez précis – Les invites génériques comme @gitbook improve this page appliqueront les meilleures pratiques générales, mais sans consignes plus précises, l’Agent risque de ne pas atteindre l’objectif que vous aviez en tête.

• Concentrez-vous sur les résultats – Si vous entendez parler d’un problème spécifique rencontré par les clients, expliquez-le à l’Agent — ou indiquez les résultats que vous souhaitez obtenir. Il proposera des améliorations basées sur ces résultats.

• Donnez des instructions directes – Si vous voulez que l’Agent utilise un bloc stepper pour un guide étape par étape, ou ajoute une section FAQ avec plusieurs blocs dépliables, dites-lui précisément quoi faire pour obtenir le bon résultat dès la première fois.

• Utilisez des invites larges pour des améliorations plus globales – Pour des 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 replace all instances of v2.3.9 with v2.4.0.