Améliorations automatiques de la documentation

Identifiez les pages incorrectes et obsolètes de votre documentation, examinez les résultats et corrigez-les automatiquement avec GitBook Agent

Cette fonctionnalité est actuellement en accès anticipé.

Nous déployons progressivement l’accès. Restez à l’écoute pour suivre l’avancement des fonctionnalités ci-dessous.

GitBook Agent peut identifier les problèmes dans votre documentation — comme des lacunes de contenu, des pages obsolètes et des informations incorrectes — et suggérer et mettre en œuvre des améliorations.

Que peut détecter GitBook Agent ?

• Lacunes de contenu se produisent lorsque GitBook voit des utilisateurs 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 pu trouver dans la documentation.
  • un point de terminaison d’API dont la documentation complète manque.
• Contenu obsolète est détecté lorsque le contenu de votre page a été remplacé par du contenu trouvé dans une source externe, comme :

  • une mise à jour du SDK qui a modifié la signature d’une fonction.
  • une fonctionnalité payante qui est passée dans l’offre gratuite, sans que la documentation ait été mise à jour.
• 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é retirée.
  • des sources externes, comme votre site web marketing, qui sont en désaccord avec la documentation.

Comment fonctionne l’identification

1

Connecter des sources

GitBook Agent fonctionne au mieux lorsqu’il est connecté à des sources externes comme votre système de tickets de support, des 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 nos connexions.

2

GitBook Agent génère des constats

GitBook examine régulièrement vos sources et génère des constats à partir des résultats. GitBook rassemble ces constats afin que votre équipe les examine. En savoir plus sur la manière dont nous ingérons les données.

3

Examinez vos constats

Passez en revue vos constats pour commencer à corriger les problèmes. Chaque constat comprend un résumé du problème, le sujet auquel il se rapporte, des preuves à l’appui et des liens vers les pages que GitBook a utilisées comme contexte.

4

Corriger ou archiver

Certains constats peuvent être corrigés automatiquement par GitBook Agent. Lorsque cette option est disponible, vous pouvez créer des demandes de modification directement depuis le constat. Vous pouvez également archiver les constats que vous ne souhaitez pas conserver dans votre liste active.

Pour demander l’accès aux fonctionnalités d’amélioration automatique de la documentation de GitBook Agent, ouvrez la section de votre site Paramètres.

Corrections automatiques

Lorsqu’un constat prend en charge les corrections automatiques, GitBook affiche un Créer une demande de modification action afin que GitBook Agent puisse générer une correction proposée que votre équipe pourra examiner. Pour ignorer la suggestion, archivez plutôt le constat. GitBook ne rouvrira pas les constats que vous avez archivés.