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

GitBook Agent suit votre guide de style

Vous pouvez ajoutez 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 plus large 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 précis

Comment interagir avec GitBook Agent

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

• Ouvrez l’Agent dans une demande de changement existante et dites-lui ce dont vous avez besoin

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

• Mentionner l’Agent dans un commentaire sur un bloc

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

Passons en revue chacune de ces possibilités pour voir comment elles fonctionnent.

Ouvrir la fenêtre de chat de GitBook Agent dans n’importe quelle demande de changement

Vous pouvez ouvrir la fenêtre de chat de l’Agent dans une demande de changement à 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 changement

Ici, vous pouvez գրել une invite à suivre par l’Agent — il expliquera ce qu’il fait au fur et à mesure qu’il suit vos instructions, avec les modifications apparaissant dans votre espace pendant son exécution.

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 changement 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 rédiger une invite pour dire à l’Agent ce que vous souhaitez inclure dans votre demande de changement, puis ajouter des pages de référence qui pourraient être utiles comme contexte pour les modifications.

Une fois que vous cliquez sur Démarrer la demande de changement l’Agent ouvrira une demande de changement 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.

Une fois terminé, vous pouvez modifier le contenu vous-même directement sur la page, ou donner à l’Agent d’autres instructions 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 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 en vous indiquant ce qu’il a fait.

Améliorer le contenu de la page avec GitBook Agent

La Améliorer menu vous propose un choix 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 Améliorer menu depuis l’éditeur en survolant le titre de la page, ou en ouvrant le menu d’actions .

Depuis le menu Améliorer, vous pouvez demander à 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 d’étapes suivantes

• Créer 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 contient déjà une icône et une description, vous ne verrez pas ces विकल्प dans le menu.

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

Rédigez-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 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 en bas d’un document détaillé, ou pour ajouter un bref résumé en haut pour les personnes qui viennent juste jeter un œil.

• 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 des personnes moins techniques.

• Traduire – Traduisez votre page actuelle dans l’une d’un certain nombre 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 qui excelle à suivre les directives. Vous devez lui donner des instructions claires et du contexte pour en obtenir les meilleurs résultats.

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

• Décomposez-le – L’Agent est plus performant lorsqu’il accomplit 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éliorer cette page appliqueront les bonnes pratiques générales, mais sans indications plus précises 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 rencontré par les clients, dites à l’Agent quels sont ces problèmes — ou les résultats que vous souhaitez obtenir. Il vous proposera des améliorations basées sur ces résultats.

• Donnez des instructions directes – Si vous voulez que l’Agent utilise un bloc de type stepper pour un guide étape par étape, ou ajoute une section FAQ avec un ensemble de blocs extensibles, dites-lui précisément quoi faire pour obtenir du premier coup les bons résultats.

• Utilisez 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 remplacer toutes les occurrences de v2.3.9 par v2.4.0.