> For the complete documentation index, see [llms.txt](https://gitbook.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://gitbook.com/docs/documentation/fr/creer-du-contenu/styleguide/build-your-style-guide.md).

# Construisez votre guide de style

Choisissez un point de départ, remplissez le modèle et rédigez des règles que GitBook Agent peut faire respecter.

La plupart des équipes partent d’un modèle et gardent leur guide de style sur une seule page. Cette page explique comment choisir un point de départ, remplir le modèle et rédiger des règles que GitBook Agent peut appliquer.

Pour configurer un guide de style, vous avez besoin de droits d’administration sur le site.

## Choisissez un point de départ

Pour commencer, cliquez sur **Guide de style** dans la barre latérale de votre site, puis sur **Configurer**. Choisissez ensuite un point de départ :

| Point de départ                | Choisissez-le lorsque                                                                                                                                  |
| ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **Un modèle**                  | Vous n’avez pas encore de guide de style.                                                                                                              |
| **Un guide de style existant** | Un autre site de votre organisation utilise déjà le guide de style souhaité. Voir [Utiliser un guide de style existant](#use-an-existing-style-guide). |
| **Une importation**            | Vous gérez un guide de style dans un autre outil ou le publiez en ligne. Voir [Importer un guide de style](#import-a-style-guide).                     |

GitBook propose trois modèles :

<table><thead><tr><th width="204.75390625">Modèle</th><th>Idéal pour</th></tr></thead><tbody><tr><td><strong>Modèle de départ</strong></td><td>Définir votre propre ton et vos propres règles à partir de zéro. Chaque section explique ce qu’elle doit contenir, et vous rédigez vous-même les règles.</td></tr><tr><td><strong>Guide de style Google</strong></td><td>Une rédaction claire, précise et professionnelle pour un public de développeurs. Généré à partir du guide de style de la documentation développeur de Google.</td></tr><tr><td><strong>Guide de style Microsoft</strong></td><td>Une écriture chaleureuse, simple et humaine pour un large public, y compris les lecteurs qui ne sont pas des experts en technologie. Généré à partir du Microsoft Writing Style Guide.</td></tr></tbody></table>

Les modèles Google et Microsoft sont accompagnés de règles applicables issues de leurs guides sources, couvrant le ton, les listes de mots, la grammaire, la mise en forme, les procédures, l’écriture accessible et le langage inclusif. Tout ce qui se trouve dans un modèle est modifiable.

{% hint style="info" %}
GitBook met à jour ses modèles lorsque les guides sources changent. Les mises à jour s’appliquent uniquement aux nouveaux guides de style. Un guide de style que vous avez déjà créé ne change pas.
{% endhint %}

## Remplissez le modèle

Chaque modèle tient sur une seule page, organisée en sections telles que le ton et la voix, la liste de mots, la grammaire, la mise en forme et les procédures. Chaque section explique ce qu’elle doit contenir. Supprimez toute section dont vous n’avez pas besoin.

Chaque modèle indique les éléments à personnaliser à l’aide d’une indication **Votre contribution est requise** . Traitez chaque élément avant de lancer votre première vérification. Ils comprennent généralement :

* La date d’instantané de la version du guide de base que le modèle reflète (modèles Google et Microsoft)
* Le nom de votre produit et la mission de votre documentation
* Qui lit et rédige votre documentation, et ce que couvre le guide
* Les noms de vos produits, les noms de fonctionnalités et tous les termes sur lesquels votre équipe débat, ajoutés à la liste de mots
* Un responsable, une fréquence de relecture et la manière de proposer des modifications
* Une première entrée dans le journal des décisions, qui consigne pourquoi votre équipe a retenu une règle ou s’est écartée du guide de base

Tout ce qui n’a pas d’indice est prêt à être utilisé tel quel. Les règles qui contiennent encore du texte de remplacement sont inactives tant que vous ne les avez pas complétées.

## Rédigez des règles que l’Agent peut appliquer

GitBook Agent applique les règles qui ont un identifiant numérique et les règles explicites comme « N’utilisez jamais de points-virgules ». Il considère tout le reste, comme la description de votre ton, comme des recommandations et ne les propose qu’à titre de suggestions. Pour en savoir plus, consultez [Comment GitBook Agent applique votre guide de style](https://gitbook.com/docs/documentation/fr/creer-du-contenu/styleguide/how-gitbook-agent-enforces-your-style-guide.md#which-rules-the-agent-enforces).

Les modèles présentent les règles sous forme de tableau, avec un ID, la règle, un exemple pour chaque côté et les éventuelles exceptions :

| ID    | Règle               | À faire                            | À ne pas faire                       | Exception                                                                                                                    |
| ----- | ------------------- | ---------------------------------- | ------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------- |
| SG-12 | Utilisez le présent | ✅ « La commande crée un fichier. » | ❌ « La commande créera un fichier. » | Temps futur pour les événements qui sont réellement dans le futur (« La prise en charge de la version 2 prend fin en mars ») |

Lorsque vous rédigez ou modifiez des règles :

* **Attribuez un identifiant à chaque règle que vous souhaitez faire appliquer.** Utilisez le numéro suivant le plus élevé actuellement, quel que soit l’emplacement de la règle. Ne renumérotez jamais un identifiant et ne le réutilisez pas, car les signalements antérieurs et votre journal de décisions s’y réfèrent.
* **Attribuez un seul identifiant à chaque règle.** Une règle qui vérifie un seul élément génère des signalements faciles à traiter.
* **Indiquez les exceptions.** L’Agent ne signale pas les textes qui relèvent d’une exception à une règle.
* **Transformez les recommandations vérifiables en règles.** Conservez la description de votre ton sous forme de recommandations et rédigez toute consigne vérifiable, comme « Aucun point d’exclamation dans le corps du texte », sous forme de règle numérotée.
* **Remplacez tous les espaces réservés.** Une règle qui contient encore du texte entre crochets, comme `[Product name]`, n’est pas appliquée.

{% hint style="info" %}
Le modèle de démarrage utilise le préfixe `SG-` pour les identifiants. Vous pouvez le modifier, mais conservez le même préfixe une fois que vous commencez à utiliser le guide.
{% endhint %}

## Conservez vos règles principales sur la première page

Une page suffit pour la plupart des guides de style. GitBook Agent charge la première page à chaque tâche, donc les règles qui s’y trouvent s’appliquent toujours.

Si votre guide de style s’allonge, déplacez les règles détaillées d’un sujet, comme une longue liste de mots ou vos types de contenu, sur leur propre page avec un titre clair. L’Agent lit cette page dès qu’une tâche concerne ce sujet. Conservez vos règles essentielles sur la première page.

## Utiliser un guide de style existant

Si votre organisation utilise déjà des guides de style sur d’autres sites, ils apparaissent en haut de l’écran de configuration, avec les sites qui les utilisent. Lorsque vous en choisissez un, vous pouvez :

* **Utilisez-le tel quel :** partagez-le avec les autres sites qui l’utilisent. Les modifications s’appliquent partout où il est utilisé.
* **Créez une copie :** créez une copie pour ce site, nommée `Style guide - {site name}`, que vous pourrez modifier indépendamment.

## Importer un guide de style

Pour importer un guide de style que vous conservez dans un autre outil :

1. Sur l’écran de configuration, cliquez sur **Importer un fichier**.
2. Déposez vos fichiers Markdown, HTML, DOCX ou ZIP, ou parcourez-les pour les sélectionner.
3. Vous pouvez également activer **Améliorer l’importation avec l’IA** pour nettoyer le contenu importé.
4. Cliquez sur **Lancer l’importation**.

Pour importer un guide de style publié en ligne :

1. Sur l’écran de configuration, cliquez sur **Importer depuis une URL**.
2. Saisissez le lien vers le guide de style.
3. Vous pouvez également activer **Améliorer l’importation avec l’IA** pour nettoyer le contenu importé.

GitBook importe toutes les pages publiques accessibles sous l’URL que vous saisissez, dans la limite de 200 pages. Par exemple, l’importation de `website.com/docs/` inclut `website.com/docs/article` mais pas `website.com/other-parent/page`. Pour les sites plus volumineux, importez séparément des sous-chemins plus restreints.

Un guide de style importé s’étend souvent sur plusieurs pages et comporte des règles sans ID. Avant d’exécuter votre premier contrôle :

1. Déplacez vos règles essentielles sur la première page.
2. Attribuez un ID à chaque règle que vous voulez faire appliquer, en utilisant un seul préfixe pour l’ensemble du guide.
3. Notez toute règle sur laquelle vous vous appuyez à partir d’un autre guide. L’Agent n’applique que ce qui est écrit dans votre guide de style.

## Avant votre premier contrôle

Votre guide de style est prêt lorsque :

* Chaque **Nécessite votre intervention** la section est remplie et aucune règle ne contient encore de texte provisoire.
* Les noms de vos produits et les termes arrêtés figurent dans la liste de mots.
* Chaque règle que vous voulez faire appliquer a un ID.
* Vos règles essentielles figurent sur la première page.

Ensuite, [vérifiez que votre contenu respecte votre guide de style](https://gitbook.com/docs/documentation/fr/creer-du-contenu/styleguide/check-content-against-your-style-guide.md).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://gitbook.com/docs/documentation/fr/creer-du-contenu/styleguide/build-your-style-guide.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
