Concepts
Apprenez les bases pour pouvoir créer et publier une documentation exceptionnelle pour vos utilisateurs
Organisation du contenu
Espace
Un espace est un projet qui vous permet de travailler sur une collection de pages liées. Dans un espace, vous pouvez rédiger du contenu, organiser vos pages avec des groupes et des sous-pages, installer des intégrations, et plus encore.
Lorsque vous souhaitez publier un espace, vous pouvez le faire en l’ajoutant à un site de documentation. Vous pouvez ajouter autant d’espaces que vous le souhaitez à un site de documentation. Ainsi, lors de la création de votre contenu, vous pouvez créer des espaces séparés pour la documentation produit, la référence API, le journal des modifications, le centre d’aide et tout autre élément que vous souhaitez inclure dans votre documentation — et tous les publier sur un même site de documentation.
Vous voudrez peut-être aussi créer des versions traduites de votre documentation principale, ou des documentations séparées pour différentes versions de votre produit. Chacune de ces documentations aura également son propre espace et pourra être ajoutée à votre site de documentation unique pour que les utilisateurs puissent les parcourir.
Collection
Les collections fonctionnent comme des dossiers dans l’application GitBook, vous permettant de regrouper des espaces afin de mieux organiser et stocker votre contenu.
En plus de vous permettre de garder le contenu organisé, les collections facilitent également la gestion des autorisations au niveau du contenu à grande échelle. Vous pouvez remplacer les autorisations au niveau de l’organisation sur plusieurs espaces en les ajoutant à une collection et en définissant des autorisations pour l’ensemble de la collection.
Site de documentation
Vous pouvez publier votre contenu sous la forme d’un site de documentation. Vos documents seront publiés et accessibles au public sélectionné sous forme de site web que vous pouvez personnaliser avec votre propre identité visuelle, des outils d’analyse et un domaine personnalisé.
Vous pouvez créer autant de sites de documentation que vous le souhaitez. Ils sont tous répertoriés dans la barre latérale et dans la section Sites de documentation de l’application, où vous pouvez modifier les paramètres et les options de personnalisation. Vous pouvez contrôler tous les paramètres et options de vos sites de documentation depuis l’application GitBook.
Le contenu de votre site provient des espaces de votre organisation GitBook. Lorsque vous créez un nouveau site de documentation, vous pouvez créer un nouvel espace ou lier un espace existant. Un site de documentation peut contenir un espace, ou plusieurs espaces contenant différents contenus — y compris des traductions et des versions antérieures du produit.
Édition du contenu
L’éditeur visuel de GitBook vous permet d’utiliser une interface WYSIWYG (ce que vous voyez est ce que vous obtenez) pour ajouter du contenu à un espace.
Pages
Une page est l’endroit où vous ajoutez, modifiez et intégrez du contenu. Les pages vivent toujours à l’intérieur d’un espace, et vous pouvez ajouter autant de pages que vous le souhaitez dans un espace.
Les pages de votre espace apparaissent dans la table des matières sur le côté gauche de l’éditeur. Ici, vous pouvez ajouter de nouvelles pages, créer des groupes de pages et imbriquer des pages dans d’autres pages pour créer des sous-pages.
Vous ne voyez pas comment modifier ou ajouter une page ?
Si votre site est publié, vous devrez créer une demande de modification avant de pouvoir apporter des modifications au contenu d’un espace. Lire la suite sur les demandes de modification ci-dessous.
Blocs
GitBook est un éditeur basé sur des blocs. Cela signifie que vous pouvez ajouter différents types de blocs à votre page — du texte et des images standards aux blocs interactifs plus avancés. Vos pages peuvent inclure n’importe quelle combinaison de blocs que vous souhaitez, et il n’y a pas de limite au nombre de blocs que vous pouvez avoir sur une page.
L’édition par blocs facilite la réorganisation de votre contenu par glisser-déposer, ou l’ajout de nouveaux blocs au milieu d’un contenu existant. Vous pouvez créer de nouveaux blocs en utilisant l’interface de l’éditeur, ou créer et formater des blocs en utilisant Markdown.
Découvrez tous les blocs que vous pouvez utiliser dans GitBook dans la section Blocs.
Édition en Markdown
L’éditeur de GitBook vous permet de créer et de formater des blocs de contenu en utilisant Markdown.
Markdown est une syntaxe de balisage populaire, largement reconnue pour sa simplicité. GitBook la prend en charge comme une manière adaptée au clavier d’écrire du texte riche et structuré — tous les blocs de GitBook peuvent être écrits en utilisant la syntaxe Markdown.
Synchronisation Git
La synchronisation Git permet aux équipes de synchroniser des dépôts GitHub ou GitLab avec GitBook et de transformer des fichiers Markdown en documentations attrayantes et conviviales. Une fois configurée, elle maintient tout votre contenu synchronisé entre l’application GitBook et votre base de code.
La synchronisation Git est bidirectionnelle, donc les modifications que vous effectuez dans l’éditeur visuel de GitBook sont automatiquement synchronisées — tout comme les commits effectués sur GitHub ou GitLab. Cela permet aux développeurs de committer directement depuis GitHub ou GitLab pendant que d’autres membres de l’équipe éditent et laissent des retours sur les modifications directement dans GitBook.
La synchronisation Git débloque également de nombreux autres flux de travail utiles dans vos docs GitBook, tels que les modifications en lot, le linting, et plus encore. En savoir plus dans notre section Synchronisation Git.
Le flux d’édition
Demandes de modification
Une demande de modification est une branche de votre contenu principal que vous pouvez utiliser pour effectuer des modifications simultanées, tout en conservant votre historique de versions. Cela semblera familier à toute personne utilisant des pull requests sur GitHub ou des merge requests sur GitLab.
Si vous souhaitez modifier le contenu de votre site de documentation publié, vous devrez d’abord ouvrir une demande de modification dans votre espace.
Dans une demande de modification, vous pouvez ajouter, modifier et supprimer du contenu dans un espace, puis demander une révision à votre équipe et fusionner vos modifications dans votre contenu principal pour mettre à jour votre site de documentation publié.
Branchement en bref
L’ouverture d’une demande de modification crée une copie de votre contenu à ce moment précis, parfois appelée « branche ». Les modifications que vous apportez n’apparaîtront pas dans votre contenu principal tant que vous n’aurez pas choisi de fusionner votre demande de modification.
L’avantage du branchement est que vos coéquipiers peuvent créer, modifier et fusionner leurs propres demandes de modification en même temps que vous sans se gêner mutuellement. Et si quelqu’un modifie le même contenu que vous, GitBook vous guidera pour résoudre les conflits avant la fusion.
Révions
Les révisions encouragent la supervision et contribuent à améliorer la qualité et la précision de votre documentation.
Vous pouvez demander une révision de votre demande de modification avant de fusionner et de rendre les modifications visibles sur votre site de documentation. Ajouter un titre et une description à votre demande de modification donne un contexte à vos relecteurs.
Les relecteurs peuvent voir le diff de votre demande de modification, qui met en évidence tout ce qui est nouveau, modifié ou supprimé dans votre demande. Ils peuvent également laisser des commentaires directement sur la page en utilisant la fonction de commentaires intégrée — puis approuver votre demande de modification, ou demander que d’autres modifications soient apportées.
Fusion
La fusion d’une demande de modification ajoutera tout le contenu de votre demande dans la branche principale du contenu — et ces modifications seront également publiées sur votre site de documentation.
Lorsque vous fusionnez votre demande de modification, cela crée également une nouvelle version dans l’historique des versions de l’espace.
Publication de la documentation
Lorsque vous publiez votre contenu en tant que site de documentation, vous pouvez ajouter plus de contenu à votre site, changer l’audience et personnaliser son apparence, son ressenti et d’autres paramètres.
Structurer votre site de documentation
Si vous souhaitez ajouter du contenu supplémentaire à votre site, vous avez deux options à utiliser, chacune conçue pour des cas d’utilisation différents : les sections du site et les variantes.
Section du site
Les sections du site sont conçues pour vous permettre d’ajouter plusieurs types différents de documentation à un seul site de documentation. Par exemple, vous pourriez utiliser un seul site de documentation pour héberger votre documentation produit, la référence API, le centre d’aide et le journal des modifications — comme nous le faisons sur ce site de documentation.
Lorsque vous ajoutez de nouvelles sections de site, vous construisez la barre de navigation en haut de votre site, chaque section obtenant sa propre entrée dans la barre. Vous pouvez également regrouper les sections de site pour créer un menu déroulant dans votre barre de navigation — idéal pour ajouter une hiérarchie à vos sections.
Variante
Les variantes sont conçues pour vous permettre d’ajouter plusieurs versions de la même documentation à un seul site de documentation. Par exemple, vous pourriez vouloir localiser l’intégralité de votre documentation dans plusieurs langues, ou documenter des versions antérieures de votre produit pour les utilisateurs qui n’ont pas mis à jour.
Vos utilisateurs finaux peuvent passer d’une variante à l’autre sur votre site de documentation en utilisant le sélecteur de langue ou le sélecteur de variante en haut de la table des matières sur le côté gauche de votre site.
Audience du site
Vous pouvez choisir qui verra votre documentation lorsque vous la publierez. Par défaut, les nouveaux sites sont publiés publiquement et indexés par les moteurs de recherche.
Cependant, si vous souhaitez un meilleur contrôle sur qui peut accéder à votre site, vous pouvez choisir de limiter l’audience en utilisant liens de partage ou accès authentifié.
Avec les liens de partage, vous pouvez partager votre contenu de manière privée avec des clients ou des partenaires sans avoir à les inviter dans votre organisation en créant un lien privé et en le partageant directement avec eux. Toute personne disposant du lien peut accéder à votre site.
Si vous voulez encore plus de contrôle, l’accès authentifié vous permet de publier votre contenu tout en exigeant une authentification pour tout visiteur souhaitant le consulter. Une fois activé, GitBook laisse votre fournisseur d’authentification gérer qui a accès au contenu. Ceci est idéal pour du contenu privé ou pour publier une base de connaissances interne qui ne devrait être accessible qu’aux membres de votre équipe.
Vous pouvez également contrôler qui voit des pages ou des blocs individuels à l’aide d’une fonctionnalité appelée contenu adaptatif. Une fois configurée, elle affichera ou masquera le contenu en fonction des attributs d’utilisateur que vous avez choisis. En savoir plus dans les pages de Contenu adaptatif.
Personnalisation du site
GitBook inclut des options de personnalisation intégrées pour les sites de documentation, vous aidant à adapter l’apparence et la sensation de votre documentation à votre produit ou marque.
Même si vous n’appliquez aucune personnalisation, vos docs auront une excellente apparence telles qu’elles sont. Mais vous avez la possibilité de personnaliser les logos, les icônes et les couleurs, d’ajouter des polices personnalisées ou de choisir parmi des thèmes intégrés qui aident vos docs à paraître aussi attractifs que votre produit.
Optimisations SEO et IA
La documentation publiée dans GitBook est automatiquement optimisée pour la recherche (SEO) et pour les systèmes d’IA comme ChatGPT, Claude et Google AI Overview (GEO). Ces optimisations sont gérées en arrière-plan, il vous suffit donc d’écrire du contenu incluant les mots-clés et termes que vous souhaitez cibler.
Les pages récupèrent les métadonnées à partir du titre et de la description de chaque page, et votre contenu est formaté pour être réactif. GitBook crée automatiquement un sitemap basé sur votre table des matières, et les pages sont mises en cache et servies via notre CDN global pour améliorer les performances. Tout cela aide votre documentation à obtenir un bon classement dans les moteurs de recherche.
De même, GitBook optimise également pour les outils d’IA en suivant toutes les normes de l’industrie au fur et à mesure de leur rapide évolution.
GitBook crée automatiquement des versions .md de chaque page, ce qui facilite l’analyse par les grands modèles de langage (LLM). Nous exposons également automatiquement un serveur Model Context Protocol (MCP) pour chaque site publié, offrant aux outils d’IA une manière structurée de découvrir et de récupérer vos docs en tant que ressources — sans avoir besoin de les scraper. De plus, votre site génère également llms.txt et llms-full.txt conçus pour l’ingestion par l’IA.
Gestion de l’équipe
Organisation
Une organisation GitBook contient tout le contenu et les sites de documentation pour une entreprise. Avec votre compte unique, vous pouvez être membre d’une ou plusieurs organisations et basculer entre elles en utilisant le menu déroulant en haut à gauche de l’application GitBook.
Membres
Les membres sont des utilisateurs individuels au sein de votre organisation. Vous pouvez avoir autant de membres que vous le souhaitez dans une organisation, chacun avec des autorisations adaptées à leurs besoins d’accès spécifiques.
Autorisations
Les autorisations vous permettent de décider du niveau d’accès des membres de votre organisation. Lorsqu’un membre rejoint votre organisation, vous lui assignez un rôle — comme Éditeur ou Lecteur. Ces rôles définissent leurs autorisations pour l’ensemble du contenu de votre organisation. Mais vous pouvez également écraser ces autorisations au niveau du contenu. Par exemple :
Vous pouvez donner à quelqu’un ayant le rôle Lecteur un accès d’édition pour un contenu particulier
Vous pouvez limiter l’accès à un contenu spécifique confidentiel ou privé et n’accorder l’accès qu’à certains membres de votre organisation.
En savoir plus sur la page Autorisations et héritage.
Mis à jour
Ce contenu vous a-t-il été utile ?