Suggestions automatiques de documentation

Découvrez comment GitBook Agent fonctionne en arrière-plan pour maintenir votre documentation à jour

Cette fonctionnalité est actuellement en accès anticipé

Nous testons actuellement cette fonctionnalité avec un petit nombre d’équipes pendant que nous la développons davantage. Rendez-vous dans Paramètres de l’organisation → GitBook Agent pour demander l’accès.

GitBook Agent peut se connecter aux mêmes signaux que votre équipe utilise pour comprendre à la fois votre produit et ce dont vos utilisateurs ont besoin : conversations de support, fils Slack, problèmes GitHub, et plus encore.

Avec ce contexte, l’Agent peut identifier de manière proactive les lacunes, proposer des mises à jour et générer automatiquement des modifications de documentation.

GitBook Agent est entraîné sur le contenu de votre organisation, ce qui signifie qu’il connaît le style d’écriture, la structure et le ton de votre équipe. Et vous pouvez ajouter des instructions personnalisées que l’Agent doit suivre — plus d’informations ci‑dessous.

1

Connecter une source

Pour permettre à GitBook Agent de proposer des améliorations automatiques de la documentation, vous devez d’abord connecter une source.

Après avoir connecté une ou plusieurs sources, l’Agent commencera à travailler en arrière‑plan pour collecter et analyser vos données.

2

Découvrez comment GitBook Agent analyse vos données

Après la connexion d’une source, GitBook Agent catégorisera ces informations contextuelles en conversations, problèmes et sujets.

Il utilise ces éléments en combinaison pour suggérer des améliorations automatiques de vos docs, qui sont ouvertes sous forme de demandes de modification.

Pour examiner les données analysées par GitBook Agent, rendez‑vous dans les paramètres de votre organisation, puis ouvrez l’onglet Explorateur de données tab dans le GitBook Agent section.

3

Examiner les demandes de modification effectuées par GitBook Agent

Au fur et à mesure que davantage de données arrivent, GitBook Agent disposera d’un contexte suffisant pour commencer à faire des suggestions — en ouvrant de nouvelles demandes de modification dans les espaces concernés.

Vous pouvez modifier les demandes de modification ouvertes par GitBook Agent comme n’importe quelle autre demande — et toute personne de votre équipe peut les examiner, à condition d’avoir les autorisations.

Vous pouvez également demander une revue à GitBook Agent pour qu’il analyse les modifications qu’il a suggérées.

4

Collaborer avec GitBook Agent sur les modifications

GitBook Agent peut également agir en tant que partenaire d’écriture, vous permettant de planifier, rédiger, réécrire ou mettre à jour n’importe quel élément dans une demande de modification.

Lors de la révision d’une demande de modification depuis l’écran des demandes de modification, ouvrir GitBook Agent vous permettra de discuter directement avec lui pour effectuer des modifications dans le contexte de la demande sur laquelle vous travaillez.

Vous pouvez aussi ajouter des commentaires à des blocs spécifiques, et identifier @gitbook pour demander à GitBook Agent d’apporter une modification.

Ajouter ou supprimer des sites publiés que GitBook Agent peut modifier

Par défaut, GitBook Agent aura accès pour créer des demandes de modification dans n’importe lequel de vos sites de documentation publiés. Dans l’écran des paramètres de GitBook Agent, vous pouvez choisir les sites sur lesquels vous souhaitez que l’Agent propose des modifications.

Ajouter des instructions personnalisées pour GitBook Agent

Pour ajouter des instructions personnalisées pour GitBook Agent à suivre, ouvrez les paramètres de votre organisation et choisissez la GitBook Agent page dans la barre latérale.

À partir d’ici, vous pouvez rédiger des instructions personnalisées que l’Agent utilisera chaque fois qu’il prépare, analyse et génère des demandes de modification pour vos sites de documentation.