Rédaction avec GitBook Agent

Utilisez GitBook Agent 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, depuis rédiger 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 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 et 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 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 :

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

• Planifier et exécuter 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

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

Ouvrir la fenêtre de chat 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 appuyant sur le Agent GitBook bouton 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 que l’Agent devra suivre — 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 le Agent GitBook section du Modifier bouton en haut à droite d’un espace pour ouvrir une fenêtre modale.

Ici vous pouvez écrire une invite pour dire à l’Agent ce que vous voulez que votre demande de modification inclue, 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 à l’Agent d’autres instructions pour continuer à affiner vos modifications.

Taguer GitBook Agent dans un commentaire

Si vous voulez que l’Agent examine un bloc spécifique de votre page, vous pouvez le taguer dans un commentaire et lui dire ce dont vous avez besoin. Cliquez simplement sur Commenter le bloc et taguez @gitbook pour identifier 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 disant ce qu’il a fait.

Créer du nouveau contenu dans un bloc vide

This feature is available on Pro and Enterprise plans.

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.

Rédigez avec GitBook AI.

Appuyez sur Espace sur n’importe quelle ligne vide, ou tapez / de la carte et choisissez Rédiger avec l’IA pour lancer GitBook Agent.

Vous pouvez commencer instantanément à taper n’importe quelle invite que vous voulez. GitBook Agent analysera l’invite et générera du contenu basé dessus. Par exemple :

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

Alternativement, vous pouvez choisir 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 basé sur celui-ci.

• Expliquer… – Choisissez ceci, puis dites à GitBook Agent ce que vous voulez qu’il explique. Cela n’est pas limité au contenu de votre page, vous pouvez donc lui demander d’expliquer n’importe quoi.

• Résumer – Résumer 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 effectuent une vérification rapide.

• Expliquer ceci – Cela 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 personnes moins techniques.

• Traduire – Traduisez votre page actuelle dans l’une des langues proposées. Si vous souhaitez traduire dans une langue qui n’est pas sur 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 excellent 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-le – L’Agent est le plus performant pour accomplir des tâches ciblées. Décomposez les projets complexes en étapes plus petites et demandez à l’Agent de les accomplir une par une.

• Soyez spécifique – Des invites génériques comme @gitbook améliorez cette page appliqueront des bonnes pratiques générales, mais sans directives plus spécifiques l’Agent peut 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 que rencontrent les clients, dites à l’Agent quels sont ces problèmes — ou les résultats que vous voulez 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 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.

• Utilisez des invites larges pour des améliorations générales – 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 telles que @gitbook remplacez toutes les occurrences de v2.3.9 par v2.4.0.