Cas d’utilisation de Docsbook : les tâches pour lesquelles les équipes font appel à la documentation
Six situations auxquelles les équipes sont confrontées, et ce que Docsbook fait pour chacune d’elles. Chacune se termine par le guide qui réalise le travail, afin que vous puissiez partir de la situation plutôt que d’une liste de fonctionnalités.
« Je veux que ChatGPT nous recommande lorsqu’un client pose la question »#
La situation. Vous avez un produit, des clients et un budget publicitaire. Quelqu’un demande à un assistant IA quel outil permet de faire ce que vous faites, et votre entreprise ne figure pas dans la réponse.
Ce qui bloque. Un assistant recommande ce qu’il peut lire et vérifier à moindre coût : ce que fait le produit, combien il coûte, quelles sont ses limites et qui en est à l’origine. Si ces informations ne sont écrites nulle part où il peut les récupérer, il cite un concurrent qui, lui, les a publiées.
Ce que fait Docsbook. Docsbook publie vos pages en HTML rendu côté serveur, afin qu’un robot d’exploration voie le texte sans exécuter JavaScript, et ajoute les éléments recherchés par les assistants : sitemap.xml, des URL canoniques, JSON-LD, une date de dernière modification visible et llms.txt à la racine du site. Chaque page possède sa propre URL et son propre titre, de sorte qu’une page consacrée à une question précise puisse se positionner sur cette question.
Commencez par : GEO — optimisation pour les moteurs génératifs, puis llms.txt.
« Notre documentation attire du trafic et je ne peux pas dire si elle vend quoi que ce soit »#
La situation. Les outils d’analyse indiquent que la documentation est consultée. Personne ne peut dire si sa lecture a incité quelqu’un à s’inscrire, ni quelles pages font perdre du temps.
Ce qui bloque. Les pages vues ne décrivent pas un parcours. Sans événements ni objectif défini, un site de documentation mesure sa popularité, pas sa progression.
Ce que fait Docsbook. Docsbook enregistre les pages vues, les recherches, le temps de lecture, les votes de feedback et les événements suivis sur chaque page, puis les présente sous forme de parcours : quelles pages personne n’atteint, quelles recherches ne renvoient rien, jusqu’où un lecteur va avant de partir, et de quels pays et dans quelles langues il arrive. Marquez une page comme étape de l’entonnoir et comptez combien de lecteurs vont jusqu’au bout.
Commencez par : Vue d’ensemble du suivi, puis Événements.
« Notre documentation a trois mois de retard sur le produit »#
La situation. Le produit a évolué. La documentation décrit toujours l'ancien comportement, et tout le monde le sait.
Ce qui bloque. Une documentation qui vit en dehors du dépôt nécessite de se rappeler séparément de la mettre à jour. Une étape de compilation et de déploiement entre la rédaction et la publication transforme une correction de cinq minutes en une tâche que personne ne commence.
Ce que fait Docsbook. Docsbook sert le Markdown présent dans votre dépôt. Il vérifie à nouveau GitHub lorsque le site est consulté et réindexe ce qui a changé : un push équivaut à une publication — il n'y a ni étape de compilation, ni pipeline CI, ni déploiement à attendre. Les modifications peuvent également provenir de l'éditeur web ou d'un agent via MCP, et les trois méthodes aboutissent à des commits dans le même dépôt.
Commencez par : Connecter un dépôt GitHub, puis Gérer votre documentation.
« Nos clients ne lisent pas l’anglais »#
La situation. Vous vendez sur des marchés où la langue de votre documentation n’est pas celle dans laquelle vos clients effectuent leurs recherches. Traduire manuellement signifie que les traductions deviennent obsolètes dès que l’anglais est modifié.
Ce qui bloque. Une traduction ne mérite d’être publiée que si elle reste à jour par rapport à l’original et est indexée comme sa propre page. Une copie collée dans un dossier ne répond à aucun de ces critères.
Ce que fait Docsbook. Docsbook traduit vos pages en 15 langues — anglais, espagnol, français, allemand, portugais, italien, russe, chinois, japonais, coréen, arabe, hindi, turc, polonais et néerlandais. Chaque langue est accessible via sa propre route avec les balises hreflang appropriées, afin que les moteurs de recherche l’indexent séparément et que les lecteurs arrivent dans la langue de leur navigateur. La traduction est effectuée par l’IA, elle est donc déduite du solde du projet.
Commencez par : Activer la traduction, puis les traductions par IA.
« Le support répond chaque semaine aux cinq mêmes questions »#
La situation. Les réponses figurent dans la documentation. Pourtant, les lecteurs ouvrent quand même un ticket, parce qu’ils n’ont pas trouvé la page.
Ce qui bloque. Une recherche qui correspond aux mots-clés exacts ne tient pas compte de la manière dont les utilisateurs posent réellement leurs questions. Un lecteur qui formule sa question différemment de votre titre n’obtient aucun résultat et s’adresse plutôt à un humain.
Ce que fait Docsbook. L’assistant IA de Docsbook répond à partir de vos pages indexées et cite la page utilisée pour formuler sa réponse, afin qu’un lecteur qui aurait ouvert un ticket obtienne la réponse directement là où il se trouve. Les questions auxquelles il n’a pas pu répondre sont enregistrées : les questions sans réponse et les recherches n’ayant renvoyé aucun résultat sont répertoriées pour vous, ce qui vous indique quelle page rédiger ensuite. Les réponses de l’assistant sont générées par l’IA et utilisent le solde du projet.
Commencez par : chat IA, puis Commentaires sur la page.
« Nous avons un README et personne n’a le temps de créer un site de documentation »#
La situation. La documentation du projet est un long README.md, ainsi qu’un dossier docs/ que personne n’a rendu. Configurer un générateur de site statique représente une semaine de travail que vous n’aurez pas.
Ce qui bloque. Un générateur a besoin d’une configuration, d’un thème, d’un pipeline de build et d’une décision concernant l’hébergement avant de générer une seule page — et quelqu’un doit ensuite assurer la maintenance de ces quatre éléments.
Ce que fait Docsbook. Docsbook lit le dépôt tel qu’il est. La structure des dossiers devient l’arborescence de navigation, les titres deviennent le plan, les liens .md relatifs sont résolus vers de vraies URL, et le site est disponible à l’adresse docsbook.io/{owner}/{repo} avec une recherche en texte intégral et une URL publique. Aucun fichier de configuration à rédiger. Votre Markdown ne quitte jamais votre dépôt GitHub, donc utiliser un autre outil avec le même dépôt plus tard ne coûte rien.
Commencez par : Démarrage rapide, puis Créez votre premier site.
Étapes suivantes#
- Vue d’ensemble — ce que Docsbook fait avec votre dépôt, de bout en bout
- Concepts — les termes utilisés ci-dessus, définis une seule fois chacun
- Tarification — ce qui est mesuré et ce que couvre le solde d’un projet
- FAQ — résiliation, confidentialité, synchronisation et propriété des données
Collez un dépôt, l’URL d’un site web ou une phrase décrivant votre produit, puis consultez le brouillon avant de vous connecter.