Rédaction avec GitBook Agent

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

This feature is available on Pro and Enterprise plans.

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

L’Agent peut tout faire, depuis écrire de petites sections de texte sur votre page jusqu’à modifier des blocs existants et créer 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 de l’organisation — ainsi l’Agent respectera toujours votre ton et votre style chaque fois que vous lui demanderez de l’aide.

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 espace.

Cela signifie que vous pouvez utiliser l’Agent pour :

• Rédiger du nouveau contenu en fonction de vos instructions

• Rechercher dans les pages existantes et mettre à jour un contenu spécifique

• Reformater le contenu pour tirer parti des différents blocs de GitBook

• Mettre à jour les exemples de code

• Déplacer le 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 :

• Ouvrir l’Agent dans une demande de modification existante et lui dire ce dont vous avez besoin

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

• Mentionner l’Agent dans un commentaire sur un bloc

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

Parcourons chacune de ces méthodes pour voir comment elles fonctionnent.

Ouvrir la fenêtre de chat GitBook Agent dans une 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 l’espace. Cela ouvrira la fenêtre de chat de l’Agent à droite de l’application.

Ouvrir GitBook Agent dans une demande de modification

Ici vous pouvez écrire une invite pour que l’Agent la suive — il expliquera ce qu’il fait pendant qu’il suit vos instructions, les modifications apparaissant dans votre espace au fur et à mesure de son travail.

Vous pouvez donner des instructions complémentaires 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 la bouton GitBook Agent section du bouton Modifier en haut à droite d’un espace pour ouvrir une fenêtre modale.

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

Une fois que vous cliquez sur Commencer la demande de modification l’Agent ouvrira une demande de modification pour vous et commencera à exécuter vos instructions. À chaque étape, l’Agent vous dira ce qu’il fait dans la fenêtre de chat à droite de l’application.

Lorsqu’il aura terminé, vous pourrez modifier le contenu vous-même directement sur la page, ou donner davantage d’instructions à l’Agent pour continuer à affiner vos modifications.

Mentionner 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 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 en vous indiquant ce qu’il a fait.

Améliorer le contenu de la page avec GitBook Agent

Le menu Améliorer vous propose un choix de préréglages qui indiquent à GitBook Agent d’exécuter 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 page basée sur son contenu

• Corriger l’orthographe et la grammaire

• Réécrire pour assurer la cohérence avec les autres pages

• Optimiser pour le référencement (SEO)

• Ajouter une section Résumé et étapes suivantes

• Lier aux sujets et 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 a 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 — formaté en Markdown — y compris des exemples de code, des modèles, des résumés de page et plus encore.

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

Vous pouvez immédiatement commencer à taper n’importe quelle invite que vous souhaitez. GitBook Agent analysera l’invite et générera du contenu en conséquence. Par exemple :

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

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

• Continuer l’écriture – GitBook Agent analysera le contenu de votre page actuelle puis générera davantage de contenu basé sur celui-ci.

• Expliquer… – Choisissez ceci, 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ésumez tout le contenu de votre page. C’est idéal pour écrire un TL;DR en bas d’un document détaillé, ou ajouter un bref résumé en haut pour les personnes qui consultent rapidement.

• Expliquer ceci – Ceci expliquera les informations complexes de votre page dans un langage plus simple — y compris en expliquant 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 des non-spécialistes.

• Traduire – Traduisez votre page actuelle dans l’une des langues proposées. Si vous souhaitez traduire dans une langue qui n’est pas dans la liste, tapez simplement son nom dans la zone d’invite.

Rédiger des invites efficaces pour GitBook Agent

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

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

• Décomposer – 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 améliore cette page appliqueront des bonnes pratiques générales, mais sans indications plus spécifiques l’Agent pourrait 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, dites-le à l’Agent — ou indiquez les résultats que vous souhaitez obtenir. Il proposera des améliorations basées sur ces résultats.

• Donner des instructions directes – Si vous voulez que l’Agent utilise un bloc pas à pas pour un guide étape par étape, ou ajoute une section FAQ avec plusieurs blocs extensibles, dites-lui précisément quoi faire pour obtenir les bons résultats dès la première fois.

• Utiliser des invites larges pour des améliorations générales – Pour des tâches de maintenance comme corriger des fautes de frappe, mettre à jour un nom de fonctionnalité sur plusieurs pages ou supprimer des types de blocs spécifiques de votre documentation, vous pouvez utiliser des commandes comme @gitbook remplacer toutes les occurrences de v2.3.9 par v2.4.0.