Lacunes de contenu

Trouvez les questions auxquelles votre documentation ne répond pas, classées par gravité, et comblez-les avec GitBook Agent

Les lacunes de contenu sont en version bêta et disponibles avec le forfait de site Ultimate.

Les lacunes de contenu vous montrent ce que votre documentation ne répond pas. GitBook analyse les questions que les visiteurs posent dans votre documentation, ainsi que les tickets d’assistance, les e-mails, les forums et d’autres enregistrements provenant des sources que vous avez connectées. Une fois par jour, il compare ces questions à votre contenu, identifie celles auxquelles votre documentation ne répond pas et les classe par ordre de gravité.

À partir de n’importe quel écart, GitBook Agent peut ouvrir une demande de modification qui le comble.

Dans la barre latérale de votre site, allez à Améliorer → Écarts de contenu.

Quatre vignettes en haut indiquent combien d’écarts GitBook a trouvés, combien sont de gravité élevée, combien de demandes de changement ont été fusionnées à partir d’écarts, et quelle source contribue le plus.

Ce que GitBook détecte

GitBook signale quatre types de problème :

• Lacunes de contenu se produisent lorsque GitBook voit des clients poser des questions sur votre produit auxquelles la documentation a du mal à répondre, par exemple :

  • Un client posant une question à votre équipe de support qu’il n’a pas trouvée dans la documentation.
  • Un point de terminaison d’API dont la documentation est incomplète.
• Contenu obsolète est détecté lorsque le contenu de votre page a été remplacé par du contenu trouvé dans une source externe, par exemple :

  • Une mise à jour du SDK qui a modifié la signature d’une fonction.
  • Une fonctionnalité payante passée au niveau gratuit, sans mise à jour de la documentation.
• Contenu incorrect est signalé lorsque le contenu du site de documentation est manifestement erroné, par exemple :

  • Un guide renvoyant vers des API qui n’existent plus, ou dont la fonctionnalité a été abandonnée.
  • Des sources externes, comme votre site marketing, qui sont en désaccord avec la documentation.
• Autre couvre les problèmes qui ne correspondent pas aux catégories ci-dessus.

Fonctionnement

1

Connectez vos sources

GitBook trouve davantage d’écarts lorsqu’il peut comparer votre documentation aux endroits où vos clients posent déjà des questions — votre système de gestion des tickets de support, les forums publics ou votre site marketing. Certaines sources nécessitent une clé API supplémentaire ou une authentification avant la fin de la configuration. En savoir plus sur les connexions.

2

GitBook analyse chaque jour

GitBook examine vos sources une fois par jour et compare ce qu’il trouve à votre contenu publié. Chaque question à laquelle votre documentation ne répond pas devient un écart.

3

Examinez les écarts

Chaque lacune décrit le problème, les preuves qui le sous-tendent, et une recommandation pour le corriger. Triez par gravité pour trouver d’abord les lacunes qui valent la peine d’être corrigées.

4

Combler ou rejeter

Comblez un écart en créant une demande de modification à partir de celui-ci, ou rejetez celles sur lesquelles vous ne souhaitez pas agir. GitBook ne rouvrira pas une lacune que vous avez rejetée.

Filtrer la liste

Un site avec un vaste catalogue d’archives peut faire apparaître des milliers de lacunes d’un coup. Filtrez la liste pour trouver celles qui valent la peine d’être traitées :

Filtrer	Options	À utiliser pour
Statut	Ouvrez, Modifié, Rejeté, Résolue	Séparez les lacunes intactes de celles déjà couvertes par une demande de changement, des suggestions que votre équipe a rejetées, et de celles qu’une demande de changement fusionnée a déjà résolues.
Gravité	Élevée, Moyen, Faible	Traitez d’abord les lacunes à plus fort impact.
Date	7 derniers jours, 30 derniers jours	Voyez ce qu’une version récente ou un pic de support a fait ressortir.
Sujet	N’importe quel sujet sur votre site	Concentrez-vous sur une zone de votre documentation. Les sujets sont regroupés de la même manière que dans le rapport de l’Assistant IA.
Type	lacune de contenu, contenu obsolète, contenu incorrect, autre	Séparez la documentation manquante de la documentation qui a déraillé.
Source	N’importe quelle source connectée	Vérifiez ce qu’une source unique signale, comme les lacunes que seul Intercom voit.
Agent GitBook	Pris en charge, non pris en charge	Trouvez les lacunes dont personne ne s’est encore occupé.

Triez la liste filtrée par gravité pour faire remonter en tête les écarts les plus dommageables.

Rejeter une lacune indique que votre équipe a examiné la suggestion et a décidé de ne pas la retenir, ce qui la maintient hors de la liste ouverte sans masquer que la décision a été prise. Filtrer par Résolue pour trouver les lacunes qu’une demande de changement fusionnée a déjà résolues.

Examiner une lacune

L’examen d’un écart suit toujours le même parcours :

1. Sur la page Lacunes de contenu, filtrez la liste pour afficher les lacunes sur lesquelles vous souhaitez travailler.
2. Cliquez sur une lacune pour l’ouvrir.
3. Lisez le Problème, Preuves, et Recommandation pour juger si la lacune est réelle et mérite d’être comblée.
4. Ouvrez les enregistrements source liés pour vérifier vous-même les preuves.
5. Cliquez sur Créer des demandes de changement, ou Rejeter si la lacune ne mérite pas d’être comblée.
6. Examinez la demande de changement que GitBook Agent rédige, puis fusionnez-la.

