docs(fr): style guide formatting

This commit is contained in:
Emmanuel Atsé 2026-05-22 01:41:40 +02:00
parent 25df26692a
commit d00d8cfe33
No known key found for this signature in database
1 changed files with 49 additions and 48 deletions

View File

@ -8,10 +8,10 @@ Ce projet suit le [Guide de style de documentation pour développeurs Google](ht
## Règles spécifiques au projet ## Règles spécifiques au projet
| Règle | Spécification | | Règle | Spécification |
| --------------------------------------- | ------------------------------------------------------ | |--------------------------------------------|--------------------------------------------------------|
| Pas de règles horizontales (`---`) | Perturbe le flux de lecture des fragments | | Pas de règles horizontales (`---`) | Perturbe le flux de lecture des fragments |
| Pas de titres `####` | Utiliser du texte en gras ou des admonitions | | Pas de titres `####` | Utiliser du texte en gras ou des admonitions |
| Pas de sections «Related» ou «Next : » | La barre latérale gère la navigation | | Pas de sections «Related» ou «Next» | La barre latérale gère la navigation |
| Pas de listes profondément imbriquées | Diviser en sections à la place | | Pas de listes profondément imbriquées | Diviser en sections à la place |
| Pas de blocs de code pour non-code | Utiliser des admonitions pour les exemples de dialogue | | Pas de blocs de code pour non-code | Utiliser des admonitions pour les exemples de dialogue |
| Pas de paragraphes en gras pour les appels | Utiliser des admonitions à la place | | Pas de paragraphes en gras pour les appels | Utiliser des admonitions à la place |
@ -42,7 +42,7 @@ Avertissements critiques uniquement — perte de données, problèmes de sécuri
### Utilisations standards ### Utilisations standards
| Admonition | Usage | | Admonition | Usage |
| -------------------------- | ---------------------------------------- | |-------------------------|----------------------------------|
| `:::note[Pré-requis]` | Dépendances avant de commencer | | `:::note[Pré-requis]` | Dépendances avant de commencer |
| `:::tip[Chemin rapide]` | Résumé TL;DR en haut du document | | `:::tip[Chemin rapide]` | Résumé TL;DR en haut du document |
| `:::caution[Important]` | Mises en garde critiques | | `:::caution[Important]` | Mises en garde critiques |
@ -54,7 +54,7 @@ Avertissements critiques uniquement — perte de données, problèmes de sécuri
```md ```md
| Phase | Nom | Ce qui se passe | | Phase | Nom | Ce qui se passe |
| ----- | ---------- | --------------------------------------------------- | |-------|---------------|-------------------------------------------------------|
| 1 | Analyse | Brainstorm, recherche *(optionnel)* | | 1 | Analyse | Brainstorm, recherche *(optionnel)* |
| 2 | Planification | Exigences — PRD ou spécification technique *(requis)* | | 2 | Planification | Exigences — PRD ou spécification technique *(requis)* |
``` ```
@ -63,7 +63,7 @@ Avertissements critiques uniquement — perte de données, problèmes de sécuri
```md ```md
| Skill | Agent | Objectif | | Skill | Agent | Objectif |
| ------------------- | ------- | ----------------------------------------------- | |----------------------|----------|---------------------------------------|
| `bmad-brainstorming` | Analyste | Brainstorming pour un nouveau projet | | `bmad-brainstorming` | Analyste | Brainstorming pour un nouveau projet |
| `bmad-create-prd` | PM | Créer un document d'exigences produit | | `bmad-create-prd` | PM | Créer un document d'exigences produit |
``` ```
@ -145,7 +145,7 @@ votre-projet/
### Types ### Types
| Type | Exemple | | Type | Exemple |
| ----------------------- | ------------------------------------ | |--------------------------|-------------------------------|
| **Index/Page daccueil** | `core-concepts/index.md` | | **Index/Page daccueil** | `core-concepts/index.md` |
| **Concept** | `what-are-agents.md` | | **Concept** | `what-are-agents.md` |
| **Fonctionnalité** | `quick-dev.md` | | **Fonctionnalité** | `quick-dev.md` |
@ -221,7 +221,7 @@ votre-projet/
### Types ### Types
| Type | Exemple | | Type | Exemple |
| ----------------------- | --------------------- | |--------------------------|-----------------------|
| **Index/Page daccueil** | `workflows/index.md` | | **Index/Page daccueil** | `workflows/index.md` |
| **Catalogue** | `agents/index.md` | | **Catalogue** | `agents/index.md` |
| **Approfondissement** | `document-project.md` | | **Approfondissement** | `document-project.md` |
@ -303,11 +303,12 @@ Starlight génère la navigation «Sur cette page» à droite à partir de
### Format de tableau ### Format de tableau
```md
## Nom de catégorie ## Nom de catégorie
```md
| Terme | Définition | | Terme | Définition |
| ------------ | --------------------------------------------------------------------------------------------- | |--------------|------------------------------------------------------------------------------------------------------------|
| **Agent** | Personnalité IA spécialisée avec une expertise spécifique qui guide les utilisateurs dans les workflows. | | **Agent** | Personnalité IA spécialisée avec une expertise spécifique qui guide les utilisateurs dans les workflows. |
| **Workflow** | Processus guidé en plusieurs étapes qui orchestre les activités des agents IA pour produire des livrables. | | **Workflow** | Processus guidé en plusieurs étapes qui orchestre les activités des agents IA pour produire des livrables. |
``` ```
@ -315,7 +316,7 @@ Starlight génère la navigation «Sur cette page» à droite à partir de
### Règles de définition ### Règles de définition
| À faire | À ne pas faire | | À faire | À ne pas faire |
| --------------------------------- | --------------------------------------------- | |------------------------------------------------|-----------------------------------------------------|
| Commencer par ce que cest ou ce que cela fait | Commencer par «Cest... » ou «Un [terme] est... » | | Commencer par ce que cest ou ce que cela fait | Commencer par «Cest... » ou «Un [terme] est... » |
| Se limiter à 1-2 phrases | Écrire des explications de plusieurs paragraphes | | Se limiter à 1-2 phrases | Écrire des explications de plusieurs paragraphes |
| Mettre le nom du terme en gras dans la cellule | Utiliser du texte simple pour les termes | | Mettre le nom du terme en gras dans la cellule | Utiliser du texte simple pour les termes |