bmad-code-org__bmad-method/docs/fr/_STYLE_GUIDE.md at feat/bmad-dev-auto

mirror of https://github.com/bmad-code-org/BMAD-METHOD.git synced 2026-09-19 08:11:52 +08:00

Files

T

Emmanuel Atsé 717a84f2e8 docs(fr): sync French docs with latest English source + fix non-ASCII anchor validation (#2408 )

* docs(fr): translation of install-custom-modules

Reference commit 97d32405

* docs(fr): refinement of forensic-investigation

* docs(fr): translation of customize-bmad TOML customization rewrite

Reference commits 0dbfae67, 4405b817, ffdd9bc6, b63086f2"

* fix(docs): handle non-ASCII anchors in link validator

Anchor validation failed for links containing accented characters
(e.g. ./customize-bmad.md#dépannage) because the raw anchor didn't
match the slugified version produced by extractAnchors.

Normalize anchors through decodeURIComponent + headingToAnchor before
comparing, and guard against malformed URI components.

* docs(fr): translation of install-bmad channel and config rewrite

Reference commits 3d824d4c, 91a57499, 0f852a38

* docs(fr): translation of expand-bmad-for-your-org organizational customization patterns

Reference commits c52c9b5b, b63086f2, 4405b817, 0dbfae67

* docs(fr): update install-custom-modules

Reference commit 231a2036

* docs(fr): consolidate non-interactive installation into unified install-bmad guide

Replace standalone non-interactive-installation.md with a redirect stub
pointing to the Installations CI non interactives section in install-bmad.md.

* docs(fr): translation of named-agents

Reference commits 0dbfae67, 4405b817, b63086f2

* docs(fr): refinement of upgrade-to-v6

* docs(fr): refine agents.md

* docs(fr): refine commands.md

rename bmad-create-prd to bmad-prd and update skill descriptions

* docs(fr): refine workflow-map-diagram

Reference commit c52c9b5b

rename create-prd to prd, create-product-brief to product-brief
add prfaq workflow, update agent labels and output names
refine French wording throughout

* docs(fr): update and refine workflow-map

Reference commits: 380590a c52c9b5

* docs(fr): update and refine getting-started

Reference commits c52c9b5b, 0f852a38

rename bmad-create-prd to bmad-prd, add PRD intents section
update Quick Reference table, refine French wording throughout

* docs(fr): refine index.md

Reference commit 0dbfae67

refine French wording throughout, improve phrasing and table formatting

* docs(fr): apply French typographic conventions across all docs

regex-based pass followed by AI + manual review of all 34 source files

Rules applied:
- Apostrophe: ASCII ' → curly ’ (U+2019) in all French prose
- Guillemets: ASCII "..." → « … » with narrow no-break space (U+202F) on both sides
- Narrow no-break space (U+202F): before ; ? ! and after « / before »
- No-break space (U+00A0): before : in French prose
- Thousands separator: narrow no-break space (U+202F) in 4+ digit numbers

Additional review fixes: remaining ASCII quotes in _STYLE_GUIDE.md
checklist items, testing.md, and party-mode.md numbering.

Preserved exclusions: YAML frontmatter delimiters, code blocks,
backtick inline code, URLs, footnote syntax, and English UI text.

* docs(fr): align sidebar ordering with current English docs

Update sidebar order values across all French explanation and how-to
pages to match the live English documentation structure.

* docs(fr): fix omission in quick-dev from english

* docs(fr): style guide formatting

* docs(fr): use quick-dev wording in workflow-map-diagram-fr

* docs(fr): fix typos

* docs(fr): add bmad-investigate / IN trigger to agent tables

The forensic investigation feature added the IN menu trigger and
bmad-investigate skill, but the French docs that enumerate triggers
and agent capabilities were not updated.

- agents.md: add IN trigger and Enquête de code to Amelia's row
- named-agents.md: add Enquête de code to Amelia's capabilities

* docs(fr): fix agent skill identifiers to use bmad-agent-* prefix

The agent skill identifiers in agents.md and commands.md were missing
the -agent- segment of the namespace (e.g. bmad-pm instead of
bmad-agent-pm). All agent launchers use the bmad-agent-* naming
convention since the installer generates skill directories under that
prefix.

- agents.md: fix bmad-dev, bmad-analyst, bmad-pm, bmad-architect,
  bmad-ux-designer, bmad-tech-writer
- commands.md: fix bmad-pm, bmad-architect

* docs(fr): rename bmad-create-ux-design to bmad-ux (#2413)

Apply ee47e30c (refactor(bmad-ux): spine-based UX skill) to French docs.
Rename skill bmad-create-ux-design → bmad-ux and update outputs
from ux-spec.md to DESIGN.md + EXPERIENCE.md.

* docs(fr): translate bmad-spec section

French translation of the bmad-spec section introduced in aa6dece
(feat(bmad-spec): introduce Spec kernel distiller skill (#2417)).

* docs(fr): improve core-tools locution, phrasing and typography

Broader pass across all sections of core-tools.md for more idiomatic
French: consistent section headers (À utiliser quand, Fonctionnement),
natural verb choices, fluid sentence construction and corrected
punctuation.

* docs(fr): apply French typography and table formatting pass

Continuation of 27002100. Systematic pass across all French documentation
assisted by an automated French typography linter:
- Replace regular space with NBSP (U+00A0) before colons per French
  typographic convention
- Align table separator rows to match column widths
- Fix thousands separator in install-bmad.md (5000 → 5 000)
- Correct glossary example code block rendering in _STYLE_GUIDE.md

* docs(fr): fix missing french typography on roadmap.mdx

* docs(fr): translate web-bundles explanation and how-to

French translation of:
- docs/explanation/web-bundles.md
- docs/how-to/use-web-bundles.md
Reference commits: 7729ad46, d659a03d, 3bc2ad30

* docs(fr): refresh skill metadata references

Fixes #2437 for French.

- agents.md: update PM triggers CP/VP/EP → PRD, remove stale US trigger
  from Technical Writer, align PRD description to create/update/validate
- commands.md: fix Cursor/Windsurf skill paths to .agents/skills/,
  update core tools count to 12, align PRD description
- core-tools.md: add missing bmad-customize tool entry and section with
  link to customize-bmad how-to
- party-mode.md: replace stale "BMad Master orchestre" with "Le Party
  Mode orchestre la discussion"

---------

Co-authored-by: Brian <bmadcode@gmail.com>

2026-06-06 20:34:42 -05:00

13 KiB

Raw Permalink Blame History

title, description

title	description
Guide de style de la documentation	Conventions de documentation spécifiques au projet, basées sur le style Google et la structure Diataxis

Ce projet suit le Guide de style de documentation pour développeurs Google et utilise Diataxis pour structurer le contenu. Seules les conventions spécifiques au projet sont présentées ci-dessous.

Règles spécifiques au projet

Règle	Spécification
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 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 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
1-2 admonitions max par section	Les tutoriels permettent 3-4 par section majeure
Cellules de tableau / éléments de liste	1-2 phrases maximum
Budget de titres	8-12 `##` par doc ; 2-3 `###` par section

Admonitions (Syntaxe Starlight)

:::tip[Titre]
Raccourcis, bonnes pratiques
:::

:::note[Titre]
Contexte, définitions, exemples, prérequis
:::

:::caution[Titre]
Mises en garde, problèmes potentiels
:::

:::danger[Titre]
Avertissements critiques uniquement — perte de données, problèmes de sécurité
:::

Utilisations standards

Admonition	Usage
`:::note[Pré-requis]`	Dépendances avant de commencer
`:::tip[Chemin rapide]`	Résumé TL;DR en haut du document
`:::caution[Important]`	Mises en garde critiques
`:::note[Exemple]`	Exemples de commandes/réponses

Formats de tableau standards

Phases :

| Phase | Nom           | Ce qui se passe                                       |
|-------|---------------|-------------------------------------------------------|
| 1     | Analyse       | Brainstorm, recherche *(optionnel)*                   |
| 2     | Planification | Exigences — PRD ou spécification technique *(requis)* |

Skills :

| Skill                | Agent    | Objectif                              |
|----------------------|----------|---------------------------------------|
| `bmad-brainstorming` | Analyste | Brainstorming pour un nouveau projet  |
| `bmad-prd`           | PM       | Créer un document d'exigences produit |

Blocs de structure de dossiers

À afficher dans les sections « Ce que vous avez accompli » :

```
votre-projet/
├── _bmad/                                   # Configuration BMad
├── _bmad-output/
│   ├── planning-artifacts/
│   │   └── PRD.md                           # Votre document d’exigences
│   ├── implementation-artifacts/
│   └── project-context.md                   # Règles d’implémentation (optionnel)
└── ...
```

Structure des tutoriels

1. Titre + Accroche (1-2 phrases décrivant le résultat)
2. Notice de version/module (admonition info ou avertissement) (optionnel)
3. Ce que vous allez apprendre (liste à puces des résultats)
4. Prérequis (admonition info)
5. Chemin rapide (admonition tip - résumé TL;DR)
6. Comprendre [Sujet] (contexte avant les étapes - tableaux pour phases/agents)
7. Installation (optionnel)
8. Étape 1 : [Première tâche majeure]
9. Étape 2 : [Deuxième tâche majeure]
10. Étape 3 : [Troisième tâche majeure]
11. Ce que vous avez accompli (résumé + structure de dossiers)
12. Référence rapide (tableau des compétences)
13. Questions courantes (format FAQ)
14. Obtenir de l'aide (liens communautaires)
15. Points clés à retenir (admonition tip)

Liste de vérification des tutoriels

L’accroche décrit le résultat en 1-2 phrases
Section « Ce que vous allez apprendre » présente
Prérequis dans une admonition
Admonition TL;DR de chemin rapide en haut
Tableaux pour phases, skills, agents
Section « Ce que vous avez accompli » présente
Tableau de référence rapide présent
Section questions courantes présente
Section obtenir de l’aide présente
Admonition points clés à retenir à la fin

Structure des guides pratiques (How-To)

1. Titre + Accroche (une phrase : « Utilisez le workflow `X` pour... »)
2. Quand utiliser ce guide (liste à puces de scénarios)
3. Quand éviter ce guide (optionnel)
4. Prérequis (admonition note)
5. Étapes (sous-sections ### numérotées)
6. Ce que vous obtenez (produits de sortie/artefacts)
7. Exemple (optionnel)
8. Conseils (optionnel)
9. Prochaines étapes (optionnel)

Liste de vérification des guides pratiques

L’accroche commence par « Utilisez le workflow X pour... »
« Quand utiliser ce guide » contient 3-5 points
Prérequis listés
Les étapes sont des sous-sections ### numérotées avec des verbes d’action
« Ce que vous obtenez » décrit les artefacts produits

Structure des explications

Types

Type	Exemple
Index/Page d’accueil	`core-concepts/index.md`
Concept	`what-are-agents.md`
Fonctionnalité	`quick-dev.md`
Philosophie	`why-solutioning-matters.md`
FAQ	`established-projects-faq.md`

Modèle général

1. Titre + Accroche (1-2 phrases)
2. Vue d'ensemble/Définition (ce que c'est, pourquoi c'est important)
3. Concepts clés (sous-sections ###)
4. Tableau comparatif (optionnel)
5. Quand utiliser / Quand ne pas utiliser (optionnel)
6. Diagramme (optionnel - mermaid, 1 max par doc)
7. Prochaines étapes (optionnel)

Pages d’index/d’accueil

1. Titre + Accroche (une phrase)
2. Tableau de contenu (liens avec descriptions)
3. Pour commencer (liste numérotée)
4. Choisissez votre parcours (optionnel - arbre de décision)

Explications de concepts

1. Titre + Accroche (ce que c'est)
2. Types/Catégories (sous-sections ###) (optionnel)
3. Tableau des différences clés
4. Composants/Parties
5. Lequel devriez-vous utiliser ?
6. Création/Personnalisation (lien vers les guides pratiques)

Explications de fonctionnalités

1. Titre + Accroche (ce que cela fait)
2. Faits rapides (optionnel - "Idéal pour :", "Temps :")
3. Quand utiliser / Quand ne pas utiliser
4. Comment cela fonctionne (diagramme mermaid optionnel)
5. Avantages clés
6. Tableau comparatif (optionnel)
7. Quand évoluer/mettre à niveau (optionnel)

Documents de philosophie/justification

1. Titre + Accroche (le principe)
2. Le problème
3. La solution
4. Principes clés (sous-sections ###)
5. Avantages
6. Quand cela s'applique

Liste de vérification des explications

L’accroche énonce ce que le document explique
Contenu dans des sections ## parcourables
Tableaux comparatifs pour 3+ options
Les diagrammes ont des étiquettes claires
Liens vers les guides pratiques pour les questions procédurales
2-3 admonitions max par document

Structure des références

Types

Type	Exemple
Index/Page d’accueil	`workflows/index.md`
Catalogue	`agents/index.md`
Approfondissement	`document-project.md`
Configuration	`core-tasks.md`
Glossaire	`glossary/index.md`
Complet	`bmgd-workflows.md`

Pages d’index de référence

1. Titre + Accroche (une phrase)
2. Sections de contenu (## pour chaque catégorie)
   - Liste à puces avec liens et descriptions

Référence de catalogue

1. Titre + Accroche
2. Éléments (## pour chaque élément)
   - Brève description (une phrase)
   - **Skills :** ou **Infos clés :** sous forme de liste simple
3. Universel/Partagé (## section) (optionnel)

Référence d’approfondissement d’élément

1. Titre + Accroche (objectif en une phrase)
2. Faits rapides (admonition note optionnelle)
   - Module, Skill, Entrée, Sortie sous forme de liste
3. Objectif/Vue d'ensemble (## section)
4. Comment invoquer (bloc de code)
5. Sections clés (## pour chaque aspect)
   - Utiliser ### pour les sous-options
6. Notes/Mises en garde (admonition tip ou caution)

Référence de configuration

1. Titre + Accroche
2. Table des matières (liens de saut si 4+ éléments)
3. Éléments (## pour chaque config/tâche)
   - **Résumé en gras** — une phrase
   - **Utilisez-le quand :** liste à puces
   - **Comment cela fonctionne :** étapes numérotées (3-5 max)
   - **Sortie :** résultat attendu (optionnel)

Guide de référence complet

1. Titre + Accroche
2. Vue d'ensemble (## section)
   - Diagramme ou tableau montrant l'organisation
3. Sections majeures (## pour chaque phase/catégorie)
   - Éléments (### pour chaque élément)
   - Champs standardisés : Skill, Agent, Entrée, Sortie, Description
4. Prochaines étapes (optionnel)

Liste de vérification des références

L’accroche énonce ce que le document référence
La structure correspond au type de référence
Les éléments utilisent une structure cohérente
Tableaux pour les données structurées/comparatives
Liens vers les documents d’explication pour la profondeur conceptuelle
1-2 admonitions max

Structure du glossaire

Starlight génère la navigation « Sur cette page » à droite à partir des titres :

Catégories en tant que titres ## — apparaissent dans la navigation à droite
Termes dans des tableaux — lignes compactes, pas de titres individuels
Pas de TOC en ligne — la barre latérale à droite gère la navigation

Format de tableau

## Nom de catégorie

| Terme        | Définition                                                                                                 |
|--------------|------------------------------------------------------------------------------------------------------------|
| **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. |

Règles de définition

À faire	À ne pas faire
Commencer par ce que c’est ou ce que cela fait	Commencer par « C’est... » ou « Un [terme] est... »
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

Marqueurs de contexte

Ajouter un contexte en italique au début de la définition pour les termes à portée limitée :

*Quick Dev uniquement.*
*méthode BMad/Enterprise.*
*Phase N.*
*BMGD.*
*Projets établis.*

Liste de vérification du glossaire

Termes dans des tableaux, pas de titres individuels
Termes alphabétisés au sein des catégories
Définitions de 1-2 phrases
Marqueurs de contexte en italique
Noms des termes en gras dans les cellules
Pas de définitions « Un [terme] est... »

Sections FAQ

## Questions

- [Ai-je toujours besoin d'architecture ?](#ai-je-toujours-besoin-darchitecture)
- [Puis-je modifier mon plan plus tard ?](#puis-je-modifier-mon-plan-plus-tard)

### Ai-je toujours besoin d'architecture ?

Uniquement pour les parcours méthode BMad et Enterprise. Quick Dev passe directement à l'implémentation.

### Puis-je modifier mon plan plus tard ?

Oui. Utilisez `bmad-correct-course` pour gérer les changements de portée en cours d’implémentation.

**Une question sans réponse ici ?** [Ouvrez une issue](...) ou posez votre question sur [Discord](...).

Commandes de validation

Avant de soumettre des modifications de documentation :

npm run docs:fix-links            # Prévisualiser les corrections de format de liens
npm run docs:fix-links -- --write # Appliquer les corrections
npm run docs:validate-links       # Vérifier que les liens existent
npm run docs:build                # Vérifier l'absence d'erreurs de build

13 KiB Raw Permalink Blame History Unescape Escape

Règles spécifiques au projet

Admonitions (Syntaxe Starlight)

Utilisations standards

Formats de tableau standards

Blocs de structure de dossiers

Structure des tutoriels

Liste de vérification des tutoriels

Structure des guides pratiques (How-To)

Liste de vérification des guides pratiques

Structure des explications

Types

Modèle général

Pages d’index/d’accueil

Explications de concepts

Explications de fonctionnalités

Documents de philosophie/justification

Liste de vérification des explications

Structure des références

Types

Pages d’index de référence

Référence de catalogue

Référence d’approfondissement d’élément

Référence de configuration

Guide de référence complet

Liste de vérification des références

Structure du glossaire

Format de tableau

Règles de définition

Marqueurs de contexte

Liste de vérification du glossaire

Sections FAQ

Commandes de validation

13 KiB

Raw Permalink Blame History