Ce qu’une lacune montre

Un écart s’ouvre avec son nom, son statut, sa gravité, son type et son sujet. Le statut est une liste déroulante, donc vous pouvez le modifier sans quitter l’écart. En dessous, un Motivation section présente le cas en trois parties :

• Problème indique ce que la documentation n’explique pas, et ce qui arrive à un lecteur en conséquence.
• Preuves présente ce que GitBook a trouvé : quelles pages couvrent aujourd’hui le sujet, ce qu’elles omettent, et ce que montrent les enregistrements source que les gens demandent.
• Recommandation propose quoi écrire et où l’ajouter, y compris les pages depuis lesquelles le lier.

Sous la motivation, GitBook liste les enregistrements source sur lesquels repose le constat — les conversations d’assistance, discussions ou pages individuelles, chacune liée afin que vous puissiez ouvrir l’original et le lire intégralement.

Les enregistrements source n’apparaissent que pour les sources que vous avez connectées. Une lacune issue de conversations d’assistance n’affiche ces conversations que si cette plateforme d’assistance est connectée. Voir Connexions pour en configurer une.

Créer une demande de changement à partir d’une lacune

Lorsqu’une lacune peut être corrigée automatiquement, une bannière indique que le constat peut être résolu dans des demandes de changement, et propose deux actions.

Cliquez sur Créer des demandes de changement pour confier la lacune à GitBook Agent. L’Agent lit le constat et les pages qu’il nomme, puis rédige la modification. Une seule lacune peut produire plus d’une demande de changement lorsque la correction s’étend sur plusieurs pages.

L’écran affiche la progression pendant que l’Agent travaille, puis répertorie ce qu’il a produit avec un lien pour examiner chacun. À partir de là, elles se comportent comme n’importe quelles autres demande de modification — vous voyez exactement quel contenu a changé, et vos règles habituelles de révision et de fusion s’appliquent. Voir Examiner les demandes de modification avec GitBook Agent pour savoir comment Agent peut aider à l’examiner.

La fusion de la demande de changement résout la lacune et la retire de la file d’attente. Filtrer par Résolue pour la retrouver.

Rejeter une lacune

Cliquez sur Rejeter lorsqu’une lacune ne mérite pas d’être comblée — la question est hors sujet, la page y répond déjà, ou le constat a mal interprété les preuves. Rejeter maintient la lacune hors de la liste ouverte, et GitBook ne la rouvrira pas.

Modifier le statut d’une lacune, y compris la rejeter, nécessite des autorisations de modification sur le site. Les actions que vous ne pouvez pas utiliser apparaissent grisées, avec une explication.

Travaillez sur les lacunes depuis votre propre agent

Tout ce qui se trouve sur la page Lacunes de contenu est également disponible via le API GitBook et le serveur MCP GitBook, afin que votre propre agent ou script puisse traiter les lacunes en dehors de l’application GitBook. Votre agent ou script peut effectuer les actions suivantes :

• Lister les lacunes d’un site et lire les éléments de preuve derrière chacune : les enregistrements sources, les questions de l’Assistant IA et les pages concernées.
• Résoudre, rejeter ou rouvrir une lacune.
• Demandez à GitBook Agent de corriger une lacune en générant une demande de modification, comme Créer des demandes de changement le fait dans l’application.
• Liez à la lacune qu’elle corrige une demande de modification que vous avez rédigée vous-même, en définissant son siteFindingId. Lorsque toutes les demandes de modification liées à la lacune sont fusionnées, la lacune est résolue.

Paramètres

Sur la page Lacunes de contenu, cliquez sur Paramètres pour voir quelles sources GitBook analyse et ce que chacune apporte.

Sources

La Sources la liste affiche chaque connexion en cours d’ingestion, ce qu’elle a analysé et combien de lacunes en proviennent. Chaque source indique ses propres unités : pages pour un site web, vidéos pour une chaîne YouTube, discussions pour GitHub Discussions et conversations pour une plateforme de support.

Votre documentation est une source à part entière. Assistant IA indique à la fois les questions sans réponse que les visiteurs ont posées sur votre site et les lacunes qui en ont découlé. Consultez le Assistant IA rapport pour examiner ces questions dans leur intégralité.

Chaque source apparaît sous l’étiquette que vous avez donnée à la connexion, donc deux connexions de site web s’affichent séparément plutôt que d’être fusionnées en une seule entrée.

Cliquez sur Afficher les écarts de contenu sur n’importe quelle source pour filtrer la liste sur les lacunes de cette source.

Connexions

La Connexions section montre les sources que vous n’avez pas encore connectées, comme Zendesk, Freshdesk, Front, HubSpot, Zoho Desk, Pylon, GitHub Issues et un serveur MCP.

Cliquez sur Gérer les connexions pour ouvrir la page Connexions, où vous ajoutez une source, vérifiez l’état de synchronisation et les nombres d’enregistrements, définissez le classement de recherche et parcourez les enregistrements individuels ingérés par GitBook. Voir Connexions pour savoir ce qu’indexe chaque connecteur et comment en configurer un.