Documentation Docsbook : publier, être cité, mesurer
Docsbook publie du Markdown provenant d’un dépôt GitHub, d’une analyse de site web ou d’un brief rédigé sous forme de site de documentation que les utilisateurs et les assistants IA peuvent consulter. Cet index est organisé selon la tâche que vous effectuez, et non selon le menu utilisé par le panneau d’administration : choisissez la tâche, puis le guide.
Chaque page consacrée à une fonctionnalité suit une règle : elle indique ce que vous obtenez, comment cela est construit avec suffisamment de détails techniques pour prévoir le résultat, les preuves avec un lien vers une source primaire, et ce qui n’est pas démontré. Si nous ne pouvons pas sourcer une affirmation, la page le précise au lieu de la supprimer — consultez comment nous le prouvons.
Vous découvrez Docsbook ? Publiez votre premier site avec le guide de démarrage rapide → — cela prend environ 5 minutes, aucune expérience préalable de GitHub n’est nécessaire. Vous souhaitez d’abord comprendre le modèle ? Lisez la présentation.
Ce que Docsbook fait avec votre dépôt et ce que cela coûte
Publier un site de documentation, de la source à l’URL publique
Espace de travail, équilibre du projet, indexation et autres termes
Les tâches pour lesquelles les équipes font appel à la documentation
La règle de preuve suivie par chaque page consacrée à une fonctionnalité
Étape par étape, aucune expérience préalable de GitHub n’est nécessaire
Paramètres, réindexation et personnes autorisées à consulter le site
Un lien « Modifier sur GitHub » sur chaque page, et lorsque la synchronisation avec le dépôt est configurée
Les dossiers et fichiers qui deviennent des pages
Un seul CNAME, SSL provisionné automatiquement
Mot de passe partagé ou votre propre fournisseur d’identité SSO
Nom, icône, couleur d’accentuation, polices
Modes clair, sombre et paramètres système par défaut
Ce que Docsbook génère pour les moteurs de recherche sans aucune configuration de votre part
Titre, description, URL canonique, hreflang, cartes, robots et sitemap, dans l’ordre de résolution
Comment une modification atteint l’index et ce qui la conditionne réellement
Ce que Docsbook ajoute pour que Perplexity, ChatGPT Search et les aperçus IA puissent vous citer
Les règles qui rendent un passage citable, et ce qui a été mesuré comme inefficace
Un index en texte brut de votre documentation pour les clients IA, et ceux qui le lisent vraiment
Ce dont un moteur de réponses a besoin sur une page, et ce que Docsbook génère
Le JSON-LD généré par Docsbook, ce qui le déclenche et ce que Google affiche encore
Les règles appliquées par Docsbook, chacune accompagnée de son effet sur un agent de réponse
Une documentation qu’un agent peut parcourir et sur laquelle il peut agir, pas seulement lire
Des fichiers SKILL.md qui enseignent le travail documentaire à tout agent
Les outils qui permettent à un agent de lire et de modifier votre documentation
Le graphe documentaire parcouru par un agent
Modèle d’authentification, ce qu’un jeton en lecture seule ne peut pas faire et ce qui n’est pas encore proposé
Un assistant qui répond à partir de vos pages indexées
Le processus de récupération et d’ancrage, et ce qui se passe lorsqu’aucun élément ne correspond
Un champ de recherche dans l’en-tête, la barre latérale, ou les deux
Les dépôts et sites que votre agent peut consulter comme sources fiables
Exécutez votre propre code avant et après le modèle
Pouces vers le haut ou vers le bas, pour chaque page
Ce que Docsbook mesure et d’où proviennent ces données
Identité des visiteurs, filtrage des robots, temps de lecture et données qui ne sont jamais collectées
Si les lecteurs atteignent la page qui vend
Ouvertures d’IA, copies de code, clics sur des liens, objectifs
Le temps que les lecteurs passent sur chaque page
Où se trouvent les lecteurs et dans quelle langue ils lisent
Quels travaux d’IA ont utilisé le solde du projet
Activer les langues et placer le sélecteur
Fonctionnement de la traduction automatique et manière de la corriger
Ce qui est protégé de la traduction, comment les dérives sont détectées et l’aspect hreflang
Ce qui est mesuré et ce que paie le solde d’un projet
Coût, annulation, synchronisation, confidentialité et propriété des données
Toutes les pages de référence dans une seule liste
Chaque outil, ses paramètres et sa catégorie tarifaire
Appelez le chat de votre documentation depuis votre propre backend
Catalogue des événements, schémas des charges utiles, format des signatures
Cartes, accordéons, étapes et blocs d’appel à l’action en Markdown
Ce qui a été livré et ce que chaque modification était censée apporter
Articles approfondis sur la recherche par IA, le SEO des documentations, l’analytique et les comparaisons de plateformes
Assistance#
Envoyez un e-mail à support@docsbook.io, ou posez votre question sur le Discord de Docsbook.
Collez un dépôt, l’URL d’un site web ou une phrase à propos de votre produit. Le brouillon est généré avant que vous ne vous connectiez.