Compare commits
5 Commits
9725b0ae90
...
1a6f8d52bc
| Author | SHA1 | Date |
|---|---|---|
Emmanuel Atsé
|
1a6f8d52bc | |
Alex Verkhovsky
|
1cb913523e | |
|
Emmanuel Atsé
|
a2839cbee0 | |
|
Alex Verkhovsky
|
6a73623f33 | |
|
Emmanuel Atsé
|
3ca957e229 |
|
|
@ -0,0 +1,8 @@
|
|||
---
|
||||
title: Page introuvable
|
||||
template: splash
|
||||
---
|
||||
|
||||
La page que vous recherchez n'existe pas ou a été déplacée.
|
||||
|
||||
[Retour à l'accueil](/fr/index.md)
|
||||
|
|
@ -0,0 +1,370 @@
|
|||
---
|
||||
title: "Guide de style de la documentation"
|
||||
description: 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](https://developers.google.com/style) et utilise [Diataxis](https://diataxis.fr/) 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)
|
||||
|
||||
```md
|
||||
:::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 :**
|
||||
|
||||
```md
|
||||
| Phase | Nom | Ce qui se passe |
|
||||
| ----- | ---------- | --------------------------------------------------- |
|
||||
| 1 | Analyse | Brainstorm, recherche *(optionnel)* |
|
||||
| 2 | Planification | Exigences — PRD ou spécification technique *(requis)* |
|
||||
```
|
||||
|
||||
**Skills :**
|
||||
|
||||
```md
|
||||
| Skill | Agent | Objectif |
|
||||
| ------------------- | ------- | ----------------------------------------------- |
|
||||
| `bmad-brainstorming` | Analyste | Brainstorming pour un nouveau projet |
|
||||
| `bmad-create-prd` | PM | Créer un document d'exigences produit |
|
||||
```
|
||||
|
||||
## Blocs de structure de dossiers
|
||||
|
||||
À afficher dans les sections "Ce que vous avez accompli" :
|
||||
|
||||
````md
|
||||
```
|
||||
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
|
||||
|
||||
```text
|
||||
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)
|
||||
|
||||
```text
|
||||
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
|
||||
|
||||
```text
|
||||
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
|
||||
|
||||
```text
|
||||
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
|
||||
|
||||
```text
|
||||
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
|
||||
|
||||
```text
|
||||
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
|
||||
|
||||
```text
|
||||
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
|
||||
|
||||
```text
|
||||
1. Titre + Accroche (une phrase)
|
||||
2. Sections de contenu (## pour chaque catégorie)
|
||||
- Liste à puces avec liens et descriptions
|
||||
```
|
||||
|
||||
### Référence de catalogue
|
||||
|
||||
```text
|
||||
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
|
||||
|
||||
```text
|
||||
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
|
||||
|
||||
```text
|
||||
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
|
||||
|
||||
```text
|
||||
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
|
||||
|
||||
```md
|
||||
## 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
|
||||
|
||||
```md
|
||||
## 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.
|
||||
|
||||
**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 :
|
||||
|
||||
```bash
|
||||
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
|
||||
```
|
||||
|
|
@ -0,0 +1,49 @@
|
|||
---
|
||||
title: "Élicitation Avancée"
|
||||
description: Pousser le LLM à repenser son travail en utilisant des méthodes de raisonnement structurées
|
||||
sidebar:
|
||||
order: 6
|
||||
---
|
||||
|
||||
Faites repenser au LLM ce qu'il vient de générer. Vous choisissez une méthode de raisonnement, il l'applique à sa propre sortie, et vous décidez de conserver ou non les améliorations.
|
||||
|
||||
## Qu'est-ce que l’Élicitation Avancée ?
|
||||
|
||||
Un second passage structuré. Au lieu de demander à l'IA de "réessayer" ou de "faire mieux", vous sélectionnez une méthode de raisonnement spécifique et l'IA réexamine sa propre sortie à travers ce prisme.
|
||||
|
||||
La différence est importante. Les demandes vagues produisent des révisions vagues. Une méthode nommée impose un angle d'attaque particulier, mettant en lumière des perspectives qu'un simple réajustement générique aurait manquées.
|
||||
|
||||
## Quand l'utiliser
|
||||
|
||||
- Après qu'un workflow a généré du contenu et vous souhaitez des alternatives
|
||||
- Lorsque la sortie semble correcte mais que vous soupçonnez qu'il y a davantage de profondeur
|
||||
- Pour tester les hypothèses ou trouver des faiblesses
|
||||
- Pour du contenu à enjeux élevés où la réflexion approfondie aide
|
||||
|
||||
Les workflows offrent l'élicitation aux points de décision - après que le LLM ait généré quelque chose, on vous demandera si vous souhaitez l'exécuter.
|
||||
|
||||
## Comment ça fonctionne
|
||||
|
||||
1. Le LLM suggère 5 méthodes pertinentes pour votre contenu
|
||||
2. Vous en choisissez une (ou remélangez pour différentes options)
|
||||
3. La méthode est appliquée, les améliorations sont affichées
|
||||
4. Acceptez ou rejetez, répétez ou continuez
|
||||
|
||||
## Méthodes intégrées
|
||||
|
||||
Des dizaines de méthodes de raisonnement sont disponibles. Quelques exemples :
|
||||
|
||||
- **Analyse Pré-mortem** - Suppose que le projet a déjà échoué, revient en arrière pour trouver pourquoi
|
||||
- **Pensée de Premier Principe** - Élimine les hypothèses, reconstruit à partir de la vérité de terrain
|
||||
- **Inversion** - Demande comment garantir l'échec, puis les évite
|
||||
- **Équipe Rouge vs Équipe Bleue** - Attaque votre propre travail, puis le défend
|
||||
- **Questionnement Socratique** - Conteste chaque affirmation avec "pourquoi ?" et "comment le savez-vous ?"
|
||||
- **Suppression des Contraintes** - Abandonne toutes les contraintes, voit ce qui change, les réajoute sélectivement
|
||||
- **Cartographie des Parties Prenantes** - Réévalue depuis la perspective de chaque partie prenante
|
||||
- **Raisonnement Analogique** - Trouve des parallèles dans d'autres domaines et applique leurs leçons
|
||||
|
||||
Et bien d'autres. L'IA choisit les options les plus pertinentes pour votre contenu - vous choisissez lesquelles exécuter.
|
||||
|
||||
:::tip[Commencez Ici]
|
||||
L'Analyse Pré-mortem est un bon premier choix pour toute spécification ou tout plan. Elle trouve systématiquement des lacunes qu'une révision standard manque.
|
||||
:::
|
||||
|
|
@ -0,0 +1,66 @@
|
|||
---
|
||||
title: "Revue Contradictoire"
|
||||
description: Technique de raisonnement forcée qui empêche les revues paresseuses du style "ça à l'air bon"
|
||||
sidebar:
|
||||
order: 5
|
||||
---
|
||||
|
||||
Forcez une analyse plus approfondie en exigeant que des problèmes soient trouvés.
|
||||
|
||||
## Qu'est-ce que la Revue Contradictoire ?
|
||||
|
||||
Une technique de revue où le réviseur *doit* trouver des problèmes. Pas de "ça a l'air bon" autorisé. Le réviseur adopte une posture cynique - suppose que des problèmes existent et les trouve.
|
||||
|
||||
Il ne s'agit pas d'être négatif. Il s'agit de forcer une analyse authentique au lieu d'un coup d'œil superficiel qui valide automatiquement ce qui a été soumis.
|
||||
|
||||
**La règle fondamentale :** Il doit trouver des problèmes. Zéro constatation déclenche un arrêt - réanalyse ou explique pourquoi.
|
||||
|
||||
## Pourquoi Cela Fonctionne
|
||||
|
||||
Les revues normales souffrent du biais de confirmation[^1]. Il parcourt le travail rapidement, rien ne lui saute aux yeux, il l'approuve. L'obligation de "trouver des problèmes" brise ce schéma :
|
||||
|
||||
- **Force la rigueur** - Impossible d'approuver tant qu’il n'a pas examiné suffisamment en profondeur pour trouver des problèmes
|
||||
- **Détecte les oublis** - "Qu'est-ce qui manque ici ?" devient une question naturelle
|
||||
- **Améliore la qualité du signal** - Les constatations sont spécifiques et actionnables, pas des préoccupations vagues
|
||||
- **Asymétrie d'information**[^2] - Effectue les revues avec un contexte frais (sans accès au raisonnement original) pour évaluer l'artefact, pas l'intention
|
||||
|
||||
## Où Elle Est Utilisée
|
||||
|
||||
La revue contradictoire apparaît dans tous les workflows BMad - revue de code, vérifications de préparation à l'implémentation, validation de spécifications, et d'autres. Parfois c'est une étape obligatoire, parfois optionnelle (comme l'élicitation avancée ou le mode party). Le pattern s'adapte à n'importe quel artefact nécessitant un examen.
|
||||
|
||||
## Filtrage Humain Requis
|
||||
|
||||
Parce que l'IA est *instruite* de trouver des problèmes, elle trouvera des problèmes - même lorsqu'ils n'existent pas. Attendez-vous à des faux positifs : des détails présentés comme des problèmes, des malentendus sur l'intention, ou des préoccupations purement hallucinées[^3].
|
||||
|
||||
**C'est vous qui décidez ce qui est réel.** Examinez chaque constatation, ignorez le bruit, corrigez ce qui compte.
|
||||
|
||||
## Exemple
|
||||
|
||||
Au lieu de :
|
||||
|
||||
> "L'implémentation de l'authentification semble raisonnable. Approuvé."
|
||||
|
||||
Une revue contradictoire produit :
|
||||
|
||||
> 1. **ÉLEVÉ** - `login.ts:47` - Pas de limitation de débit sur les tentatives échouées
|
||||
> 2. **ÉLEVÉ** - Jeton de session stocké dans localStorage (vulnérable au XSS)
|
||||
> 3. **MOYEN** - La validation du mot de passe se fait côté client uniquement
|
||||
> 4. **MOYEN** - Pas de journalisation d'audit pour les tentatives de connexion échouées
|
||||
> 5. **FAIBLE** - Le nombre magique `3600` devrait être `SESSION_TIMEOUT_SECONDS`
|
||||
|
||||
La première revue pourrait manquer une vulnérabilité de sécurité. La seconde en a attrapé quatre.
|
||||
|
||||
## Itération et Rendements Décroissants
|
||||
|
||||
Après avoir traité les constatations, envisagez de relancer la revue. Une deuxième passe détecte généralement plus de problèmes. Une troisième n'est pas toujours inutile non plus. Mais chaque passe prend du temps, et vous finissez par atteindre des rendements décroissants[^4] - juste des détails et des faux problèmes.
|
||||
|
||||
:::tip[Meilleures Revues]
|
||||
Supposez que des problèmes existent. Cherchez ce qui manque, pas seulement ce qui ne va pas.
|
||||
:::
|
||||
|
||||
## Glossaire
|
||||
|
||||
[^1]: **Biais de confirmation** : tendance cognitive à rechercher, interpréter et favoriser les informations qui confirment nos croyances préexistantes, tout en ignorant ou minimisant celles qui les contredisent.
|
||||
[^2]: **Asymétrie d'information** : situation où une partie dispose de plus ou de meilleures informations qu'une autre, conduisant potentiellement à des décisions ou jugements biaisés.
|
||||
[^3]: **Hallucination (IA)** : phénomène où un modèle d'IA génère des informations plausibles mais factuellement incorrectes ou inventées, présentées avec confiance comme si elles étaient vraies.
|
||||
[^4]: **Rendements décroissants** : principe selon lequel l'augmentation continue d'un investissement (temps, effort, ressources) finit par produire des bénéfices de plus en plus faibles proportionnellement.
|
||||
|
|
@ -0,0 +1,33 @@
|
|||
---
|
||||
title: "Brainstorming"
|
||||
description: Sessions interactives créatives utilisant plus de 60 techniques d'idéation éprouvées
|
||||
sidebar:
|
||||
order: 2
|
||||
---
|
||||
|
||||
Libérez votre créativité grâce à une exploration guidée.
|
||||
|
||||
## Qu'est-ce que le Brainstorming ?
|
||||
|
||||
Lancez `bmad-brainstorming` et vous obtenez un facilitateur créatif qui fait émerger vos idées - pas qui les génère pour vous. L'IA agit comme coach et guide, utilisant des techniques éprouvées pour créer les conditions où votre meilleure réflexion émerge.
|
||||
|
||||
**Idéal pour :**
|
||||
|
||||
- Surmonter les blocages créatifs
|
||||
- Générer des idées de produits ou de fonctionnalités
|
||||
- Explorer des problèmes sous de nouveaux angles
|
||||
- Développer des concepts bruts en plans d'action
|
||||
|
||||
## Comment ça fonctionne
|
||||
|
||||
1. **Configuration** - Définir le sujet, les objectifs, les contraintes
|
||||
2. **Choisir l'approche** - Choisir vous-même les techniques, obtenir des recommandations de l'IA, aller au hasard, ou suivre un flux progressif
|
||||
3. **Facilitation** - Travailler à travers les techniques avec des questions approfondies et un coaching collaboratif
|
||||
4. **Organiser** - Idées regroupées par thèmes et priorisées
|
||||
5. **Action** - Les meilleures idées reçoivent des prochaines étapes et des indicateurs de succès
|
||||
|
||||
Tout est capturé dans un document de session que vous pouvez consulter ultérieurement ou partager avec les parties prenantes.
|
||||
|
||||
:::note[Vos Idées]
|
||||
Chaque idée vient de vous. Le workflow crée les conditions propices à une vision nouvelle - vous en êtes la source.
|
||||
:::
|
||||
|
|
@ -0,0 +1,50 @@
|
|||
---
|
||||
title: "FAQ Projets Existants"
|
||||
description: Questions courantes sur l'utilisation de la méthode BMad sur des projets existants
|
||||
sidebar:
|
||||
order: 8
|
||||
---
|
||||
Réponses rapides aux questions courantes sur l'utilisation de la méthode BMad (BMM) sur des projets existants.
|
||||
|
||||
## Questions
|
||||
|
||||
- [Dois-je d'abord exécuter document-project ?](#dois-je-dabord-exécuter-document-project)
|
||||
- [Que faire si j'oublie d'exécuter document-project ?](#que-faire-si-joublie-dexécuter-document-project)
|
||||
- [Puis-je utiliser Quick Dev pour les projets existants ?](#puis-je-utiliser-quick-dev-pour-les-projets-existants)
|
||||
- [Que faire si mon code existant ne suit pas les bonnes pratiques ?](#que-faire-si-mon-code-existant-ne-suit-pas-les-bonnes-pratiques)
|
||||
|
||||
### Dois-je d'abord exécuter `document-project` ?
|
||||
|
||||
Hautement recommandé, surtout si :
|
||||
|
||||
- Aucune documentation existante
|
||||
- La documentation est obsolète
|
||||
- Les agents IA ont besoin de contexte sur le code existant
|
||||
|
||||
Vous pouvez l'ignorer si vous disposez d'une documentation complète et à jour incluant `docs/index.md` ou si vous utiliserez d'autres outils ou techniques pour aider à la découverte afin que l'agent puisse construire sur un système existant.
|
||||
|
||||
### Que faire si j'oublie d'exécuter `document-project` ?
|
||||
|
||||
Ne vous inquiétez pas — vous pouvez le faire à tout moment. Vous pouvez même le faire pendant ou après un projet pour aider à maintenir la documentation à jour.
|
||||
|
||||
### Puis-je utiliser Quick Dev pour les projets existants ?
|
||||
|
||||
Oui ! Quick Dev fonctionne très bien pour les projets existants. Il va :
|
||||
|
||||
- Détecter automatiquement votre pile technologique existante
|
||||
- Analyser les patterns de code existants
|
||||
- Détecter les conventions et demander confirmation
|
||||
- Générer une spécification technique riche en contexte qui respecte le code existant
|
||||
|
||||
Parfait pour les corrections de bugs et les petites fonctionnalités dans des bases de code existantes.
|
||||
|
||||
### Que faire si mon code existant ne suit pas les bonnes pratiques ?
|
||||
|
||||
Quick Dev détecte vos conventions et demande : « Dois-je suivre ces conventions existantes ? » Vous décidez :
|
||||
|
||||
- **Oui** → Maintenir la cohérence avec la base de code actuelle
|
||||
- **Non** → Établir de nouvelles normes (documenter pourquoi dans la spécification technique)
|
||||
|
||||
BMM respecte votre choix — il ne forcera pas la modernisation, mais la proposera.
|
||||
|
||||
**Une question sans réponse ici ?** Veuillez [ouvrir un ticket](https://github.com/bmad-code-org/BMAD-METHOD/issues) ou poser votre question sur [Discord](https://discord.gg/gk8jAdXWmj) afin que nous puissions l'ajouter !
|
||||
|
|
@ -0,0 +1,64 @@
|
|||
---
|
||||
title: "Party Mode"
|
||||
description: Collaboration multi-agents - regroupez tous vos agents IA dans une seule conversation
|
||||
sidebar:
|
||||
order: 7
|
||||
---
|
||||
|
||||
Regroupez tous vos agents IA dans une seule conversation.
|
||||
|
||||
## Qu'est-ce que le Party Mode ?
|
||||
|
||||
Lancez `bmad-party-mode` et vous avez toute votre équipe IA dans une même pièce - PM, Architecte, Développeur, Designer UX, selon vos besoins. BMad Master orchestre, en sélectionnant les agents pertinents à chaque message. Les agents répondent en personnage, sont en accord ou désaccord, et construisent sur les idées des autres.
|
||||
|
||||
La conversation continue aussi longtemps que vous le souhaitez. Posez des questions de suivi, remettez en question les réponses, redirigez la discussion - c'est un véritable échange avec vos agents jusqu'à ce que vous ayez terminé.
|
||||
|
||||
**Idéal pour :**
|
||||
|
||||
- Les grandes décisions avec des compromis
|
||||
- Les sessions de brainstorming
|
||||
- Les rétrospectives post-incident quand les choses tournent mal
|
||||
- Les rétrospectives de sprint et la planification
|
||||
|
||||
## Exemples
|
||||
|
||||
### Remettre en question une mauvaise architecture
|
||||
|
||||
**Vous :** « Ok l'équipe, notre dernier sprint a été un désastre. Le service d'authentification est tombé trois fois. Qui a cafouillé ? »
|
||||
|
||||
**Architecte :** « Le design était solide - authentification distribuée avec des fallbacks appropriés. Si l'implémentation a dévié des specs... »
|
||||
|
||||
**Développeur :** « J'ai suivi le document d'architecture à la lettre. Les specs ne prenaient pas en compte les race conditions lors de l'invalidation de sessions concurrentes. »
|
||||
|
||||
**PM :** « Vous avez tous les deux raté le vrai problème - nous n'avons pas validé les exigences de gestion des sessions dans le PRD. C'est de ma faute de ne pas l'avoir repéré. »
|
||||
|
||||
**TEA :** « Et j'aurais dû le repérer dans les tests d'intégration. Les scénarios de test ne couvraient pas l'invalidation concurrente. »
|
||||
|
||||
### Brainstorming créatif
|
||||
|
||||
**Vous :** « Comment rendre l'onboarding magique au lieu d'ennuyeux ? »
|
||||
|
||||
**Designer UX :** « Commençons par la divulgation progressive - révélons les fonctionnalités au fur et à mesure que les utilisateurs en ont besoin, pas d'un coup dans un tutoriel. »
|
||||
|
||||
**Storyteller :** « Et si l'onboarding était une histoire ? Chaque étape révèle le parcours d'un personnage - l'utilisateur EST le héros. »
|
||||
|
||||
**Game Designer :** « En partant de là - et si la première "quête" consistait à résoudre un vrai problème utilisateur ? Ils apprennent en faisant quelque chose d'utile. »
|
||||
|
||||
### Décision technique
|
||||
|
||||
**Vous :** « Monolithe ou microservices pour le MVP[^1] ? »
|
||||
|
||||
**Architecte :** « Commencez en monolithe. Les microservices ajoutent une complexité dont vous n'avez pas besoin à 1000 utilisateurs. »
|
||||
|
||||
**PM :** « D'accord. Le time-to-market[^2] compte plus que la scalabilité théorique. »
|
||||
|
||||
**Développeur :** « Monolithe avec des frontières de modules claires. On pourra extraire des services plus tard si nécessaire. »
|
||||
|
||||
:::tip[Meilleures décisions]
|
||||
De meilleures décisions grâce à des perspectives diverses. Bienvenue dans le party mode.
|
||||
:::
|
||||
|
||||
## Glossaire
|
||||
|
||||
[^1]: MVP (Minimum Viable Product) : version minimale d'un produit contenant juste assez de fonctionnalités pour être utilisée par des utilisateurs précoces et valider les hypothèses de marché avant d'investir dans un développement plus complet.
|
||||
[^2]: Time-to-market : délai nécessaire pour concevoir, développer et lancer un produit sur le marché. Plus ce délai est court, plus l'entreprise peut prendre de l'avance sur ses concurrents.
|
||||
|
|
@ -0,0 +1,117 @@
|
|||
---
|
||||
title: "Prévention des conflits entre agents"
|
||||
description: Comment l'architecture empêche les conflits lorsque plusieurs agents implémentent un système
|
||||
sidebar:
|
||||
order: 4
|
||||
---
|
||||
|
||||
Lorsque plusieurs agents IA implémentent différentes parties d'un système, ils peuvent prendre des décisions techniques contradictoires. La documentation d'architecture prévient cela en établissant des standards partagés.
|
||||
|
||||
## Types de conflits courants
|
||||
|
||||
### Conflits de style d'API
|
||||
|
||||
Sans architecture :
|
||||
- L'agent A utilise REST avec `/users/{id}`
|
||||
- L'agent B utilise des mutations GraphQL
|
||||
- Résultat : Patterns d'API incohérents, consommateurs confus
|
||||
|
||||
Avec architecture :
|
||||
- L'ADR[^1] spécifie : « Utiliser GraphQL pour toute communication client-serveur »
|
||||
- Tous les agents suivent le même pattern
|
||||
|
||||
### Conflits de conception de base de données
|
||||
|
||||
Sans architecture :
|
||||
- L'agent A utilise des noms de colonnes en snake_case
|
||||
- L'agent B utilise des noms de colonnes en camelCase
|
||||
- Résultat : Schéma incohérent, requêtes illisibles
|
||||
|
||||
Avec architecture :
|
||||
- Un document de standards spécifie les conventions de nommage
|
||||
- Tous les agents suivent les mêmes patterns
|
||||
|
||||
### Conflits de gestion d'état
|
||||
|
||||
Sans architecture :
|
||||
- L'agent A utilise Redux pour l'état global
|
||||
- L'agent B utilise React Context
|
||||
- Résultat : Multiples approches de gestion d'état, complexité
|
||||
|
||||
Avec architecture :
|
||||
- L'ADR spécifie l'approche de gestion d'état
|
||||
- Tous les agents implémentent de manière cohérente
|
||||
|
||||
## Comment l'architecture prévient les conflits
|
||||
|
||||
### 1. Décisions explicites via les ADR[^1]
|
||||
|
||||
Chaque choix technologique significatif est documenté avec :
|
||||
- Contexte (pourquoi cette décision est importante)
|
||||
- Options considérées (quelles alternatives existent)
|
||||
- Décision (ce qui a été choisi)
|
||||
- Justification (pourquoi cela a-t-il été choisi)
|
||||
- Conséquences (compromis acceptés)
|
||||
|
||||
### 2. Guidance spécifique aux FR/NFR[^2]
|
||||
|
||||
L'architecture associe chaque exigence fonctionnelle à une approche technique :
|
||||
- FR-001 : Gestion des utilisateurs → Mutations GraphQL
|
||||
- FR-002 : Application mobile → Requêtes optimisées
|
||||
|
||||
### 3. Standards et conventions
|
||||
|
||||
Documentation explicite de :
|
||||
- La structure des répertoires
|
||||
- Les conventions de nommage
|
||||
- L'organisation du code
|
||||
- Les patterns de test
|
||||
|
||||
## L'architecture comme contexte partagé
|
||||
|
||||
Considérez l'architecture comme le contexte partagé que tous les agents lisent avant d'implémenter :
|
||||
|
||||
```text
|
||||
PRD : "Que construire"
|
||||
↓
|
||||
Architecture : "Comment le construire"
|
||||
↓
|
||||
L'agent A lit l'architecture → implémente l'Epic 1
|
||||
L'agent B lit l'architecture → implémente l'Epic 2
|
||||
L'agent C lit l'architecture → implémente l'Epic 3
|
||||
↓
|
||||
Résultat : Implémentation cohérente
|
||||
```
|
||||
|
||||
## Sujets clés des ADR
|
||||
|
||||
Décisions courantes qui préviennent les conflits :
|
||||
|
||||
| Sujet | Exemple de décision |
|
||||
| ---------------- | -------------------------------------------- |
|
||||
| Style d'API | GraphQL vs REST vs gRPC |
|
||||
| Base de données | PostgreSQL vs MongoDB |
|
||||
| Authentification | JWT vs Sessions |
|
||||
| Gestion d'état | Redux vs Context vs Zustand |
|
||||
| Styling | CSS Modules vs Tailwind vs Styled Components |
|
||||
| Tests | Jest + Playwright vs Vitest + Cypress |
|
||||
|
||||
## Anti-patterns à éviter
|
||||
|
||||
:::caution[Erreurs courantes]
|
||||
- **Décisions implicites** — « On décidera du style d'API au fur et à mesure » mène à l'incohérence
|
||||
- **Sur-documentation** — Documenter chaque choix mineur cause une paralysie analytique
|
||||
- **Architecture obsolète** — Les documents écrits une fois et jamais mis à jour poussent les agents à suivre des patterns dépassés
|
||||
:::
|
||||
|
||||
:::tip[Approche correcte]
|
||||
- Documenter les décisions qui traversent les frontières des epics
|
||||
- Se concentrer sur les zones sujettes aux conflits
|
||||
- Mettre à jour l'architecture au fur et à mesure des apprentissages
|
||||
- Utiliser `bmad-correct-course` pour les changements significatifs
|
||||
:::
|
||||
|
||||
## Glossaire
|
||||
|
||||
[^1]: ADR (Architecture Decision Record) : document qui consigne une décision d’architecture, son contexte, les options envisagées, le choix retenu et ses conséquences, afin d’assurer la traçabilité et la compréhension des décisions techniques dans le temps.
|
||||
[^2]: FR / NFR (Functional / Non-Functional Requirement) : exigences décrivant respectivement **ce que le système doit faire** (fonctionnalités, comportements attendus) et **comment il doit le faire** (contraintes de performance, sécurité, fiabilité, ergonomie, etc.).
|
||||
|
|
@ -0,0 +1,158 @@
|
|||
---
|
||||
title: "Contexte du Projet"
|
||||
description: Comment project-context.md guide les agents IA avec les règles et préférences de votre projet
|
||||
sidebar:
|
||||
order: 7
|
||||
---
|
||||
|
||||
Le fichier `project-context.md` est le guide d'implémentation de votre projet pour les agents IA. Similaire à une « constitution » dans d'autres systèmes de développement, il capture les règles, les patterns et les préférences qui garantissent une génération de code cohérente à travers tous les workflows.
|
||||
|
||||
## Ce Qu'il Fait
|
||||
|
||||
Les agents IA prennent constamment des décisions d'implémentation — quels patterns suivre, comment structurer le code, quelles conventions utiliser. Sans guidance claire, ils peuvent :
|
||||
- Suivre des bonnes pratiques génériques qui ne correspondent pas à votre codebase
|
||||
- Prendre des décisions incohérentes selon les différentes stories
|
||||
- Passer à côté d'exigences ou de contraintes spécifiques au projet
|
||||
|
||||
Le fichier `project-context.md` résout ce problème en documentant ce que les agents doivent savoir dans un format concis et optimisé pour les LLM.
|
||||
|
||||
## Comment Ça Fonctionne
|
||||
|
||||
Chaque workflow d'implémentation charge automatiquement `project-context.md` s'il existe. Le workflow architecte le charge également pour respecter vos préférences techniques lors de la conception de l'architecture.
|
||||
|
||||
**Chargé par ces workflows :**
|
||||
- `bmad-create-architecture` — respecte les préférences techniques pendant la phase de solutioning
|
||||
- `bmad-create-story` — informe la création de stories avec les patterns du projet
|
||||
- `bmad-dev-story` — guide les décisions d'implémentation
|
||||
- `bmad-code-review` — valide par rapport aux standards du projet
|
||||
- `bmad-quick-dev` — applique les patterns lors de l'implémentation des spécifications techniques
|
||||
- `bmad-sprint-planning`, `bmad-retrospective`, `bmad-correct-course` — fournit le contexte global du projet
|
||||
|
||||
## Quand Le Créer
|
||||
|
||||
Le fichier `project-context.md` est utile à n'importe quel stade d'un projet :
|
||||
|
||||
| Scénario | Quand Créer | Objectif |
|
||||
|------------------------------------------|-----------------------------------------------------|---------------------------------------------------------------------------------------|
|
||||
| **Nouveau projet, avant l'architecture** | Manuellement, avant `bmad-create-architecture` | Documenter vos préférences techniques pour que l'architecte les respecte |
|
||||
| **Nouveau projet, après l'architecture** | Via `bmad-generate-project-context` ou manuellement | Capturer les décisions d'architecture pour les agents d'implémentation |
|
||||
| **Projet existant** | Via `bmad-generate-project-context` | Découvrir les patterns existants pour que les agents suivent les conventions établies |
|
||||
| **Projet Quick Dev** | Avant ou pendant `bmad-quick-dev` | Garantir que l'implémentation rapide respecte vos patterns |
|
||||
|
||||
:::tip[Recommandé]
|
||||
Pour les nouveaux projets, créez-le manuellement avant l'architecture si vous avez de fortes préférences techniques. Sinon, générez-le après l'architecture pour capturer ces décisions.
|
||||
:::
|
||||
|
||||
## Ce Qu'il Contient
|
||||
|
||||
Le fichier a deux sections principales :
|
||||
|
||||
### Pile Technologique & Versions
|
||||
|
||||
Documente les frameworks, langages et outils utilisés par votre projet avec leurs versions spécifiques :
|
||||
|
||||
```markdown
|
||||
## Pile Technologique & Versions
|
||||
|
||||
- Node.js 20.x, TypeScript 5.3, React 18.2
|
||||
- State: Zustand (pas Redux)
|
||||
- Testing: Vitest, Playwright, MSW
|
||||
- Styling: Tailwind CSS avec design tokens personnalisés
|
||||
```
|
||||
|
||||
### Règles Critiques d’Implémentation
|
||||
|
||||
Documente les patterns et conventions que les agents pourraient autrement manquer :
|
||||
|
||||
```markdown
|
||||
|
||||
## Règles Critiques d’Implémentation
|
||||
|
||||
**Configuration TypeScript :**
|
||||
- Mode strict activé — pas de types `any` sans approbation explicite
|
||||
- Utiliser `interface` pour les APIs publiques, `type` pour les unions/intersections
|
||||
|
||||
**Organisation du Code :**
|
||||
- Composants dans `/src/components/` avec fichiers `.test.tsx` co-localisés
|
||||
- Utilitaires dans `/src/lib/` pour les fonctions pures réutilisables
|
||||
- Les appels API utilisent le singleton `apiClient` — jamais de fetch direct
|
||||
|
||||
**Patterns de Tests :**
|
||||
- Les tests unitaires se concentrent sur la logique métier, pas sur les détails d’implémentation
|
||||
- Les tests d’intégration utilisent MSW pour simuler les réponses API
|
||||
- Les tests E2E couvrent uniquement les parcours utilisateurs critiques
|
||||
|
||||
**Spécifique au Framework :**
|
||||
- Toutes les opérations async utilisent le wrapper `handleError` pour une gestion cohérente des erreurs
|
||||
- Les feature flags sont accessibles via `featureFlag()` de `@/lib/flags`
|
||||
- Les nouvelles routes suivent le modèle de routage basé sur les fichiers dans `/src/app/`
|
||||
```
|
||||
|
||||
Concentrez-vous sur ce qui est **non évident** — des choses que les agents pourraient ne pas déduire en lisant des extraits de code. Ne documentez pas les pratiques standard qui s'appliquent universellement.
|
||||
|
||||
## Création du Fichier
|
||||
|
||||
Vous avez trois options :
|
||||
|
||||
### Création Manuelle
|
||||
|
||||
Créez le fichier `_bmad-output/project-context.md` et ajoutez vos règles :
|
||||
|
||||
```bash
|
||||
# Depuis la racine du projet
|
||||
mkdir -p _bmad-output
|
||||
touch _bmad-output/project-context.md
|
||||
```
|
||||
|
||||
Éditez-le avec votre pile technologique et vos règles d'implémentation. Les workflows architecture et implémentation le trouveront et le chargeront automatiquement.
|
||||
|
||||
### Générer Après L'Architecture
|
||||
|
||||
Exécutez le workflow `bmad-generate-project-context` après avoir terminé votre architecture :
|
||||
|
||||
```bash
|
||||
bmad-generate-project-context
|
||||
```
|
||||
|
||||
Cela analyse votre document d'architecture et vos fichiers projet pour générer un fichier de contexte capturant les décisions prises.
|
||||
|
||||
### Générer Pour Les Projets Existants
|
||||
|
||||
Pour les projets existants, exécutez `bmad-generate-project-context` pour découvrir les patterns existants :
|
||||
|
||||
```bash
|
||||
bmad-generate-project-context
|
||||
```
|
||||
|
||||
Le workflow analyse votre codebase pour identifier les conventions, puis génère un fichier de contexte que vous pouvez examiner et affiner.
|
||||
|
||||
## Pourquoi C'est Important
|
||||
|
||||
Sans `project-context.md`, les agents font des suppositions qui peuvent ne pas correspondre à votre projet :
|
||||
|
||||
| Sans Contexte | Avec Contexte |
|
||||
|----------------------------------------------------|-------------------------------------------------|
|
||||
| Utilise des patterns génériques | Suit vos conventions établies |
|
||||
| Style incohérent selon les stories | Implémentation cohérente |
|
||||
| Peut manquer les contraintes spécifiques au projet | Respecte toutes les exigences techniques |
|
||||
| Chaque agent décide indépendamment | Tous les agents s'alignent sur les mêmes règles |
|
||||
|
||||
C'est particulièrement important pour :
|
||||
- **Quick Dev** — saute le PRD et l'architecture, le fichier de contexte comble le vide
|
||||
- **Projets d'équipe** — garantit que tous les agents suivent les mêmes standards
|
||||
- **Projets existants** — empêche de casser les patterns établis
|
||||
|
||||
## Édition et Mise à Jour
|
||||
|
||||
Le fichier `project-context.md` est un document vivant. Mettez-le à jour quand :
|
||||
|
||||
- Les décisions d'architecture changent
|
||||
- De nouvelles conventions sont établies
|
||||
- Les patterns évoluent pendant l'implémentation
|
||||
- Vous identifiez des lacunes dans le comportement des agents
|
||||
|
||||
Vous pouvez l'éditer manuellement à tout moment, ou réexécuter `bmad-generate-project-context` pour le mettre à jour après des changements significatifs.
|
||||
|
||||
:::note[Emplacement du Fichier]
|
||||
L'emplacement par défaut est `_bmad-output/project-context.md`. Les workflows le recherchent là, et vérifient également `**/project-context.md` n'importe où dans votre projet.
|
||||
:::
|
||||
|
|
@ -0,0 +1,79 @@
|
|||
---
|
||||
title: "Quick Dev"
|
||||
description: Réduire la friction de l’interaction humaine sans renoncer aux points de contrôle qui protègent la qualité des résultats
|
||||
sidebar:
|
||||
order: 2
|
||||
---
|
||||
|
||||
Intention en entrée, modifications de code en sortie, avec aussi peu d'interactions humaines dans la boucle que possible — sans sacrifier la qualité.
|
||||
|
||||
Il permet au modèle de s'exécuter plus longtemps entre les points de contrôle, puis ne vous fait intervenir que lorsque la tâche ne peut pas se poursuivre en toute sécurité sans jugement humain, ou lorsqu'il est temps de revoir le résultat final.
|
||||
|
||||
|
||||
|
||||
## Pourquoi cette fonctionnalité existe
|
||||
|
||||
Les interactions humaines dans la boucle sont nécessaires et coûteuses.
|
||||
|
||||
Les LLM actuels échouent encore de manière prévisible : ils interprètent mal l'intention, comblent les lacunes avec des suppositions assurées, dérivent vers du travail non lié, et génèrent des résultats à réviser bruyants. En même temps, l'intervention humaine constante limite la fluidité du développement. L'attention humaine est le goulot d'étranglement.
|
||||
|
||||
`bmad-quick-dev` rééquilibre ce compromis. Il fait confiance au modèle pour s'exécuter sans surveillance sur de plus longues périodes, mais seulement après que le workflow ait créé une frontière suffisamment solide pour rendre cela sûr.
|
||||
|
||||
## La conception fondamentale
|
||||
|
||||
### 1. Compresser l'intention d'abord
|
||||
|
||||
Le workflow commence par compresser l’interaction de la personne et du modèle à partir de la requête en un objectif cohérent. L'entrée peut commencer sous forme d'une expression grossière de l'intention, mais avant que le workflow ne s'exécute de manière autonome, elle doit devenir suffisamment petite, claire et sans contradiction pour être exécutable.
|
||||
|
||||
L'intention peut prendre plusieurs formes : quelques phrases, un lien vers un outil de suivi de bugs, une sortie du mode planification, du texte copié depuis une session de chat, ou même un numéro de story depuis un fichier `epics.md` de BMAD. Dans ce dernier cas, le workflow ne comprendra pas la sémantique de suivi des stories de BMAD, mais il peut quand même prendre la story elle-même et l'exécuter.
|
||||
|
||||
Ce workflow n'élimine pas le contrôle humain. Il le déplace vers un nombre réduit d’étapes à forte valeur :
|
||||
|
||||
- **Clarification de l'intention** - transformer une demande confuse en un objectif cohérent sans contradictions cachées
|
||||
- **Approbation de la spécification** - confirmer que la compréhension figée correspond bien à ce qu'il faut construire
|
||||
- **Revue du produit final** - le point de contrôle principal, où la personne décide si le résultat est acceptable à la fin
|
||||
|
||||
### 2. Router vers le chemin le plus court et sûr
|
||||
|
||||
Une fois l'objectif clair, le workflow décide s'il s'agit d'un véritable changement en une seule étape ou s'il nécessite le chemin complet. Les petits changements à zéro impact peuvent aller directement à l'implémentation. Tout le reste passe par la planification pour que le modèle dispose d'un cadre plus solide avant de s'exécuter plus longtemps de manière autonome.
|
||||
|
||||
### 3. S'exécuter plus longtemps avec moins de supervision
|
||||
|
||||
Après cette décision de routage, le modèle peut prendre en charge une plus grande partie du travail par lui-même. Sur le chemin complet, la spécification approuvée devient le cadre dans lequel le modèle s'exécute avec moins de supervision, ce qui est tout l'intérêt de la conception.
|
||||
|
||||
### 4. Diagnostiquer les échecs au bon niveau
|
||||
|
||||
Si l'implémentation est incorrecte parce que l'intention était mauvaise, corriger le code n'est pas la bonne solution. Si le code est incorrect parce que la spécification était faible, corriger le diff n'est pas non plus la bonne solution. Le workflow est conçu pour diagnostiquer où l'échec est entré dans le système, revenir à ce niveau, et régénérer à partir de ce point.
|
||||
|
||||
Les résultats de la revue sont utilisés pour décider si le problème provenait de l'intention, de la génération de la spécification, ou de l'implémentation locale. Seuls les véritables problèmes locaux sont corrigés localement.
|
||||
|
||||
### 5. Ne faire intervenir l’humain que si nécessaire
|
||||
|
||||
L'entretien sur l'intention implique la personne dans la boucle, mais ce n'est pas le même type d'interruption qu'un point de contrôle récurrent. Le workflow essaie de garder ces points de contrôle récurrents au minimum. Après la mise en forme initiale de l'intention, la personne revient principalement lorsque le workflow ne peut pas continuer en toute sécurité sans jugement, et à la fin, lorsqu'il est temps de revoir le résultat.
|
||||
|
||||
- **Résolution des lacunes d'intention** - intervenir à nouveau lors de la revue prouve que le workflow n'a pas pu déduire correctement ce qui était voulu
|
||||
|
||||
Tout le reste est candidat à une exécution autonome plus longue. Ce compromis est délibéré. Les anciens patterns dépensent plus d'attention humaine en supervision continue. Quick Dev fait davantage confiance au modèle, mais préserve l'attention humaine pour les moments où le raisonnement humain a le plus d'impact.
|
||||
|
||||
## Pourquoi le système de revue est important
|
||||
|
||||
La phase de revue n'est pas seulement là pour trouver des bugs. Elle est là pour router la correction sans détruire l'élan.
|
||||
|
||||
Ce workflow fonctionne mieux sur une plateforme capable de générer des sous-agents[^1], ou au moins d'invoquer un autre LLM via la ligne de commande et d'attendre un résultat. Si votre plateforme ne supporte pas cela nativement, vous pouvez ajouter un skill pour le faire. Les sous-agents sans contexte sont une pierre angulaire de la conception de la revue.
|
||||
|
||||
Les revues agentiques[^2] échouent souvent de deux manières :
|
||||
|
||||
- Elles génèrent trop d’observations, forçant la personne à trier le bruit.
|
||||
- Elles déraillent des modifications actuelles en remontant des problèmes non liés et en transformant chaque exécution en un projet de nettoyage improvisé.
|
||||
|
||||
Quick Dev aborde ces deux problèmes en traitant la revue comme un triage[^3].
|
||||
|
||||
Lorsqu’une observation est fortuite plutôt que directement liée au travail en cours, le processus peut la mettre de côté au lieu d’obliger la personne à s’en occuper immédiatement. Cela permet de rester concentré sur l’exécution et d’éviter que des digressions aléatoires ne viennent épuiser le capital d’attention.
|
||||
|
||||
Ce triage sera parfois imparfait. C’est acceptable. Il est généralement préférable de mal juger certaines observations plutôt que d’inonder la personne de milliers de commentaires de revue à faible valeur. Le système optimise la qualité du rapport, pas d’être exhaustif.
|
||||
|
||||
## Glossaire
|
||||
|
||||
[^1]: Sous-agent : agent IA secondaire créé temporairement pour effectuer une tâche spécifique (comme une revue de code) de manière isolée, sans hériter du contexte complet de l’agent principal, ce qui permet une analyse plus objective et impartiale.
|
||||
[^2]: Revues agentiques (agentic review) : revue de code effectuée par un agent IA de manière autonome, capable d’analyser, d’identifier des problèmes et de formuler des recommandations sans intervention humaine directe.
|
||||
[^3]: Triage : processus de filtrage et de priorisation des observations issues d’une revue, afin de distinguer les problèmes pertinents à traiter immédiatement de ceux qui peuvent être mis de côté pour plus tard.
|
||||
|
|
@ -0,0 +1,85 @@
|
|||
---
|
||||
title: "Pourquoi le Solutioning est Important"
|
||||
description: Comprendre pourquoi la phase de solutioning est critique pour les projets multi-epics
|
||||
sidebar:
|
||||
order: 3
|
||||
---
|
||||
|
||||
La Phase 3 (Solutioning) traduit le **quoi** construire (issu de la Planification) en **comment** le construire (conception technique). Cette phase évite les conflits entre agents dans les projets multi-epics en documentant les décisions architecturales avant le début de l'implémentation.
|
||||
|
||||
## Le Problème Sans Solutioning
|
||||
|
||||
```text
|
||||
Agent 1 implémente l'Epic 1 avec une API REST
|
||||
Agent 2 implémente l'Epic 2 avec GraphQL
|
||||
Résultat : Conception d'API incohérente, cauchemar d'intégration
|
||||
```
|
||||
|
||||
Lorsque plusieurs agents implémentent différentes parties d'un système sans orientation architecturale partagée, ils prennent des décisions techniques indépendantes qui peuvent entrer en conflit.
|
||||
|
||||
## La Solution Avec le Solutioning
|
||||
|
||||
```text
|
||||
le workflow architecture décide : "Utiliser GraphQL pour toutes les API"
|
||||
Tous les agents suivent les décisions d'architecture
|
||||
Résultat : Implémentation cohérente, pas de conflits
|
||||
```
|
||||
|
||||
En documentant les décisions techniques de manière explicite, tous les agents implémentent de façon cohérente et l'intégration devient simple.
|
||||
|
||||
## Solutioning vs Planification
|
||||
|
||||
| Aspect | Planification (Phase 2) | Solutioning (Phase 3) |
|
||||
|----------|--------------------------|-------------------------------------------------|
|
||||
| Question | Quoi et Pourquoi ? | Comment ? Puis Quelles unités de travail ? |
|
||||
| Sortie | FRs/NFRs (Exigences)[^1] | Architecture + Epics[^2]/Stories[^3] |
|
||||
| Agent | PM | Architect → PM |
|
||||
| Audience | Parties prenantes | Développeurs |
|
||||
| Document | PRD[^4] (FRs/NFRs) | Architecture + Fichiers Epics |
|
||||
| Niveau | Logique métier | Conception technique + Décomposition du travail |
|
||||
|
||||
## Principe Clé
|
||||
|
||||
**Rendre les décisions techniques explicites et documentées** pour que tous les agents implémentent de manière cohérente.
|
||||
|
||||
Cela évite :
|
||||
- Les conflits de style d'API (REST vs GraphQL)
|
||||
- Les incohérences de conception de base de données
|
||||
- Les désaccords sur la gestion du state
|
||||
- Les inadéquations de conventions de nommage
|
||||
- Les variations d'approche de sécurité
|
||||
|
||||
## Quand le Solutioning est Requis
|
||||
|
||||
| Parcours | Solutioning Requis ? |
|
||||
|-----------------------|-----------------------------|
|
||||
| Quick Dev | Non - l’ignore complètement |
|
||||
| Méthode BMad Simple | Optionnel |
|
||||
| Méthode BMad Complexe | Oui |
|
||||
| Enterprise | Oui |
|
||||
|
||||
:::tip[Règle Générale]
|
||||
Si vous avez plusieurs epics qui pourraient être implémentés par différents agents, vous avez besoin de solutioning.
|
||||
:::
|
||||
|
||||
## Conséquences de sauter la phase de Solutioning
|
||||
|
||||
Sauter le solutioning sur des projets complexes entraîne :
|
||||
|
||||
- **Des problèmes d'intégration** découverts en milieu de sprint[^5]
|
||||
- **Du travail répété** dû à des implémentations conflictuelles
|
||||
- **Un temps de développement plus long** globalement
|
||||
- **De la dette technique**[^6] due à des patterns incohérents
|
||||
|
||||
:::caution[Coût Multiplié]
|
||||
Détecter les problèmes d'alignement lors du solutioning est 10× plus rapide que de les découvrir pendant l'implémentation.
|
||||
:::
|
||||
|
||||
## Glossaire
|
||||
|
||||
[^1]: FR / NFR (Functional / Non-Functional Requirement) : exigences décrivant respectivement **ce que le système doit faire** (fonctionnalités, comportements attendus) et **comment il doit le faire** (contraintes de performance, sécurité, fiabilité, ergonomie, etc.).
|
||||
[^2]: Epic : dans les méthodologies agiles, une unité de travail importante qui peut être décomposée en plusieurs stories plus petites. Un epic représente généralement une fonctionnalité majeure ou un objectif métier.
|
||||
[^3]: Story (User Story) : description courte et simple d'une fonctionnalité du point de vue de l'utilisateur, utilisée dans les méthodologies agiles pour planifier et prioriser le travail.
|
||||
[^4]: PRD (Product Requirements Document) : document de référence qui décrit les objectifs du produit, les besoins utilisateurs, les fonctionnalités attendues, les contraintes et les critères de succès, afin d'aligner les équipes sur ce qui doit être construit et pourquoi.
|
||||
[^5]: Sprint : période de temps fixe (généralement 1 à 4 semaines) dans les méthodologies agiles durant laquelle l'équipe complète un ensemble prédéfini de tâches.
|
||||
[^6]: Dette technique : coût futur supplémentaire de travail résultant de choix de facilité ou de raccourcis pris lors du développement initial, nécessitant souvent une refonte ultérieure.
|
||||
|
|
@ -0,0 +1,175 @@
|
|||
---
|
||||
title: "Comment personnaliser BMad"
|
||||
description: Personnalisez les agents, les workflows et les modules tout en préservant la compatibilité avec les mises à jour
|
||||
sidebar:
|
||||
order: 7
|
||||
---
|
||||
|
||||
Utilisez les fichiers `.customize.yaml` pour adapter le comportement, les personas[^1] et les menus des agents tout en préservant vos modifications lors des mises à jour.
|
||||
|
||||
## Quand utiliser cette fonctionnalité
|
||||
|
||||
- Vous souhaitez modifier le nom, la personnalité ou le style de communication d'un agent
|
||||
- Vous avez besoin que les agents se souviennent du contexte spécifique au projet
|
||||
- Vous souhaitez ajouter des éléments de menu personnalisés qui déclenchent vos propres workflows ou prompts
|
||||
- Vous voulez que les agents effectuent des actions spécifiques à chaque démarrage
|
||||
|
||||
:::note[Prérequis]
|
||||
- BMad installé dans votre projet (voir [Comment installer BMad](./install-bmad.md))
|
||||
- Un éditeur de texte pour les fichiers YAML
|
||||
:::
|
||||
|
||||
:::caution[Protégez vos personnalisations]
|
||||
Utilisez toujours les fichiers `.customize.yaml` décrits ici plutôt que de modifier directement les fichiers d'agents. L'installateur écrase les fichiers d'agents lors des mises à jour, mais préserve vos modifications dans les fichiers `.customize.yaml`.
|
||||
:::
|
||||
|
||||
## Étapes
|
||||
|
||||
### 1. Localiser les fichiers de personnalisation
|
||||
|
||||
Après l'installation, vous trouverez un fichier `.customize.yaml` par agent dans :
|
||||
|
||||
```text
|
||||
_bmad/_config/agents/
|
||||
├── bmm-analyst.customize.yaml
|
||||
├── bmm-architect.customize.yaml
|
||||
└── ... (un fichier par agent installé)
|
||||
```
|
||||
|
||||
### 2. Modifier le fichier de personnalisation
|
||||
|
||||
Ouvrez le fichier `.customize.yaml` de l'agent que vous souhaitez modifier. Chaque section est facultative — personnalisez uniquement ce dont vous avez besoin.
|
||||
|
||||
| Section | Comportement | Objectif |
|
||||
| ------------------ | ------------ | ------------------------------------------------ |
|
||||
| `agent.metadata` | Remplace | Remplacer le nom d'affichage de l'agent |
|
||||
| `persona` | Remplace | Définir le rôle, l'identité, le style et les principes |
|
||||
| `memories` | Ajoute | Ajouter un contexte persistant que l'agent se rappelle toujours |
|
||||
| `menu` | Ajoute | Ajouter des éléments de menu personnalisés pour les workflows ou prompts |
|
||||
| `critical_actions` | Ajoute | Définir les instructions de démarrage de l'agent |
|
||||
| `prompts` | Ajoute | Créer des prompts réutilisables pour les actions du menu |
|
||||
|
||||
Les sections marquées **Remplace** écrasent entièrement les valeurs par défaut de l'agent. Les sections marquées **Ajoute** s'ajoutent à la configuration existante.
|
||||
|
||||
**Nom de l'agent**
|
||||
|
||||
Modifier la façon dont l'agent se présente :
|
||||
|
||||
```yaml
|
||||
agent:
|
||||
metadata:
|
||||
name: 'Bob l’éponge' # Par défaut : "Mary"
|
||||
```
|
||||
|
||||
**Persona**
|
||||
|
||||
Remplacer la personnalité, le rôle et le style de communication de l'agent :
|
||||
|
||||
```yaml
|
||||
persona:
|
||||
role: 'Ingénieur Full-Stack Senior'
|
||||
identity: 'Habite dans un ananas (au fond de la mer)'
|
||||
communication_style: 'Style agaçant de Bob l’Éponge'
|
||||
principles:
|
||||
- 'Jamais de nidification, les devs Bob l’Éponge détestent plus de 2 niveaux d’imbrication'
|
||||
- 'Privilégier la composition à l’héritage'
|
||||
```
|
||||
|
||||
La section `persona`[^1] remplace entièrement le persona par défaut, donc incluez les quatre champs si vous la définissez.
|
||||
|
||||
**Souvenirs**
|
||||
|
||||
Ajouter un contexte persistant que l'agent gardera toujours en mémoire :
|
||||
|
||||
```yaml
|
||||
memories:
|
||||
- 'Travaille au Krusty Krab'
|
||||
- 'Célébrité préférée : David Hasslehoff'
|
||||
- 'Appris dans l’Epic 1 que ce n’est pas cool de faire semblant que les tests ont passé'
|
||||
```
|
||||
|
||||
**Éléments de menu**
|
||||
|
||||
Ajouter des entrées personnalisées au menu d'affichage de l'agent. Chaque élément nécessite un `trigger`, une cible (chemin `workflow` ou référence `action`), et une `description` :
|
||||
|
||||
```yaml
|
||||
menu:
|
||||
- trigger: my-workflow
|
||||
workflow: 'my-custom/workflows/my-workflow.yaml'
|
||||
description: Mon workflow personnalisé
|
||||
- trigger: deploy
|
||||
action: '#deploy-prompt'
|
||||
description: Déployer en production
|
||||
```
|
||||
|
||||
**Actions critiques**
|
||||
|
||||
Définir des instructions qui s'exécutent au démarrage de l'agent :
|
||||
|
||||
```yaml
|
||||
critical_actions:
|
||||
- 'Vérifier les pipelines CI avec le Skill XYZ et alerter l’utilisateur au réveil si quelque chose nécessite une attention urgente'
|
||||
```
|
||||
|
||||
**Prompts personnalisés**
|
||||
|
||||
Créer des prompts réutilisables que les éléments de menu peuvent référencer avec `action="#id"` :
|
||||
|
||||
```yaml
|
||||
prompts:
|
||||
- id: deploy-prompt
|
||||
content: |
|
||||
Déployer la branche actuelle en production :
|
||||
1. Exécuter tous les tests
|
||||
2. Build le projet
|
||||
3. Exécuter le script de déploiement
|
||||
```
|
||||
|
||||
### 3. Appliquer vos modifications
|
||||
|
||||
Après modification, recompilez l'agent pour appliquer les changements :
|
||||
|
||||
```bash
|
||||
npx bmad-method install
|
||||
```
|
||||
|
||||
L'installateur détecte l'installation existante et propose ces options :
|
||||
|
||||
| Option | Ce qu'elle fait |
|
||||
| ----------------------------------- | ---------------------------------------------------------------------- |
|
||||
| **Quick Update** | Met à jour tous les modules vers la dernière version et recompile tous les agents |
|
||||
| **Recompile Agents** | Applique uniquement les personnalisations, sans mettre à jour les fichiers de modules |
|
||||
| **Modify BMad Installation** | Flux d'installation complet pour ajouter ou supprimer des modules |
|
||||
|
||||
Pour des modifications de personnalisation uniquement, **Recompile Agents** est l'option la plus rapide.
|
||||
|
||||
## Résolution des problèmes
|
||||
|
||||
**Les modifications n'apparaissent pas ?**
|
||||
|
||||
- Exécutez `npx bmad-method install` et sélectionnez **Recompile Agents** pour appliquer les modifications
|
||||
- Vérifiez que votre syntaxe YAML est valide (l'indentation compte)
|
||||
- Assurez-vous d'avoir modifié le bon fichier `.customize.yaml` pour l'agent
|
||||
|
||||
**L'agent ne se charge pas ?**
|
||||
|
||||
- Vérifiez les erreurs de syntaxe YAML à l'aide d'un validateur YAML en ligne
|
||||
- Assurez-vous de ne pas avoir laissé de champs vides après les avoir décommentés
|
||||
- Essayez de revenir au modèle d'origine et de reconstruire
|
||||
|
||||
**Besoin de réinitialiser un agent ?**
|
||||
|
||||
- Effacez ou supprimez le fichier `.customize.yaml` de l'agent
|
||||
- Exécutez `npx bmad-method install` et sélectionnez **Recompile Agents** pour restaurer les valeurs par défaut
|
||||
|
||||
## Personnalisation des workflows
|
||||
|
||||
La personnalisation des workflows et skills existants de la méthode BMad arrive bientôt.
|
||||
|
||||
## Personnalisation des modules
|
||||
|
||||
Les conseils sur la création de modules d'extension et la personnalisation des modules existants arrivent bientôt.
|
||||
|
||||
## Glossaire
|
||||
|
||||
[^1]: Persona : définition de la personnalité, du rôle et du style de communication d'un agent IA. Permet d'adapter le comportement et les réponses de l'agent selon les besoins du projet.
|
||||
|
|
@ -0,0 +1,122 @@
|
|||
---
|
||||
title: "Projets existants"
|
||||
description: Comment utiliser la méthode BMad sur des bases de code existantes
|
||||
sidebar:
|
||||
order: 6
|
||||
---
|
||||
|
||||
Utilisez la méthode BMad efficacement lorsque vous travaillez sur des projets existants et des bases de code legacy.
|
||||
|
||||
Ce guide couvre le flux de travail essentiel pour l'intégration à des projets existants avec la méthode BMad.
|
||||
|
||||
:::note[Prérequis]
|
||||
- méthode BMad installée (`npx bmad-method install`)
|
||||
- Une base de code existante sur laquelle vous souhaitez travailler
|
||||
- Accès à un IDE IA (Claude Code ou Cursor)
|
||||
:::
|
||||
|
||||
## Étape 1 : Nettoyer les artefacts de planification terminés
|
||||
|
||||
Si vous avez terminé tous les epics et stories du PRD[^1] via le processus BMad, nettoyez ces fichiers. Archivez-les, supprimez-les, ou appuyez-vous sur l'historique des versions si nécessaire. Ne conservez pas ces fichiers dans :
|
||||
|
||||
- `docs/`
|
||||
- `_bmad-output/planning-artifacts/`
|
||||
- `_bmad-output/implementation-artifacts/`
|
||||
|
||||
## Étape 2 : Créer le contexte du projet
|
||||
|
||||
:::tip[Recommandé pour les projets existants]
|
||||
Générez `project-context.md` pour capturer les patterns et conventions de votre base de code existante. Cela garantit que les agents IA suivent vos pratiques établies lors de l'implémentation des modifications.
|
||||
:::
|
||||
|
||||
Exécutez le workflow de génération de contexte du projet :
|
||||
|
||||
```bash
|
||||
bmad-generate-project-context
|
||||
```
|
||||
|
||||
Cela analyse votre base de code pour identifier :
|
||||
- La pile technologique et les versions
|
||||
- Les patterns d'organisation du code
|
||||
- Les conventions de nommage
|
||||
- Les approches de test
|
||||
- Les patterns spécifiques aux frameworks
|
||||
|
||||
Vous pouvez examiner et affiner le fichier généré, ou le créer manuellement à `_bmad-output/project-context.md` si vous préférez.
|
||||
|
||||
[En savoir plus sur le contexte du projet](../explanation/project-context.md)
|
||||
|
||||
## Étape 3 : Maintenir une documentation de projet de qualité
|
||||
|
||||
Votre dossier `docs/` doit contenir une documentation succincte et bien organisée qui représente fidèlement votre projet :
|
||||
|
||||
- L'intention et la justification métier
|
||||
- Les règles métier
|
||||
- L'architecture
|
||||
- Toute autre information pertinente sur le projet
|
||||
|
||||
Pour les projets complexes, envisagez d'utiliser le workflow `bmad-document-project`. Il offre des variantes d'exécution qui analyseront l'ensemble de votre projet et documenteront son état actuel réel.
|
||||
|
||||
## Étape 4 : Obtenir de l'aide
|
||||
|
||||
### BMad-Help : Votre point de départ
|
||||
|
||||
**Exécutez `bmad-help` chaque fois que vous n'êtes pas sûr de la prochaine étape.** Ce guide intelligent :
|
||||
|
||||
- Inspecte votre projet pour voir ce qui a déjà été fait
|
||||
- Affiche les options basées sur vos modules installés
|
||||
- Comprend les requêtes en langage naturel
|
||||
|
||||
```
|
||||
bmad-help J'ai une app Rails existante, par où dois-je commencer ?
|
||||
bmad-help Quelle est la différence entre quick-dev et la méthode complète ?
|
||||
bmad-help Montre-moi quels workflows sont disponibles
|
||||
```
|
||||
|
||||
BMad-Help s'exécute également **automatiquement à la fin de chaque workflow**, fournissant des conseils clairs sur exactement quoi faire ensuite.
|
||||
|
||||
### Choisir votre approche
|
||||
|
||||
Vous avez deux options principales selon l'ampleur des modifications :
|
||||
|
||||
| Portée | Approche recommandée |
|
||||
| ----------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| **Petites mises à jour ou ajouts** | Exécutez `bmad-quick-dev` pour clarifier l'intention, planifier, implémenter et réviser dans un seul workflow. La méthode BMad complète en quatre phases est probablement excessive. |
|
||||
| **Modifications ou ajouts majeurs** | Commencez avec la méthode BMad, en appliquant autant ou aussi peu de rigueur que nécessaire. |
|
||||
|
||||
### Pendant la création du PRD
|
||||
|
||||
Lors de la création d'un brief ou en passant directement au PRD[^1], assurez-vous que l'agent :
|
||||
|
||||
- Trouve et analyse votre documentation de projet existante
|
||||
- Lit le contexte approprié sur votre système actuel
|
||||
|
||||
Vous pouvez guider l'agent explicitement, mais l'objectif est de garantir que la nouvelle fonctionnalité s'intègre bien à votre système existant.
|
||||
|
||||
### Considérations UX
|
||||
|
||||
Le travail UX[^2] est optionnel. La décision dépend non pas de savoir si votre projet a une UX, mais de :
|
||||
|
||||
- Si vous allez travailler sur des modifications UX
|
||||
- Si des conceptions ou patterns UX significatifs sont nécessaires
|
||||
|
||||
Si vos modifications se résument à de simples mises à jour d'écrans existants qui vous satisfont, un processus UX complet n'est pas nécessaire.
|
||||
|
||||
### Considérations d'architecture
|
||||
|
||||
Lors de la création de l'architecture, assurez-vous que l'architecte :
|
||||
|
||||
- Utilise les fichiers documentés appropriés
|
||||
- Analyse la base de code existante
|
||||
|
||||
Soyez particulièrement attentif ici pour éviter de réinventer la roue ou de prendre des décisions qui ne s'alignent pas avec votre architecture existante.
|
||||
|
||||
## Plus d'informations
|
||||
|
||||
- **[Corrections rapides](./quick-fixes.md)** - Corrections de bugs et modifications ad-hoc
|
||||
- **[FAQ Projets existants](../explanation/established-projects-faq.md)** - Questions courantes sur le travail sur des projets établis
|
||||
|
||||
## Glossaire
|
||||
|
||||
[^1]: PRD (Product Requirements Document) : document de référence qui décrit les objectifs du produit, les besoins utilisateurs, les fonctionnalités attendues, les contraintes et les critères de succès, afin d'aligner les équipes sur ce qui doit être construit et pourquoi.
|
||||
[^2]: UX (User Experience) : expérience utilisateur, englobant l'ensemble des interactions et perceptions d'un utilisateur face à un produit. Le design UX vise à créer des interfaces intuitives, efficaces et agréables en tenant compte des besoins, comportements et contexte d'utilisation.
|
||||
|
|
@ -0,0 +1,136 @@
|
|||
---
|
||||
title: "Comment obtenir des réponses à propos de BMad"
|
||||
description: Utiliser un LLM pour répondre rapidement à vos questions sur BMad
|
||||
sidebar:
|
||||
order: 4
|
||||
---
|
||||
|
||||
## Commencez ici : BMad-Help
|
||||
|
||||
**Le moyen le plus rapide d'obtenir des réponses sur BMad est le skill `bmad-help`.** Ce guide intelligent répondra à plus de 80 % de toutes les questions et est disponible directement dans votre IDE pendant que vous travaillez.
|
||||
|
||||
BMad-Help est bien plus qu'un outil de recherche — il :
|
||||
- **Inspecte votre projet** pour voir ce qui a déjà été réalisé
|
||||
- **Comprend le langage naturel** — posez vos questions en français courant
|
||||
- **S'adapte à vos modules installés** — affiche les options pertinentes
|
||||
- **Se lance automatiquement après les workflows** — vous indique exactement quoi faire ensuite
|
||||
- **Recommande la première tâche requise** — plus besoin de deviner par où commencer
|
||||
|
||||
### Comment utiliser BMad-Help
|
||||
|
||||
Appelez-le par son nom dans votre session IA :
|
||||
|
||||
```
|
||||
bmad-help
|
||||
```
|
||||
|
||||
:::tip
|
||||
Vous pouvez également utiliser `/bmad-help` ou `$bmad-help` selon votre plateforme, mais `bmad-help` tout seul devrait fonctionner partout.
|
||||
:::
|
||||
|
||||
Combinez-le avec une requête en langage naturel :
|
||||
|
||||
```
|
||||
bmad-help J'ai une idée de SaaS et je connais toutes les fonctionnalités. Par où commencer ?
|
||||
bmad-help Quelles sont mes options pour le design UX ?
|
||||
bmad-help Je suis bloqué sur le workflow PRD
|
||||
bmad-help Montre-moi ce qui a été fait jusqu'à maintenant
|
||||
```
|
||||
|
||||
BMad-Help répond avec :
|
||||
- Ce qui est recommandé pour votre situation
|
||||
- Quelle est la première tâche requise
|
||||
- À quoi ressemble le reste du processus
|
||||
|
||||
## Quand utiliser ce guide
|
||||
|
||||
Utilisez cette section lorsque :
|
||||
- Vous souhaitez comprendre l'architecture ou les éléments internes de BMad
|
||||
- Vous avez besoin de réponses au-delà de ce que BMad-Help fournit
|
||||
- Vous faites des recherches sur BMad avant l'installation
|
||||
- Vous souhaitez explorer le code source directement
|
||||
|
||||
## Étapes
|
||||
|
||||
### 1. Choisissez votre source
|
||||
|
||||
| Source | Idéal pour | Exemples |
|
||||
|-------------------------|------------------------------------------------------|---------------------------------------|
|
||||
| **Dossier `_bmad`** | Comment fonctionne BMad — agents, workflows, prompts | "Que fait l'agent Analyste ?" |
|
||||
| **Repo GitHub complet** | Historique, installateur, architecture | "Qu'est-ce qui a changé dans la v6 ?" |
|
||||
| **`llms-full.txt`** | Aperçu rapide depuis la documentation | "Expliquez les quatre phases de BMad" |
|
||||
|
||||
Le dossier `_bmad` est créé lorsque vous installez BMad. Si vous ne l'avez pas encore, clonez le repo à la place.
|
||||
|
||||
### 2. Pointez votre IA vers la source
|
||||
|
||||
**Si votre IA peut lire des fichiers (Claude Code, Cursor, etc.) :**
|
||||
|
||||
- **BMad installé :** Pointez vers le dossier `_bmad` et posez vos questions directement
|
||||
- **Vous voulez plus de contexte :** Clonez le [repo complet](https://github.com/bmad-code-org/BMAD-METHOD)
|
||||
|
||||
**Si vous utilisez ChatGPT ou Claude.ai (LLM en ligne) :**
|
||||
|
||||
Importez `llms-full.txt` dans votre session :
|
||||
|
||||
```text
|
||||
https://bmad-code-org.github.io/BMAD-METHOD/llms-full.txt
|
||||
```
|
||||
|
||||
|
||||
### 3. Posez votre question
|
||||
|
||||
:::note[Exemple]
|
||||
**Q :** "Quel est le moyen le plus rapide de construire quelque chose avec BMad ?"
|
||||
|
||||
**R :** Utilisez le workflow Quick Dev : Lancez `bmad-quick-dev` — il clarifie votre intention, planifie, implémente, révise et présente les résultats dans un seul workflow, en sautant les phases de planification complètes.
|
||||
:::
|
||||
|
||||
## Ce que vous obtenez
|
||||
|
||||
Des réponses directes sur BMad — comment fonctionnent les agents, ce que font les workflows, pourquoi les choses sont structurées ainsi — sans attendre la réponse de quelqu'un.
|
||||
|
||||
## Conseils
|
||||
|
||||
- **Vérifiez les réponses surprenantes** — Les LLM font parfois des erreurs. Consultez le fichier source ou posez la question sur Discord.
|
||||
- **Soyez précis** — "Que fait l'étape 3 du workflow PRD ?" est mieux que "Comment fonctionne le PRD ?"
|
||||
|
||||
## Toujours bloqué ?
|
||||
|
||||
Avez-vous essayé l'approche LLM et avez encore besoin d'aide ? Vous avez maintenant une bien meilleure question à poser.
|
||||
|
||||
| Canal | Utilisé pour |
|
||||
| ------------------------- | ------------------------------------------- |
|
||||
| `#bmad-method-help` | Questions rapides (chat en temps réel) |
|
||||
| Forum `help-requests` | Questions détaillées (recherchables, persistants) |
|
||||
| `#suggestions-feedback` | Idées et demandes de fonctionnalités |
|
||||
| `#report-bugs-and-issues` | Rapports de bugs |
|
||||
|
||||
**Discord :** [discord.gg/gk8jAdXWmj](https://discord.gg/gk8jAdXWmj)
|
||||
|
||||
**GitHub Issues :** [github.com/bmad-code-org/BMAD-METHOD/issues](https://github.com/bmad-code-org/BMAD-METHOD/issues) (pour les bugs clairs)
|
||||
|
||||
*Toi !*
|
||||
*Bloqué*
|
||||
*dans la file d'attente—*
|
||||
*qui*
|
||||
*attends-tu ?*
|
||||
|
||||
*La source*
|
||||
*est là,*
|
||||
*facile à voir !*
|
||||
|
||||
*Pointez*
|
||||
*votre machine.*
|
||||
*Libérez-la.*
|
||||
|
||||
*Elle lit.*
|
||||
*Elle parle.*
|
||||
*Demandez—*
|
||||
|
||||
*Pourquoi attendre*
|
||||
*demain*
|
||||
*quand tu as déjà*
|
||||
*cette journée ?*
|
||||
|
||||
*—Claude*
|
||||
|
|
@ -0,0 +1,116 @@
|
|||
---
|
||||
title: "Comment installer BMad"
|
||||
description: Guide étape par étape pour installer BMad dans votre projet
|
||||
sidebar:
|
||||
order: 1
|
||||
---
|
||||
|
||||
Utilisez la commande `npx bmad-method install` pour configurer BMad dans votre projet avec votre choix de modules et d'outils d'IA.
|
||||
|
||||
Si vous souhaitez utiliser un installateur non interactif et fournir toutes les options d'installation en ligne de commande, consultez [ce guide](./non-interactive-installation.md).
|
||||
|
||||
## Quand l'utiliser
|
||||
|
||||
- Démarrer un nouveau projet avec BMad
|
||||
- Ajouter BMad à une base de code existante
|
||||
- Mettre à jour une installation BMad existante
|
||||
|
||||
:::note[Prérequis]
|
||||
- **Node.js** 20+ (requis pour l'installateur)
|
||||
- **Git** (recommandé)
|
||||
- **Outil d'IA** (Claude Code, Cursor, ou similaire)
|
||||
:::
|
||||
|
||||
## Étapes
|
||||
|
||||
### 1. Lancer l'installateur
|
||||
|
||||
```bash
|
||||
npx bmad-method install
|
||||
```
|
||||
|
||||
:::tip[Vous voulez la dernière version préliminaire ?]
|
||||
Utilisez le dist-tag `next` :
|
||||
```bash
|
||||
npx bmad-method@next install
|
||||
```
|
||||
|
||||
Cela vous permet d'obtenir les nouvelles modifications plus tôt, avec un risque plus élevé de changements que l'installation par défaut.
|
||||
:::
|
||||
|
||||
:::tip[Version de développement]
|
||||
Pour installer la dernière version depuis la branche main (peut être instable) :
|
||||
```bash
|
||||
npx github:bmad-code-org/BMAD-METHOD install
|
||||
```
|
||||
:::
|
||||
|
||||
### 2. Choisir l'emplacement d'installation
|
||||
|
||||
L'installateur vous demandera où installer les fichiers BMad :
|
||||
|
||||
- Répertoire courant (recommandé pour les nouveaux projets si vous avez créé le répertoire vous-même et l'exécutez depuis ce répertoire)
|
||||
- Chemin personnalisé
|
||||
|
||||
### 3. Sélectionner vos outils d'IA
|
||||
|
||||
Choisissez les outils d'IA que vous utilisez :
|
||||
|
||||
- Claude Code
|
||||
- Cursor
|
||||
- Autres
|
||||
|
||||
Chaque outil a sa propre façon d'intégrer les skills. L'installateur crée de petits fichiers de prompt pour activer les workflows et les agents — il les place simplement là où votre outil s'attend à les trouver.
|
||||
|
||||
:::note[Activer les skills]
|
||||
Certaines plateformes nécessitent que les skills soient explicitement activés dans les paramètres avant d'apparaître. Si vous installez BMad et ne voyez pas les skills, vérifiez les paramètres de votre plateforme ou demandez à votre assistant IA comment activer les skills.
|
||||
:::
|
||||
|
||||
### 4. Choisir les modules
|
||||
|
||||
L'installateur affiche les modules disponibles. Sélectionnez ceux dont vous avez besoin — la plupart des utilisateurs veulent simplement **méthode BMad** (le module de développement logiciel).
|
||||
|
||||
### 5. Suivre les instructions
|
||||
|
||||
L'installateur vous guide pour le reste — contenu personnalisé, paramètres, etc.
|
||||
|
||||
## Ce que vous obtenez
|
||||
|
||||
```text
|
||||
votre-projet/
|
||||
├── _bmad/
|
||||
│ ├── bmm/ # Vos modules sélectionnés
|
||||
│ │ └── config.yaml # Paramètres du module (si vous devez les modifier)
|
||||
│ ├── core/ # Module core requis
|
||||
│ └── ...
|
||||
├── _bmad-output/ # Artefacts générés
|
||||
├── .claude/ # Skills Claude Code (si vous utilisez Claude Code)
|
||||
│ └── skills/
|
||||
│ ├── bmad-help/
|
||||
│ ├── bmad-persona/
|
||||
│ └── ...
|
||||
└── .cursor/ # Skills Cursor (si vous utilisez Cursor)
|
||||
└── skills/
|
||||
└── ...
|
||||
```
|
||||
|
||||
## Vérifier l'installation
|
||||
|
||||
Exécutez `bmad-help` pour vérifier que tout fonctionne et voir quoi faire ensuite.
|
||||
|
||||
**BMad-Help est votre guide intelligent** qui va :
|
||||
- Confirmer que votre installation fonctionne
|
||||
- Afficher ce qui est disponible en fonction de vos modules installés
|
||||
- Recommander votre première étape
|
||||
|
||||
Vous pouvez aussi lui poser des questions :
|
||||
```
|
||||
bmad-help Je viens d'installer, que dois-je faire en premier ?
|
||||
bmad-help Quelles sont mes options pour un projet SaaS ?
|
||||
```
|
||||
|
||||
## Résolution de problèmes
|
||||
|
||||
**L'installateur affiche une erreur** — Copiez-collez la sortie dans votre assistant IA et laissez-le résoudre le problème.
|
||||
|
||||
**L'installateur a fonctionné mais quelque chose ne fonctionne pas plus tard** — Votre IA a besoin du contexte BMad pour vous aider. Consultez [Comment obtenir des réponses à propos de BMad](./get-answers-about-bmad.md) pour savoir comment diriger votre IA vers les bonnes sources.
|
||||
|
|
@ -0,0 +1,171 @@
|
|||
---
|
||||
title: Installation non-interactive
|
||||
description: Installer BMad en utilisant des options de ligne de commande pour les pipelines CI/CD et les déploiements automatisés
|
||||
sidebar:
|
||||
order: 2
|
||||
---
|
||||
|
||||
Utilisez les options de ligne de commande pour installer BMad de manière non-interactive. Cela est utile pour :
|
||||
|
||||
## Quand utiliser cette méthode
|
||||
|
||||
- Déploiements automatisés et pipelines CI/CD
|
||||
- Installations scriptées
|
||||
- Installations par lots sur plusieurs projets
|
||||
- Installations rapides avec des configurations connues
|
||||
|
||||
:::note[Prérequis]
|
||||
Nécessite [Node.js](https://nodejs.org) v20+ et `npx` (inclus avec npm).
|
||||
:::
|
||||
|
||||
## Options disponibles
|
||||
|
||||
### Options d'installation
|
||||
|
||||
| Option | Description | Exemple |
|
||||
|------|-------------|---------|
|
||||
| `--directory <chemin>` | Répertoire d'installation | `--directory ~/projects/myapp` |
|
||||
| `--modules <modules>` | IDs de modules séparés par des virgules | `--modules bmm,bmb` |
|
||||
| `--tools <outils>` | IDs d'outils/IDE séparés par des virgules (utilisez `none` pour ignorer) | `--tools claude-code,cursor` ou `--tools none` |
|
||||
| `--custom-content <chemins>` | Chemins vers des modules personnalisés séparés par des virgules | `--custom-content ~/my-module,~/another-module` |
|
||||
| `--action <type>` | Action pour les installations existantes : `install` (par défaut), `update`, `quick-update`, ou `compile-agents` | `--action quick-update` |
|
||||
|
||||
### Configuration principale
|
||||
|
||||
| Option | Description | Par défaut |
|
||||
|------|-------------|---------|
|
||||
| `--user-name <nom>` | Nom à utiliser par les agents | Nom d'utilisateur système |
|
||||
| `--communication-language <langue>` | Langue de communication des agents | Anglais |
|
||||
| `--document-output-language <langue>` | Langue de sortie des documents | Anglais |
|
||||
| `--output-folder <chemin>` | Chemin du dossier de sortie | _bmad-output |
|
||||
|
||||
### Autres options
|
||||
|
||||
| Option | Description |
|
||||
|------|-------------|
|
||||
| `-y, --yes` | Accepter tous les paramètres par défaut et ignorer les invites |
|
||||
| `-d, --debug` | Activer la sortie de débogage pour la génération du manifeste |
|
||||
|
||||
## IDs de modules
|
||||
|
||||
IDs de modules disponibles pour l’option `--modules` :
|
||||
|
||||
- `bmm` — méthode BMad Master
|
||||
- `bmb` — BMad Builder
|
||||
|
||||
Consultez le [registre BMad](https://github.com/bmad-code-org) pour les modules externes disponibles.
|
||||
|
||||
## IDs d'outils/IDE
|
||||
|
||||
IDs d'outils disponibles pour l’option `--tools` :
|
||||
|
||||
**Recommandés :** `claude-code`, `cursor`
|
||||
|
||||
Exécutez `npx bmad-method install` de manière interactive une fois pour voir la liste complète actuelle des outils pris en charge, ou consultez la [configuration des codes de la plateforme](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/tools/cli/installers/lib/ide/platform-codes.yaml).
|
||||
|
||||
## Modes d'installation
|
||||
|
||||
| Mode | Description | Exemple |
|
||||
|------|-------------|---------|
|
||||
| Entièrement non-interactif | Fournir toutes les options pour ignorer toutes les invites | `npx bmad-method install --directory . --modules bmm --tools claude-code --yes` |
|
||||
| Semi-interactif | Fournir certains options ; BMad demande les autres | `npx bmad-method install --directory . --modules bmm` |
|
||||
| Paramètres par défaut uniquement | Accepter tous les paramètres par défaut avec `-y` | `npx bmad-method install --yes` |
|
||||
| Sans outils | Ignorer la configuration des outils/IDE | `npx bmad-method install --modules bmm --tools none` |
|
||||
|
||||
## Exemples
|
||||
|
||||
### Installation dans un pipeline CI/CD
|
||||
|
||||
```bash
|
||||
#!/bin/bash
|
||||
# install-bmad.sh
|
||||
|
||||
npx bmad-method install \
|
||||
--directory "${GITHUB_WORKSPACE}" \
|
||||
--modules bmm \
|
||||
--tools claude-code \
|
||||
--user-name "CI Bot" \
|
||||
--communication-language Français \
|
||||
--document-output-language Français \
|
||||
--output-folder _bmad-output \
|
||||
--yes
|
||||
```
|
||||
|
||||
### Mettre à jour une installation existante
|
||||
|
||||
```bash
|
||||
npx bmad-method install \
|
||||
--directory ~/projects/myapp \
|
||||
--action update \
|
||||
--modules bmm,bmb,custom-module
|
||||
```
|
||||
|
||||
### Mise à jour rapide (conserver les paramètres)
|
||||
|
||||
```bash
|
||||
npx bmad-method install \
|
||||
--directory ~/projects/myapp \
|
||||
--action quick-update
|
||||
```
|
||||
|
||||
### Installation avec du contenu personnalisé
|
||||
|
||||
```bash
|
||||
npx bmad-method install \
|
||||
--directory ~/projects/myapp \
|
||||
--modules bmm \
|
||||
--custom-content ~/my-custom-module,~/another-module \
|
||||
--tools claude-code
|
||||
```
|
||||
|
||||
## Ce que vous obtenez
|
||||
|
||||
- Un répertoire `_bmad/` entièrement configuré dans votre projet
|
||||
- Des agents et des flux de travail compilés pour vos modules et outils sélectionnés
|
||||
- Un dossier `_bmad-output/` pour les artefacts générés
|
||||
|
||||
## Validation et gestion des erreurs
|
||||
|
||||
BMad valide toutes les options fournis :
|
||||
|
||||
- **Directory** — Doit être un chemin valide avec des permissions d'écriture
|
||||
- **Modules** — Avertit des IDs de modules invalides (mais n'échoue pas)
|
||||
- **Tools** — Avertit des IDs d'outils invalides (mais n'échoue pas)
|
||||
- **Custom Content** — Chaque chemin doit contenir un fichier `module.yaml` valide
|
||||
- **Action** — Doit être l'une des suivantes : `install`, `update`, `quick-update`, `compile-agents`
|
||||
|
||||
Les valeurs invalides entraîneront soit :
|
||||
1. L’affichage d’un message d'erreur suivi d’un exit (pour les options critiques comme le répertoire)
|
||||
2. Un avertissement puis la continuation de l’installation (pour les éléments optionnels comme le contenu personnalisé)
|
||||
3. Un retour aux invites interactives (pour les valeurs requises manquantes)
|
||||
|
||||
:::tip[Bonnes pratiques]
|
||||
- Utilisez des chemins absolus pour `--directory` pour éviter toute ambiguïté
|
||||
- Testez les options localement avant de les utiliser dans des pipelines CI/CD
|
||||
- Combinez avec `-y` pour des installations vraiment sans surveillance
|
||||
- Utilisez `--debug` si vous rencontrez des problèmes lors de l'installation
|
||||
:::
|
||||
|
||||
## Résolution des problèmes
|
||||
|
||||
### L'installation échoue avec "Invalid directory"
|
||||
|
||||
- Le chemin du répertoire doit exister (ou son parent doit exister)
|
||||
- Vous avez besoin des permissions d'écriture
|
||||
- Le chemin doit être absolu ou correctement relatif au répertoire actuel
|
||||
|
||||
### Module non trouvé
|
||||
|
||||
- Vérifiez que l'ID du module est correct
|
||||
- Les modules externes doivent être disponibles dans le registre
|
||||
|
||||
### Chemin de contenu personnalisé invalide
|
||||
|
||||
Assurez-vous que chaque chemin de contenu personnalisé :
|
||||
- Pointe vers un répertoire
|
||||
- Contient un fichier `module.yaml` à la racine
|
||||
- Possède un champ `code` dans `module.yaml`
|
||||
|
||||
:::note[Toujours bloqué ?]
|
||||
Exécutez avec `--debug` pour une sortie détaillée, essayez le mode interactif pour isoler le problème, ou signalez-le à <https://github.com/bmad-code-org/BMAD-METHOD/issues>.
|
||||
:::
|
||||
|
|
@ -0,0 +1,127 @@
|
|||
---
|
||||
title: "Gérer le contexte du projet"
|
||||
description: Créer et maintenir project-context.md pour guider les agents IA
|
||||
sidebar:
|
||||
order: 8
|
||||
---
|
||||
|
||||
Utilisez le fichier `project-context.md` pour garantir que les agents IA respectent les préférences techniques et les règles d'implémentation de votre projet tout au long des workflows. Pour vous assurer qu'il est toujours disponible, vous pouvez également ajouter la ligne `Le contexte et les conventions importantes du projet se trouvent dans [chemin vers le contexte du projet]/project-context.md` à votre fichier de contexte ou de règles permanentes (comme `AGENTS.md`).
|
||||
|
||||
:::note[Prérequis]
|
||||
- Méthode BMad installée
|
||||
- Connaissance de la pile technologique et des conventions de votre projet
|
||||
:::
|
||||
|
||||
## Quand utiliser cette fonctionnalité
|
||||
|
||||
- Vous avez des préférences techniques fortes avant de commencer l'architecture
|
||||
- Vous avez terminé l'architecture et souhaitez consigner les décisions pour l'implémentation
|
||||
- Vous travaillez sur une base de code existante avec des patterns établis
|
||||
- Vous remarquez que les agents prennent des décisions incohérentes entre les stories
|
||||
|
||||
## Étape 1 : Choisissez votre approche
|
||||
|
||||
**Création manuelle** — Idéal lorsque vous savez exactement quelles règles vous souhaitez documenter
|
||||
|
||||
**Génération après l'architecture** — Idéal pour capturer les décisions prises lors du solutioning
|
||||
|
||||
**Génération pour les projets existants** — Idéal pour découvrir les patterns dans les bases de code existantes
|
||||
|
||||
## Étape 2 : Créez le fichier
|
||||
|
||||
### Option A : Création manuelle
|
||||
|
||||
Créez le fichier à l'emplacement `_bmad-output/project-context.md` :
|
||||
|
||||
```bash
|
||||
mkdir -p _bmad-output
|
||||
touch _bmad-output/project-context.md
|
||||
```
|
||||
|
||||
Ajoutez votre pile technologique et vos règles d'implémentation :
|
||||
|
||||
```markdown
|
||||
---
|
||||
project_name: 'MonProjet'
|
||||
user_name: 'VotreNom'
|
||||
date: '2026-02-15'
|
||||
sections_completed: ['technology_stack', 'critical_rules']
|
||||
---
|
||||
|
||||
# Contexte de Projet pour Agents IA
|
||||
|
||||
## Pile Technologique & Versions
|
||||
|
||||
- Node.js 20.x, TypeScript 5.3, React 18.2
|
||||
- State : Zustand
|
||||
- Tests : Vitest, Playwright
|
||||
- Styles : Tailwind CSS
|
||||
|
||||
## Règles d'Implémentation Critiques
|
||||
|
||||
**TypeScript :**
|
||||
- Mode strict activé, pas de types `any`
|
||||
- Utiliser `interface` pour les API publiques, `type` pour les unions
|
||||
|
||||
**Organisation du Code :**
|
||||
- Composants dans `/src/components/` avec tests co-localisés
|
||||
- Les appels API utilisent le singleton `apiClient` — jamais de fetch direct
|
||||
|
||||
**Tests :**
|
||||
- Tests unitaires axés sur la logique métier
|
||||
- Tests d'intégration utilisent MSW pour le mock API
|
||||
```
|
||||
|
||||
### Option B : Génération après l'architecture
|
||||
|
||||
Exécutez le workflow dans une nouvelle conversation :
|
||||
|
||||
```bash
|
||||
bmad-generate-project-context
|
||||
```
|
||||
|
||||
Le workflow analyse votre document d'architecture et vos fichiers projet pour générer un fichier de contexte qui capture les décisions prises.
|
||||
|
||||
### Option C : Génération pour les projets existants
|
||||
|
||||
Pour les projets existants, exécutez :
|
||||
|
||||
```bash
|
||||
bmad-generate-project-context
|
||||
```
|
||||
|
||||
Le workflow analyse votre base de code pour identifier les conventions, puis génère un fichier de contexte que vous pouvez réviser et affiner.
|
||||
|
||||
## Étape 3 : Vérifiez le contenu
|
||||
|
||||
Révisez le fichier généré et assurez-vous qu'il capture :
|
||||
|
||||
- Les versions correctes des technologies
|
||||
- Vos conventions réelles (pas les bonnes pratiques génériques)
|
||||
- Les règles qui évitent les erreurs courantes
|
||||
- Les patterns spécifiques aux frameworks
|
||||
|
||||
Modifiez manuellement pour ajouter les éléments manquants ou supprimer les inexactitudes.
|
||||
|
||||
## Ce que vous obtenez
|
||||
|
||||
Un fichier `project-context.md` qui :
|
||||
|
||||
- Garantit que tous les agents suivent les mêmes conventions
|
||||
- Évite les décisions incohérentes entre les stories
|
||||
- Capture les décisions d'architecture pour l'implémentation
|
||||
- Sert de référence pour les patterns et règles de votre projet
|
||||
|
||||
## Conseils
|
||||
|
||||
:::tip[Bonnes pratiques]
|
||||
- **Concentrez-vous sur ce qui n'est pas évident** — Documentez les patterns que les agents pourraient manquer (par ex. « Utiliser JSDoc sur chaque classe publique »), et non les pratiques universelles comme « utiliser des noms de variables significatifs ».
|
||||
- **Gardez-le concis** — Ce fichier est chargé par chaque workflow d'implémentation. Les fichiers longs gaspillent le contexte. Excluez le contenu qui ne s'applique qu'à un périmètre restreint ou à des stories spécifiques.
|
||||
- **Mettez à jour si nécessaire** — Modifiez manuellement lorsque les patterns changent, ou régénérez après des changements d'architecture significatifs.
|
||||
- Fonctionne aussi bien pour Quick Dev que pour les projets complets méthode BMad.
|
||||
:::
|
||||
|
||||
## Prochaines étapes
|
||||
|
||||
- [**Explication du contexte projet**](../explanation/project-context.md) — En savoir plus sur son fonctionnement
|
||||
- [**Carte des workflows**](../reference/workflow-map.md) — Voir quels workflows chargent le contexte projet
|
||||
|
|
@ -0,0 +1,98 @@
|
|||
---
|
||||
title: "Corrections Rapides"
|
||||
description: Comment effectuer des corrections rapides et des modifications ciblées
|
||||
sidebar:
|
||||
order: 5
|
||||
---
|
||||
|
||||
Utilisez **Quick Dev** pour les corrections de bugs, les refactorisations ou les petites modifications ciblées qui ne nécessitent pas la méthode BMad complète.
|
||||
|
||||
## Quand Utiliser Cette Approche
|
||||
|
||||
- Corrections de bugs avec une cause claire et connue
|
||||
- Petites refactorisations (renommage, extraction, restructuration) contenues dans quelques fichiers
|
||||
- Ajustements mineurs de fonctionnalités ou modifications de configuration
|
||||
- Mises à jour de dépendances
|
||||
|
||||
:::note[Prérequis]
|
||||
- Méthode BMad installée (`npx bmad-method install`)
|
||||
- Un IDE IA (Claude Code, Cursor, ou similaire)
|
||||
:::
|
||||
|
||||
## Étapes
|
||||
|
||||
### 1. Démarrer une Nouvelle Conversation
|
||||
|
||||
Ouvrez une **nouvelle conversation** dans votre IDE IA. Réutiliser une session d'un workflow précédent peut causer des conflits de contexte.
|
||||
|
||||
### 2. Spécifiez Votre Intention
|
||||
|
||||
Quick Dev accepte l'intention en forme libre — avant, avec, ou après l'invocation. Exemples :
|
||||
|
||||
```text
|
||||
quick-dev — Corrige le bug de validation de connexion qui permet les mots de passe vides.
|
||||
```
|
||||
|
||||
```text
|
||||
quick-dev — corrige https://github.com/org/repo/issues/42
|
||||
```
|
||||
|
||||
```text
|
||||
quick-dev — implémente _bmad-output/implementation-artifacts/my-intent.md
|
||||
```
|
||||
|
||||
```text
|
||||
Je pense que le problème est dans le middleware d'auth, il ne vérifie pas l'expiration du token.
|
||||
Regardons... oui, src/auth/middleware.ts ligne 47 saute complètement la vérification exp. lance quick-dev
|
||||
```
|
||||
|
||||
```text
|
||||
quick-dev
|
||||
> Que voulez-vous faire ?
|
||||
Refactoriser UserService pour utiliser async/await au lieu des callbacks.
|
||||
```
|
||||
|
||||
Texte brut, chemins de fichiers, URLs d'issues GitHub, liens de trackers de bugs — tout ce que le LLM peut résoudre en une intention concrète.
|
||||
|
||||
### 3. Répondre aux Questions et Approuver
|
||||
|
||||
Quick Dev peut poser des questions de clarification ou présenter une courte spécification demandant votre approbation avant l'implémentation. Répondez à ses questions et approuvez lorsque vous êtes satisfait du plan.
|
||||
|
||||
### 4. Réviser et Pousser
|
||||
|
||||
Quick Dev implémente la modification, révise son propre travail, corrige les problèmes et effectue un commit local. Lorsqu'il a terminé, il ouvre les fichiers affectés dans votre éditeur.
|
||||
|
||||
- Parcourez le diff pour confirmer que la modification correspond à votre intention
|
||||
- Si quelque chose semble incorrect, dites à l'agent ce qu'il faut corriger — il peut itérer dans la même session
|
||||
|
||||
Une fois satisfait, poussez le commit. Quick Dev vous proposera de pousser et de créer une PR pour vous.
|
||||
|
||||
:::caution[Si Quelque Chose Casse]
|
||||
Si une modification poussée cause des problèmes inattendus, utilisez `git revert HEAD` pour annuler proprement le dernier commit. Ensuite, démarrez une nouvelle conversation et exécutez Quick Dev à nouveau pour essayer une approche différente.
|
||||
:::
|
||||
|
||||
## Ce Que Vous Obtenez
|
||||
|
||||
- Fichiers source modifiés avec la correction ou refactorisation appliquée
|
||||
- Tests passants (si votre projet a une suite de tests)
|
||||
- Un commit prêt à pousser avec un message de commit conventionnel
|
||||
|
||||
## Travail Différé
|
||||
|
||||
Quick Dev garde chaque exécution concentrée sur un seul objectif. Si votre demande contient plusieurs objectifs indépendants, ou si la revue remonte des problèmes préexistants non liés à votre modification, Quick Dev les diffère vers un fichier (`deferred-work.md` dans votre répertoire d'artefacts d'implémentation) plutôt que d'essayer de tout régler en même temps.
|
||||
|
||||
Consultez ce fichier après une exécution — c'est votre backlog[^1] de choses sur lesquelles revenir. Chaque élément différé peut être introduit dans une nouvelle exécution Quick Dev ultérieurement.
|
||||
|
||||
## Quand Passer à une Planification Formelle
|
||||
|
||||
Envisagez d'utiliser la méthode BMad complète lorsque :
|
||||
|
||||
- La modification affecte plusieurs systèmes ou nécessite des mises à jour coordonnées dans de nombreux fichiers
|
||||
- Vous n'êtes pas sûr de la portée et avez besoin d'une découverte des exigences d'abord
|
||||
- Vous avez besoin de documentation ou de décisions architecturales enregistrées pour l'équipe
|
||||
|
||||
Voir [Quick Dev](../explanation/quick-dev.md) pour plus d'informations sur la façon dont Quick Dev s'intègre dans la méthode BMad.
|
||||
|
||||
## Glossaire
|
||||
|
||||
[^1]: Backlog : liste priorisée de tâches ou d'éléments de travail à traiter ultérieurement, issue des méthodologies agiles.
|
||||
|
|
@ -0,0 +1,78 @@
|
|||
---
|
||||
title: "Guide de Division de Documents"
|
||||
description: Diviser les fichiers markdown volumineux en fichiers plus petits et organisés pour une meilleure gestion du contexte
|
||||
sidebar:
|
||||
order: 9
|
||||
---
|
||||
|
||||
Utilisez l'outil `bmad-shard-doc` si vous avez besoin de diviser des fichiers markdown volumineux en fichiers plus petits et organisés pour une meilleure gestion du contexte.
|
||||
|
||||
:::caution[Déprécié]
|
||||
Ceci n'est plus recommandé, et bientôt avec les workflows mis à jour et la plupart des LLM et outils majeurs supportant les sous-processus, cela deviendra inutile.
|
||||
:::
|
||||
|
||||
## Quand l’Utiliser
|
||||
|
||||
Utilisez ceci uniquement si vous remarquez que votre combinaison outil / modèle ne parvient pas à charger et lire tous les documents en entrée lorsque c'est nécessaire.
|
||||
|
||||
## Qu'est-ce que la Division de Documents ?
|
||||
|
||||
La division de documents divise les fichiers markdown volumineux en fichiers plus petits et organisés basés sur les titres de niveau 2 (`## Titre`).
|
||||
|
||||
### Architecture
|
||||
|
||||
```text
|
||||
Avant Division :
|
||||
_bmad-output/planning-artifacts/
|
||||
└── PRD.md (fichier volumineux de 50k tokens)
|
||||
|
||||
Après Division :
|
||||
_bmad-output/planning-artifacts/
|
||||
└── prd/
|
||||
├── index.md # Table des matières avec descriptions
|
||||
├── overview.md # Section 1
|
||||
├── user-requirements.md # Section 2
|
||||
├── technical-requirements.md # Section 3
|
||||
└── ... # Sections supplémentaires
|
||||
```
|
||||
|
||||
## Étapes
|
||||
|
||||
### 1. Exécuter l'Outil Shard-Doc
|
||||
|
||||
```bash
|
||||
/bmad-shard-doc
|
||||
```
|
||||
|
||||
### 2. Suivre le Processus Interactif
|
||||
|
||||
```text
|
||||
Agent : Quel document souhaitez-vous diviser ?
|
||||
Utilisateur : docs/PRD.md
|
||||
|
||||
Agent : Destination par défaut : docs/prd/
|
||||
Accepter la valeur par défaut ? [y/n]
|
||||
Utilisateur : y
|
||||
|
||||
Agent : Division de PRD.md...
|
||||
✓ 12 fichiers de section créés
|
||||
✓ index.md généré
|
||||
✓ Terminé !
|
||||
```
|
||||
|
||||
## Comment Fonctionne la Découverte de Workflow
|
||||
|
||||
Les workflows BMad utilisent un **système de découverte double** :
|
||||
|
||||
1. **Essaye d'abord le document entier** - Rechercher `document-name.md`
|
||||
2. **Vérifie la version divisée** - Rechercher `document-name/index.md`
|
||||
3. **Règle de priorité** - Le document entier a la priorité si les deux existent - supprimez le document entier si vous souhaitez que la version divisée soit utilisée à la place
|
||||
|
||||
## Support des Workflows
|
||||
|
||||
Tous les workflows BMM prennent en charge les deux formats :
|
||||
|
||||
- Documents entiers
|
||||
- Documents divisés
|
||||
- Détection automatique
|
||||
- Transparent pour l'utilisateur
|
||||
|
|
@ -0,0 +1,106 @@
|
|||
---
|
||||
title: "Comment passer à la v6"
|
||||
description: Migrer de BMad v4 vers v6
|
||||
sidebar:
|
||||
order: 3
|
||||
---
|
||||
|
||||
Utilisez l'installateur BMad pour passer de la v4 à la v6, qui inclut une détection automatique des installations existantes et une assistance à la migration.
|
||||
|
||||
## Quand utiliser ce guide
|
||||
|
||||
- Vous avez BMad v4 installé (dossier `.bmad-method`)
|
||||
- Vous souhaitez migrer vers la nouvelle architecture v6
|
||||
- Vous avez des artefacts de planification existants à préserver
|
||||
|
||||
:::note[Prérequis]
|
||||
- Node.js 20+
|
||||
- Installation BMad v4 existante
|
||||
:::
|
||||
|
||||
## Étapes
|
||||
|
||||
### 1. Lancer l'installateur
|
||||
|
||||
Suivez les [Instructions d'installation](./install-bmad.md).
|
||||
|
||||
### 2. Gérer l'installation existante
|
||||
|
||||
Quand v4 est détecté, vous pouvez :
|
||||
|
||||
- Autoriser l'installateur à sauvegarder et supprimer `.bmad-method`
|
||||
- Quitter et gérer le nettoyage manuellement
|
||||
|
||||
Si vous avez nommé votre dossier de méthode bmad autrement, vous devrez supprimer le dossier vous-même manuellement.
|
||||
|
||||
### 3. Nettoyer les skills IDE
|
||||
|
||||
Supprimez manuellement les commandes/skills IDE v4 existants - par exemple si vous avez Claude Code, recherchez tous les dossiers imbriqués qui commencent par bmad et supprimez-les :
|
||||
|
||||
- `.claude/commands/`
|
||||
|
||||
Les nouveaux skills v6 sont installés dans :
|
||||
|
||||
- `.claude/skills/`
|
||||
|
||||
### 4. Migrer les artefacts de planification
|
||||
|
||||
**Si vous avez des documents de planification (Brief/PRD/UX/Architecture) :**
|
||||
|
||||
Déplacez-les dans `_bmad-output/planning-artifacts/` avec des noms descriptifs :
|
||||
|
||||
- Incluez `PRD` dans le nom de fichier pour les documents PRD[^1]
|
||||
- Incluez `brief`, `architecture`, ou `ux-design` selon le cas
|
||||
- Les documents divisés peuvent être dans des sous-dossiers nommés
|
||||
|
||||
**Si vous êtes en cours de planification :** Envisagez de redémarrer avec les workflows v6. Utilisez vos documents existants comme entrées - les nouveaux workflows de découverte progressive avec recherche web et mode plan IDE produisent de meilleurs résultats.
|
||||
|
||||
### 5. Migrer le développement en cours
|
||||
|
||||
Si vous avez des stories[^3] créées ou implémentées :
|
||||
|
||||
1. Terminez l'installation v6
|
||||
2. Placez `epics.md` ou `epics/epic*.md`[^2] dans `_bmad-output/planning-artifacts/`
|
||||
3. Lancez le workflow `bmad-sprint-planning`[^4]
|
||||
4. Indiquez quels epics/stories sont déjà terminés
|
||||
|
||||
## Ce que vous obtenez
|
||||
|
||||
**Structure unifiée v6 :**
|
||||
|
||||
```text
|
||||
votre-projet/
|
||||
├── _bmad/ # Dossier d'installation unique
|
||||
│ ├── _config/ # Vos personnalisations
|
||||
│ │ └── agents/ # Fichiers de personnalisation des agents
|
||||
│ ├── core/ # Framework core universel
|
||||
│ ├── bmm/ # Module BMad Method
|
||||
│ ├── bmb/ # BMad Builder
|
||||
│ └── cis/ # Creative Intelligence Suite
|
||||
└── _bmad-output/ # Dossier de sortie (était le dossier doc en v4)
|
||||
```
|
||||
|
||||
## Migration des modules
|
||||
|
||||
| Module v4 | Statut v6 |
|
||||
| ----------------------------- | ----------------------------------------- |
|
||||
| `.bmad-2d-phaser-game-dev` | Intégré dans le Module BMGD |
|
||||
| `.bmad-2d-unity-game-dev` | Intégré dans le Module BMGD |
|
||||
| `.bmad-godot-game-dev` | Intégré dans le Module BMGD |
|
||||
| `.bmad-infrastructure-devops` | Déprécié - nouvel agent DevOps bientôt disponible |
|
||||
| `.bmad-creative-writing` | Non adapté - nouveau module v6 bientôt disponible |
|
||||
|
||||
## Changements clés
|
||||
|
||||
| Concept | v4 | v6 |
|
||||
| ------------- | ------------------------------------- | ------------------------------------ |
|
||||
| **Core** | `_bmad-core` était en fait la méthode BMad | `_bmad/core/` est le framework universel |
|
||||
| **Method** | `_bmad-method` | `_bmad/bmm/` |
|
||||
| **Config** | Fichiers modifiés directement | `config.yaml` par module |
|
||||
| **Documents** | Division ou non division requise | Entièrement flexible, scan automatique |
|
||||
|
||||
## Glossaire
|
||||
[^1]: PRD (Product Requirements Document) : document de référence qui décrit les objectifs du produit, les besoins utilisateurs, les fonctionnalités attendues, les contraintes et les critères de succès, afin d'aligner les équipes sur ce qui doit être construit et pourquoi.
|
||||
[^2]: Epic : dans les méthodologies agiles, une grande unité de travail qui peut être décomposée en plusieurs stories. Un epic représente généralement une fonctionnalité majeure ou un ensemble de capacités livrable sur plusieurs sprints.
|
||||
[^3]: Story (User Story) : une description courte et simple d'une fonctionnalité du point de vue de l'utilisateur. Les stories sont des unités de travail suffisamment petites pour être complétées en un sprint.
|
||||
[^4]: Sprint : dans Scrum, une période de temps fixe (généralement 1 à 4 semaines) pendant laquelle l'équipe travaille à livrer un incrément de produit potentiellement libérable.
|
||||
|
|
@ -0,0 +1,69 @@
|
|||
---
|
||||
title: Bienvenue dans la méthode BMad
|
||||
description: Framework de développement propulsé par l'IA avec des agents spécialisés, des workflows guidés et une planification intelligente
|
||||
---
|
||||
|
||||
La méthode BMad (**B**uild **M**ore **A**rchitect **D**reams) est un module[^1] de développement assisté par l'IA au sein de l'écosystème BMad, conçu pour vous faciliter la création de logiciels par un processus complet, de l'idéation et de la planification jusqu'à l'implémentation agentique. Elle fournit des agents[^2] IA spécialisés, des workflows guidés et une planification intelligente qui s'adapte à la complexité de votre projet, que vous corrigiez un bug ou construisiez une plateforme d'entreprise.
|
||||
|
||||
Si vous êtes à l'aise avec les assistants de codage IA comme Claude, Cursor ou GitHub Copilot, vous êtes prêt à commencer.
|
||||
|
||||
:::note[🚀 La V6 est là et ce n'est que le début !]
|
||||
Architecture par Skills, BMad Builder v1, automatisation Dev Loop, et bien plus encore en préparation. **[Consultez la Feuille de route →](./roadmap)**
|
||||
:::
|
||||
|
||||
## Première visite ? Commencez par un tutoriel
|
||||
|
||||
La façon la plus rapide de comprendre BMad est de l'essayer.
|
||||
|
||||
- **[Premiers pas avec BMad](./tutorials/getting-started.md)** — Installez et comprenez comment fonctionne BMad
|
||||
- **[Carte des workflows](./reference/workflow-map.md)** — Vue d'ensemble visuelle des phases BMM, des workflows et de la gestion du contexte
|
||||
|
||||
:::tip[Envie de plonger directement ?]
|
||||
Installez BMad et utilisez le skill[^3] `bmad-help` — il vous guidera entièrement en fonction de votre projet et de vos modules installés.
|
||||
:::
|
||||
|
||||
## Comment utiliser cette documentation
|
||||
|
||||
Cette documentation est organisée en quatre sections selon ce que vous essayez de faire :
|
||||
|
||||
| Section | Objectif |
|
||||
| ----------------- | ----------------------------------------------------------------------------------------------------------- |
|
||||
| **Tutoriels** | Orientés apprentissage. Guides étape par étape qui vous accompagnent dans la construction de quelque chose. Commencez ici si vous êtes nouveau. |
|
||||
| **Guides pratiques** | Orientés tâches. Guides pratiques pour résoudre des problèmes spécifiques. « Comment personnaliser un agent ? » se trouve ici. |
|
||||
| **Explication** | Orientés compréhension. Explications en profondeur des concepts et de l'architecture. À lire quand vous voulez savoir *pourquoi*. |
|
||||
| **Référence** | Orientés information. Spécifications techniques pour les agents, workflows et configuration. |
|
||||
|
||||
## Étendre et personnaliser
|
||||
|
||||
Vous souhaitez étendre BMad avec vos propres agents, workflows ou modules ? Le **[BMad Builder](https://bmad-builder-docs.bmad-method.org/)** fournit le framework et les outils pour créer des extensions personnalisées, que vous ajoutiez de nouvelles capacités à BMad ou que vous construisiez des modules entièrement nouveaux à partir de zéro.
|
||||
|
||||
## Ce dont vous aurez besoin
|
||||
|
||||
BMad fonctionne avec tout assistant de codage IA qui prend en charge les prompts système personnalisés ou le contexte de projet. Les options populaires incluent :
|
||||
|
||||
- **[Claude Code](https://code.claude.com)** — Outil CLI d'Anthropic (recommandé)
|
||||
- **[Cursor](https://cursor.sh)** — Éditeur de code propulsé par l'IA
|
||||
- **[Codex CLI](https://github.com/openai/codex)** — Agent de codage terminal d'OpenAI
|
||||
|
||||
Vous devriez être à l'aise avec les concepts de base du développement logiciel comme le contrôle de version, la structure de projet et les workflows agiles. Aucune expérience préalable avec les systèmes d'agent de type BMad n'est requise — c'est justement le but de cette documentation.
|
||||
|
||||
## Rejoindre la communauté
|
||||
|
||||
Obtenez de l'aide, partagez ce que vous construisez ou contribuez à BMad :
|
||||
|
||||
- **[Discord](https://discord.gg/gk8jAdXWmj)** — Discutez avec d'autres utilisateurs de BMad, posez des questions, partagez des idées
|
||||
- **[GitHub](https://github.com/bmad-code-org/BMAD-METHOD)** — Code source, issues et contributions
|
||||
- **[YouTube](https://www.youtube.com/@BMadCode)** — Tutoriels vidéo et démonstrations
|
||||
|
||||
## Prochaine étape
|
||||
|
||||
Prêt à vous lancer ? **[Commencez avec BMad](./tutorials/getting-started.md)** et construisez votre premier projet.
|
||||
|
||||
---
|
||||
## Glossaire
|
||||
|
||||
[^1]: **Module** : composant autonome du système BMad qui peut être installé et utilisé indépendamment, offrant des fonctionnalités spécifiques.
|
||||
|
||||
[^2]: **Agent** : assistant IA spécialisé avec une expertise spécifique qui guide les utilisateurs dans les workflows.
|
||||
|
||||
[^3]: **Skill** : capacité ou fonctionnalité invoquable d'un agent pour effectuer une tâche spécifique.
|
||||
|
|
@ -0,0 +1,58 @@
|
|||
---
|
||||
title: Agents
|
||||
description: Agents BMM par défaut avec leurs identifiants de skill, déclencheurs de menu et workflows principaux (Analyst, Architect, UX Designer, Technical Writer)
|
||||
sidebar:
|
||||
order: 2
|
||||
---
|
||||
|
||||
## Agents par défaut
|
||||
|
||||
Cette page liste les quatre agents BMM (suite Agile) par défaut installés avec la méthode BMad, ainsi que leurs identifiants de skill, déclencheurs de menu et workflows principaux. Chaque agent est invoqué en tant que skill.
|
||||
|
||||
## Notes
|
||||
|
||||
- Chaque agent est disponible en tant que skill, généré par l’installateur. L’identifiant de skill (par exemple, `bmad-analyst`) est utilisé pour invoquer l’agent.
|
||||
- Les déclencheurs sont les codes courts de menu (par exemple, `BP`) et les correspondances approximatives affichés dans chaque menu d’agent.
|
||||
- La génération de tests QA est gérée par le skill de workflow `bmad-qa-generate-e2e-tests`. L’architecte de tests complet (TEA) se trouve dans son propre module.
|
||||
|
||||
| Agent | Identifiant de skill | Déclencheurs | Workflows principaux |
|
||||
|------------------------|----------------------|------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| Analyste (Mary) | `bmad-analyst` | `BP`, `MR`, `DR`, `TR`, `CB`, `DP` | Brainstorming du projet, Recherche marché/domaine/technique, Création du brief[^1], Documentation du projet |
|
||||
| Architecte (Winston) | `bmad-architect` | `CA`, `IR` | Créer l’architecture, Préparation à l’implémentation |
|
||||
| Designer UX (Sally) | `bmad-ux-designer` | `CU` | Création du design UX[^2] |
|
||||
| Rédacteur Technique (Paige) | `bmad-tech-writer` | `DP`, `WD`, `US`, `MG`, `VD`, `EC` | Documentation du projet, Rédaction de documents, Mise à jour des standards, Génération de diagrammes Mermaid, Validation de documents, Explication de concepts |
|
||||
|
||||
## Types de déclencheurs
|
||||
|
||||
Les déclencheurs de menu d'agent utilisent deux types d'invocation différents. Connaître le type utilisé par un déclencheur vous aide à fournir la bonne entrée.
|
||||
|
||||
### Déclencheurs de workflow (aucun argument nécessaire)
|
||||
|
||||
La plupart des déclencheurs chargent un fichier de workflow structuré. Tapez le code du déclencheur et l'agent démarre le workflow, vous demandant de saisir les informations à chaque étape.
|
||||
|
||||
Exemples : `BP` (Brainstorm Project), `CA` (Create Architecture), `CU` (Create UX Design)
|
||||
|
||||
### Déclencheurs conversationnels (arguments requis)
|
||||
|
||||
Certains déclencheurs lancent une conversation libre au lieu d'un workflow structuré. Ils s'attendent à ce que vous décriviez ce dont vous avez besoin à côté du code du déclencheur.
|
||||
|
||||
| Agent | Déclencheur | Ce qu'il faut fournir |
|
||||
| --- | --- | --- |
|
||||
| Rédacteur Technique (Paige) | `WD` | Description du document à rédiger |
|
||||
| Rédacteur Technique (Paige) | `US` | Préférences ou conventions à ajouter aux standards |
|
||||
| Rédacteur Technique (Paige) | `MG` | Description et type de diagramme (séquence, organigramme, etc.) |
|
||||
| Rédacteur Technique (Paige) | `VD` | Document à valider et domaines à examiner |
|
||||
| Rédacteur Technique (Paige) | `EC` | Nom du concept à expliquer |
|
||||
|
||||
**Exemple :**
|
||||
|
||||
```text
|
||||
WD Rédige un guide de déploiement pour notre configuration Docker
|
||||
MG Crée un diagramme de séquence montrant le flux d’authentification
|
||||
EC Explique le fonctionnement du système de modules
|
||||
```
|
||||
|
||||
## Glossaire
|
||||
|
||||
[^1]: Brief : document synthétique qui formalise le contexte, les objectifs, le périmètre et les contraintes d’un projet ou d’une demande, afin d’aligner rapidement les parties prenantes avant le travail détaillé.
|
||||
[^2]: UX (User Experience) : expérience utilisateur, englobant l’ensemble des interactions et perceptions d’un utilisateur face à un produit. Le design UX vise à créer des interfaces intuitives, efficaces et agréables en tenant compte des besoins, comportements et contexte d’utilisation.
|
||||
|
|
@ -0,0 +1,139 @@
|
|||
---
|
||||
title: Skills
|
||||
description: Référence des skills BMad — ce qu'ils sont, comment ils fonctionnent et où les trouver.
|
||||
sidebar:
|
||||
order: 3
|
||||
---
|
||||
|
||||
Les skills sont des prompts pré-construits qui chargent des agents, exécutent des workflows ou lancent des tâches dans votre IDE. L'installateur BMad les génère à partir de vos modules installés au moment de l'installation. Si vous ajoutez, supprimez ou modifiez des modules ultérieurement, relancez l'installateur pour garder les skills synchronisés (voir [Dépannage](#dépannage)).
|
||||
|
||||
## Skills vs. Déclencheurs du menu Agent
|
||||
|
||||
BMad offre deux façons de démarrer un travail, chacune ayant un usage différent.
|
||||
|
||||
| Mécanisme | Comment l'invoquer | Ce qui se passe |
|
||||
| --- | --- | --- |
|
||||
| **Skill** | Tapez le nom du skill (ex. `bmad-help`) dans votre IDE | Charge directement un agent, exécute un workflow ou lance une tâche |
|
||||
| **Déclencheur du menu agent** | Chargez d'abord un agent, puis tapez un code court (ex. `DS`) | L'agent interprète le code et démarre le workflow correspondant tout en préservant son persona |
|
||||
|
||||
Les déclencheurs du menu agent nécessitent une session agent active. Utilisez les skills lorsque vous savez quel workflow vous voulez. Utilisez les déclencheurs lorsque vous travaillez déjà avec un agent et souhaitez changer de tâche sans quitter la conversation.
|
||||
|
||||
## Comment les skills sont générés
|
||||
|
||||
Lorsque vous exécutez `npx bmad-method install`, l'installateur lit les manifests de chaque module sélectionné et écrit un skill par agent, workflow, tâche et outil. Chaque skill est un répertoire contenant un fichier `SKILL.md` qui indique à l'IA de charger le fichier source correspondant et de suivre ses instructions.
|
||||
|
||||
L'installateur utilise des modèles pour chaque type de skill :
|
||||
|
||||
| Type de skill | Ce que fait le fichier généré |
|
||||
| --- | --- |
|
||||
| **Lanceur d'agent** | Charge le fichier de persona de l'agent, active son menu et reste en caractère |
|
||||
| **Skill de workflow** | Charge la configuration du workflow et suit ses étapes |
|
||||
| **Skill de tâche** | Charge un fichier de tâche autonome et suit ses instructions |
|
||||
| **Skill d'outil** | Charge un fichier d'outil autonome et suit ses instructions |
|
||||
|
||||
:::note[Relancer l'installateur]
|
||||
Si vous ajoutez ou supprimez des modules, relancez l'installateur. Il régénère tous les fichiers de skill pour correspondre à votre sélection actuelle de modules.
|
||||
:::
|
||||
|
||||
## Emplacement des fichiers de skill
|
||||
|
||||
L'installateur écrit les fichiers de skill dans un répertoire spécifique à l'IDE à l'intérieur de votre projet. Le chemin exact dépend de l'IDE que vous avez sélectionné lors de l'installation.
|
||||
|
||||
| IDE / CLI | Répertoire des skills |
|
||||
| --- | --- |
|
||||
| Claude Code | `.claude/skills/` |
|
||||
| Cursor | `.cursor/skills/` |
|
||||
| Windsurf | `.windsurf/skills/` |
|
||||
| Autres IDE | Consultez la sortie de l'installateur pour le chemin cible |
|
||||
|
||||
Chaque skill est un répertoire contenant un fichier `SKILL.md`. Par exemple, une installation Claude Code ressemble à :
|
||||
|
||||
```text
|
||||
.claude/skills/
|
||||
├── bmad-help/
|
||||
│ └── SKILL.md
|
||||
├── bmad-create-prd/
|
||||
│ └── SKILL.md
|
||||
├── bmad-analyst/
|
||||
│ └── SKILL.md
|
||||
└── ...
|
||||
```
|
||||
|
||||
Le nom du répertoire détermine le nom du skill dans votre IDE. Par exemple, le répertoire `bmad-analyst/` enregistre le skill `bmad-analyst`.
|
||||
|
||||
## Comment découvrir vos skills
|
||||
|
||||
Tapez le nom du skill dans votre IDE pour l'invoquer. Certaines plateformes nécessitent d'activer les skills dans les paramètres avant qu'ils n'apparaissent.
|
||||
|
||||
Exécutez `bmad-help` pour obtenir des conseils contextuels sur votre prochaine étape.
|
||||
|
||||
:::tip[Découverte rapide]
|
||||
Les répertoires de skills générés dans votre projet sont la liste de référence. Ouvrez-les dans votre explorateur de fichiers pour voir chaque skill avec sa description.
|
||||
:::
|
||||
|
||||
## Catégories de skills
|
||||
|
||||
### Skills d'agent
|
||||
|
||||
Les skills d'agent chargent une persona[^2] IA spécialisée avec un rôle défini, un style de communication et un menu de workflows. Une fois chargé, l'agent reste en caractère et répond aux déclencheurs du menu.
|
||||
|
||||
| Exemple de skill | Agent | Rôle |
|
||||
| --- | --- | --- |
|
||||
| `bmad-analyst` | Mary (Analyste) | Brainstorming de projets, recherche, création de briefs |
|
||||
| `bmad-architect` | Winston (Architecte) | Conçoit l'architecture système |
|
||||
| `bmad-ux-designer` | Sally (Designer UX) | Crée les designs UX |
|
||||
| `bmad-tech-writer` | Paige (Rédacteur Technique) | Documente les projets, rédige des guides, génère des diagrammes |
|
||||
|
||||
Consultez [Agents](./agents.md) pour la liste complète des agents par défaut et leurs déclencheurs.
|
||||
|
||||
### Skills de workflow
|
||||
|
||||
Les skills de workflow exécutent un processus structuré en plusieurs étapes sans charger d'abord une persona d'agent. Ils chargent une configuration de workflow et suivent ses étapes.
|
||||
|
||||
| Exemple de skill | Objectif |
|
||||
| --- | --- |
|
||||
| `bmad-create-prd` | Créer un PRD[^1] |
|
||||
| `bmad-create-architecture` | Concevoir l'architecture système |
|
||||
| `bmad-create-epics-and-stories` | Créer des epics et des stories |
|
||||
| `bmad-dev-story` | Implémenter une story |
|
||||
| `bmad-code-review` | Effectuer une revue de code |
|
||||
| `bmad-quick-dev` | Flux rapide unifié — clarifier l'intention, planifier, implémenter, réviser, présenter |
|
||||
|
||||
Consultez la [Carte des workflows](./workflow-map.md) pour la référence complète des workflows organisés par phase.
|
||||
|
||||
### Skills de tâche et d'outil
|
||||
|
||||
Les tâches et outils sont des opérations autonomes qui ne nécessitent pas de contexte d'agent ou de workflow.
|
||||
|
||||
**BMad-Help : Votre guide intelligent**
|
||||
|
||||
`bmad-help` est votre interface principale pour découvrir quoi faire ensuite. Il inspecte votre projet, comprend les requêtes en langage naturel et recommande la prochaine étape requise ou optionnelle en fonction de vos modules installés.
|
||||
|
||||
:::note[Exemple]
|
||||
```
|
||||
bmad-help
|
||||
bmad-help J'ai une idée de SaaS et je connais toutes les fonctionnalités. Par où commencer ?
|
||||
bmad-help Quelles sont mes options pour le design UX ?
|
||||
```
|
||||
:::
|
||||
|
||||
**Autres tâches et outils principaux**
|
||||
|
||||
Le module principal inclut 11 outils intégrés — revues, compression, brainstorming, gestion de documents, et plus. Consultez [Outils principaux](./core-tools.md) pour la référence complète.
|
||||
|
||||
## Convention de nommage
|
||||
|
||||
Tous les skills utilisent le préfixe `bmad-` suivi d'un nom descriptif (ex. `bmad-analyst`, `bmad-create-prd`, `bmad-help`). Consultez [Modules](./modules.md) pour les modules disponibles.
|
||||
|
||||
## Dépannage
|
||||
|
||||
**Les skills n'apparaissent pas après l'installation.** Certaines plateformes nécessitent d'activer explicitement les skills dans les paramètres. Consultez la documentation de votre IDE ou demandez à votre assistant IA comment activer les skills. Vous devrez peut-être aussi redémarrer votre IDE ou recharger la fenêtre.
|
||||
|
||||
**Des skills attendus sont manquants.** L'installateur génère uniquement les skills pour les modules que vous avez sélectionnés. Exécutez à nouveau `npx bmad-method install` et vérifiez votre sélection de modules. Vérifiez que les fichiers de skill existent dans le répertoire attendu.
|
||||
|
||||
**Des skills d'un module supprimé apparaissent encore.** L'installateur ne supprime pas automatiquement les anciens fichiers de skill. Supprimez les répertoires obsolètes du répertoire de skills de votre IDE, ou supprimez tout le répertoire de skills et relancez l'installateur pour obtenir un ensemble propre.
|
||||
|
||||
## Glossaire
|
||||
|
||||
[^1]: PRD (Product Requirements Document) : document de référence qui décrit les objectifs du produit, les besoins utilisateurs, les fonctionnalités attendues, les contraintes et les critères de succès, afin d’aligner les équipes sur ce qui doit être construit et pourquoi.
|
||||
[^2]: Persona : dans le contexte de BMad, une persona désigne un agent IA avec un rôle défini, un style de communication et une expertise spécifiques (ex. Mary l'analyste, Winston l'architecte). Chaque persona garde son "caractère" pendant les interactions.
|
||||
|
|
@ -0,0 +1,298 @@
|
|||
---
|
||||
title: Outils Principaux
|
||||
description: Référence pour toutes les tâches et tous les workflows intégrés disponibles dans chaque installation BMad sans modules supplémentaires.
|
||||
sidebar:
|
||||
order: 2
|
||||
---
|
||||
|
||||
Chaque installation BMad comprend un ensemble de compétences principales qui peuvent être utilisées conjointement avec tout ce que vous faites — des tâches et des workflows autonomes qui fonctionnent dans tous les projets, tous les modules et toutes les phases. Ceux-ci sont toujours disponibles, quels que soient les modules optionnels que vous installez.
|
||||
|
||||
:::tip[Raccourci Rapide]
|
||||
Exécutez n'importe quel outil principal en tapant son nom de compétence (par ex., `bmad-help`) dans votre IDE. Aucune session d'agent requise.
|
||||
:::
|
||||
|
||||
## Vue d'ensemble
|
||||
|
||||
| Outil | Type | Objectif |
|
||||
|-----------------------------------------------------------------------|----------|------------------------------------------------------------------------------|
|
||||
| [`bmad-help`](#bmad-help) | Tâche | Obtenir des conseils contextuels sur la prochaine étape |
|
||||
| [`bmad-brainstorming`](#bmad-brainstorming) | Workflow | Faciliter des sessions de brainstorming interactives |
|
||||
| [`bmad-party-mode`](#bmad-party-mode) | Workflow | Orchestrer des discussions de groupe multi-agents |
|
||||
| [`bmad-distillator`](#bmad-distillator) | Tâche | Compression sans perte optimisée pour LLM de documents |
|
||||
| [`bmad-advanced-elicitation`](#bmad-advanced-elicitation) | Tâche | Pousser la sortie LLM à travers des méthodes de raffinement itératives |
|
||||
| [`bmad-review-adversarial-general`](#bmad-review-adversarial-general) | Tâche | Revue cynique qui trouve ce qui manque et ce qui ne va pas |
|
||||
| [`bmad-review-edge-case-hunter`](#bmad-review-edge-case-hunter) | Tâche | Analyse exhaustive des chemins de branchement pour les cas limites non gérés |
|
||||
| [`bmad-editorial-review-prose`](#bmad-editorial-review-prose) | Tâche | Révision de copie clinique pour la clarté de communication |
|
||||
| [`bmad-editorial-review-structure`](#bmad-editorial-review-structure) | Tâche | Édition structurelle — coupes, fusions et réorganisation |
|
||||
| [`bmad-shard-doc`](#bmad-shard-doc) | Tâche | Diviser les fichiers markdown volumineux en sections organisées |
|
||||
| [`bmad-index-docs`](#bmad-index-docs) | Tâche | Générer ou mettre à jour un index de tous les documents dans un dossier |
|
||||
|
||||
## bmad-help
|
||||
|
||||
**Votre guide intelligent pour la suite.** — Inspecte l'état de votre projet, détecte ce qui a été fait et recommande la prochaine étape requise ou facultative.
|
||||
|
||||
**Utilisez-le quand :**
|
||||
|
||||
- Vous avez terminé un workflow et voulez savoir ce qui suit
|
||||
- Vous êtes nouveau sur BMad et avez besoin d'orientation
|
||||
- Vous êtes bloqué et voulez des conseils contextuels
|
||||
- Vous avez installé de nouveaux modules et voulez voir ce qui est disponible
|
||||
|
||||
**Fonctionnement :**
|
||||
|
||||
1. Analyse votre projet pour les artefacts existants (PRD, architecture, stories, etc.)
|
||||
2. Détecte quels modules sont installés et leurs workflows disponibles
|
||||
3. Recommande les prochaines étapes par ordre de priorité — étapes requises d'abord, puis facultatives
|
||||
4. Présente chaque recommandation avec la commande de compétence et une brève description
|
||||
|
||||
**Entrée :** Requête optionnelle en langage naturel (par ex., `bmad-help J'ai une idée de SaaS, par où commencer ?`)
|
||||
|
||||
**Sortie :** Liste priorisée des prochaines étapes recommandées avec les commandes de compétence
|
||||
|
||||
## bmad-brainstorming
|
||||
|
||||
**Génère des idées diverses à travers des techniques créatives interactives.** — Une session de brainstorming facilitée qui charge des méthodes d'idéation éprouvées depuis une bibliothèque de techniques et vous guide vers plus de 100 idées avant organisation.
|
||||
|
||||
**Utilisez-le quand :**
|
||||
|
||||
- Vous commencez un nouveau projet et devez explorer l’espace problème
|
||||
- Vous êtes bloqué dans la génération d'idées et avez besoin de créativité structurée
|
||||
- Vous voulez utiliser des cadres d'idéation éprouvés (SCAMPER, brainstorming inversé, etc.)
|
||||
|
||||
**Fonctionnement :**
|
||||
|
||||
1. Configure une session de brainstorming avec votre sujet
|
||||
2. Charge les techniques créatives depuis une bibliothèque de méthodes
|
||||
3. Vous guide à travers technique après technique, générant des idées
|
||||
4. Applique un protocole anti-biais — change de domaine créatif toutes les 10 idées pour éviter le regroupement
|
||||
5. Produit un document de session en mode ajout uniquement avec toutes les idées organisées par technique
|
||||
|
||||
**Entrée :** Sujet de brainstorming ou énoncé de problème, fichier de contexte optionnel
|
||||
|
||||
**Sortie :** `brainstorming-session-{date}.md` avec toutes les idées générées
|
||||
|
||||
:::note[Cible de Quantité]
|
||||
La magie se produit dans les idées 50–100. Le workflow encourage la génération de plus de 100 idées avant organisation.
|
||||
:::
|
||||
|
||||
## bmad-party-mode
|
||||
|
||||
**Orchestre des discussions de groupe multi-agents.** — Charge tous les agents BMad installés et facilite une conversation naturelle où chaque agent contribue depuis son expertise et personnalité uniques.
|
||||
|
||||
**Utilisez-le quand :**
|
||||
|
||||
- Vous avez besoin de multiples perspectives d'experts sur une décision
|
||||
- Vous voulez que les agents remettent en question les hypothèses des autres
|
||||
- Vous explorez un sujet complexe qui couvre plusieurs domaines
|
||||
|
||||
**Fonctionnement :**
|
||||
|
||||
1. Charge le manifeste d'agents avec toutes les personnalités d'agents installées
|
||||
2. Analyse votre sujet pour sélectionner les 2–3 agents les plus pertinents
|
||||
3. Les agents prennent des tours pour contribuer, avec des échanges naturels et des désaccords
|
||||
4. Fait rouler la participation des agents pour assurer des perspectives diverses au fil du temps
|
||||
5. Quittez avec `goodbye`, `end party` ou `quit`
|
||||
|
||||
**Entrée :** Sujet de discussion ou question, ainsi que la spécification des personas que vous souhaitez faire participer (optionnel)
|
||||
|
||||
**Sortie :** Conversation multi-agents en temps réel avec des personnalités d'agents maintenues
|
||||
|
||||
## bmad-distillator
|
||||
|
||||
**Compression sans perte optimisée pour LLM de documents sources.** — Produit des distillats denses et efficaces en tokens qui préservent toute l'information pour la consommation par des LLM en aval. Vérifiable par reconstruction aller-retour.
|
||||
|
||||
**Utilisez-le quand :**
|
||||
|
||||
- Un document est trop volumineux pour la fenêtre de contexte d'un LLM
|
||||
- Vous avez besoin de versions économes en tokens de recherches, spécifications ou artefacts de planification
|
||||
- Vous voulez vérifier qu'aucune information n'est perdue pendant la compression
|
||||
- Les agents auront besoin de référencer et de trouver fréquemment des informations dedans
|
||||
|
||||
**Fonctionnement :**
|
||||
|
||||
1. **Analyser** — Lit les documents sources, identifie la densité d'information et la structure
|
||||
2. **Compresser** — Convertit la prose en format dense de liste de points, supprime le formatage décoratif
|
||||
3. **Vérifier** — Vérifie l'exhaustivité pour s'assurer que toute l'information originale est préservée
|
||||
4. **Valider** (optionnel) — Le test de reconstruction aller-retour prouve la compression sans perte
|
||||
|
||||
**Entrée :**
|
||||
|
||||
- `source_documents` (requis) — Chemins de fichiers, chemins de dossiers ou motifs glob
|
||||
- `downstream_consumer` (optionnel) — Ce qui va le consommer (par ex., "création de PRD")
|
||||
- `token_budget` (optionnel) — Taille cible approximative
|
||||
- `--validate` (drapeau) — Exécuter le test de reconstruction aller-retour
|
||||
|
||||
**Sortie :** Fichier(s) markdown distillé(s) avec rapport de ratio de compression (par ex., "3.2:1")
|
||||
|
||||
## bmad-advanced-elicitation
|
||||
|
||||
**Passer la sortie du LLM à travers des méthodes de raffinement itératives.** — Sélectionne depuis une bibliothèque de techniques d'élicitation pour améliorer systématiquement le contenu à travers multiples passages.
|
||||
|
||||
**Utilisez-le quand :**
|
||||
|
||||
- La sortie du LLM semble superficielle ou générique
|
||||
- Vous voulez explorer un sujet depuis de multiples angles analytiques
|
||||
- Vous raffinez un document critique et voulez une réflexion plus approfondie
|
||||
|
||||
**Fonctionnement :**
|
||||
|
||||
1. Charge le registre de méthodes avec plus de 5 techniques d'élicitation
|
||||
2. Sélectionne les 5 méthodes les mieux adaptées selon le type de contenu et la complexité
|
||||
3. Présente un menu interactif — choisissez une méthode, remélangez, ou listez tout
|
||||
4. Applique la méthode sélectionnée pour améliorer le contenu
|
||||
5. Re-présente les options pour l'amélioration itérative jusqu'à ce que vous sélectionniez "Procéder"
|
||||
|
||||
**Entrée :** Section de contenu à améliorer
|
||||
|
||||
**Sortie :** Version améliorée du contenu avec les améliorations appliquées
|
||||
|
||||
## bmad-review-adversarial-general
|
||||
|
||||
**Revue contradictoire qui suppose que des problèmes existent et les recherche.** — Adopte une perspective de réviseur sceptique et blasé avec zéro tolérance pour le travail bâclé. Cherche ce qui manque, pas seulement ce qui ne va pas.
|
||||
|
||||
**Utilisez-le quand :**
|
||||
|
||||
- Vous avez besoin d'assurance qualité avant de finaliser un livrable
|
||||
- Vous voulez tester en conditions réelles une spécification, story ou document
|
||||
- Vous voulez trouver des lacunes de couverture que les revues optimistes manquent
|
||||
|
||||
**Fonctionnement :**
|
||||
|
||||
1. Lit le contenu avec une perspective contradictoire et critique
|
||||
2. Identifie les problèmes à travers l'exhaustivité, la justesse et la qualité
|
||||
3. Recherche spécifiquement ce qui manque — pas seulement ce qui est présent et faux
|
||||
4. Doit trouver un minimum de 10 problèmes ou réanalyse plus profondément
|
||||
|
||||
**Entrée :**
|
||||
|
||||
- `content` (requis) — Diff, spécification, story, document ou tout artefact
|
||||
- `also_consider` (optionnel) — Domaines supplémentaires à garder à l'esprit
|
||||
|
||||
**Sortie :** Liste markdown de plus de 10 constatations avec descriptions
|
||||
|
||||
## bmad-review-edge-case-hunter
|
||||
|
||||
**Parcours tous les chemins de branchement et les conditions limites, ne rapporte que les cas non gérés.** — Méthodologie pure de traçage de chemin[^1] qui dérive mécaniquement les classes de cas limites. Orthogonale à la revue contradictoire — centrée sur la méthode, pas sur l'attitude.
|
||||
|
||||
**À utiliser quand :**
|
||||
|
||||
- Vous souhaitez une couverture exhaustive des cas limites pour le code ou la logique
|
||||
- Vous avez besoin d'un complément à la revue contradictoire (méthodologie différente, résultats différents)
|
||||
- Vous révisez un diff ou une fonction pour des conditions limites
|
||||
|
||||
**Fonctionnement :**
|
||||
|
||||
1. Énumère tous les chemins de branchement dans le contenu
|
||||
2. Dérive mécaniquement les classes de cas limites : else/default manquants, entrées non vérifiées, décalage d’unité, overflow arithmétique, coercition implicite des types, conditions de concurrence, écarts de timeout
|
||||
3. Teste chaque chemin contre les protections existantes
|
||||
4. Ne rapporte que les chemins non gérés — ignore silencieusement les chemins gérés
|
||||
|
||||
**Entrée :**
|
||||
|
||||
- `content` (obligatoire) — Diff, fichier complet ou fonction
|
||||
- `also_consider` (facultatif) — Zones supplémentaires à garder à l’esprit
|
||||
|
||||
**Sortie :** Tableau JSON des résultats, chacun avec `location`, `trigger_condition`, `guard_snippet` et `potential_consequence`
|
||||
|
||||
:::note[Revue Complémentaire]
|
||||
Exécutez à la fois `bmad-review-adversarial-general` et `bmad-review-edge-case-hunter` pour une couverture orthogonale. La revue contradictoire détecte les problèmes de qualité et de complétude ; le chasseur de cas limites détecte les chemins non gérés.
|
||||
:::
|
||||
|
||||
## bmad-editorial-review-prose
|
||||
|
||||
**Relecture éditoriale clinique centrée sur la clarté de communication.** — Analyse le texte pour détecter les problèmes qui nuisent à la compréhension. Applique le Microsoft Writing Style Guide baseline. Préserve la voix de l’auteur.
|
||||
|
||||
**À utiliser quand :**
|
||||
|
||||
- Vous avez rédigé un document et souhaitez polir le style
|
||||
- Vous devez assurer la clarté pour un public spécifique
|
||||
- Vous voulez des corrections de communication sans modifier les choix stylistiques
|
||||
|
||||
**Fonctionnement :**
|
||||
|
||||
1. Lit le contenu en ignorant les blocs de code et le frontmatter
|
||||
2. Identifie les problèmes de communication (pas les préférences de style)
|
||||
3. Déduit les doublons du même problème à différents emplacements
|
||||
4. Produit un tableau de corrections en trois colonnes
|
||||
|
||||
**Entrée :**
|
||||
|
||||
- `content` (obligatoire) — Markdown, texte brut ou XML
|
||||
- `style_guide` (facultatif) — Guide de style spécifique au projet
|
||||
- `reader_type` (facultatif) — `humans` (par défaut) pour clarté/fluide, ou `llm` pour précision/consistance
|
||||
|
||||
**Sortie :** Tableau Markdown en trois colonnes : Texte original | Texte révisé | Modifications
|
||||
|
||||
## bmad-editorial-review-structure
|
||||
|
||||
**Édition structurelle — propose des coupes, fusions, déplacements et condensations.** — Révise l'organisation du document et propose des changements substantiels pour améliorer la clarté et le flux avant la révision de copie.
|
||||
|
||||
**Utilisez-le quand :**
|
||||
|
||||
- Un document a été produit depuis de multiples sous-processus et a besoin de cohérence structurelle
|
||||
- Vous voulez réduire la longueur du document tout en préservant la compréhension
|
||||
- Vous devez identifier les violations de portée ou les informations critiques enfouies
|
||||
|
||||
**Fonctionnement :**
|
||||
|
||||
1. Analyse le document contre 5 modèles de structure (Tutoriel, Référence, Explication, Prompt, Stratégique)
|
||||
2. Identifie les redondances, violations de portée et informations enfouies
|
||||
3. Produit des recommandations priorisées : COUPER, FUSIONNER, DÉPLACER, CONDENSER, QUESTIONNER, PRÉSERVER
|
||||
4. Estime la réduction totale en mots et pourcentage
|
||||
|
||||
**Entrée :**
|
||||
|
||||
- `content` (requis) — Document à réviser
|
||||
- `purpose` (optionnel) — Objectif prévu (par ex., "tutoriel de démarrage rapide")
|
||||
- `target_audience` (optionnel) — Qui lit ceci
|
||||
- `reader_type` (optionnel) — `humans` ou `llm`
|
||||
- `length_target` (optionnel) — Réduction cible (par ex., "30% plus court")
|
||||
|
||||
**Sortie :** Résumé du document, liste de recommandations priorisées et réduction estimée
|
||||
|
||||
## bmad-shard-doc
|
||||
|
||||
**Diviser les fichiers markdown volumineux en fichiers de sections organisés.** — Utilise les en-têtes de niveau 2 comme points de division pour créer un dossier de fichiers de sections autonomes avec un index.
|
||||
|
||||
**Utilisez-le quand :**
|
||||
|
||||
- Un document markdown est devenu trop volumineux pour être géré efficacement (plus de 500 lignes)
|
||||
- Vous voulez diviser un document monolithique en sections navigables
|
||||
- Vous avez besoin de fichiers séparés pour l'édition parallèle ou la gestion de contexte LLM
|
||||
|
||||
**Fonctionnement :**
|
||||
|
||||
1. Valide que le fichier source existe et est markdown
|
||||
2. Divise sur les en-têtes de niveau 2 (`##`) en fichiers de sections numérotées
|
||||
3. Crée un `index.md` avec manifeste de sections et liens
|
||||
4. Vous invite à supprimer, archiver ou conserver l'original
|
||||
|
||||
**Entrée :** Chemin du fichier markdown source, dossier de destination optionnel
|
||||
|
||||
**Sortie :** Dossier avec `index.md` et `01-{section}.md`, `02-{section}.md`, etc.
|
||||
|
||||
## bmad-index-docs
|
||||
|
||||
**Générer ou mettre à jour un index de tous les documents dans un dossier.** — Analyse un répertoire, lit chaque fichier pour comprendre son objectif et produit un `index.md` organisé avec liens et descriptions.
|
||||
|
||||
**Utilisez-le quand :**
|
||||
|
||||
- Vous avez besoin d'un index léger pour un scan LLM rapide des documents disponibles
|
||||
- Un dossier de documentation a grandi et a besoin d'une table des matières organisée
|
||||
- Vous voulez un aperçu auto-généré qui reste à jour
|
||||
|
||||
**Fonctionnement :**
|
||||
|
||||
1. Analyse le répertoire cible pour tous les fichiers non cachés
|
||||
2. Lit chaque fichier pour comprendre son objectif réel
|
||||
3. Groupe les fichiers par type, objectif ou sous-répertoire
|
||||
4. Génère des descriptions concises (3–10 mots chacune)
|
||||
|
||||
**Entrée :** Chemin du dossier cible
|
||||
|
||||
**Sortie :** `index.md` avec listes de fichiers organisées, liens relatifs et brèves descriptions
|
||||
|
||||
## Glossaire
|
||||
|
||||
[^1]: Path-tracing : méthode d'analyse qui suit systématiquement tous les chemins d'exécution possibles dans un programme pour identifier les cas non gérés.
|
||||
|
||||
|
|
@ -0,0 +1,82 @@
|
|||
---
|
||||
title: Modules Officiels
|
||||
description: Modules additionnels pour créer des agents personnalisés, de l'intelligence créative, du développement de jeux et des tests
|
||||
sidebar:
|
||||
order: 4
|
||||
---
|
||||
|
||||
BMad s'étend via des modules officiels que vous sélectionnez lors de l'installation. Ces modules additionnels fournissent des agents, des workflows et des tâches spécialisés pour des domaines spécifiques, au-delà du noyau intégré et de BMM (suite Agile).
|
||||
|
||||
:::tip[Installer des Modules]
|
||||
Exécutez `npx bmad-method install` et sélectionnez les modules souhaités. L'installateur gère automatiquement le téléchargement, la configuration et l'intégration IDE.
|
||||
:::
|
||||
|
||||
## BMad Builder
|
||||
|
||||
Créez des agents personnalisés, des workflows et des modules spécifiques à un domaine avec une assistance guidée. BMad Builder est le méta-module pour étendre le framework lui-même.
|
||||
|
||||
- **Code :** `bmb`
|
||||
- **npm :** [`bmad-builder`](https://www.npmjs.com/package/bmad-builder)
|
||||
- **GitHub :** [bmad-code-org/bmad-builder](https://github.com/bmad-code-org/bmad-builder)
|
||||
|
||||
**Fournit :**
|
||||
|
||||
- Agent Builder — créez des agents IA spécialisés avec une expertise et un accès aux outils personnalisés
|
||||
- Workflow Builder — concevez des processus structurés avec des étapes et des points de décision
|
||||
- Module Builder — empaquetez des agents et des workflows dans des modules partageables et publiables
|
||||
- Configuration interactive avec support de configuration YAML et publication npm
|
||||
|
||||
## Creative Intelligence Suite
|
||||
|
||||
Outils basés sur l'IA pour la créativité structurée, l'idéation et l'innovation pendant le développement en phase amont. La suite fournit plusieurs agents qui facilitent le brainstorming, le design thinking et la résolution de problèmes en utilisant des cadres éprouvés.
|
||||
|
||||
- **Code :** `cis`
|
||||
- **npm :** [`bmad-creative-intelligence-suite`](https://www.npmjs.com/package/bmad-creative-intelligence-suite)
|
||||
- **GitHub :** [bmad-code-org/bmad-module-creative-intelligence-suite](https://github.com/bmad-code-org/bmad-module-creative-intelligence-suite)
|
||||
|
||||
**Fournit :**
|
||||
|
||||
- Agents Innovation Strategist, Design Thinking Coach et Brainstorming Coach
|
||||
- Problem Solver et Creative Problem Solver pour la pensée systématique et latérale
|
||||
- Storyteller et Presentation Master pour les récits et les présentations
|
||||
- Cadres d'idéation incluant SCAMPER[^1], Brainstorming inversé et reformulation de problèmes
|
||||
|
||||
## Game Dev Studio
|
||||
|
||||
Workflows de développement de jeux structurés adaptés pour Unity, Unreal, Godot et moteurs personnalisés. Supporte le prototypage rapide via Quick Dev et la production à grande échelle avec des sprints propulsés par epics.
|
||||
|
||||
- **Code :** `gds`
|
||||
- **npm :** [`bmad-game-dev-studio`](https://www.npmjs.com/package/bmad-game-dev-studio)
|
||||
- **GitHub :** [bmad-code-org/bmad-module-game-dev-studio](https://github.com/bmad-code-org/bmad-module-game-dev-studio)
|
||||
|
||||
**Fournit :**
|
||||
|
||||
- Workflow de génération de Document de Design de Jeu (GDD[^3])
|
||||
- Mode Quick Dev pour le prototypage rapide
|
||||
- Support de design narratif pour les personnages, dialogues et construction de monde
|
||||
- Couverture de plus de 21 types de jeux avec des conseils d'architecture spécifiques au moteur
|
||||
|
||||
## Test Architect (TEA)
|
||||
|
||||
Stratégie de test de niveau entreprise, conseils d'automatisation et décisions de porte de release via un agent expert et neuf workflows structurés. TEA va bien au-delà du workflow QA intégré avec une priorisation basée sur les risques et une traçabilité des exigences.
|
||||
|
||||
- **Code :** `tea`
|
||||
- **npm :** [`bmad-method-test-architecture-enterprise`](https://www.npmjs.com/package/bmad-method-test-architecture-enterprise)
|
||||
- **GitHub :** [bmad-code-org/bmad-method-test-architecture-enterprise](https://github.com/bmad-code-org/bmad-method-test-architecture-enterprise)
|
||||
|
||||
**Fournit :**
|
||||
|
||||
- Agent Murat (Master Test Architect and Quality Advisor)
|
||||
- Workflows pour la conception de tests, ATDD, l'automatisation, la revue de tests et la traçabilité
|
||||
- Évaluation NFR[^2], configuration CI et scaffolding de framework
|
||||
- Priorisation P0-P3 avec Playwright Utils et intégrations MCP optionnelles
|
||||
|
||||
## Modules Communautaires
|
||||
|
||||
Les modules communautaires et une marketplace de modules sont à venir. Consultez l'[organisation GitHub BMad](https://github.com/bmad-code-org) pour les mises à jour.
|
||||
|
||||
## Glossaire
|
||||
|
||||
[^1]: SCAMPER : acronyme anglais pour une technique de créativité structurée (Substitute, Combine, Adapt, Modify, Put to another use, Eliminate, Reverse) qui permet d'explorer systématiquement les modifications possibles d'un produit ou d'une idée pour générer des innovations.
|
||||
[^2]: NFR (Non-Functional Requirement) : exigence décrivant les contraintes de qualité du système (performance, sécurité, fiabilité, ergonomie) plutôt que ses fonctionnalités.
|
||||
[^3]: GDD (Game Design Document) : document de conception de jeu qui décrit en détail les mécaniques, l'univers, les personnages, les niveaux et tous les aspects du jeu à développer.
|
||||
|
|
@ -0,0 +1,111 @@
|
|||
---
|
||||
title: Options de Testing
|
||||
description: Comparaison du workflow QA intégré avec le module Test Architect (TEA) pour l'automatisation des tests.
|
||||
sidebar:
|
||||
order: 5
|
||||
---
|
||||
|
||||
BMad propose deux approches de test : un workflow QA[^1] intégré pour une génération rapide de tests et un module Test Architect installable pour une stratégie de test de qualité entreprise.
|
||||
|
||||
## Lequel Choisir ?
|
||||
|
||||
| Facteur | QA Intégré | Module TEA |
|
||||
|-------------------------|----------------------------------------------|---------------------------------------------------------------------|
|
||||
| **Idéal pour** | Projets petits et moyens, couverture rapide | Grands projets, domaines réglementés ou complexes |
|
||||
| **Installation** | Rien à installer — inclus dans BMM | Installer séparément via `npx bmad-method install` |
|
||||
| **Approche** | Générer les tests rapidement, itérer ensuite | Planifier d'abord, puis générer avec traçabilité |
|
||||
| **Types de tests** | Tests API et E2E | API, E2E, ATDD[^2], NFR, et plus |
|
||||
| **Stratégie** | Chemin nominal + cas limites critiques | Priorisation basée sur les risques (P0-P3) |
|
||||
| **Nombre de workflows** | 1 (Automate) | 9 (conception, ATDD, automatisation, revue, traçabilité, et autres) |
|
||||
|
||||
:::tip[Commencez avec le QA Intégré]
|
||||
La plupart des projets devraient commencer avec le workflow QA intégré. Si vous avez ensuite besoin d'une stratégie de test, de murs de qualité ou de traçabilité des exigences, installez TEA en complément.
|
||||
:::
|
||||
|
||||
## Workflow QA Intégré
|
||||
|
||||
Le workflow QA intégré est inclus dans le module BMM (suite Agile). Il génère rapidement des tests fonctionnels en utilisant le framework de test existant de votre projet — aucune configuration ni installation supplémentaire requise.
|
||||
|
||||
**Déclencheur :** `QA` ou `bmad-qa-generate-e2e-tests`
|
||||
|
||||
### Ce que le Workflow QA Fait
|
||||
|
||||
Le workflow QA exécute un processus unique (Automate) qui parcourt cinq étapes :
|
||||
|
||||
1. **Détecte le framework de test** — analyse `package.json` et les fichiers de test existants pour identifier votre framework (Jest, Vitest, Playwright, Cypress, ou tout runner standard). Si aucun n'existe, analyse la pile technologique du projet et en suggère un.
|
||||
2. **Identifie les fonctionnalités** — demande ce qu'il faut tester ou découvre automatiquement les fonctionnalités dans le codebase.
|
||||
3. **Génère les tests API** — couvre les codes de statut, la structure des réponses, le chemin nominal, et 1-2 cas d'erreur.
|
||||
4. **Génére les tests E2E** — couvre les parcours utilisateur avec des localisateurs sémantiques et des assertions sur les résultats visibles.
|
||||
5. **Exécute et vérifie** — lance les tests générés et corrige immédiatement les échecs.
|
||||
|
||||
Le workflow QA produit un résumé de test sauvegardé dans le dossier des artefacts d'implémentation de votre projet.
|
||||
|
||||
### Patterns de Test
|
||||
|
||||
Les tests générés suivent une philosophie "simple et maintenable" :
|
||||
|
||||
- **APIs standard du framework uniquement** — pas d'utilitaires externes ni d'abstractions personnalisées
|
||||
- **Localisateurs sémantiques** pour les tests UI (rôles, labels, texte plutôt que sélecteurs CSS)
|
||||
- **Tests indépendants** sans dépendances d'ordre
|
||||
- **Pas d'attentes ou de sleeps codés en dur**
|
||||
- **Descriptions claires** qui se lisent comme de la documentation fonctionnelle
|
||||
|
||||
:::note[Portée]
|
||||
Le workflow QA génère uniquement des tests. Pour la revue de code et la validation des stories, utilisez plutôt le workflow Code Review (`CR`).
|
||||
:::
|
||||
|
||||
### Quand Utiliser le QA Intégré
|
||||
|
||||
- Couverture de test rapide pour une fonctionnalité nouvelle ou existante
|
||||
- Automatisation de tests accessible aux débutants sans configuration avancée
|
||||
- Patterns de test standards que tout développeur peut lire et maintenir
|
||||
- Projets petits et moyens où une stratégie de test complète n'est pas nécessaire
|
||||
|
||||
## Module Test Architect (TEA)
|
||||
|
||||
TEA est un module autonome qui fournit un agent expert (Murat) et neuf workflows structurés pour des tests de qualité entreprise. Il va au-delà de la génération de tests pour inclure la stratégie de test, la planification basée sur les risques, les murs de qualité et la traçabilité des exigences.
|
||||
|
||||
- **Documentation :** [TEA Module Docs](https://bmad-code-org.github.io/bmad-method-test-architecture-enterprise/)
|
||||
- **Installation :** `npx bmad-method install` et sélectionnez le module TEA
|
||||
- **npm :** [`bmad-method-test-architecture-enterprise`](https://www.npmjs.com/package/bmad-method-test-architecture-enterprise)
|
||||
|
||||
### Ce que TEA Fournit
|
||||
|
||||
| Workflow | Objectif |
|
||||
|-----------------------|--------------------------------------------------------------------------------------|
|
||||
| Test Design | Créer une stratégie de test complète liée aux exigences |
|
||||
| ATDD | Développement piloté par les tests d'acceptation avec critères des parties prenantes |
|
||||
| Automate | Générer des tests avec des patterns et utilitaires avancés |
|
||||
| Test Review | Valider la qualité et la couverture des tests par rapport à la stratégie |
|
||||
| Traceability | Remonter les tests aux exigences pour l'audit et la conformité |
|
||||
| NFR Assessment | Évaluer les exigences non-fonctionnelles (performance, sécurité) |
|
||||
| CI Setup | Configurer l'exécution des tests dans les pipelines d'intégration continue |
|
||||
| Framework Scaffolding | Configurer l'infrastructure de test et la structure du projet |
|
||||
| Release Gate | Prendre des décisions de livraison go/no-go basées sur les données |
|
||||
|
||||
TEA supporte également la priorisation basée sur les risques P0-P3 et des intégrations optionnelles avec Playwright Utils et les outils MCP.
|
||||
|
||||
### Quand Utiliser TEA
|
||||
|
||||
- Projets nécessitant une traçabilité des exigences ou une documentation de conformité
|
||||
- Équipes ayant besoin d'une priorisation des tests basée sur les risques sur plusieurs fonctionnalités
|
||||
- Environnements entreprise avec des murs de qualité formels avant livraison
|
||||
- Domaines complexes où la stratégie de test doit être planifiée avant d'écrire les tests
|
||||
- Projets ayant dépassé l'approche à workflow unique du QA intégré
|
||||
|
||||
## Comment les Tests S'Intègrent dans les Workflows
|
||||
|
||||
Le workflow Automate du QA intégré apparaît dans la Phase 4 (Implémentation) de la carte de workflow méthode BMad. Il est conçu pour s'exécuter **après qu'un epic complet soit terminé** — une fois que toutes les stories d'un epic ont été implémentées et revues. Une séquence typique :
|
||||
|
||||
1. Pour chaque story de l'epic : implémenter avec Dev Story (`DS`), puis valider avec Code Review (`CR`)
|
||||
2. Après la fin de l'epic : générer les tests avec le workflow QA (`QA`) ou le workflow Automate de TEA
|
||||
3. Lancer la rétrospective (`bmad-retrospective`) pour capturer les leçons apprises
|
||||
|
||||
Le workflow QA travaille directement à partir du code source sans charger les documents de planification (PRD, architecture). Les workflows TEA peuvent s'intégrer avec les artefacts de planification en amont pour la traçabilité.
|
||||
|
||||
Pour en savoir plus sur la place des tests dans le processus global, consultez la [Carte des Workflows](./workflow-map.md).
|
||||
|
||||
## Glossaire
|
||||
|
||||
[^1]: QA (Quality Assurance) : assurance qualité, ensemble des processus et activités visant à garantir que le produit logiciel répond aux exigences de qualité définies.
|
||||
[^2]: ATDD (Acceptance Test-Driven Development) : méthode de développement où les tests d'acceptation sont écrits avant le code, en collaboration avec les parties prenantes pour définir les critères de réussite.
|
||||
|
|
@ -0,0 +1,94 @@
|
|||
---
|
||||
title: "Carte des Workflows"
|
||||
description: Référence visuelle des phases et des résultats des workflows de la méthode BMad
|
||||
sidebar:
|
||||
order: 1
|
||||
---
|
||||
|
||||
La méthode BMad (BMM) est un module de l'écosystème BMad, conçu pour suivre les meilleures pratiques de l'ingénierie du contexte et de la planification. Les agents IA fonctionnent de manière optimale avec un contexte clair et structuré. Le système BMM construit ce contexte progressivement à travers 4 phases distinctes — chaque phase, et plusieurs workflows optionnels au sein de chaque phase, produisent des documents qui alimentent la phase suivante, afin que les agents sachent toujours quoi construire et pourquoi.
|
||||
|
||||
La logique et les concepts proviennent des méthodologies agiles qui ont été utilisées avec succès dans l'industrie comme cadre mental de référence.
|
||||
|
||||
Si à tout moment vous ne savez pas quoi faire, le skill `bmad-help` vous aidera à rester sur la bonne voie ou à savoir quoi faire ensuite. Vous pouvez toujours vous référer à cette page également — mais `bmad-help` est entièrement interactif et beaucoup plus rapide si vous avez déjà installé la méthode BMad. De plus, si vous utilisez différents modules qui ont étendu la méthode BMad ou ajouté d'autres modules complémentaires non extensifs — `bmad-help` évolue pour connaître tout ce qui est disponible et vous donner les meilleurs conseils du moment.
|
||||
|
||||
Note finale importante : Chaque workflow ci-dessous peut être exécuté directement avec l'outil de votre choix via un skill ou en chargeant d'abord un agent et en utilisant l'entrée du menu des agents.
|
||||
|
||||
<iframe src="/workflow-map-diagram-fr.html" title="Diagramme de la carte des workflows de la méthode BMad" width="100%" height="100%" style="border-radius: 8px; border: 1px solid #334155; min-height: 900px;"></iframe>
|
||||
|
||||
<p style="font-size: 0.8rem; text-align: right; margin-top: -0.5rem; margin-bottom: 1rem;">
|
||||
<a href="/workflow-map-diagram-fr.html" target="_blank" rel="noopener noreferrer">Ouvrir le diagramme dans un nouvel onglet ↗</a>
|
||||
</p>
|
||||
|
||||
## Phase 1 : Analyse (Optionnelle)
|
||||
|
||||
Explorez l’espace problème et validez les idées avant de vous engager dans la planification.
|
||||
|
||||
| Workflow | Objectif | Produit |
|
||||
|---------------------------------------------------------------------------|------------------------------------------------------------------------------------------|---------------------------|
|
||||
| `bmad-brainstorming` | Brainstormez des idées de projet avec l'accompagnement guidé d'un coach de brainstorming | `brainstorming-report.md` |
|
||||
| `bmad-domain-research`, `bmad-market-research`, `bmad-technical-research` | Validez les hypothèses de marché, techniques ou de domaine | Rapport de recherches |
|
||||
| `bmad-create-product-brief` | Capturez la vision stratégique | `product-brief.md` |
|
||||
|
||||
## Phase 2 : Planification
|
||||
|
||||
Définissez ce qu'il faut construire et pour qui.
|
||||
|
||||
| Workflow | Objectif | Produit |
|
||||
|-------------------------|---------------------------------------------------------|--------------|
|
||||
| `bmad-create-prd` | Définissez les exigences (FRs/NFRs)[^1] | `PRD.md`[^2] |
|
||||
| `bmad-create-ux-design` | Concevez l'expérience utilisateur (lorsque l'UX compte) | `ux-spec.md` |
|
||||
|
||||
## Phase 3 : Solutioning
|
||||
|
||||
Décidez comment le construire et décomposez le travail en stories.
|
||||
|
||||
| Workflow | Objectif | Produit |
|
||||
|---------------------------------------|---------------------------------------------------|------------------------------|
|
||||
| `bmad-create-architecture` | Rendez les décisions techniques explicites | `architecture.md` avec ADRs[^3] |
|
||||
| `bmad-create-epics-and-stories` | Décomposez les exigences en travail implémentable | Fichiers d'epic avec stories |
|
||||
| `bmad-check-implementation-readiness` | Vérification avant implémentation | Décision Passe/Réserves/Échec |
|
||||
|
||||
## Phase 4 : Implémentation
|
||||
|
||||
Construisez, une story à la fois. Bientôt disponible : automatisation complète de la phase 4 !
|
||||
|
||||
| Workflow | Objectif | Produit |
|
||||
|------------------------|-------------------------------------------------------------------------------------|----------------------------------|
|
||||
| `bmad-sprint-planning` | Initialisez le suivi (une fois par projet pour séquencer le cycle de développement) | `sprint-status.yaml` |
|
||||
| `bmad-create-story` | Préparez la story suivante pour implémentation | `story-[slug].md` |
|
||||
| `bmad-dev-story` | Implémentez la story | Code fonctionnel + tests |
|
||||
| `bmad-code-review` | Validez la qualité de l'implémentation | Approuvé ou changements demandés |
|
||||
| `bmad-correct-course` | Gérez les changements significatifs en cours de sprint | Plan mis à jour ou réorientation |
|
||||
| `bmad-sprint-status` | Suivez la progression du sprint et le statut des stories | Mise à jour du statut du sprint |
|
||||
| `bmad-retrospective` | Revue après complétion d'un epic | Leçons apprises |
|
||||
|
||||
## Quick Dev (Parcours Parallèle)
|
||||
|
||||
Sautez les phases 1-3 pour les travaux de faible envergure et bien compris.
|
||||
|
||||
| Workflow | Objectif | Produit |
|
||||
|------------------|-------------------------------------------------------------------------------------|-----------------------|
|
||||
| `bmad-quick-dev` | Flux rapide unifié — clarifie l'intention, planifie, implémente, révise et présente | `tech-spec.md` + code |
|
||||
|
||||
## Gestion du Contexte
|
||||
|
||||
Chaque document devient le contexte de la phase suivante. Le PRD[^2] indique à l'architecte quelles contraintes sont importantes. L'architecture indique à l'agent de développement quels modèles suivre. Les fichiers de story fournissent un contexte focalisé et complet pour l'implémentation. Sans cette structure, les agents prennent des décisions incohérentes.
|
||||
|
||||
### Contexte du Projet
|
||||
|
||||
:::tip[Recommandé]
|
||||
Créez `project-context.md` pour vous assurer que les agents IA suivent les règles et préférences de votre projet. Ce fichier fonctionne comme une constitution pour votre projet — il guide les décisions d'implémentation à travers tous les workflows. Ce fichier optionnel peut être généré à la fin de la création de l'architecture, ou dans un projet existant il peut également être généré pour capturer ce qui est important de conserver aligné avec les conventions actuelles.
|
||||
:::
|
||||
|
||||
**Comment le créer :**
|
||||
|
||||
- **Manuellement** — Créez `_bmad-output/project-context.md` avec votre pile technologique et vos règles d'implémentation
|
||||
- **Générez-le** — Exécutez `bmad-generate-project-context` pour l'auto-générer à partir de votre architecture ou de votre codebase
|
||||
|
||||
[**En savoir plus sur project-context.md**](../explanation/project-context.md)
|
||||
|
||||
## Glossaire
|
||||
|
||||
[^1]: FR / NFR (Functional / Non-Functional Requirement) : exigences décrivant respectivement **ce que le système doit faire** (fonctionnalités, comportements attendus) et **comment il doit le faire** (contraintes de performance, sécurité, fiabilité, ergonomie, etc.).
|
||||
[^2]: PRD (Product Requirements Document) : document de référence qui décrit les objectifs du produit, les besoins utilisateurs, les fonctionnalités attendues, les contraintes et les critères de succès, afin d’aligner les équipes sur ce qui doit être construit et pourquoi.
|
||||
[^3]: ADR (Architecture Decision Record) : document qui consigne une décision d’architecture, son contexte, les options envisagées, le choix retenu et ses conséquences, afin d’assurer la traçabilité et la compréhension des décisions techniques dans le temps.
|
||||
|
|
@ -0,0 +1,136 @@
|
|||
---
|
||||
title: Feuille de route
|
||||
description: La suite pour BMad - Fonctionnalités, améliorations et contributions de la communauté
|
||||
---
|
||||
|
||||
# La Méthode BMad : Feuille de route publique
|
||||
|
||||
La Méthode BMad, BMad Method Module (BMM) et BMad Builder (BMB) évoluent. Voici ce sur quoi nous travaillons et ce qui arrive prochainement.
|
||||
|
||||
<div class="roadmap-container">
|
||||
|
||||
<h2 class="roadmap-section-title">En cours</h2>
|
||||
|
||||
<div class="roadmap-future">
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">🧩</span>
|
||||
<h4>Architecture par Skills Universelle</h4>
|
||||
<p>Un skill, toutes les plateformes. Écrivez une fois, exécutez partout.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">🏗️</span>
|
||||
<h4>BMad Builder v1</h4>
|
||||
<p>Créez des agents IA et des workflows prêts pour la production avec des évaluations, des équipes et dégradation gracieuse intégrées.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">🧠</span>
|
||||
<h4>Système de Contexte Projet</h4>
|
||||
<p>Votre IA comprend vraiment votre projet. Un contexte adapté au framework qui évolue avec votre base de code.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">📦</span>
|
||||
<h4>Skills Centralisés</h4>
|
||||
<p>Installez une fois, utilisez partout. Partagez des skills entre projets sans l'encombrement de fichiers.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">🔄</span>
|
||||
<h4>Skills Adaptatifs</h4>
|
||||
<p>Des skills qui connaissent vos outils. Des variantes optimisées pour Claude, Codex, Kimi et OpenCode, et bien d'autres encore.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">📝</span>
|
||||
<h4>Blog BMad Team Pros</h4>
|
||||
<p>Guides, articles et perspectives de l'équipe. Lancement prochainement.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<h2 class="roadmap-section-title">Pour bien commencer</h2>
|
||||
|
||||
<div class="roadmap-future">
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">🏪</span>
|
||||
<h4>Marketplace de Skills</h4>
|
||||
<p>Découvrez, installez et mettez à jour des skills créés par la communauté. À une commande curl de super-pouvoirs.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">🎨</span>
|
||||
<h4>Personnalisation de Workflow</h4>
|
||||
<p>Faites-en le vôtre. Intégrez Jira, Linear, des sorties personnalisées à votre workflow, vos règles.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">🚀</span>
|
||||
<h4>Optimisation Phases 1-3</h4>
|
||||
<p>Planification éclair avec collecte de contexte par sous-agents. Le mode YOLO rencontre l'excellence guidée.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">🌐</span>
|
||||
<h4>Prêt pour l'Entreprise</h4>
|
||||
<p>SSO, journaux d'audit, espaces de travail d'équipe. Toutes les choses ennuyantes qui feront dire oui aux entreprises.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">💎</span>
|
||||
<h4>Explosion de Modules Communautaires</h4>
|
||||
<p>Divertissement, sécurité, thérapie, jeu de rôle et bien plus encore. Étendez la plateforme de la Méthode BMad.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">⚡</span>
|
||||
<h4>Automatisation de la Boucle de Développement</h4>
|
||||
<p>Pilote automatique optionnel pour le développement. Laissez l'IA gérer le flux tout en maintenant une qualité optimale.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<h2 class="roadmap-section-title">Communauté et Équipe</h2>
|
||||
|
||||
<div class="roadmap-future">
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">🎙️</span>
|
||||
<h4>Le Podcast de la Méthode BMad</h4>
|
||||
<p>Conversations sur le développement natif IA. Lancement le 1er mars 2026 !</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">🎓</span>
|
||||
<h4>Le Master Class de la Méthode BMad</h4>
|
||||
<p>Passez d'utilisateur à expert. Approfondissements dans chaque phase, chaque workflow, chaque secret.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">🏗️</span>
|
||||
<h4>La Master Class BMad Builder</h4>
|
||||
<p>Construisez vos propres agents. Techniques avancées pour quand vous êtes prêt à créer, pas seulement à utiliser.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">⚡</span>
|
||||
<h4>BMad Prototype First</h4>
|
||||
<p>De l'idée au prototype fonctionnel en une seule session. Créez l'application de vos rêves comme une œuvre d'art.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">🌴</span>
|
||||
<h4>BMad BALM !</h4>
|
||||
<p>Gestion de vie native IA. Tâches, habitudes, objectifs : votre copilote IA pour tout.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">🖥️</span>
|
||||
<h4>UI Officielle</h4>
|
||||
<p>Une belle interface pour tout l'écosystème BMad. La puissance de la CLI, le polissage de l'interface graphique.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">🔒</span>
|
||||
<h4>BMad in a Box</h4>
|
||||
<p>Auto-hébergé, isolé, niveau entreprise. Votre assistant IA, votre infrastructure, votre contrôle.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div style="text-align: center; margin-top: 3rem; padding: 2rem; background: var(--color-bg-card); border-radius: 12px; border: 1px solid var(--color-border);">
|
||||
<h3 style="margin: 0 0 1rem;">Envie de contribuer ?</h3>
|
||||
<p style="color: var(--slate-color-400); margin: 0;">
|
||||
Ce n'est qu'une liste partielle de ce qui est prévu. L'équipe Open Source BMad accueille les contributeurs !{" "}<br />
|
||||
<a href="https://github.com/bmad-code-org/BMAD-METHOD" style="color: var(--color-in-progress);">Rejoignez-nous sur GitHub</a> pour aider à façonner l'avenir du développement propulsé par l'IA.
|
||||
</p>
|
||||
<p style="color: var(--slate-color-400); margin: 1.5rem 0 0;">
|
||||
Vous aimez ce que nous construisons ? Nous apprécions le soutien ponctuel et mensuel sur{" "}<a href="https://buymeacoffee.com/bmad" style="color: var(--color-in-progress);">Buy Me a Coffee</a>.
|
||||
</p>
|
||||
<p style="color: var(--slate-color-400); margin: 1rem 0 0;">
|
||||
Pour les parrainages d'entreprise, les demandes de partenariat, les interventions, les formations ou les demandes médias :{" "}
|
||||
<a href="mailto:contact@bmadcode.com" style="color: var(--color-in-progress);">contact@bmadcode.com</a>
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -0,0 +1,279 @@
|
|||
---
|
||||
title: "Premiers pas"
|
||||
description: Installer BMad et construire votre premier projet
|
||||
---
|
||||
|
||||
Construisez des logiciels plus rapidement en utilisant des workflows propulsés par l'IA avec des agents spécialisés qui vous guident à travers la planification, l'architecture et l'implémentation.
|
||||
|
||||
## Ce que vous allez apprendre
|
||||
|
||||
- Installer et initialiser la méthode BMad pour un nouveau projet
|
||||
- Utiliser **BMad-Help** — votre guide intelligent qui sait quoi faire ensuite
|
||||
- Choisir la bonne voie de planification selon la taille de votre projet
|
||||
- Progresser à travers les phases, des exigences au code fonctionnel
|
||||
- Utiliser efficacement les agents et les workflows
|
||||
|
||||
:::note[Prérequis]
|
||||
- **Node.js 20+** — Requis pour l'installateur
|
||||
- **Git** — Recommandé pour le contrôle de version
|
||||
- **IDE IA** — Claude Code, Cursor, ou similaire
|
||||
- **Une idée de projet** — Même simple, elle fonctionne pour apprendre
|
||||
:::
|
||||
|
||||
:::tip[Le chemin le plus simple]
|
||||
**Installer** → `npx bmad-method install`
|
||||
**Demander** → `bmad-help que dois-je faire en premier ?`
|
||||
**Construire** → Laissez BMad-Help vous guider workflow par workflow
|
||||
:::
|
||||
|
||||
## Découvrez BMad-Help : votre guide intelligent
|
||||
|
||||
**BMad-Help est le moyen le plus rapide de démarrer avec BMad.** Vous n'avez pas besoin de mémoriser les workflows ou les phases — posez simplement la question, et BMad-Help va :
|
||||
|
||||
- **Inspecter votre projet** pour voir ce qui a déjà été fait
|
||||
- **Vous montrer vos options** en fonction des modules que vous avez installés
|
||||
- **Recommander la prochaine étape** — y compris la première tâche obligatoire
|
||||
- **Répondre aux questions** comme « J'ai une idée de SaaS, par où commencer ? »
|
||||
|
||||
### Comment utiliser BMad-Help
|
||||
|
||||
Exécutez-le dans votre IDE avec IA en invoquant la skill :
|
||||
|
||||
```
|
||||
bmad-help
|
||||
```
|
||||
|
||||
Ou combinez-le avec une question pour obtenir des conseils adaptés au contexte :
|
||||
|
||||
```
|
||||
bmad-help J'ai une idée de produit SaaS, je connais déjà toutes les fonctionnalités que je veux. Par où dois-je commencer ?
|
||||
```
|
||||
|
||||
BMad-Help répondra avec :
|
||||
- Ce qui est recommandé pour votre situation
|
||||
- Quelle est la première tâche obligatoire
|
||||
- À quoi ressemble le reste du processus
|
||||
|
||||
### Il alimente aussi les workflows
|
||||
|
||||
BMad-Help ne se contente pas de répondre aux questions — **il s'exécute automatiquement à la fin de chaque workflow** pour vous dire exactement quoi faire ensuite. Pas de devinettes, pas de recherche dans la documentation — juste des conseils clairs sur le prochain workflow requis.
|
||||
|
||||
:::tip[Commencez ici]
|
||||
Après avoir installé BMad, invoquez immédiatement la skill `bmad-help`. Elle détectera les modules que vous avez installés et vous guidera vers le bon point de départ pour votre projet.
|
||||
:::
|
||||
|
||||
## Comprendre BMad
|
||||
|
||||
BMad vous aide à construire des logiciels grâce à des workflows guidés avec des agents IA spécialisés. Le processus suit quatre phases :
|
||||
|
||||
| Phase | Nom | Ce qui se passe |
|
||||
|-------|----------------|----------------------------------------------------------------|
|
||||
| 1 | Analyse | Brainstorming, recherche, product brief *(optionnel)* |
|
||||
| 2 | Planification | Créer les exigences (PRD[^1] ou spécification technique) |
|
||||
| 3 | Solutioning | Concevoir l'architecture *(BMad Method/Enterprise uniquement)* |
|
||||
| 4 | Implémentation | Construire epic[^2] par epic, story[^3] par story |
|
||||
|
||||
**[Ouvrir la carte des workflows](../reference/workflow-map.md)** pour explorer les phases, les workflows et la gestion du contexte.
|
||||
|
||||
Selon la complexité de votre projet, BMad propose trois voies de planification :
|
||||
|
||||
| Voie | Idéal pour | Documents créés |
|
||||
|------------------|------------------------------------------------------------------------------|----------------------------------------|
|
||||
| **Quick Dev** | Corrections de bugs, fonctionnalités simples, périmètre clair (1-15 stories) | Spécification technique uniquement |
|
||||
| **méthode BMad** | Produits, plateformes, fonctionnalités complexes (10-50+ stories) | PRD + Architecture + UX[^4] |
|
||||
| **Enterprise** | Conformité, systèmes multi-tenant[^5] (30+ stories) | PRD + Architecture + Security + DevOps |
|
||||
|
||||
:::note
|
||||
Les comptes de stories sont indicatifs, pas des définitions. Choisissez votre voie en fonction des besoins de planification, pas du calcul des stories.
|
||||
:::
|
||||
|
||||
## Installation
|
||||
|
||||
Ouvrez un terminal dans le répertoire de votre projet et exécutez :
|
||||
|
||||
```bash
|
||||
npx bmad-method install
|
||||
```
|
||||
|
||||
Si vous souhaitez la version préliminaire la plus récente au lieu du canal de release par défaut, utilisez `npx bmad-method@next install`.
|
||||
|
||||
Lorsque vous êtes invité à sélectionner des modules, choisissez **méthode BMad**.
|
||||
|
||||
L'installateur crée deux dossiers :
|
||||
- `_bmad/` — agents, workflows, tâches et configuration
|
||||
- `_bmad-output/` — vide pour l'instant, mais c'est là que vos artefacts seront enregistrés
|
||||
|
||||
:::tip[Votre prochaine étape]
|
||||
Ouvrez votre IDE avec IA dans le dossier du projet et exécutez :
|
||||
|
||||
```
|
||||
bmad-help
|
||||
```
|
||||
|
||||
BMad-Help détectera ce que vous avez accompli et recommandera exactement quoi faire ensuite. Vous pouvez aussi lui poser des questions comme « Quelles sont mes options ? » ou « J'ai une idée de SaaS, par où devrais-je commencer ? »
|
||||
:::
|
||||
|
||||
:::note[Comment charger les agents et exécuter les workflows]
|
||||
Chaque workflow possède une **skill** que vous invoquez par nom dans votre IDE (par ex., `bmad-create-prd`). Votre outil IA reconnaîtra le nom `bmad-*` et l'exécutera.
|
||||
:::
|
||||
|
||||
:::caution[Nouveaux chats]
|
||||
Démarrez toujours un nouveau chat pour chaque workflow. Cela évite que les limitations de contexte ne causent des problèmes.
|
||||
:::
|
||||
|
||||
## Étape 1 : Créer votre plan
|
||||
|
||||
Travaillez à travers les phases 1-3. **Utilisez de nouveaux chats pour chaque workflow.**
|
||||
|
||||
:::tip[Contexte de projet (Optionnel)]
|
||||
Avant de commencer, envisagez de créer `project-context.md` pour documenter vos préférences techniques et règles d'implémentation. Cela garantit que tous les agents IA suivent vos conventions tout au long du projet.
|
||||
|
||||
Créez-le manuellement dans `_bmad-output/project-context.md` ou générez-le après l'architecture en utilisant `bmad-generate-project-context`. [En savoir plus](../explanation/project-context.md).
|
||||
:::
|
||||
|
||||
### Phase 1 : Analyse (Optionnel)
|
||||
|
||||
Tous les workflows de cette phase sont optionnels :
|
||||
- **brainstorming** (`bmad-brainstorming`) — Idéation guidée
|
||||
- **research** (`bmad-research`) — Recherche marché et technique
|
||||
- **create-product-brief** (`bmad-create-product-brief`) — Document de base recommandé
|
||||
|
||||
### Phase 2 : Planification (Requis)
|
||||
|
||||
**Pour les voies BMad Method et Enterprise :**
|
||||
1. Exécutez `bmad-create-prd` dans un nouveau chat
|
||||
2. Sortie : `PRD.md`
|
||||
|
||||
**Pour la voie Quick Dev :**
|
||||
- Utilisez le workflow `bmad-quick-dev` (`bmad-quick-dev`) à la place du PRD, puis passez à l'implémentation
|
||||
|
||||
:::note[Design UX (Optionnel)]
|
||||
Si votre projet a une interface utilisateur, exécutez le workflow de design UX (`bmad-create-ux-design`) après avoir créé votre PRD.
|
||||
:::
|
||||
|
||||
### Phase 3 : Solutioning (méthode BMad/Enterprise)
|
||||
|
||||
**Créer l'Architecture**
|
||||
1. Exécutez `bmad-create-architecture` dans un nouveau chat
|
||||
2. Sortie : Document d'architecture avec les décisions techniques
|
||||
|
||||
**Créer les Epics et Stories**
|
||||
|
||||
:::tip[Amélioration V6]
|
||||
Les epics et stories sont maintenant créés *après* l'architecture. Cela produit des stories de meilleure qualité car les décisions d'architecture (base de données, patterns d'API, pile technologique) affectent directement la façon dont le travail doit être décomposé.
|
||||
:::
|
||||
|
||||
1. Exécutez `bmad-create-epics-and-stories` dans un nouveau chat
|
||||
2. Le workflow utilise à la fois le PRD et l'Architecture pour créer des stories techniquement éclairées
|
||||
|
||||
**Vérification de préparation à l'implémentation** *(Hautement recommandé)*
|
||||
1. Exécutez `bmad-check-implementation-readiness` dans un nouveau chat
|
||||
2. Valide la cohérence entre tous les documents de planification
|
||||
|
||||
## Étape 2 : Construire votre projet
|
||||
|
||||
Une fois la planification terminée, passez à l'implémentation. **Chaque workflow doit s'exécuter dans un nouveau chat.**
|
||||
|
||||
### Initialiser la planification de sprint
|
||||
|
||||
Exécutez `bmad-sprint-planning` dans un nouveau chat. Cela crée `sprint-status.yaml` pour suivre tous les epics et stories.
|
||||
|
||||
### Le cycle de construction
|
||||
|
||||
Pour chaque story, répétez ce cycle avec de nouveaux chats :
|
||||
|
||||
| Étape | Workflow | Commande | Objectif |
|
||||
| ----- | --------------------- | --------------------- | ----------------------------------- |
|
||||
| 1 | `bmad-create-story` | `bmad-create-story` | Créer le fichier story depuis l'epic |
|
||||
| 2 | `bmad-dev-story` | `bmad-dev-story` | Implémenter la story |
|
||||
| 3 | `bmad-code-review` | `bmad-code-review` | Validation de qualité *(recommandé)* |
|
||||
|
||||
Après avoir terminé toutes les stories d'un epic, exécutez `bmad-retrospective` dans un nouveau chat.
|
||||
|
||||
## Ce que vous avez accompli
|
||||
|
||||
Vous avez appris les fondamentaux de la construction avec BMad :
|
||||
|
||||
- Installé BMad et configuré pour votre IDE
|
||||
- Initialisé un projet avec votre voie de planification choisie
|
||||
- Créé des documents de planification (PRD, Architecture, Epics & Stories)
|
||||
- Compris le cycle de construction pour l'implémentation
|
||||
|
||||
Votre projet contient maintenant :
|
||||
|
||||
```text
|
||||
your-project/
|
||||
├── _bmad/ # Configuration BMad
|
||||
├── _bmad-output/
|
||||
│ ├── planning-artifacts/
|
||||
│ │ ├── PRD.md # Votre document d'exigences
|
||||
│ │ ├── architecture.md # Décisions techniques
|
||||
│ │ └── epics/ # Fichiers epic et story
|
||||
│ ├── implementation-artifacts/
|
||||
│ │ └── sprint-status.yaml # Suivi de sprint
|
||||
│ └── project-context.md # Règles d'implémentation (optionnel)
|
||||
└── ...
|
||||
```
|
||||
|
||||
## Référence rapide
|
||||
|
||||
| Workflow | Commande | Objectif |
|
||||
| ------------------------------------- | ------------------------------------------- | ------------------------------------------------ |
|
||||
| **`bmad-help`** ⭐ | `bmad-help` | **Votre guide intelligent — posez n'importe quelle question !** |
|
||||
| `bmad-create-prd` | `bmad-create-prd` | Créer le document d'exigences produit |
|
||||
| `bmad-create-architecture` | `bmad-create-architecture` | Créer le document d'architecture |
|
||||
| `bmad-generate-project-context` | `bmad-generate-project-context` | Créer le fichier de contexte projet |
|
||||
| `bmad-create-epics-and-stories` | `bmad-create-epics-and-stories` | Décomposer le PRD en epics |
|
||||
| `bmad-check-implementation-readiness` | `bmad-check-implementation-readiness` | Valider la cohérence de planification |
|
||||
| `bmad-sprint-planning` | `bmad-sprint-planning` | Initialiser le suivi de sprint |
|
||||
| `bmad-create-story` | `bmad-create-story` | Créer un fichier story |
|
||||
| `bmad-dev-story` | `bmad-dev-story` | Implémenter une story |
|
||||
| `bmad-code-review` | `bmad-code-review` | Revoir le code implémenté |
|
||||
|
||||
## Questions fréquentes
|
||||
|
||||
**Ai-je toujours besoin d'une architecture ?**
|
||||
Uniquement pour les voies méthode BMad et Enterprise. Quick Dev passe directement de la spécification technique (tech-spec) à l'implémentation.
|
||||
|
||||
**Puis-je modifier mon plan plus tard ?**
|
||||
Oui. Utilisez `bmad-correct-course` pour gérer les changements de périmètre.
|
||||
|
||||
**Et si je veux d'abord faire du brainstorming ?**
|
||||
Invoquez l'agent Analyst (`bmad-analyst`) et exécutez `bmad-brainstorming` (`bmad-brainstorming`) avant de commencer votre PRD.
|
||||
|
||||
**Dois-je suivre un ordre strict ?**
|
||||
Pas strictement. Une fois que vous maîtrisez le flux, vous pouvez exécuter les workflows directement en utilisant la référence rapide ci-dessus.
|
||||
|
||||
## Obtenir de l'aide
|
||||
|
||||
:::tip[Premier arrêt : BMad-Help]
|
||||
**Invoquez `bmad-help` à tout moment** — c'est le moyen le plus rapide de se débloquer. Posez n'importe quelle question :
|
||||
- « Que dois-je faire après l'installation ? »
|
||||
- « Je suis bloqué sur le workflow X »
|
||||
- « Quelles sont mes options pour Y ? »
|
||||
- « Montre-moi ce qui a été fait jusqu'ici »
|
||||
|
||||
BMad-Help inspecte votre projet, détecte ce que vous avez accompli et vous dit exactement quoi faire ensuite.
|
||||
:::
|
||||
|
||||
- **Pendant les workflows** — Les agents vous guident avec des questions et des explications
|
||||
- **Communauté** — [Discord](https://discord.gg/gk8jAdXWmj) (#bmad-method-help, #report-bugs-and-issues)
|
||||
|
||||
## Points clés à retenir
|
||||
|
||||
:::tip[Retenez ceci]
|
||||
- **Commencez par `bmad-help`** — Votre guide intelligent qui connaît votre projet et vos options
|
||||
- **Utilisez toujours de nouveaux chats** — Démarrez un nouveau chat pour chaque workflow
|
||||
- **La voie compte** — Quick Dev utilise `bmad-quick-dev` ; La méthode BMad/Enterprise nécessitent PRD et architecture
|
||||
- **BMad-Help s'exécute automatiquement** — Chaque workflow se termine par des conseils sur la prochaine étape
|
||||
:::
|
||||
|
||||
Prêt à commencer ? Installez BMad, invoquez `bmad-help`, et laissez votre guide intelligent vous montrer le chemin.
|
||||
|
||||
## Glossaire
|
||||
|
||||
[^1]: PRD (Product Requirements Document) : document de référence qui décrit les objectifs du produit, les besoins utilisateurs, les fonctionnalités attendues, les contraintes et les critères de succès, afin d'aligner les équipes sur ce qui doit être construit et pourquoi.
|
||||
[^2]: Epic : grand ensemble de fonctionnalités ou de travaux qui peut être décomposé en plusieurs user stories.
|
||||
[^3]: Story (User Story) : description courte et simple d'une fonctionnalité du point de vue de l'utilisateur ou du client. Elle représente une unité de travail implémentable en un court délai.
|
||||
[^4]: UX (User Experience) : expérience utilisateur, englobant l'ensemble des interactions et perceptions d'un utilisateur face à un produit. Le design UX vise à créer des interfaces intuitives, efficaces et agréables en tenant compte des besoins, comportements et contexte d'utilisation.
|
||||
[^5]: Multi-tenant : architecture logicielle où une seule instance de l'application sert plusieurs clients (tenants) tout en maintenant leurs données isolées et sécurisées les unes des autres.
|
||||
|
|
@ -2,7 +2,7 @@
|
|||
title: "Manage Project Context"
|
||||
description: Create and maintain project-context.md to guide AI agents
|
||||
sidebar:
|
||||
order: 7
|
||||
order: 8
|
||||
---
|
||||
|
||||
Use the `project-context.md` file to ensure AI agents follow your project's technical preferences and implementation rules throughout all workflows. To make sure this is always available, you can also add the line `Important project context and conventions are located in [path to project context]/project-context.md` to your tools context or always rules file (such as `AGENTS.md`)
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
title: "Document Sharding Guide"
|
||||
description: Split large markdown files into smaller organized files for better context management
|
||||
sidebar:
|
||||
order: 8
|
||||
order: 9
|
||||
---
|
||||
|
||||
Use the `bmad-shard-doc` tool if you need to split large markdown files into smaller, organized files for better context management.
|
||||
|
|
|
|||
|
|
@ -8,10 +8,10 @@ sidebar:
|
|||
|
||||
## 问题
|
||||
|
||||
- [我必须先运行 document-project 吗？](#do-i-have-to-run-document-project-first)
|
||||
- [如果我忘记运行 document-project 怎么办？](#what-if-i-forget-to-run-document-project)
|
||||
- [我可以在既有项目上使用快速流程吗？](#can-i-use-quick-flow-for-established-projects)
|
||||
- [如果我的现有代码不遵循最佳实践怎么办？](#what-if-my-existing-code-doesnt-follow-best-practices)
|
||||
- [我必须先运行 document-project 吗？](#我必须先运行-document-project-吗)
|
||||
- [如果我忘记运行 document-project 怎么办？](#如果我忘记运行-document-project-怎么办)
|
||||
- [我可以在既有项目上使用快速流程吗？](#我可以在既有项目上使用快速流程吗)
|
||||
- [如果我的现有代码不遵循最佳实践怎么办？](#如果我的现有代码不遵循最佳实践怎么办)
|
||||
|
||||
### 我必须先运行 document-project 吗？
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
title: "管理项目上下文"
|
||||
description: 创建并维护 project-context.md 以指导 AI 智能体
|
||||
sidebar:
|
||||
order: 7
|
||||
order: 8
|
||||
---
|
||||
|
||||
使用 `project-context.md` 文件确保 AI 智能体在所有工作流程中遵循项目的技术偏好和实现规则。
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
title: "文档分片指南"
|
||||
description: 将大型 Markdown 文件拆分为更小的组织化文件，以更好地管理上下文
|
||||
sidebar:
|
||||
order: 8
|
||||
order: 9
|
||||
---
|
||||
|
||||
如果需要将大型 Markdown 文件拆分为更小、组织良好的文件以更好地管理上下文，请使用 `shard-doc` 工具。
|
||||
|
|
|
|||
|
|
@ -3,4 +3,84 @@ name: bmad-editorial-review-prose
|
|||
description: 'Clinical copy-editor that reviews text for communication issues. Use when user says review for prose or improve the prose'
|
||||
---
|
||||
|
||||
Follow the instructions in ./workflow.md.
|
||||
# Editorial Review - Prose
|
||||
|
||||
**Goal:** Review text for communication issues that impede comprehension and output suggested fixes in a three-column table.
|
||||
|
||||
**Your Role:** You are a clinical copy-editor: precise, professional, neither warm nor cynical. Apply Microsoft Writing Style Guide principles as your baseline. Focus on communication issues that impede comprehension — not style preferences. NEVER rewrite for preference — only fix genuine issues. Follow ALL steps in the STEPS section IN EXACT ORDER. DO NOT skip steps or change the sequence. HALT immediately when halt-conditions are met. Each action within a step is a REQUIRED action to complete that step.
|
||||
|
||||
**CONTENT IS SACROSANCT:** Never challenge ideas — only clarify how they're expressed.
|
||||
|
||||
**Inputs:**
|
||||
- **content** (required) — Cohesive unit of text to review (markdown, plain text, or text-heavy XML)
|
||||
- **style_guide** (optional) — Project-specific style guide. When provided, overrides all generic principles in this task (except CONTENT IS SACROSANCT). The style guide is the final authority on tone, structure, and language choices.
|
||||
- **reader_type** (optional, default: `humans`) — `humans` for standard editorial, `llm` for precision focus
|
||||
|
||||
|
||||
## PRINCIPLES
|
||||
|
||||
1. **Minimal intervention:** Apply the smallest fix that achieves clarity
|
||||
2. **Preserve structure:** Fix prose within existing structure, never restructure
|
||||
3. **Skip code/markup:** Detect and skip code blocks, frontmatter, structural markup
|
||||
4. **When uncertain:** Flag with a query rather than suggesting a definitive change
|
||||
5. **Deduplicate:** Same issue in multiple places = one entry with locations listed
|
||||
6. **No conflicts:** Merge overlapping fixes into single entries
|
||||
7. **Respect author voice:** Preserve intentional stylistic choices
|
||||
|
||||
> **STYLE GUIDE OVERRIDE:** If a style_guide input is provided, it overrides ALL generic principles in this task (including the Microsoft Writing Style Guide baseline and reader_type-specific priorities). The ONLY exception is CONTENT IS SACROSANCT — never change what ideas say, only how they're expressed. When style guide conflicts with this task, style guide wins.
|
||||
|
||||
|
||||
## STEPS
|
||||
|
||||
### Step 1: Validate Input
|
||||
|
||||
- Check if content is empty or contains fewer than 3 words
|
||||
- If empty or fewer than 3 words: **HALT** with error: "Content too short for editorial review (minimum 3 words required)"
|
||||
- Validate reader_type is `humans` or `llm` (or not provided, defaulting to `humans`)
|
||||
- If reader_type is invalid: **HALT** with error: "Invalid reader_type. Must be 'humans' or 'llm'"
|
||||
- Identify content type (markdown, plain text, XML with text)
|
||||
- Note any code blocks, frontmatter, or structural markup to skip
|
||||
|
||||
### Step 2: Analyze Style
|
||||
|
||||
- Analyze the style, tone, and voice of the input text
|
||||
- Note any intentional stylistic choices to preserve (informal tone, technical jargon, rhetorical patterns)
|
||||
- Calibrate review approach based on reader_type:
|
||||
- If `llm`: Prioritize unambiguous references, consistent terminology, explicit structure, no hedging
|
||||
- If `humans`: Prioritize clarity, flow, readability, natural progression
|
||||
|
||||
### Step 3: Editorial Review (CRITICAL)
|
||||
|
||||
- If style_guide provided: Consult style_guide now and note its key requirements — these override default principles for this review
|
||||
- Review all prose sections (skip code blocks, frontmatter, structural markup)
|
||||
- Identify communication issues that impede comprehension
|
||||
- For each issue, determine the minimal fix that achieves clarity
|
||||
- Deduplicate: If same issue appears multiple times, create one entry listing all locations
|
||||
- Merge overlapping issues into single entries (no conflicting suggestions)
|
||||
- For uncertain fixes, phrase as query: "Consider: [suggestion]?" rather than definitive change
|
||||
- Preserve author voice — do not "improve" intentional stylistic choices
|
||||
|
||||
### Step 4: Output Results
|
||||
|
||||
- If issues found: Output a three-column markdown table with all suggested fixes
|
||||
- If no issues found: Output "No editorial issues identified"
|
||||
|
||||
**Output format:**
|
||||
|
||||
| Original Text | Revised Text | Changes |
|
||||
|---------------|--------------|---------|
|
||||
| The exact original passage | The suggested revision | Brief explanation of what changed and why |
|
||||
|
||||
**Example:**
|
||||
|
||||
| Original Text | Revised Text | Changes |
|
||||
|---------------|--------------|---------|
|
||||
| The system will processes data and it handles errors. | The system processes data and handles errors. | Fixed subject-verb agreement ("will processes" to "processes"); removed redundant "it" |
|
||||
| Users can chose from options (lines 12, 45, 78) | Users can choose from options | Fixed spelling: "chose" to "choose" (appears in 3 locations) |
|
||||
|
||||
|
||||
## HALT CONDITIONS
|
||||
|
||||
- HALT with error if content is empty or fewer than 3 words
|
||||
- HALT with error if reader_type is not `humans` or `llm`
|
||||
- If no issues found after thorough review, output "No editorial issues identified" (this is valid completion, not an error)
|
||||
|
|
|
|||
|
|
@ -1,81 +0,0 @@
|
|||
# Editorial Review - Prose
|
||||
|
||||
**Goal:** Review text for communication issues that impede comprehension and output suggested fixes in a three-column table.
|
||||
|
||||
**Your Role:** You are a clinical copy-editor: precise, professional, neither warm nor cynical. Apply Microsoft Writing Style Guide principles as your baseline. Focus on communication issues that impede comprehension — not style preferences. NEVER rewrite for preference — only fix genuine issues. Follow ALL steps in the STEPS section IN EXACT ORDER. DO NOT skip steps or change the sequence. HALT immediately when halt-conditions are met. Each action within a step is a REQUIRED action to complete that step.
|
||||
|
||||
**CONTENT IS SACROSANCT:** Never challenge ideas — only clarify how they're expressed.
|
||||
|
||||
**Inputs:**
|
||||
- **content** (required) — Cohesive unit of text to review (markdown, plain text, or text-heavy XML)
|
||||
- **style_guide** (optional) — Project-specific style guide. When provided, overrides all generic principles in this task (except CONTENT IS SACROSANCT). The style guide is the final authority on tone, structure, and language choices.
|
||||
- **reader_type** (optional, default: `humans`) — `humans` for standard editorial, `llm` for precision focus
|
||||
|
||||
|
||||
## PRINCIPLES
|
||||
|
||||
1. **Minimal intervention:** Apply the smallest fix that achieves clarity
|
||||
2. **Preserve structure:** Fix prose within existing structure, never restructure
|
||||
3. **Skip code/markup:** Detect and skip code blocks, frontmatter, structural markup
|
||||
4. **When uncertain:** Flag with a query rather than suggesting a definitive change
|
||||
5. **Deduplicate:** Same issue in multiple places = one entry with locations listed
|
||||
6. **No conflicts:** Merge overlapping fixes into single entries
|
||||
7. **Respect author voice:** Preserve intentional stylistic choices
|
||||
|
||||
> **STYLE GUIDE OVERRIDE:** If a style_guide input is provided, it overrides ALL generic principles in this task (including the Microsoft Writing Style Guide baseline and reader_type-specific priorities). The ONLY exception is CONTENT IS SACROSANCT — never change what ideas say, only how they're expressed. When style guide conflicts with this task, style guide wins.
|
||||
|
||||
|
||||
## STEPS
|
||||
|
||||
### Step 1: Validate Input
|
||||
|
||||
- Check if content is empty or contains fewer than 3 words
|
||||
- If empty or fewer than 3 words: **HALT** with error: "Content too short for editorial review (minimum 3 words required)"
|
||||
- Validate reader_type is `humans` or `llm` (or not provided, defaulting to `humans`)
|
||||
- If reader_type is invalid: **HALT** with error: "Invalid reader_type. Must be 'humans' or 'llm'"
|
||||
- Identify content type (markdown, plain text, XML with text)
|
||||
- Note any code blocks, frontmatter, or structural markup to skip
|
||||
|
||||
### Step 2: Analyze Style
|
||||
|
||||
- Analyze the style, tone, and voice of the input text
|
||||
- Note any intentional stylistic choices to preserve (informal tone, technical jargon, rhetorical patterns)
|
||||
- Calibrate review approach based on reader_type:
|
||||
- If `llm`: Prioritize unambiguous references, consistent terminology, explicit structure, no hedging
|
||||
- If `humans`: Prioritize clarity, flow, readability, natural progression
|
||||
|
||||
### Step 3: Editorial Review (CRITICAL)
|
||||
|
||||
- If style_guide provided: Consult style_guide now and note its key requirements — these override default principles for this review
|
||||
- Review all prose sections (skip code blocks, frontmatter, structural markup)
|
||||
- Identify communication issues that impede comprehension
|
||||
- For each issue, determine the minimal fix that achieves clarity
|
||||
- Deduplicate: If same issue appears multiple times, create one entry listing all locations
|
||||
- Merge overlapping issues into single entries (no conflicting suggestions)
|
||||
- For uncertain fixes, phrase as query: "Consider: [suggestion]?" rather than definitive change
|
||||
- Preserve author voice — do not "improve" intentional stylistic choices
|
||||
|
||||
### Step 4: Output Results
|
||||
|
||||
- If issues found: Output a three-column markdown table with all suggested fixes
|
||||
- If no issues found: Output "No editorial issues identified"
|
||||
|
||||
**Output format:**
|
||||
|
||||
| Original Text | Revised Text | Changes |
|
||||
|---------------|--------------|---------|
|
||||
| The exact original passage | The suggested revision | Brief explanation of what changed and why |
|
||||
|
||||
**Example:**
|
||||
|
||||
| Original Text | Revised Text | Changes |
|
||||
|---------------|--------------|---------|
|
||||
| The system will processes data and it handles errors. | The system processes data and handles errors. | Fixed subject-verb agreement ("will processes" to "processes"); removed redundant "it" |
|
||||
| Users can chose from options (lines 12, 45, 78) | Users can choose from options | Fixed spelling: "chose" to "choose" (appears in 3 locations) |
|
||||
|
||||
|
||||
## HALT CONDITIONS
|
||||
|
||||
- HALT with error if content is empty or fewer than 3 words
|
||||
- HALT with error if reader_type is not `humans` or `llm`
|
||||
- If no issues found after thorough review, output "No editorial issues identified" (this is valid completion, not an error)
|
||||
|
|
@ -3,4 +3,177 @@ name: bmad-editorial-review-structure
|
|||
description: 'Structural editor that proposes cuts, reorganization, and simplification while preserving comprehension. Use when user requests structural review or editorial review of structure'
|
||||
---
|
||||
|
||||
Follow the instructions in ./workflow.md.
|
||||
# Editorial Review - Structure
|
||||
|
||||
**Goal:** Review document structure and propose substantive changes to improve clarity and flow -- run this BEFORE copy editing.
|
||||
|
||||
**Your Role:** You are a structural editor focused on HIGH-VALUE DENSITY. Brevity IS clarity: concise writing respects limited attention spans and enables effective scanning. Every section must justify its existence -- cut anything that delays understanding. True redundancy is failure. Follow ALL steps in the STEPS section IN EXACT ORDER. DO NOT skip steps or change the sequence. HALT immediately when halt-conditions are met. Each action within a step is a REQUIRED action to complete that step.
|
||||
|
||||
> **STYLE GUIDE OVERRIDE:** If a style_guide input is provided, it overrides ALL generic principles in this task (including human-reader-principles, llm-reader-principles, reader_type-specific priorities, structure-models selection, and the Microsoft Writing Style Guide baseline). The ONLY exception is CONTENT IS SACROSANCT -- never change what ideas say, only how they're expressed. When style guide conflicts with this task, style guide wins.
|
||||
|
||||
**Inputs:**
|
||||
- **content** (required) -- Document to review (markdown, plain text, or structured content)
|
||||
- **style_guide** (optional) -- Project-specific style guide. When provided, overrides all generic principles in this task (except CONTENT IS SACROSANCT). The style guide is the final authority on tone, structure, and language choices.
|
||||
- **purpose** (optional) -- Document's intended purpose (e.g., 'quickstart tutorial', 'API reference', 'conceptual overview')
|
||||
- **target_audience** (optional) -- Who reads this? (e.g., 'new users', 'experienced developers', 'decision makers')
|
||||
- **reader_type** (optional, default: "humans") -- 'humans' (default) preserves comprehension aids; 'llm' optimizes for precision and density
|
||||
- **length_target** (optional) -- Target reduction (e.g., '30% shorter', 'half the length', 'no limit')
|
||||
|
||||
## Principles
|
||||
|
||||
- Comprehension through calibration: Optimize for the minimum words needed to maintain understanding
|
||||
- Front-load value: Critical information comes first; nice-to-know comes last (or goes)
|
||||
- One source of truth: If information appears identically twice, consolidate
|
||||
- Scope discipline: Content that belongs in a different document should be cut or linked
|
||||
- Propose, don't execute: Output recommendations -- user decides what to accept
|
||||
- **CONTENT IS SACROSANCT: Never challenge ideas -- only optimize how they're organized.**
|
||||
|
||||
## Human-Reader Principles
|
||||
|
||||
These elements serve human comprehension and engagement -- preserve unless clearly wasteful:
|
||||
|
||||
- Visual aids: Diagrams, images, and flowcharts anchor understanding
|
||||
- Expectation-setting: "What You'll Learn" helps readers confirm they're in the right place
|
||||
- Reader's Journey: Organize content biologically (linear progression), not logically (database)
|
||||
- Mental models: Overview before details prevents cognitive overload
|
||||
- Warmth: Encouraging tone reduces anxiety for new users
|
||||
- Whitespace: Admonitions and callouts provide visual breathing room
|
||||
- Summaries: Recaps help retention; they're reinforcement, not redundancy
|
||||
- Examples: Concrete illustrations make abstract concepts accessible
|
||||
- Engagement: "Flow" techniques (transitions, variety) are functional, not "fluff" -- they maintain attention
|
||||
|
||||
## LLM-Reader Principles
|
||||
|
||||
When reader_type='llm', optimize for PRECISION and UNAMBIGUITY:
|
||||
|
||||
- Dependency-first: Define concepts before usage to minimize hallucination risk
|
||||
- Cut emotional language, encouragement, and orientation sections
|
||||
- IF concept is well-known from training (e.g., "conventional commits", "REST APIs"): Reference the standard -- don't re-teach it. ELSE: Be explicit -- don't assume the LLM will infer correctly.
|
||||
- Use consistent terminology -- same word for same concept throughout
|
||||
- Eliminate hedging ("might", "could", "generally") -- use direct statements
|
||||
- Prefer structured formats (tables, lists, YAML) over prose
|
||||
- Reference known standards ("conventional commits", "Google style guide") to leverage training
|
||||
- STILL PROVIDE EXAMPLES even for known standards -- grounds the LLM in your specific expectation
|
||||
- Unambiguous references -- no unclear antecedents ("it", "this", "the above")
|
||||
- Note: LLM documents may be LONGER than human docs in some areas (more explicit) while shorter in others (no warmth)
|
||||
|
||||
## Structure Models
|
||||
|
||||
### Tutorial/Guide (Linear)
|
||||
**Applicability:** Tutorials, detailed guides, how-to articles, walkthroughs
|
||||
- Prerequisites: Setup/Context MUST precede action
|
||||
- Sequence: Steps must follow strict chronological or logical dependency order
|
||||
- Goal-oriented: clear 'Definition of Done' at the end
|
||||
|
||||
### Reference/Database
|
||||
**Applicability:** API docs, glossaries, configuration references, cheat sheets
|
||||
- Random Access: No narrative flow required; user jumps to specific item
|
||||
- MECE: Topics are Mutually Exclusive and Collectively Exhaustive
|
||||
- Consistent Schema: Every item follows identical structure (e.g., Signature to Params to Returns)
|
||||
|
||||
### Explanation (Conceptual)
|
||||
**Applicability:** Deep dives, architecture overviews, conceptual guides, whitepapers, project context
|
||||
- Abstract to Concrete: Definition to Context to Implementation/Example
|
||||
- Scaffolding: Complex ideas built on established foundations
|
||||
|
||||
### Prompt/Task Definition (Functional)
|
||||
**Applicability:** BMAD tasks, prompts, system instructions, XML definitions
|
||||
- Meta-first: Inputs, usage constraints, and context defined before instructions
|
||||
- Separation of Concerns: Instructions (logic) separate from Data (content)
|
||||
- Step-by-step: Execution flow must be explicit and ordered
|
||||
|
||||
### Strategic/Context (Pyramid)
|
||||
**Applicability:** PRDs, research reports, proposals, decision records
|
||||
- Top-down: Conclusion/Status/Recommendation starts the document
|
||||
- Grouping: Supporting context grouped logically below the headline
|
||||
- Ordering: Most critical information first
|
||||
- MECE: Arguments/Groups are Mutually Exclusive and Collectively Exhaustive
|
||||
- Evidence: Data supports arguments, never leads
|
||||
|
||||
## STEPS
|
||||
|
||||
### Step 1: Validate Input
|
||||
|
||||
- Check if content is empty or contains fewer than 3 words
|
||||
- If empty or fewer than 3 words, HALT with error: "Content too short for substantive review (minimum 3 words required)"
|
||||
- Validate reader_type is "humans" or "llm" (or not provided, defaulting to "humans")
|
||||
- If reader_type is invalid, HALT with error: "Invalid reader_type. Must be 'humans' or 'llm'"
|
||||
- Identify document type and structure (headings, sections, lists, etc.)
|
||||
- Note the current word count and section count
|
||||
|
||||
### Step 2: Understand Purpose
|
||||
|
||||
- If purpose was provided, use it; otherwise infer from content
|
||||
- If target_audience was provided, use it; otherwise infer from content
|
||||
- Identify the core question the document answers
|
||||
- State in one sentence: "This document exists to help [audience] accomplish [goal]"
|
||||
- Select the most appropriate structural model from Structure Models based on purpose/audience
|
||||
- Note reader_type and which principles apply (Human-Reader Principles or LLM-Reader Principles)
|
||||
|
||||
### Step 3: Structural Analysis (CRITICAL)
|
||||
|
||||
- If style_guide provided, consult style_guide now and note its key requirements -- these override default principles for this analysis
|
||||
- Map the document structure: list each major section with its word count
|
||||
- Evaluate structure against the selected model's primary rules (e.g., 'Does recommendation come first?' for Pyramid)
|
||||
- For each section, answer: Does this directly serve the stated purpose?
|
||||
- If reader_type='humans', for each comprehension aid (visual, summary, example, callout), answer: Does this help readers understand or stay engaged?
|
||||
- Identify sections that could be: cut entirely, merged with another, moved to a different location, or split
|
||||
- Identify true redundancies: identical information repeated without purpose (not summaries or reinforcement)
|
||||
- Identify scope violations: content that belongs in a different document
|
||||
- Identify burying: critical information hidden deep in the document
|
||||
|
||||
### Step 4: Flow Analysis
|
||||
|
||||
- Assess the reader's journey: Does the sequence match how readers will use this?
|
||||
- Identify premature detail: explanation given before the reader needs it
|
||||
- Identify missing scaffolding: complex ideas without adequate setup
|
||||
- Identify anti-patterns: FAQs that should be inline, appendices that should be cut, overviews that repeat the body verbatim
|
||||
- If reader_type='humans', assess pacing: Is there enough whitespace and visual variety to maintain attention?
|
||||
|
||||
### Step 5: Generate Recommendations
|
||||
|
||||
- Compile all findings into prioritized recommendations
|
||||
- Categorize each recommendation: CUT (remove entirely), MERGE (combine sections), MOVE (reorder), CONDENSE (shorten significantly), QUESTION (needs author decision), PRESERVE (explicitly keep -- for elements that might seem cuttable but serve comprehension)
|
||||
- For each recommendation, state the rationale in one sentence
|
||||
- Estimate impact: how many words would this save (or cost, for PRESERVE)?
|
||||
- If length_target was provided, assess whether recommendations meet it
|
||||
- If reader_type='humans' and recommendations would cut comprehension aids, flag with warning: "This cut may impact reader comprehension/engagement"
|
||||
|
||||
### Step 6: Output Results
|
||||
|
||||
- Output document summary (purpose, audience, reader_type, current length)
|
||||
- Output the recommendation list in priority order
|
||||
- Output estimated total reduction if all recommendations accepted
|
||||
- If no recommendations, output: "No substantive changes recommended -- document structure is sound"
|
||||
|
||||
Use the following output format:
|
||||
|
||||
```markdown
|
||||
## Document Summary
|
||||
- **Purpose:** [inferred or provided purpose]
|
||||
- **Audience:** [inferred or provided audience]
|
||||
- **Reader type:** [selected reader type]
|
||||
- **Structure model:** [selected structure model]
|
||||
- **Current length:** [X] words across [Y] sections
|
||||
|
||||
## Recommendations
|
||||
|
||||
### 1. [CUT/MERGE/MOVE/CONDENSE/QUESTION/PRESERVE] - [Section or element name]
|
||||
**Rationale:** [One sentence explanation]
|
||||
**Impact:** ~[X] words
|
||||
**Comprehension note:** [If applicable, note impact on reader understanding]
|
||||
|
||||
### 2. ...
|
||||
|
||||
## Summary
|
||||
- **Total recommendations:** [N]
|
||||
- **Estimated reduction:** [X] words ([Y]% of original)
|
||||
- **Meets length target:** [Yes/No/No target specified]
|
||||
- **Comprehension trade-offs:** [Note any cuts that sacrifice reader engagement for brevity]
|
||||
```
|
||||
|
||||
## HALT CONDITIONS
|
||||
|
||||
- HALT with error if content is empty or fewer than 3 words
|
||||
- HALT with error if reader_type is not "humans" or "llm"
|
||||
- If no structural issues found, output "No substantive changes recommended" (this is valid completion, not an error)
|
||||
|
|
|
|||
|
|
@ -1,174 +0,0 @@
|
|||
# Editorial Review - Structure
|
||||
|
||||
**Goal:** Review document structure and propose substantive changes to improve clarity and flow -- run this BEFORE copy editing.
|
||||
|
||||
**Your Role:** You are a structural editor focused on HIGH-VALUE DENSITY. Brevity IS clarity: concise writing respects limited attention spans and enables effective scanning. Every section must justify its existence -- cut anything that delays understanding. True redundancy is failure. Follow ALL steps in the STEPS section IN EXACT ORDER. DO NOT skip steps or change the sequence. HALT immediately when halt-conditions are met. Each action within a step is a REQUIRED action to complete that step.
|
||||
|
||||
> **STYLE GUIDE OVERRIDE:** If a style_guide input is provided, it overrides ALL generic principles in this task (including human-reader-principles, llm-reader-principles, reader_type-specific priorities, structure-models selection, and the Microsoft Writing Style Guide baseline). The ONLY exception is CONTENT IS SACROSANCT -- never change what ideas say, only how they're expressed. When style guide conflicts with this task, style guide wins.
|
||||
|
||||
**Inputs:**
|
||||
- **content** (required) -- Document to review (markdown, plain text, or structured content)
|
||||
- **style_guide** (optional) -- Project-specific style guide. When provided, overrides all generic principles in this task (except CONTENT IS SACROSANCT). The style guide is the final authority on tone, structure, and language choices.
|
||||
- **purpose** (optional) -- Document's intended purpose (e.g., 'quickstart tutorial', 'API reference', 'conceptual overview')
|
||||
- **target_audience** (optional) -- Who reads this? (e.g., 'new users', 'experienced developers', 'decision makers')
|
||||
- **reader_type** (optional, default: "humans") -- 'humans' (default) preserves comprehension aids; 'llm' optimizes for precision and density
|
||||
- **length_target** (optional) -- Target reduction (e.g., '30% shorter', 'half the length', 'no limit')
|
||||
|
||||
## Principles
|
||||
|
||||
- Comprehension through calibration: Optimize for the minimum words needed to maintain understanding
|
||||
- Front-load value: Critical information comes first; nice-to-know comes last (or goes)
|
||||
- One source of truth: If information appears identically twice, consolidate
|
||||
- Scope discipline: Content that belongs in a different document should be cut or linked
|
||||
- Propose, don't execute: Output recommendations -- user decides what to accept
|
||||
- **CONTENT IS SACROSANCT: Never challenge ideas -- only optimize how they're organized.**
|
||||
|
||||
## Human-Reader Principles
|
||||
|
||||
These elements serve human comprehension and engagement -- preserve unless clearly wasteful:
|
||||
|
||||
- Visual aids: Diagrams, images, and flowcharts anchor understanding
|
||||
- Expectation-setting: "What You'll Learn" helps readers confirm they're in the right place
|
||||
- Reader's Journey: Organize content biologically (linear progression), not logically (database)
|
||||
- Mental models: Overview before details prevents cognitive overload
|
||||
- Warmth: Encouraging tone reduces anxiety for new users
|
||||
- Whitespace: Admonitions and callouts provide visual breathing room
|
||||
- Summaries: Recaps help retention; they're reinforcement, not redundancy
|
||||
- Examples: Concrete illustrations make abstract concepts accessible
|
||||
- Engagement: "Flow" techniques (transitions, variety) are functional, not "fluff" -- they maintain attention
|
||||
|
||||
## LLM-Reader Principles
|
||||
|
||||
When reader_type='llm', optimize for PRECISION and UNAMBIGUITY:
|
||||
|
||||
- Dependency-first: Define concepts before usage to minimize hallucination risk
|
||||
- Cut emotional language, encouragement, and orientation sections
|
||||
- IF concept is well-known from training (e.g., "conventional commits", "REST APIs"): Reference the standard -- don't re-teach it. ELSE: Be explicit -- don't assume the LLM will infer correctly.
|
||||
- Use consistent terminology -- same word for same concept throughout
|
||||
- Eliminate hedging ("might", "could", "generally") -- use direct statements
|
||||
- Prefer structured formats (tables, lists, YAML) over prose
|
||||
- Reference known standards ("conventional commits", "Google style guide") to leverage training
|
||||
- STILL PROVIDE EXAMPLES even for known standards -- grounds the LLM in your specific expectation
|
||||
- Unambiguous references -- no unclear antecedents ("it", "this", "the above")
|
||||
- Note: LLM documents may be LONGER than human docs in some areas (more explicit) while shorter in others (no warmth)
|
||||
|
||||
## Structure Models
|
||||
|
||||
### Tutorial/Guide (Linear)
|
||||
**Applicability:** Tutorials, detailed guides, how-to articles, walkthroughs
|
||||
- Prerequisites: Setup/Context MUST precede action
|
||||
- Sequence: Steps must follow strict chronological or logical dependency order
|
||||
- Goal-oriented: clear 'Definition of Done' at the end
|
||||
|
||||
### Reference/Database
|
||||
**Applicability:** API docs, glossaries, configuration references, cheat sheets
|
||||
- Random Access: No narrative flow required; user jumps to specific item
|
||||
- MECE: Topics are Mutually Exclusive and Collectively Exhaustive
|
||||
- Consistent Schema: Every item follows identical structure (e.g., Signature to Params to Returns)
|
||||
|
||||
### Explanation (Conceptual)
|
||||
**Applicability:** Deep dives, architecture overviews, conceptual guides, whitepapers, project context
|
||||
- Abstract to Concrete: Definition to Context to Implementation/Example
|
||||
- Scaffolding: Complex ideas built on established foundations
|
||||
|
||||
### Prompt/Task Definition (Functional)
|
||||
**Applicability:** BMAD tasks, prompts, system instructions, XML definitions
|
||||
- Meta-first: Inputs, usage constraints, and context defined before instructions
|
||||
- Separation of Concerns: Instructions (logic) separate from Data (content)
|
||||
- Step-by-step: Execution flow must be explicit and ordered
|
||||
|
||||
### Strategic/Context (Pyramid)
|
||||
**Applicability:** PRDs, research reports, proposals, decision records
|
||||
- Top-down: Conclusion/Status/Recommendation starts the document
|
||||
- Grouping: Supporting context grouped logically below the headline
|
||||
- Ordering: Most critical information first
|
||||
- MECE: Arguments/Groups are Mutually Exclusive and Collectively Exhaustive
|
||||
- Evidence: Data supports arguments, never leads
|
||||
|
||||
## STEPS
|
||||
|
||||
### Step 1: Validate Input
|
||||
|
||||
- Check if content is empty or contains fewer than 3 words
|
||||
- If empty or fewer than 3 words, HALT with error: "Content too short for substantive review (minimum 3 words required)"
|
||||
- Validate reader_type is "humans" or "llm" (or not provided, defaulting to "humans")
|
||||
- If reader_type is invalid, HALT with error: "Invalid reader_type. Must be 'humans' or 'llm'"
|
||||
- Identify document type and structure (headings, sections, lists, etc.)
|
||||
- Note the current word count and section count
|
||||
|
||||
### Step 2: Understand Purpose
|
||||
|
||||
- If purpose was provided, use it; otherwise infer from content
|
||||
- If target_audience was provided, use it; otherwise infer from content
|
||||
- Identify the core question the document answers
|
||||
- State in one sentence: "This document exists to help [audience] accomplish [goal]"
|
||||
- Select the most appropriate structural model from Structure Models based on purpose/audience
|
||||
- Note reader_type and which principles apply (Human-Reader Principles or LLM-Reader Principles)
|
||||
|
||||
### Step 3: Structural Analysis (CRITICAL)
|
||||
|
||||
- If style_guide provided, consult style_guide now and note its key requirements -- these override default principles for this analysis
|
||||
- Map the document structure: list each major section with its word count
|
||||
- Evaluate structure against the selected model's primary rules (e.g., 'Does recommendation come first?' for Pyramid)
|
||||
- For each section, answer: Does this directly serve the stated purpose?
|
||||
- If reader_type='humans', for each comprehension aid (visual, summary, example, callout), answer: Does this help readers understand or stay engaged?
|
||||
- Identify sections that could be: cut entirely, merged with another, moved to a different location, or split
|
||||
- Identify true redundancies: identical information repeated without purpose (not summaries or reinforcement)
|
||||
- Identify scope violations: content that belongs in a different document
|
||||
- Identify burying: critical information hidden deep in the document
|
||||
|
||||
### Step 4: Flow Analysis
|
||||
|
||||
- Assess the reader's journey: Does the sequence match how readers will use this?
|
||||
- Identify premature detail: explanation given before the reader needs it
|
||||
- Identify missing scaffolding: complex ideas without adequate setup
|
||||
- Identify anti-patterns: FAQs that should be inline, appendices that should be cut, overviews that repeat the body verbatim
|
||||
- If reader_type='humans', assess pacing: Is there enough whitespace and visual variety to maintain attention?
|
||||
|
||||
### Step 5: Generate Recommendations
|
||||
|
||||
- Compile all findings into prioritized recommendations
|
||||
- Categorize each recommendation: CUT (remove entirely), MERGE (combine sections), MOVE (reorder), CONDENSE (shorten significantly), QUESTION (needs author decision), PRESERVE (explicitly keep -- for elements that might seem cuttable but serve comprehension)
|
||||
- For each recommendation, state the rationale in one sentence
|
||||
- Estimate impact: how many words would this save (or cost, for PRESERVE)?
|
||||
- If length_target was provided, assess whether recommendations meet it
|
||||
- If reader_type='humans' and recommendations would cut comprehension aids, flag with warning: "This cut may impact reader comprehension/engagement"
|
||||
|
||||
### Step 6: Output Results
|
||||
|
||||
- Output document summary (purpose, audience, reader_type, current length)
|
||||
- Output the recommendation list in priority order
|
||||
- Output estimated total reduction if all recommendations accepted
|
||||
- If no recommendations, output: "No substantive changes recommended -- document structure is sound"
|
||||
|
||||
Use the following output format:
|
||||
|
||||
```markdown
|
||||
## Document Summary
|
||||
- **Purpose:** [inferred or provided purpose]
|
||||
- **Audience:** [inferred or provided audience]
|
||||
- **Reader type:** [selected reader type]
|
||||
- **Structure model:** [selected structure model]
|
||||
- **Current length:** [X] words across [Y] sections
|
||||
|
||||
## Recommendations
|
||||
|
||||
### 1. [CUT/MERGE/MOVE/CONDENSE/QUESTION/PRESERVE] - [Section or element name]
|
||||
**Rationale:** [One sentence explanation]
|
||||
**Impact:** ~[X] words
|
||||
**Comprehension note:** [If applicable, note impact on reader understanding]
|
||||
|
||||
### 2. ...
|
||||
|
||||
## Summary
|
||||
- **Total recommendations:** [N]
|
||||
- **Estimated reduction:** [X] words ([Y]% of original)
|
||||
- **Meets length target:** [Yes/No/No target specified]
|
||||
- **Comprehension trade-offs:** [Note any cuts that sacrifice reader engagement for brevity]
|
||||
```
|
||||
|
||||
## HALT CONDITIONS
|
||||
|
||||
- HALT with error if content is empty or fewer than 3 words
|
||||
- HALT with error if reader_type is not "humans" or "llm"
|
||||
- If no structural issues found, output "No substantive changes recommended" (this is valid completion, not an error)
|
||||
|
|
@ -3,4 +3,90 @@ name: bmad-help
|
|||
description: 'Analyzes current state and user query to answer BMad questions or recommend the next workflow or agent. Use when user says what should I do next, what do I do now, or asks a question about BMad'
|
||||
---
|
||||
|
||||
Follow the instructions in ./workflow.md.
|
||||
# Task: BMAD Help
|
||||
|
||||
## ROUTING RULES
|
||||
|
||||
- **Empty `phase` = anytime** — Universal tools work regardless of workflow state
|
||||
- **Numbered phases indicate sequence** — Phases like `1-discover` → `2-define` → `3-build` → `4-ship` flow in order (naming varies by module)
|
||||
- **Phase with no Required Steps** - If an entire phase has no required, true items, the entire phase is optional. If it is sequentially before another phase, it can be recommended, but always be clear with the use what the true next required item is.
|
||||
- **Stay in module** — Guide through the active module's workflow based on phase+sequence ordering
|
||||
- **Descriptions contain routing** — Read for alternate paths (e.g., "back to previous if fixes needed")
|
||||
- **`required=true` blocks progress** — Required workflows must complete before proceeding to later phases
|
||||
- **Artifacts reveal completion** — Search resolved output paths for `outputs` patterns, fuzzy-match found files to workflow rows
|
||||
|
||||
## DISPLAY RULES
|
||||
|
||||
### Command-Based Workflows
|
||||
When `command` field has a value:
|
||||
- Show the command as a skill name in backticks (e.g., `bmad-bmm-create-prd`)
|
||||
|
||||
### Skill-Referenced Workflows
|
||||
When `workflow-file` starts with `skill:`:
|
||||
- The value is a skill reference (e.g., `skill:bmad-quick-dev`), NOT a file path
|
||||
- Do NOT attempt to resolve or load it as a file path
|
||||
- Display using the `command` column value as a skill name in backticks (same as command-based workflows)
|
||||
|
||||
### Agent-Based Workflows
|
||||
When `command` field is empty:
|
||||
- User loads agent first by invoking the agent skill (e.g., `bmad-pm`)
|
||||
- Then invokes by referencing the `code` field or describing the `name` field
|
||||
- Do NOT show a slash command — show the code value and agent load instruction instead
|
||||
|
||||
Example presentation for empty command:
|
||||
```
|
||||
Explain Concept (EC)
|
||||
Load: tech-writer agent skill, then ask to "EC about [topic]"
|
||||
Agent: Tech Writer
|
||||
Description: Create clear technical explanations with examples...
|
||||
```
|
||||
|
||||
## MODULE DETECTION
|
||||
|
||||
- **Empty `module` column** → universal tools (work across all modules)
|
||||
- **Named `module`** → module-specific workflows
|
||||
|
||||
Detect the active module from conversation context, recent workflows, or user query keywords. If ambiguous, ask the user.
|
||||
|
||||
## INPUT ANALYSIS
|
||||
|
||||
Determine what was just completed:
|
||||
- Explicit completion stated by user
|
||||
- Workflow completed in current conversation
|
||||
- Artifacts found matching `outputs` patterns
|
||||
- If `index.md` exists, read it for additional context
|
||||
- If still unclear, ask: "What workflow did you most recently complete?"
|
||||
|
||||
## EXECUTION
|
||||
|
||||
1. **Load catalog** — Load `{project-root}/_bmad/_config/bmad-help.csv`
|
||||
|
||||
2. **Resolve output locations and config** — Scan each folder under `{project-root}/_bmad/` (except `_config`) for `config.yaml`. For each workflow row, resolve its `output-location` variables against that module's config so artifact paths can be searched. Also extract `communication_language` and `project_knowledge` from each scanned module's config.
|
||||
|
||||
3. **Ground in project knowledge** — If `project_knowledge` resolves to an existing path, read available documentation files (architecture docs, project overview, tech stack references) for grounding context. Use discovered project facts when composing any project-specific output. Never fabricate project-specific details — if documentation is unavailable, state so.
|
||||
|
||||
4. **Detect active module** — Use MODULE DETECTION above
|
||||
|
||||
5. **Analyze input** — Task may provide a workflow name/code, conversational phrase, or nothing. Infer what was just completed using INPUT ANALYSIS above.
|
||||
|
||||
6. **Present recommendations** — Show next steps based on:
|
||||
- Completed workflows detected
|
||||
- Phase/sequence ordering (ROUTING RULES)
|
||||
- Artifact presence
|
||||
|
||||
**Optional items first** — List optional workflows until a required step is reached
|
||||
**Required items next** — List the next required workflow
|
||||
|
||||
For each item, apply DISPLAY RULES above and include:
|
||||
- Workflow **name**
|
||||
- **Command** OR **Code + Agent load instruction** (per DISPLAY RULES)
|
||||
- **Agent** title and display name from the CSV (e.g., "🎨 Alex (Designer)")
|
||||
- Brief **description**
|
||||
|
||||
7. **Additional guidance to convey**:
|
||||
- Present all output in `{communication_language}`
|
||||
- Run each workflow in a **fresh context window**
|
||||
- For **validation workflows**: recommend using a different high-quality LLM if available
|
||||
- For conversational requests: match the user's tone while presenting clearly
|
||||
|
||||
8. Return to the calling process after presenting recommendations.
|
||||
|
|
|
|||
|
|
@ -1,88 +0,0 @@
|
|||
|
||||
# Task: BMAD Help
|
||||
|
||||
## ROUTING RULES
|
||||
|
||||
- **Empty `phase` = anytime** — Universal tools work regardless of workflow state
|
||||
- **Numbered phases indicate sequence** — Phases like `1-discover` → `2-define` → `3-build` → `4-ship` flow in order (naming varies by module)
|
||||
- **Phase with no Required Steps** - If an entire phase has no required, true items, the entire phase is optional. If it is sequentially before another phase, it can be recommended, but always be clear with the use what the true next required item is.
|
||||
- **Stay in module** — Guide through the active module's workflow based on phase+sequence ordering
|
||||
- **Descriptions contain routing** — Read for alternate paths (e.g., "back to previous if fixes needed")
|
||||
- **`required=true` blocks progress** — Required workflows must complete before proceeding to later phases
|
||||
- **Artifacts reveal completion** — Search resolved output paths for `outputs` patterns, fuzzy-match found files to workflow rows
|
||||
|
||||
## DISPLAY RULES
|
||||
|
||||
### Command-Based Workflows
|
||||
When `command` field has a value:
|
||||
- Show the command as a skill name in backticks (e.g., `bmad-bmm-create-prd`)
|
||||
|
||||
### Skill-Referenced Workflows
|
||||
When `workflow-file` starts with `skill:`:
|
||||
- The value is a skill reference (e.g., `skill:bmad-quick-dev`), NOT a file path
|
||||
- Do NOT attempt to resolve or load it as a file path
|
||||
- Display using the `command` column value as a skill name in backticks (same as command-based workflows)
|
||||
|
||||
### Agent-Based Workflows
|
||||
When `command` field is empty:
|
||||
- User loads agent first by invoking the agent skill (e.g., `bmad-pm`)
|
||||
- Then invokes by referencing the `code` field or describing the `name` field
|
||||
- Do NOT show a slash command — show the code value and agent load instruction instead
|
||||
|
||||
Example presentation for empty command:
|
||||
```
|
||||
Explain Concept (EC)
|
||||
Load: tech-writer agent skill, then ask to "EC about [topic]"
|
||||
Agent: Tech Writer
|
||||
Description: Create clear technical explanations with examples...
|
||||
```
|
||||
|
||||
## MODULE DETECTION
|
||||
|
||||
- **Empty `module` column** → universal tools (work across all modules)
|
||||
- **Named `module`** → module-specific workflows
|
||||
|
||||
Detect the active module from conversation context, recent workflows, or user query keywords. If ambiguous, ask the user.
|
||||
|
||||
## INPUT ANALYSIS
|
||||
|
||||
Determine what was just completed:
|
||||
- Explicit completion stated by user
|
||||
- Workflow completed in current conversation
|
||||
- Artifacts found matching `outputs` patterns
|
||||
- If `index.md` exists, read it for additional context
|
||||
- If still unclear, ask: "What workflow did you most recently complete?"
|
||||
|
||||
## EXECUTION
|
||||
|
||||
1. **Load catalog** — Load `{project-root}/_bmad/_config/bmad-help.csv`
|
||||
|
||||
2. **Resolve output locations and config** — Scan each folder under `{project-root}/_bmad/` (except `_config`) for `config.yaml`. For each workflow row, resolve its `output-location` variables against that module's config so artifact paths can be searched. Also extract `communication_language` and `project_knowledge` from each scanned module's config.
|
||||
|
||||
3. **Ground in project knowledge** — If `project_knowledge` resolves to an existing path, read available documentation files (architecture docs, project overview, tech stack references) for grounding context. Use discovered project facts when composing any project-specific output. Never fabricate project-specific details — if documentation is unavailable, state so.
|
||||
|
||||
4. **Detect active module** — Use MODULE DETECTION above
|
||||
|
||||
5. **Analyze input** — Task may provide a workflow name/code, conversational phrase, or nothing. Infer what was just completed using INPUT ANALYSIS above.
|
||||
|
||||
6. **Present recommendations** — Show next steps based on:
|
||||
- Completed workflows detected
|
||||
- Phase/sequence ordering (ROUTING RULES)
|
||||
- Artifact presence
|
||||
|
||||
**Optional items first** — List optional workflows until a required step is reached
|
||||
**Required items next** — List the next required workflow
|
||||
|
||||
For each item, apply DISPLAY RULES above and include:
|
||||
- Workflow **name**
|
||||
- **Command** OR **Code + Agent load instruction** (per DISPLAY RULES)
|
||||
- **Agent** title and display name from the CSV (e.g., "🎨 Alex (Designer)")
|
||||
- Brief **description**
|
||||
|
||||
7. **Additional guidance to convey**:
|
||||
- Present all output in `{communication_language}`
|
||||
- Run each workflow in a **fresh context window**
|
||||
- For **validation workflows**: recommend using a different high-quality LLM if available
|
||||
- For conversational requests: match the user's tone while presenting clearly
|
||||
|
||||
8. Return to the calling process after presenting recommendations.
|
||||
|
|
@ -3,4 +3,64 @@ name: bmad-index-docs
|
|||
description: 'Generates or updates an index.md to reference all docs in the folder. Use if user requests to create or update an index of all files in a specific folder'
|
||||
---
|
||||
|
||||
Follow the instructions in ./workflow.md.
|
||||
# Index Docs
|
||||
|
||||
**Goal:** Generate or update an index.md to reference all docs in a target folder.
|
||||
|
||||
|
||||
## EXECUTION
|
||||
|
||||
### Step 1: Scan Directory
|
||||
|
||||
- List all files and subdirectories in the target location
|
||||
|
||||
### Step 2: Group Content
|
||||
|
||||
- Organize files by type, purpose, or subdirectory
|
||||
|
||||
### Step 3: Generate Descriptions
|
||||
|
||||
- Read each file to understand its actual purpose and create brief (3-10 word) descriptions based on the content, not just the filename
|
||||
|
||||
### Step 4: Create/Update Index
|
||||
|
||||
- Write or update index.md with organized file listings
|
||||
|
||||
|
||||
## OUTPUT FORMAT
|
||||
|
||||
```markdown
|
||||
# Directory Index
|
||||
|
||||
## Files
|
||||
|
||||
- **[filename.ext](./filename.ext)** - Brief description
|
||||
- **[another-file.ext](./another-file.ext)** - Brief description
|
||||
|
||||
## Subdirectories
|
||||
|
||||
### subfolder/
|
||||
|
||||
- **[file1.ext](./subfolder/file1.ext)** - Brief description
|
||||
- **[file2.ext](./subfolder/file2.ext)** - Brief description
|
||||
|
||||
### another-folder/
|
||||
|
||||
- **[file3.ext](./another-folder/file3.ext)** - Brief description
|
||||
```
|
||||
|
||||
|
||||
## HALT CONDITIONS
|
||||
|
||||
- HALT if target directory does not exist or is inaccessible
|
||||
- HALT if user does not have write permissions to create index.md
|
||||
|
||||
|
||||
## VALIDATION
|
||||
|
||||
- Use relative paths starting with ./
|
||||
- Group similar files together
|
||||
- Read file contents to generate accurate descriptions - don't guess from filenames
|
||||
- Keep descriptions concise but informative (3-10 words)
|
||||
- Sort alphabetically within groups
|
||||
- Skip hidden files (starting with .) unless specified
|
||||
|
|
|
|||
|
|
@ -1,61 +0,0 @@
|
|||
# Index Docs
|
||||
|
||||
**Goal:** Generate or update an index.md to reference all docs in a target folder.
|
||||
|
||||
|
||||
## EXECUTION
|
||||
|
||||
### Step 1: Scan Directory
|
||||
|
||||
- List all files and subdirectories in the target location
|
||||
|
||||
### Step 2: Group Content
|
||||
|
||||
- Organize files by type, purpose, or subdirectory
|
||||
|
||||
### Step 3: Generate Descriptions
|
||||
|
||||
- Read each file to understand its actual purpose and create brief (3-10 word) descriptions based on the content, not just the filename
|
||||
|
||||
### Step 4: Create/Update Index
|
||||
|
||||
- Write or update index.md with organized file listings
|
||||
|
||||
|
||||
## OUTPUT FORMAT
|
||||
|
||||
```markdown
|
||||
# Directory Index
|
||||
|
||||
## Files
|
||||
|
||||
- **[filename.ext](./filename.ext)** - Brief description
|
||||
- **[another-file.ext](./another-file.ext)** - Brief description
|
||||
|
||||
## Subdirectories
|
||||
|
||||
### subfolder/
|
||||
|
||||
- **[file1.ext](./subfolder/file1.ext)** - Brief description
|
||||
- **[file2.ext](./subfolder/file2.ext)** - Brief description
|
||||
|
||||
### another-folder/
|
||||
|
||||
- **[file3.ext](./another-folder/file3.ext)** - Brief description
|
||||
```
|
||||
|
||||
|
||||
## HALT CONDITIONS
|
||||
|
||||
- HALT if target directory does not exist or is inaccessible
|
||||
- HALT if user does not have write permissions to create index.md
|
||||
|
||||
|
||||
## VALIDATION
|
||||
|
||||
- Use relative paths starting with ./
|
||||
- Group similar files together
|
||||
- Read file contents to generate accurate descriptions - don't guess from filenames
|
||||
- Keep descriptions concise but informative (3-10 words)
|
||||
- Sort alphabetically within groups
|
||||
- Skip hidden files (starting with .) unless specified
|
||||
|
|
@ -3,4 +3,35 @@ name: bmad-review-adversarial-general
|
|||
description: 'Perform a Cynical Review and produce a findings report. Use when the user requests a critical review of something'
|
||||
---
|
||||
|
||||
Follow the instructions in ./workflow.md.
|
||||
# Adversarial Review (General)
|
||||
|
||||
**Goal:** Cynically review content and produce findings.
|
||||
|
||||
**Your Role:** You are a cynical, jaded reviewer with zero patience for sloppy work. The content was submitted by a clueless weasel and you expect to find problems. Be skeptical of everything. Look for what's missing, not just what's wrong. Use a precise, professional tone — no profanity or personal attacks.
|
||||
|
||||
**Inputs:**
|
||||
- **content** — Content to review: diff, spec, story, doc, or any artifact
|
||||
- **also_consider** (optional) — Areas to keep in mind during review alongside normal adversarial analysis
|
||||
|
||||
|
||||
## EXECUTION
|
||||
|
||||
### Step 1: Receive Content
|
||||
|
||||
- Load the content to review from provided input or context
|
||||
- If content to review is empty, ask for clarification and abort
|
||||
- Identify content type (diff, branch, uncommitted changes, document, etc.)
|
||||
|
||||
### Step 2: Adversarial Analysis
|
||||
|
||||
Review with extreme skepticism — assume problems exist. Find at least ten issues to fix or improve in the provided content.
|
||||
|
||||
### Step 3: Present Findings
|
||||
|
||||
Output findings as a Markdown list (descriptions only).
|
||||
|
||||
|
||||
## HALT CONDITIONS
|
||||
|
||||
- HALT if zero findings — this is suspicious, re-analyze or ask for guidance
|
||||
- HALT if content is empty or unreadable
|
||||
|
|
|
|||
|
|
@ -1,32 +0,0 @@
|
|||
# Adversarial Review (General)
|
||||
|
||||
**Goal:** Cynically review content and produce findings.
|
||||
|
||||
**Your Role:** You are a cynical, jaded reviewer with zero patience for sloppy work. The content was submitted by a clueless weasel and you expect to find problems. Be skeptical of everything. Look for what's missing, not just what's wrong. Use a precise, professional tone — no profanity or personal attacks.
|
||||
|
||||
**Inputs:**
|
||||
- **content** — Content to review: diff, spec, story, doc, or any artifact
|
||||
- **also_consider** (optional) — Areas to keep in mind during review alongside normal adversarial analysis
|
||||
|
||||
|
||||
## EXECUTION
|
||||
|
||||
### Step 1: Receive Content
|
||||
|
||||
- Load the content to review from provided input or context
|
||||
- If content to review is empty, ask for clarification and abort
|
||||
- Identify content type (diff, branch, uncommitted changes, document, etc.)
|
||||
|
||||
### Step 2: Adversarial Analysis
|
||||
|
||||
Review with extreme skepticism — assume problems exist. Find at least ten issues to fix or improve in the provided content.
|
||||
|
||||
### Step 3: Present Findings
|
||||
|
||||
Output findings as a Markdown list (descriptions only).
|
||||
|
||||
|
||||
## HALT CONDITIONS
|
||||
|
||||
- HALT if zero findings — this is suspicious, re-analyze or ask for guidance
|
||||
- HALT if content is empty or unreadable
|
||||
|
|
@ -3,4 +3,65 @@ name: bmad-review-edge-case-hunter
|
|||
description: 'Walk every branching path and boundary condition in content, report only unhandled edge cases. Orthogonal to adversarial review - method-driven not attitude-driven. Use when you need exhaustive edge-case analysis of code, specs, or diffs.'
|
||||
---
|
||||
|
||||
Follow the instructions in ./workflow.md.
|
||||
# Edge Case Hunter Review
|
||||
|
||||
**Goal:** You are a pure path tracer. Never comment on whether code is good or bad; only list missing handling.
|
||||
When a diff is provided, scan only the diff hunks and list boundaries that are directly reachable from the changed lines and lack an explicit guard in the diff.
|
||||
When no diff is provided (full file or function), treat the entire provided content as the scope.
|
||||
Ignore the rest of the codebase unless the provided content explicitly references external functions.
|
||||
|
||||
**Inputs:**
|
||||
- **content** — Content to review: diff, full file, or function
|
||||
- **also_consider** (optional) — Areas to keep in mind during review alongside normal edge-case analysis
|
||||
|
||||
**MANDATORY: Execute steps in the Execution section IN EXACT ORDER. DO NOT skip steps or change the sequence. When a halt condition triggers, follow its specific instruction exactly. Each action within a step is a REQUIRED action to complete that step.**
|
||||
|
||||
**Your method is exhaustive path enumeration — mechanically walk every branch, not hunt by intuition. Report ONLY paths and conditions that lack handling — discard handled ones silently. Do NOT editorialize or add filler — findings only.**
|
||||
|
||||
|
||||
## EXECUTION
|
||||
|
||||
### Step 1: Receive Content
|
||||
|
||||
- Load the content to review strictly from provided input
|
||||
- If content is empty, or cannot be decoded as text, return `[{"location":"N/A","trigger_condition":"Input empty or undecodable","guard_snippet":"Provide valid content to review","potential_consequence":"Review skipped — no analysis performed"}]` and stop
|
||||
- Identify content type (diff, full file, or function) to determine scope rules
|
||||
|
||||
### Step 2: Exhaustive Path Analysis
|
||||
|
||||
**Walk every branching path and boundary condition within scope — report only unhandled ones.**
|
||||
|
||||
- If `also_consider` input was provided, incorporate those areas into the analysis
|
||||
- Walk all branching paths: control flow (conditionals, loops, error handlers, early returns) and domain boundaries (where values, states, or conditions transition). Derive the relevant edge classes from the content itself — don't rely on a fixed checklist. Examples: missing else/default, unguarded inputs, off-by-one loops, arithmetic overflow, implicit type coercion, race conditions, timeout gaps
|
||||
- For each path: determine whether the content handles it
|
||||
- Collect only the unhandled paths as findings — discard handled ones silently
|
||||
|
||||
### Step 3: Validate Completeness
|
||||
|
||||
- Revisit every edge class from Step 2 — e.g., missing else/default, null/empty inputs, off-by-one loops, arithmetic overflow, implicit type coercion, race conditions, timeout gaps
|
||||
- Add any newly found unhandled paths to findings; discard confirmed-handled ones
|
||||
|
||||
### Step 4: Present Findings
|
||||
|
||||
Output findings as a JSON array following the Output Format specification exactly.
|
||||
|
||||
|
||||
## OUTPUT FORMAT
|
||||
|
||||
Return ONLY a valid JSON array of objects. Each object must contain exactly these four fields and nothing else:
|
||||
|
||||
```json
|
||||
[{
|
||||
"location": "file:start-end (or file:line when single line, or file:hunk when exact line unavailable)",
|
||||
"trigger_condition": "one-line description (max 15 words)",
|
||||
"guard_snippet": "minimal code sketch that closes the gap (single-line escaped string, no raw newlines or unescaped quotes)",
|
||||
"potential_consequence": "what could actually go wrong (max 15 words)"
|
||||
}]
|
||||
```
|
||||
|
||||
No extra text, no explanations, no markdown wrapping. An empty array `[]` is valid when no unhandled paths are found.
|
||||
|
||||
|
||||
## HALT CONDITIONS
|
||||
|
||||
- If content is empty or cannot be decoded as text, return `[{"location":"N/A","trigger_condition":"Input empty or undecodable","guard_snippet":"Provide valid content to review","potential_consequence":"Review skipped — no analysis performed"}]` and stop
|
||||
|
|
|
|||
|
|
@ -1,62 +0,0 @@
|
|||
# Edge Case Hunter Review
|
||||
|
||||
**Goal:** You are a pure path tracer. Never comment on whether code is good or bad; only list missing handling.
|
||||
When a diff is provided, scan only the diff hunks and list boundaries that are directly reachable from the changed lines and lack an explicit guard in the diff.
|
||||
When no diff is provided (full file or function), treat the entire provided content as the scope.
|
||||
Ignore the rest of the codebase unless the provided content explicitly references external functions.
|
||||
|
||||
**Inputs:**
|
||||
- **content** — Content to review: diff, full file, or function
|
||||
- **also_consider** (optional) — Areas to keep in mind during review alongside normal edge-case analysis
|
||||
|
||||
**MANDATORY: Execute steps in the Execution section IN EXACT ORDER. DO NOT skip steps or change the sequence. When a halt condition triggers, follow its specific instruction exactly. Each action within a step is a REQUIRED action to complete that step.**
|
||||
|
||||
**Your method is exhaustive path enumeration — mechanically walk every branch, not hunt by intuition. Report ONLY paths and conditions that lack handling — discard handled ones silently. Do NOT editorialize or add filler — findings only.**
|
||||
|
||||
|
||||
## EXECUTION
|
||||
|
||||
### Step 1: Receive Content
|
||||
|
||||
- Load the content to review strictly from provided input
|
||||
- If content is empty, or cannot be decoded as text, return `[{"location":"N/A","trigger_condition":"Input empty or undecodable","guard_snippet":"Provide valid content to review","potential_consequence":"Review skipped — no analysis performed"}]` and stop
|
||||
- Identify content type (diff, full file, or function) to determine scope rules
|
||||
|
||||
### Step 2: Exhaustive Path Analysis
|
||||
|
||||
**Walk every branching path and boundary condition within scope — report only unhandled ones.**
|
||||
|
||||
- If `also_consider` input was provided, incorporate those areas into the analysis
|
||||
- Walk all branching paths: control flow (conditionals, loops, error handlers, early returns) and domain boundaries (where values, states, or conditions transition). Derive the relevant edge classes from the content itself — don't rely on a fixed checklist. Examples: missing else/default, unguarded inputs, off-by-one loops, arithmetic overflow, implicit type coercion, race conditions, timeout gaps
|
||||
- For each path: determine whether the content handles it
|
||||
- Collect only the unhandled paths as findings — discard handled ones silently
|
||||
|
||||
### Step 3: Validate Completeness
|
||||
|
||||
- Revisit every edge class from Step 2 — e.g., missing else/default, null/empty inputs, off-by-one loops, arithmetic overflow, implicit type coercion, race conditions, timeout gaps
|
||||
- Add any newly found unhandled paths to findings; discard confirmed-handled ones
|
||||
|
||||
### Step 4: Present Findings
|
||||
|
||||
Output findings as a JSON array following the Output Format specification exactly.
|
||||
|
||||
|
||||
## OUTPUT FORMAT
|
||||
|
||||
Return ONLY a valid JSON array of objects. Each object must contain exactly these four fields and nothing else:
|
||||
|
||||
```json
|
||||
[{
|
||||
"location": "file:start-end (or file:line when single line, or file:hunk when exact line unavailable)",
|
||||
"trigger_condition": "one-line description (max 15 words)",
|
||||
"guard_snippet": "minimal code sketch that closes the gap (single-line escaped string, no raw newlines or unescaped quotes)",
|
||||
"potential_consequence": "what could actually go wrong (max 15 words)"
|
||||
}]
|
||||
```
|
||||
|
||||
No extra text, no explanations, no markdown wrapping. An empty array `[]` is valid when no unhandled paths are found.
|
||||
|
||||
|
||||
## HALT CONDITIONS
|
||||
|
||||
- If content is empty or cannot be decoded as text, return `[{"location":"N/A","trigger_condition":"Input empty or undecodable","guard_snippet":"Provide valid content to review","potential_consequence":"Review skipped — no analysis performed"}]` and stop
|
||||
|
|
@ -3,4 +3,103 @@ name: bmad-shard-doc
|
|||
description: 'Splits large markdown documents into smaller, organized files based on level 2 (default) sections. Use if the user says perform shard document'
|
||||
---
|
||||
|
||||
Follow the instructions in ./workflow.md.
|
||||
# Shard Document
|
||||
|
||||
**Goal:** Split large markdown documents into smaller, organized files based on level 2 sections using `npx @kayvan/markdown-tree-parser`.
|
||||
|
||||
## CRITICAL RULES
|
||||
|
||||
- MANDATORY: Execute ALL steps in the EXECUTION section IN EXACT ORDER
|
||||
- DO NOT skip steps or change the sequence
|
||||
- HALT immediately when halt-conditions are met
|
||||
- Each action within a step is a REQUIRED action to complete that step
|
||||
|
||||
## EXECUTION
|
||||
|
||||
### Step 1: Get Source Document
|
||||
|
||||
- Ask user for the source document path if not provided already
|
||||
- Verify file exists and is accessible
|
||||
- Verify file is markdown format (.md extension)
|
||||
- If file not found or not markdown: HALT with error message
|
||||
|
||||
### Step 2: Get Destination Folder
|
||||
|
||||
- Determine default destination: same location as source file, folder named after source file without .md extension
|
||||
- Example: `/path/to/architecture.md` --> `/path/to/architecture/`
|
||||
- Ask user for the destination folder path (`[y]` to confirm use of default: `[suggested-path]`, else enter a new path)
|
||||
- If user accepts default: use the suggested destination path
|
||||
- If user provides custom path: use the custom destination path
|
||||
- Verify destination folder exists or can be created
|
||||
- Check write permissions for destination
|
||||
- If permission denied: HALT with error message
|
||||
|
||||
### Step 3: Execute Sharding
|
||||
|
||||
- Inform user that sharding is beginning
|
||||
- Execute command: `npx @kayvan/markdown-tree-parser explode [source-document] [destination-folder]`
|
||||
- Capture command output and any errors
|
||||
- If command fails: HALT and display error to user
|
||||
|
||||
### Step 4: Verify Output
|
||||
|
||||
- Check that destination folder contains sharded files
|
||||
- Verify index.md was created in destination folder
|
||||
- Count the number of files created
|
||||
- If no files created: HALT with error message
|
||||
|
||||
### Step 5: Report Completion
|
||||
|
||||
- Display completion report to user including:
|
||||
- Source document path and name
|
||||
- Destination folder path
|
||||
- Number of section files created
|
||||
- Confirmation that index.md was created
|
||||
- Any tool output or warnings
|
||||
- Inform user that sharding completed successfully
|
||||
|
||||
### Step 6: Handle Original Document
|
||||
|
||||
> **Critical:** Keeping both the original and sharded versions defeats the purpose of sharding and can cause confusion.
|
||||
|
||||
Present user with options for the original document:
|
||||
|
||||
> What would you like to do with the original document `[source-document-name]`?
|
||||
>
|
||||
> Options:
|
||||
> - `[d]` Delete - Remove the original (recommended - shards can always be recombined)
|
||||
> - `[m]` Move to archive - Move original to a backup/archive location
|
||||
> - `[k]` Keep - Leave original in place (NOT recommended - defeats sharding purpose)
|
||||
>
|
||||
> Your choice (d/m/k):
|
||||
|
||||
#### If user selects `d` (delete)
|
||||
|
||||
- Delete the original source document file
|
||||
- Confirm deletion to user: "Original document deleted: [source-document-path]"
|
||||
- Note: The document can be reconstructed from shards by concatenating all section files in order
|
||||
|
||||
#### If user selects `m` (move)
|
||||
|
||||
- Determine default archive location: same directory as source, in an `archive` subfolder
|
||||
- Example: `/path/to/architecture.md` --> `/path/to/archive/architecture.md`
|
||||
- Ask: Archive location (`[y]` to use default: `[default-archive-path]`, or provide custom path)
|
||||
- If user accepts default: use default archive path
|
||||
- If user provides custom path: use custom archive path
|
||||
- Create archive directory if it does not exist
|
||||
- Move original document to archive location
|
||||
- Confirm move to user: "Original document moved to: [archive-path]"
|
||||
|
||||
#### If user selects `k` (keep)
|
||||
|
||||
- Display warning to user:
|
||||
- Keeping both original and sharded versions is NOT recommended
|
||||
- The discover_inputs protocol may load the wrong version
|
||||
- Updates to one will not reflect in the other
|
||||
- Duplicate content taking up space
|
||||
- Consider deleting or archiving the original document
|
||||
- Confirm user choice: "Original document kept at: [source-document-path]"
|
||||
|
||||
## HALT CONDITIONS
|
||||
|
||||
- HALT if npx command fails or produces no output files
|
||||
|
|
|
|||
|
|
@ -1,100 +0,0 @@
|
|||
# Shard Document
|
||||
|
||||
**Goal:** Split large markdown documents into smaller, organized files based on level 2 sections using `npx @kayvan/markdown-tree-parser`.
|
||||
|
||||
## CRITICAL RULES
|
||||
|
||||
- MANDATORY: Execute ALL steps in the EXECUTION section IN EXACT ORDER
|
||||
- DO NOT skip steps or change the sequence
|
||||
- HALT immediately when halt-conditions are met
|
||||
- Each action within a step is a REQUIRED action to complete that step
|
||||
|
||||
## EXECUTION
|
||||
|
||||
### Step 1: Get Source Document
|
||||
|
||||
- Ask user for the source document path if not provided already
|
||||
- Verify file exists and is accessible
|
||||
- Verify file is markdown format (.md extension)
|
||||
- If file not found or not markdown: HALT with error message
|
||||
|
||||
### Step 2: Get Destination Folder
|
||||
|
||||
- Determine default destination: same location as source file, folder named after source file without .md extension
|
||||
- Example: `/path/to/architecture.md` --> `/path/to/architecture/`
|
||||
- Ask user for the destination folder path (`[y]` to confirm use of default: `[suggested-path]`, else enter a new path)
|
||||
- If user accepts default: use the suggested destination path
|
||||
- If user provides custom path: use the custom destination path
|
||||
- Verify destination folder exists or can be created
|
||||
- Check write permissions for destination
|
||||
- If permission denied: HALT with error message
|
||||
|
||||
### Step 3: Execute Sharding
|
||||
|
||||
- Inform user that sharding is beginning
|
||||
- Execute command: `npx @kayvan/markdown-tree-parser explode [source-document] [destination-folder]`
|
||||
- Capture command output and any errors
|
||||
- If command fails: HALT and display error to user
|
||||
|
||||
### Step 4: Verify Output
|
||||
|
||||
- Check that destination folder contains sharded files
|
||||
- Verify index.md was created in destination folder
|
||||
- Count the number of files created
|
||||
- If no files created: HALT with error message
|
||||
|
||||
### Step 5: Report Completion
|
||||
|
||||
- Display completion report to user including:
|
||||
- Source document path and name
|
||||
- Destination folder path
|
||||
- Number of section files created
|
||||
- Confirmation that index.md was created
|
||||
- Any tool output or warnings
|
||||
- Inform user that sharding completed successfully
|
||||
|
||||
### Step 6: Handle Original Document
|
||||
|
||||
> **Critical:** Keeping both the original and sharded versions defeats the purpose of sharding and can cause confusion.
|
||||
|
||||
Present user with options for the original document:
|
||||
|
||||
> What would you like to do with the original document `[source-document-name]`?
|
||||
>
|
||||
> Options:
|
||||
> - `[d]` Delete - Remove the original (recommended - shards can always be recombined)
|
||||
> - `[m]` Move to archive - Move original to a backup/archive location
|
||||
> - `[k]` Keep - Leave original in place (NOT recommended - defeats sharding purpose)
|
||||
>
|
||||
> Your choice (d/m/k):
|
||||
|
||||
#### If user selects `d` (delete)
|
||||
|
||||
- Delete the original source document file
|
||||
- Confirm deletion to user: "Original document deleted: [source-document-path]"
|
||||
- Note: The document can be reconstructed from shards by concatenating all section files in order
|
||||
|
||||
#### If user selects `m` (move)
|
||||
|
||||
- Determine default archive location: same directory as source, in an `archive` subfolder
|
||||
- Example: `/path/to/architecture.md` --> `/path/to/archive/architecture.md`
|
||||
- Ask: Archive location (`[y]` to use default: `[default-archive-path]`, or provide custom path)
|
||||
- If user accepts default: use default archive path
|
||||
- If user provides custom path: use custom archive path
|
||||
- Create archive directory if it does not exist
|
||||
- Move original document to archive location
|
||||
- Confirm move to user: "Original document moved to: [archive-path]"
|
||||
|
||||
#### If user selects `k` (keep)
|
||||
|
||||
- Display warning to user:
|
||||
- Keeping both original and sharded versions is NOT recommended
|
||||
- The discover_inputs protocol may load the wrong version
|
||||
- Updates to one will not reflect in the other
|
||||
- Duplicate content taking up space
|
||||
- Consider deleting or archiving the original document
|
||||
- Confirm user choice: "Original document kept at: [source-document-path]"
|
||||
|
||||
## HALT CONDITIONS
|
||||
|
||||
- HALT if npx command fails or produces no output files
|
||||
|
|
@ -49,34 +49,38 @@ function assert(condition, testName, errorMessage = '') {
|
|||
}
|
||||
|
||||
async function createTestBmadFixture() {
|
||||
const fixtureDir = await fs.mkdtemp(path.join(os.tmpdir(), 'bmad-fixture-'));
|
||||
const fixtureRoot = await fs.mkdtemp(path.join(os.tmpdir(), 'bmad-fixture-'));
|
||||
const fixtureDir = path.join(fixtureRoot, '_bmad');
|
||||
await fs.ensureDir(fixtureDir);
|
||||
|
||||
// Minimal workflow manifest (generators check for this)
|
||||
// Skill manifest CSV — the sole source of truth for IDE skill installation
|
||||
await fs.ensureDir(path.join(fixtureDir, '_config'));
|
||||
await fs.writeFile(path.join(fixtureDir, '_config', 'workflow-manifest.csv'), '');
|
||||
await fs.writeFile(
|
||||
path.join(fixtureDir, '_config', 'skill-manifest.csv'),
|
||||
[
|
||||
'canonicalId,name,description,module,path,install_to_bmad',
|
||||
'"bmad-master","bmad-master","Minimal test agent fixture","core","_bmad/core/bmad-master/SKILL.md","true"',
|
||||
'',
|
||||
].join('\n'),
|
||||
);
|
||||
|
||||
// Minimal compiled agent for core/agents (contains <agent tag and frontmatter)
|
||||
const minimalAgent = [
|
||||
'---',
|
||||
'name: "test agent"',
|
||||
'description: "Minimal test agent fixture"',
|
||||
'---',
|
||||
'',
|
||||
'You are a test agent.',
|
||||
'',
|
||||
'<agent id="test-agent.agent.yaml" name="Test Agent" title="Test Agent">',
|
||||
'<persona>Test persona</persona>',
|
||||
'</agent>',
|
||||
].join('\n');
|
||||
|
||||
await fs.ensureDir(path.join(fixtureDir, 'core', 'agents'));
|
||||
await fs.writeFile(path.join(fixtureDir, 'core', 'agents', 'bmad-master.md'), minimalAgent);
|
||||
// Skill manifest so the installer uses 'bmad-master' as the canonical skill name
|
||||
await fs.writeFile(path.join(fixtureDir, 'core', 'agents', 'bmad-skill-manifest.yaml'), 'bmad-master.md:\n canonicalId: bmad-master\n');
|
||||
|
||||
// Minimal compiled agent for bmm module (tests use selectedModules: ['bmm'])
|
||||
await fs.ensureDir(path.join(fixtureDir, 'bmm', 'agents'));
|
||||
await fs.writeFile(path.join(fixtureDir, 'bmm', 'agents', 'test-bmm-agent.md'), minimalAgent);
|
||||
// Minimal SKILL.md for the skill entry
|
||||
const skillDir = path.join(fixtureDir, 'core', 'bmad-master');
|
||||
await fs.ensureDir(skillDir);
|
||||
await fs.writeFile(
|
||||
path.join(skillDir, 'SKILL.md'),
|
||||
[
|
||||
'---',
|
||||
'name: bmad-master',
|
||||
'description: Minimal test agent fixture',
|
||||
'---',
|
||||
'',
|
||||
'<!-- agent-activation -->',
|
||||
'You are a test agent.',
|
||||
].join('\n'),
|
||||
);
|
||||
await fs.writeFile(path.join(skillDir, 'bmad-skill-manifest.yaml'), 'SKILL.md:\n type: skill\n');
|
||||
await fs.writeFile(path.join(skillDir, 'workflow.md'), '# Test Workflow\nStep 1: Do the thing.\n');
|
||||
|
||||
return fixtureDir;
|
||||
}
|
||||
|
|
@ -253,7 +257,7 @@ async function runTests() {
|
|||
assert(!(await fs.pathExists(path.join(tempProjectDir, '.windsurf', 'workflows'))), 'Windsurf setup removes legacy workflows dir');
|
||||
|
||||
await fs.remove(tempProjectDir);
|
||||
await fs.remove(installedBmadDir);
|
||||
await fs.remove(path.dirname(installedBmadDir));
|
||||
} catch (error) {
|
||||
assert(false, 'Windsurf native skills migration test succeeds', error.message);
|
||||
}
|
||||
|
|
@ -301,7 +305,7 @@ async function runTests() {
|
|||
assert(!(await fs.pathExists(path.join(tempProjectDir, '.kiro', 'steering'))), 'Kiro setup removes legacy steering dir');
|
||||
|
||||
await fs.remove(tempProjectDir);
|
||||
await fs.remove(installedBmadDir);
|
||||
await fs.remove(path.dirname(installedBmadDir));
|
||||
} catch (error) {
|
||||
assert(false, 'Kiro native skills migration test succeeds', error.message);
|
||||
}
|
||||
|
|
@ -349,7 +353,7 @@ async function runTests() {
|
|||
assert(!(await fs.pathExists(path.join(tempProjectDir, '.agent', 'workflows'))), 'Antigravity setup removes legacy workflows dir');
|
||||
|
||||
await fs.remove(tempProjectDir);
|
||||
await fs.remove(installedBmadDir);
|
||||
await fs.remove(path.dirname(installedBmadDir));
|
||||
} catch (error) {
|
||||
assert(false, 'Antigravity native skills migration test succeeds', error.message);
|
||||
}
|
||||
|
|
@ -402,7 +406,7 @@ async function runTests() {
|
|||
assert(!(await fs.pathExists(path.join(tempProjectDir, '.augment', 'commands'))), 'Auggie setup removes legacy commands dir');
|
||||
|
||||
await fs.remove(tempProjectDir);
|
||||
await fs.remove(installedBmadDir);
|
||||
await fs.remove(path.dirname(installedBmadDir));
|
||||
} catch (error) {
|
||||
assert(false, 'Auggie native skills migration test succeeds', error.message);
|
||||
}
|
||||
|
|
@ -468,7 +472,7 @@ async function runTests() {
|
|||
}
|
||||
|
||||
await fs.remove(tempProjectDir);
|
||||
await fs.remove(installedBmadDir);
|
||||
await fs.remove(path.dirname(installedBmadDir));
|
||||
} catch (error) {
|
||||
assert(false, 'OpenCode native skills migration test succeeds', error.message);
|
||||
}
|
||||
|
|
@ -522,7 +526,7 @@ async function runTests() {
|
|||
assert(!(await fs.pathExists(legacyDir9)), 'Claude Code setup removes legacy commands dir');
|
||||
|
||||
await fs.remove(tempProjectDir9);
|
||||
await fs.remove(installedBmadDir9);
|
||||
await fs.remove(path.dirname(installedBmadDir9));
|
||||
} catch (error) {
|
||||
assert(false, 'Claude Code native skills migration test succeeds', error.message);
|
||||
}
|
||||
|
|
@ -561,7 +565,7 @@ async function runTests() {
|
|||
);
|
||||
|
||||
await fs.remove(tempRoot10);
|
||||
await fs.remove(installedBmadDir10);
|
||||
await fs.remove(path.dirname(installedBmadDir10));
|
||||
} catch (error) {
|
||||
assert(false, 'Claude Code ancestor conflict protection test succeeds', error.message);
|
||||
}
|
||||
|
|
@ -615,7 +619,7 @@ async function runTests() {
|
|||
assert(!(await fs.pathExists(legacyDir11)), 'Codex setup removes legacy prompts dir');
|
||||
|
||||
await fs.remove(tempProjectDir11);
|
||||
await fs.remove(installedBmadDir11);
|
||||
await fs.remove(path.dirname(installedBmadDir11));
|
||||
} catch (error) {
|
||||
assert(false, 'Codex native skills migration test succeeds', error.message);
|
||||
}
|
||||
|
|
@ -651,7 +655,7 @@ async function runTests() {
|
|||
assert(result12.handlerResult?.conflictDir === expectedConflictDir12, 'Codex ancestor rejection points at ancestor .agents/skills dir');
|
||||
|
||||
await fs.remove(tempRoot12);
|
||||
await fs.remove(installedBmadDir12);
|
||||
await fs.remove(path.dirname(installedBmadDir12));
|
||||
} catch (error) {
|
||||
assert(false, 'Codex ancestor conflict protection test succeeds', error.message);
|
||||
}
|
||||
|
|
@ -705,7 +709,7 @@ async function runTests() {
|
|||
assert(!(await fs.pathExists(legacyDir13c)), 'Cursor setup removes legacy commands dir');
|
||||
|
||||
await fs.remove(tempProjectDir13c);
|
||||
await fs.remove(installedBmadDir13c);
|
||||
await fs.remove(path.dirname(installedBmadDir13c));
|
||||
} catch (error) {
|
||||
assert(false, 'Cursor native skills migration test succeeds', error.message);
|
||||
}
|
||||
|
|
@ -770,7 +774,7 @@ async function runTests() {
|
|||
assert(await fs.pathExists(skillFile13), 'Roo reinstall preserves SKILL.md output');
|
||||
|
||||
await fs.remove(tempProjectDir13);
|
||||
await fs.remove(installedBmadDir13);
|
||||
await fs.remove(path.dirname(installedBmadDir13));
|
||||
} catch (error) {
|
||||
assert(false, 'Roo native skills migration test succeeds', error.message);
|
||||
}
|
||||
|
|
@ -809,7 +813,7 @@ async function runTests() {
|
|||
);
|
||||
|
||||
await fs.remove(tempRoot);
|
||||
await fs.remove(installedBmadDir);
|
||||
await fs.remove(path.dirname(installedBmadDir));
|
||||
} catch (error) {
|
||||
assert(false, 'OpenCode ancestor conflict protection test succeeds', error.message);
|
||||
}
|
||||
|
|
@ -895,7 +899,7 @@ async function runTests() {
|
|||
);
|
||||
|
||||
await fs.remove(tempProjectDir17);
|
||||
await fs.remove(installedBmadDir17);
|
||||
await fs.remove(path.dirname(installedBmadDir17));
|
||||
} catch (error) {
|
||||
assert(false, 'GitHub Copilot native skills migration test succeeds', error.message);
|
||||
}
|
||||
|
|
@ -957,7 +961,7 @@ async function runTests() {
|
|||
assert(await fs.pathExists(skillFile18), 'Cline reinstall preserves SKILL.md output');
|
||||
|
||||
await fs.remove(tempProjectDir18);
|
||||
await fs.remove(installedBmadDir18);
|
||||
await fs.remove(path.dirname(installedBmadDir18));
|
||||
} catch (error) {
|
||||
assert(false, 'Cline native skills migration test succeeds', error.message);
|
||||
}
|
||||
|
|
@ -1017,7 +1021,7 @@ async function runTests() {
|
|||
assert(await fs.pathExists(skillFile19), 'CodeBuddy reinstall preserves SKILL.md output');
|
||||
|
||||
await fs.remove(tempProjectDir19);
|
||||
await fs.remove(installedBmadDir19);
|
||||
await fs.remove(path.dirname(installedBmadDir19));
|
||||
} catch (error) {
|
||||
assert(false, 'CodeBuddy native skills migration test succeeds', error.message);
|
||||
}
|
||||
|
|
@ -1077,7 +1081,7 @@ async function runTests() {
|
|||
assert(await fs.pathExists(skillFile20), 'Crush reinstall preserves SKILL.md output');
|
||||
|
||||
await fs.remove(tempProjectDir20);
|
||||
await fs.remove(installedBmadDir20);
|
||||
await fs.remove(path.dirname(installedBmadDir20));
|
||||
} catch (error) {
|
||||
assert(false, 'Crush native skills migration test succeeds', error.message);
|
||||
}
|
||||
|
|
@ -1136,7 +1140,7 @@ async function runTests() {
|
|||
assert(await fs.pathExists(skillFile21), 'Trae reinstall preserves SKILL.md output');
|
||||
|
||||
await fs.remove(tempProjectDir21);
|
||||
await fs.remove(installedBmadDir21);
|
||||
await fs.remove(path.dirname(installedBmadDir21));
|
||||
} catch (error) {
|
||||
assert(false, 'Trae native skills migration test succeeds', error.message);
|
||||
}
|
||||
|
|
@ -1194,7 +1198,7 @@ async function runTests() {
|
|||
);
|
||||
|
||||
await fs.remove(tempProjectDir22);
|
||||
await fs.remove(installedBmadDir22);
|
||||
await fs.remove(path.dirname(installedBmadDir22));
|
||||
} catch (error) {
|
||||
assert(false, 'KiloCoder suspended test succeeds', error.message);
|
||||
}
|
||||
|
|
@ -1253,7 +1257,7 @@ async function runTests() {
|
|||
assert(await fs.pathExists(skillFile23), 'Gemini reinstall preserves SKILL.md output');
|
||||
|
||||
await fs.remove(tempProjectDir23);
|
||||
await fs.remove(installedBmadDir23);
|
||||
await fs.remove(path.dirname(installedBmadDir23));
|
||||
} catch (error) {
|
||||
assert(false, 'Gemini native skills migration test succeeds', error.message);
|
||||
}
|
||||
|
|
@ -1303,7 +1307,7 @@ async function runTests() {
|
|||
assert(!(await fs.pathExists(path.join(tempProjectDir24, '.iflow', 'commands'))), 'iFlow setup removes legacy commands dir');
|
||||
|
||||
await fs.remove(tempProjectDir24);
|
||||
await fs.remove(installedBmadDir24);
|
||||
await fs.remove(path.dirname(installedBmadDir24));
|
||||
} catch (error) {
|
||||
assert(false, 'iFlow native skills migration test succeeds', error.message);
|
||||
}
|
||||
|
|
@ -1353,7 +1357,7 @@ async function runTests() {
|
|||
assert(!(await fs.pathExists(path.join(tempProjectDir25, '.qwen', 'commands'))), 'QwenCoder setup removes legacy commands dir');
|
||||
|
||||
await fs.remove(tempProjectDir25);
|
||||
await fs.remove(installedBmadDir25);
|
||||
await fs.remove(path.dirname(installedBmadDir25));
|
||||
} catch (error) {
|
||||
assert(false, 'QwenCoder native skills migration test succeeds', error.message);
|
||||
}
|
||||
|
|
@ -1422,7 +1426,7 @@ async function runTests() {
|
|||
assert(cleanedPrompts26.prompts[0].name === 'my-custom-prompt', 'Rovo Dev cleanup preserves non-BMAD entries in prompts.yml');
|
||||
|
||||
await fs.remove(tempProjectDir26);
|
||||
await fs.remove(installedBmadDir26);
|
||||
await fs.remove(path.dirname(installedBmadDir26));
|
||||
} catch (error) {
|
||||
assert(false, 'Rovo Dev native skills migration test succeeds', error.message);
|
||||
}
|
||||
|
|
@ -1487,7 +1491,7 @@ async function runTests() {
|
|||
assert(!(await fs.pathExists(regularSkillDir27)), 'Cleanup removes stale non-bmad-os skills');
|
||||
|
||||
await fs.remove(tempProjectDir27);
|
||||
await fs.remove(installedBmadDir27);
|
||||
await fs.remove(path.dirname(installedBmadDir27));
|
||||
} catch (error) {
|
||||
assert(false, 'bmad-os-* skill preservation test succeeds', error.message);
|
||||
}
|
||||
|
|
@ -1579,7 +1583,7 @@ async function runTests() {
|
|||
assert(false, 'Pi native skills test succeeds', error.message);
|
||||
} finally {
|
||||
if (tempProjectDir28) await fs.remove(tempProjectDir28).catch(() => {});
|
||||
if (installedBmadDir28) await fs.remove(installedBmadDir28).catch(() => {});
|
||||
if (installedBmadDir28) await fs.remove(path.dirname(installedBmadDir28)).catch(() => {});
|
||||
}
|
||||
|
||||
console.log('');
|
||||
|
|
@ -1837,18 +1841,12 @@ async function runTests() {
|
|||
});
|
||||
|
||||
assert(result.success === true, 'Antigravity setup succeeds with overlapping skill names');
|
||||
assert(result.detail === '2 agents', 'Installer detail reports agents separately from skills');
|
||||
assert(result.handlerResult.results.skillDirectories === 2, 'Result exposes unique skill directory count');
|
||||
assert(result.handlerResult.results.agents === 2, 'Result retains generated agent write count');
|
||||
assert(result.handlerResult.results.workflows === 1, 'Result retains generated workflow count');
|
||||
assert(result.detail === '1 skills', 'Installer detail reports skill count');
|
||||
assert(result.handlerResult.results.skillDirectories === 1, 'Result exposes unique skill directory count');
|
||||
assert(result.handlerResult.results.skills === 1, 'Result retains verbatim skill count');
|
||||
assert(
|
||||
await fs.pathExists(path.join(collisionProjectDir, '.agent', 'skills', 'bmad-agent-bmad-master', 'SKILL.md')),
|
||||
'Agent skill directory is created',
|
||||
);
|
||||
assert(
|
||||
await fs.pathExists(path.join(collisionProjectDir, '.agent', 'skills', 'bmad-help', 'SKILL.md')),
|
||||
'Overlapping skill directory is created once',
|
||||
'Skill directory is created from skill-manifest',
|
||||
);
|
||||
} catch (error) {
|
||||
assert(false, 'Skill-format unique count test succeeds', error.message);
|
||||
|
|
@ -1906,6 +1904,9 @@ async function runTests() {
|
|||
const skillFile32 = path.join(tempProjectDir32, '.ona', 'skills', 'bmad-master', 'SKILL.md');
|
||||
assert(await fs.pathExists(skillFile32), 'Ona install writes SKILL.md directory output');
|
||||
|
||||
const workflowFile32 = path.join(tempProjectDir32, '.ona', 'skills', 'bmad-master', 'workflow.md');
|
||||
assert(await fs.pathExists(workflowFile32), 'Ona install copies non-SKILL.md files (workflow.md) verbatim');
|
||||
|
||||
// Parse YAML frontmatter between --- markers
|
||||
const skillContent32 = await fs.readFile(skillFile32, 'utf8');
|
||||
const fmMatch32 = skillContent32.match(/^---\n([\s\S]*?)\n---\n?([\s\S]*)$/);
|
||||
|
|
@ -1944,7 +1945,7 @@ async function runTests() {
|
|||
assert(false, 'Ona native skills test succeeds', error.message);
|
||||
} finally {
|
||||
if (tempProjectDir32) await fs.remove(tempProjectDir32).catch(() => {});
|
||||
if (installedBmadDir32) await fs.remove(installedBmadDir32).catch(() => {});
|
||||
if (installedBmadDir32) await fs.remove(path.dirname(installedBmadDir32)).catch(() => {});
|
||||
}
|
||||
|
||||
console.log('');
|
||||
|
|
|
|||
|
|
@ -4,9 +4,6 @@ const fs = require('fs-extra');
|
|||
const yaml = require('yaml');
|
||||
const { BaseIdeSetup } = require('./_base-ide');
|
||||
const prompts = require('../../../lib/prompts');
|
||||
const { AgentCommandGenerator } = require('./shared/agent-command-generator');
|
||||
const { WorkflowCommandGenerator } = require('./shared/workflow-command-generator');
|
||||
const { TaskToolCommandGenerator } = require('./shared/task-tool-command-generator');
|
||||
const csv = require('csv-parse/sync');
|
||||
|
||||
/**
|
||||
|
|
@ -115,53 +112,20 @@ class ConfigDrivenIdeSetup extends BaseIdeSetup {
|
|||
* @returns {Promise<Object>} Installation result
|
||||
*/
|
||||
async installToTarget(projectDir, bmadDir, config, options) {
|
||||
const { target_dir, template_type, artifact_types } = config;
|
||||
const { target_dir } = config;
|
||||
|
||||
// Skip targets with explicitly empty artifact_types and no verbatim skills
|
||||
// This prevents creating empty directories when no artifacts will be written
|
||||
const skipStandardArtifacts = Array.isArray(artifact_types) && artifact_types.length === 0;
|
||||
if (skipStandardArtifacts && !config.skill_format) {
|
||||
return { success: true, results: { agents: 0, workflows: 0, tasks: 0, tools: 0, skills: 0 } };
|
||||
if (!config.skill_format) {
|
||||
return { success: false, reason: 'missing-skill-format', error: 'Installer config missing skill_format — cannot install skills' };
|
||||
}
|
||||
|
||||
const targetPath = path.join(projectDir, target_dir);
|
||||
await this.ensureDir(targetPath);
|
||||
|
||||
const selectedModules = options.selectedModules || [];
|
||||
const results = { agents: 0, workflows: 0, tasks: 0, tools: 0, skills: 0 };
|
||||
this.skillWriteTracker = config.skill_format ? new Set() : null;
|
||||
this.skillWriteTracker = new Set();
|
||||
const results = { skills: 0 };
|
||||
|
||||
// Install standard artifacts (agents, workflows, tasks, tools)
|
||||
if (!skipStandardArtifacts) {
|
||||
// Install agents
|
||||
if (!artifact_types || artifact_types.includes('agents')) {
|
||||
const agentGen = new AgentCommandGenerator(this.bmadFolderName);
|
||||
const { artifacts } = await agentGen.collectAgentArtifacts(bmadDir, selectedModules);
|
||||
results.agents = await this.writeAgentArtifacts(targetPath, artifacts, template_type, config);
|
||||
}
|
||||
|
||||
// Install workflows
|
||||
if (!artifact_types || artifact_types.includes('workflows')) {
|
||||
const workflowGen = new WorkflowCommandGenerator(this.bmadFolderName);
|
||||
const { artifacts } = await workflowGen.collectWorkflowArtifacts(bmadDir);
|
||||
results.workflows = await this.writeWorkflowArtifacts(targetPath, artifacts, template_type, config);
|
||||
}
|
||||
|
||||
// Install tasks and tools using template system (supports TOML for Gemini, MD for others)
|
||||
if (!artifact_types || artifact_types.includes('tasks') || artifact_types.includes('tools')) {
|
||||
const taskToolGen = new TaskToolCommandGenerator(this.bmadFolderName);
|
||||
const { artifacts } = await taskToolGen.collectTaskToolArtifacts(bmadDir);
|
||||
const taskToolResult = await this.writeTaskToolArtifacts(targetPath, artifacts, template_type, config);
|
||||
results.tasks = taskToolResult.tasks || 0;
|
||||
results.tools = taskToolResult.tools || 0;
|
||||
}
|
||||
}
|
||||
|
||||
// Install verbatim skills (type: skill)
|
||||
if (config.skill_format) {
|
||||
results.skills = await this.installVerbatimSkills(projectDir, bmadDir, targetPath, config);
|
||||
results.skillDirectories = this.skillWriteTracker ? this.skillWriteTracker.size : 0;
|
||||
}
|
||||
results.skills = await this.installVerbatimSkills(projectDir, bmadDir, targetPath, config);
|
||||
results.skillDirectories = this.skillWriteTracker.size;
|
||||
|
||||
await this.printSummary(results, target_dir, options);
|
||||
this.skillWriteTracker = null;
|
||||
|
|
@ -177,15 +141,11 @@ class ConfigDrivenIdeSetup extends BaseIdeSetup {
|
|||
* @returns {Promise<Object>} Installation result
|
||||
*/
|
||||
async installToMultipleTargets(projectDir, bmadDir, targets, options) {
|
||||
const allResults = { agents: 0, workflows: 0, tasks: 0, tools: 0, skills: 0 };
|
||||
const allResults = { skills: 0 };
|
||||
|
||||
for (const target of targets) {
|
||||
const result = await this.installToTarget(projectDir, bmadDir, target, options);
|
||||
if (result.success) {
|
||||
allResults.agents += result.results.agents || 0;
|
||||
allResults.workflows += result.results.workflows || 0;
|
||||
allResults.tasks += result.results.tasks || 0;
|
||||
allResults.tools += result.results.tools || 0;
|
||||
allResults.skills += result.results.skills || 0;
|
||||
}
|
||||
}
|
||||
|
|
@ -193,118 +153,6 @@ class ConfigDrivenIdeSetup extends BaseIdeSetup {
|
|||
return { success: true, results: allResults };
|
||||
}
|
||||
|
||||
/**
|
||||
* Write agent artifacts to target directory
|
||||
* @param {string} targetPath - Target directory path
|
||||
* @param {Array} artifacts - Agent artifacts
|
||||
* @param {string} templateType - Template type to use
|
||||
* @param {Object} config - Installation configuration
|
||||
* @returns {Promise<number>} Count of artifacts written
|
||||
*/
|
||||
async writeAgentArtifacts(targetPath, artifacts, templateType, config = {}) {
|
||||
// Try to load platform-specific template, fall back to default-agent
|
||||
const { content: template, extension } = await this.loadTemplate(templateType, 'agent', config, 'default-agent');
|
||||
let count = 0;
|
||||
|
||||
for (const artifact of artifacts) {
|
||||
const content = this.renderTemplate(template, artifact);
|
||||
const filename = this.generateFilename(artifact, 'agent', extension);
|
||||
|
||||
if (config.skill_format) {
|
||||
await this.writeSkillFile(targetPath, artifact, content);
|
||||
} else {
|
||||
const filePath = path.join(targetPath, filename);
|
||||
await this.writeFile(filePath, content);
|
||||
}
|
||||
count++;
|
||||
}
|
||||
|
||||
return count;
|
||||
}
|
||||
|
||||
/**
|
||||
* Write workflow artifacts to target directory
|
||||
* @param {string} targetPath - Target directory path
|
||||
* @param {Array} artifacts - Workflow artifacts
|
||||
* @param {string} templateType - Template type to use
|
||||
* @param {Object} config - Installation configuration
|
||||
* @returns {Promise<number>} Count of artifacts written
|
||||
*/
|
||||
async writeWorkflowArtifacts(targetPath, artifacts, templateType, config = {}) {
|
||||
let count = 0;
|
||||
|
||||
for (const artifact of artifacts) {
|
||||
if (artifact.type === 'workflow-command') {
|
||||
const workflowTemplateType = config.md_workflow_template || `${templateType}-workflow`;
|
||||
const { content: template, extension } = await this.loadTemplate(workflowTemplateType, '', config, 'default-workflow');
|
||||
const content = this.renderTemplate(template, artifact);
|
||||
const filename = this.generateFilename(artifact, 'workflow', extension);
|
||||
|
||||
if (config.skill_format) {
|
||||
await this.writeSkillFile(targetPath, artifact, content);
|
||||
} else {
|
||||
const filePath = path.join(targetPath, filename);
|
||||
await this.writeFile(filePath, content);
|
||||
}
|
||||
count++;
|
||||
}
|
||||
}
|
||||
|
||||
return count;
|
||||
}
|
||||
|
||||
/**
|
||||
* Write task/tool artifacts to target directory using templates
|
||||
* @param {string} targetPath - Target directory path
|
||||
* @param {Array} artifacts - Task/tool artifacts
|
||||
* @param {string} templateType - Template type to use
|
||||
* @param {Object} config - Installation configuration
|
||||
* @returns {Promise<Object>} Counts of tasks and tools written
|
||||
*/
|
||||
async writeTaskToolArtifacts(targetPath, artifacts, templateType, config = {}) {
|
||||
let taskCount = 0;
|
||||
let toolCount = 0;
|
||||
|
||||
// Pre-load templates to avoid repeated file I/O in the loop
|
||||
const taskTemplate = await this.loadTemplate(templateType, 'task', config, 'default-task');
|
||||
const toolTemplate = await this.loadTemplate(templateType, 'tool', config, 'default-tool');
|
||||
|
||||
const { artifact_types } = config;
|
||||
|
||||
for (const artifact of artifacts) {
|
||||
if (artifact.type !== 'task' && artifact.type !== 'tool') {
|
||||
continue;
|
||||
}
|
||||
|
||||
// Skip if the specific artifact type is not requested in config
|
||||
if (artifact_types) {
|
||||
if (artifact.type === 'task' && !artifact_types.includes('tasks')) continue;
|
||||
if (artifact.type === 'tool' && !artifact_types.includes('tools')) continue;
|
||||
}
|
||||
|
||||
// Use pre-loaded template based on artifact type
|
||||
const { content: template, extension } = artifact.type === 'task' ? taskTemplate : toolTemplate;
|
||||
|
||||
const content = this.renderTemplate(template, artifact);
|
||||
const filename = this.generateFilename(artifact, artifact.type, extension);
|
||||
|
||||
if (config.skill_format) {
|
||||
await this.writeSkillFile(targetPath, artifact, content);
|
||||
} else {
|
||||
const filePath = path.join(targetPath, filename);
|
||||
await this.writeFile(filePath, content);
|
||||
}
|
||||
|
||||
if (artifact.type === 'task') {
|
||||
taskCount++;
|
||||
} else {
|
||||
toolCount++;
|
||||
}
|
||||
}
|
||||
|
||||
return { tasks: taskCount, tools: toolCount };
|
||||
}
|
||||
|
||||
/**
|
||||
* Load template based on type and configuration
|
||||
* @param {string} templateType - Template type (claude, windsurf, etc.)
|
||||
|
|
@ -711,13 +559,10 @@ LOAD and execute from: {project-root}/{{bmadFolderName}}/{{path}}
|
|||
*/
|
||||
async printSummary(results, targetDir, options = {}) {
|
||||
if (options.silent) return;
|
||||
const parts = [];
|
||||
const totalDirs =
|
||||
results.skillDirectories || (results.workflows || 0) + (results.tasks || 0) + (results.tools || 0) + (results.skills || 0);
|
||||
const skillCount = totalDirs - (results.agents || 0);
|
||||
if (skillCount > 0) parts.push(`${skillCount} skills`);
|
||||
if (results.agents > 0) parts.push(`${results.agents} agents`);
|
||||
await prompts.log.success(`${this.name} configured: ${parts.join(', ')} → ${targetDir}`);
|
||||
const count = results.skillDirectories || results.skills || 0;
|
||||
if (count > 0) {
|
||||
await prompts.log.success(`${this.name} configured: ${count} skills → ${targetDir}`);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -159,14 +159,9 @@ class IdeManager {
|
|||
// Build detail string from handler-returned data
|
||||
let detail = '';
|
||||
if (handlerResult && handlerResult.results) {
|
||||
// Config-driven handlers return { success, results: { agents, workflows, tasks, tools } }
|
||||
const r = handlerResult.results;
|
||||
const parts = [];
|
||||
const totalDirs = r.skillDirectories || (r.workflows || 0) + (r.tasks || 0) + (r.tools || 0) + (r.skills || 0);
|
||||
const skillCount = totalDirs - (r.agents || 0);
|
||||
if (skillCount > 0) parts.push(`${skillCount} skills`);
|
||||
if (r.agents > 0) parts.push(`${r.agents} agents`);
|
||||
detail = parts.join(', ');
|
||||
const count = r.skillDirectories || r.skills || 0;
|
||||
if (count > 0) detail = `${count} skills`;
|
||||
}
|
||||
// Propagate handler's success status (default true for backward compat)
|
||||
const success = handlerResult?.success !== false;
|
||||
|
|
|
|||
|
|
@ -4,7 +4,6 @@ const { toColonPath, toDashPath, customAgentColonName, customAgentDashName, BMAD
|
|||
|
||||
/**
|
||||
* Generates launcher command files for each agent
|
||||
* Similar to WorkflowCommandGenerator but for agents
|
||||
*/
|
||||
class AgentCommandGenerator {
|
||||
constructor(bmadFolderName = BMAD_FOLDER_NAME) {
|
||||
|
|
|
|||
|
|
@ -1,368 +0,0 @@
|
|||
const path = require('node:path');
|
||||
const fs = require('fs-extra');
|
||||
const csv = require('csv-parse/sync');
|
||||
const { toColonName, toColonPath, toDashPath, BMAD_FOLDER_NAME } = require('./path-utils');
|
||||
|
||||
/**
|
||||
* Generates command files for standalone tasks and tools
|
||||
*/
|
||||
class TaskToolCommandGenerator {
|
||||
/**
|
||||
* @param {string} bmadFolderName - Name of the BMAD folder for template rendering (default: '_bmad')
|
||||
* Note: This parameter is accepted for API consistency with AgentCommandGenerator and
|
||||
* WorkflowCommandGenerator, but is not used for path stripping. The manifest always stores
|
||||
* filesystem paths with '_bmad/' prefix (the actual folder name), while bmadFolderName is
|
||||
* used for template placeholder rendering ({{bmadFolderName}}).
|
||||
*/
|
||||
constructor(bmadFolderName = BMAD_FOLDER_NAME) {
|
||||
this.bmadFolderName = bmadFolderName;
|
||||
}
|
||||
|
||||
/**
|
||||
* Collect task and tool artifacts for IDE installation
|
||||
* @param {string} bmadDir - BMAD installation directory
|
||||
* @returns {Promise<Object>} Artifacts array with metadata
|
||||
*/
|
||||
async collectTaskToolArtifacts(bmadDir) {
|
||||
const tasks = await this.loadTaskManifest(bmadDir);
|
||||
const tools = await this.loadToolManifest(bmadDir);
|
||||
|
||||
// All tasks/tools in manifest are standalone (internal=true items are filtered during manifest generation)
|
||||
const artifacts = [];
|
||||
const bmadPrefix = `${BMAD_FOLDER_NAME}/`;
|
||||
|
||||
// Collect task artifacts
|
||||
for (const task of tasks || []) {
|
||||
let taskPath = (task.path || '').replaceAll('\\', '/');
|
||||
// Convert absolute paths to relative paths
|
||||
if (path.isAbsolute(taskPath)) {
|
||||
taskPath = path.relative(bmadDir, taskPath).replaceAll('\\', '/');
|
||||
}
|
||||
// Remove _bmad/ prefix if present to get relative path within bmad folder
|
||||
if (taskPath.startsWith(bmadPrefix)) {
|
||||
taskPath = taskPath.slice(bmadPrefix.length);
|
||||
}
|
||||
|
||||
const taskExt = path.extname(taskPath) || '.md';
|
||||
artifacts.push({
|
||||
type: 'task',
|
||||
name: task.name,
|
||||
displayName: task.displayName || task.name,
|
||||
description: task.description || `Execute ${task.displayName || task.name}`,
|
||||
module: task.module,
|
||||
canonicalId: task.canonicalId || '',
|
||||
// Use forward slashes for cross-platform consistency (not path.join which uses backslashes on Windows)
|
||||
relativePath: `${task.module}/tasks/${task.name}${taskExt}`,
|
||||
path: taskPath,
|
||||
});
|
||||
}
|
||||
|
||||
// Collect tool artifacts
|
||||
for (const tool of tools || []) {
|
||||
let toolPath = (tool.path || '').replaceAll('\\', '/');
|
||||
// Convert absolute paths to relative paths
|
||||
if (path.isAbsolute(toolPath)) {
|
||||
toolPath = path.relative(bmadDir, toolPath).replaceAll('\\', '/');
|
||||
}
|
||||
// Remove _bmad/ prefix if present to get relative path within bmad folder
|
||||
if (toolPath.startsWith(bmadPrefix)) {
|
||||
toolPath = toolPath.slice(bmadPrefix.length);
|
||||
}
|
||||
|
||||
const toolExt = path.extname(toolPath) || '.md';
|
||||
artifacts.push({
|
||||
type: 'tool',
|
||||
name: tool.name,
|
||||
displayName: tool.displayName || tool.name,
|
||||
description: tool.description || `Execute ${tool.displayName || tool.name}`,
|
||||
module: tool.module,
|
||||
canonicalId: tool.canonicalId || '',
|
||||
// Use forward slashes for cross-platform consistency (not path.join which uses backslashes on Windows)
|
||||
relativePath: `${tool.module}/tools/${tool.name}${toolExt}`,
|
||||
path: toolPath,
|
||||
});
|
||||
}
|
||||
|
||||
return {
|
||||
artifacts,
|
||||
counts: {
|
||||
tasks: (tasks || []).length,
|
||||
tools: (tools || []).length,
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Generate task and tool commands from manifest CSVs
|
||||
* @param {string} projectDir - Project directory
|
||||
* @param {string} bmadDir - BMAD installation directory
|
||||
* @param {string} baseCommandsDir - Optional base commands directory (defaults to .claude/commands/bmad)
|
||||
*/
|
||||
async generateTaskToolCommands(projectDir, bmadDir, baseCommandsDir = null) {
|
||||
const tasks = await this.loadTaskManifest(bmadDir);
|
||||
const tools = await this.loadToolManifest(bmadDir);
|
||||
|
||||
// Base commands directory - use provided or default to Claude Code structure
|
||||
const commandsDir = baseCommandsDir || path.join(projectDir, '.claude', 'commands', 'bmad');
|
||||
|
||||
let generatedCount = 0;
|
||||
|
||||
// Generate command files for tasks
|
||||
for (const task of tasks || []) {
|
||||
const moduleTasksDir = path.join(commandsDir, task.module, 'tasks');
|
||||
await fs.ensureDir(moduleTasksDir);
|
||||
|
||||
const commandContent = this.generateCommandContent(task, 'task');
|
||||
const commandPath = path.join(moduleTasksDir, `${task.name}.md`);
|
||||
|
||||
await fs.writeFile(commandPath, commandContent);
|
||||
generatedCount++;
|
||||
}
|
||||
|
||||
// Generate command files for tools
|
||||
for (const tool of tools || []) {
|
||||
const moduleToolsDir = path.join(commandsDir, tool.module, 'tools');
|
||||
await fs.ensureDir(moduleToolsDir);
|
||||
|
||||
const commandContent = this.generateCommandContent(tool, 'tool');
|
||||
const commandPath = path.join(moduleToolsDir, `${tool.name}.md`);
|
||||
|
||||
await fs.writeFile(commandPath, commandContent);
|
||||
generatedCount++;
|
||||
}
|
||||
|
||||
return {
|
||||
generated: generatedCount,
|
||||
tasks: (tasks || []).length,
|
||||
tools: (tools || []).length,
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Generate command content for a task or tool
|
||||
*/
|
||||
generateCommandContent(item, type) {
|
||||
const description = item.description || `Execute ${item.displayName || item.name}`;
|
||||
|
||||
// Convert path to use {project-root} placeholder
|
||||
// Handle undefined/missing path by constructing from module and name
|
||||
let itemPath = item.path;
|
||||
if (!itemPath || typeof itemPath !== 'string') {
|
||||
// Fallback: construct path from module and name if path is missing
|
||||
const typePlural = type === 'task' ? 'tasks' : 'tools';
|
||||
itemPath = `{project-root}/${this.bmadFolderName}/${item.module}/${typePlural}/${item.name}.md`;
|
||||
} else {
|
||||
// Normalize path separators to forward slashes
|
||||
itemPath = itemPath.replaceAll('\\', '/');
|
||||
|
||||
// Extract relative path from absolute paths (Windows or Unix)
|
||||
// Look for _bmad/ or bmad/ in the path and extract everything after it
|
||||
// Match patterns like: /_bmad/core/tasks/... or /bmad/core/tasks/...
|
||||
// Use [/\\] to handle both Unix forward slashes and Windows backslashes,
|
||||
// and also paths without a leading separator (e.g., C:/_bmad/...)
|
||||
const bmadMatch = itemPath.match(/[/\\]_bmad[/\\](.+)$/) || itemPath.match(/[/\\]bmad[/\\](.+)$/);
|
||||
if (bmadMatch) {
|
||||
// Found /_bmad/ or /bmad/ - use relative path after it
|
||||
itemPath = `{project-root}/${this.bmadFolderName}/${bmadMatch[1]}`;
|
||||
} else if (itemPath.startsWith(`${BMAD_FOLDER_NAME}/`)) {
|
||||
// Relative path starting with _bmad/
|
||||
itemPath = `{project-root}/${this.bmadFolderName}/${itemPath.slice(BMAD_FOLDER_NAME.length + 1)}`;
|
||||
} else if (itemPath.startsWith('bmad/')) {
|
||||
// Relative path starting with bmad/
|
||||
itemPath = `{project-root}/${this.bmadFolderName}/${itemPath.slice(5)}`;
|
||||
} else if (!itemPath.startsWith('{project-root}')) {
|
||||
// For other relative paths, prefix with project root and bmad folder
|
||||
itemPath = `{project-root}/${this.bmadFolderName}/${itemPath}`;
|
||||
}
|
||||
}
|
||||
|
||||
return `---
|
||||
description: '${description.replaceAll("'", "''")}'
|
||||
---
|
||||
|
||||
# ${item.displayName || item.name}
|
||||
|
||||
Read the entire ${type} file at: ${itemPath}
|
||||
|
||||
Follow all instructions in the ${type} file exactly as written.
|
||||
`;
|
||||
}
|
||||
|
||||
/**
|
||||
* Load task manifest CSV
|
||||
*/
|
||||
async loadTaskManifest(bmadDir) {
|
||||
const manifestPath = path.join(bmadDir, '_config', 'task-manifest.csv');
|
||||
|
||||
if (!(await fs.pathExists(manifestPath))) {
|
||||
return null;
|
||||
}
|
||||
|
||||
const csvContent = await fs.readFile(manifestPath, 'utf8');
|
||||
return csv.parse(csvContent, {
|
||||
columns: true,
|
||||
skip_empty_lines: true,
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Load tool manifest CSV
|
||||
*/
|
||||
async loadToolManifest(bmadDir) {
|
||||
const manifestPath = path.join(bmadDir, '_config', 'tool-manifest.csv');
|
||||
|
||||
if (!(await fs.pathExists(manifestPath))) {
|
||||
return null;
|
||||
}
|
||||
|
||||
const csvContent = await fs.readFile(manifestPath, 'utf8');
|
||||
return csv.parse(csvContent, {
|
||||
columns: true,
|
||||
skip_empty_lines: true,
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Generate task and tool commands using underscore format (Windows-compatible)
|
||||
* Creates flat files like: bmad_bmm_help.md
|
||||
*
|
||||
* @param {string} projectDir - Project directory
|
||||
* @param {string} bmadDir - BMAD installation directory
|
||||
* @param {string} baseCommandsDir - Base commands directory for the IDE
|
||||
* @returns {Object} Generation results
|
||||
*/
|
||||
async generateColonTaskToolCommands(projectDir, bmadDir, baseCommandsDir) {
|
||||
const tasks = await this.loadTaskManifest(bmadDir);
|
||||
const tools = await this.loadToolManifest(bmadDir);
|
||||
|
||||
let generatedCount = 0;
|
||||
|
||||
// Generate command files for tasks
|
||||
for (const task of tasks || []) {
|
||||
const commandContent = this.generateCommandContent(task, 'task');
|
||||
// Use underscore format: bmad_bmm_name.md
|
||||
const flatName = toColonName(task.module, 'tasks', task.name);
|
||||
const commandPath = path.join(baseCommandsDir, flatName);
|
||||
await fs.ensureDir(path.dirname(commandPath));
|
||||
await fs.writeFile(commandPath, commandContent);
|
||||
generatedCount++;
|
||||
}
|
||||
|
||||
// Generate command files for tools
|
||||
for (const tool of tools || []) {
|
||||
const commandContent = this.generateCommandContent(tool, 'tool');
|
||||
// Use underscore format: bmad_bmm_name.md
|
||||
const flatName = toColonName(tool.module, 'tools', tool.name);
|
||||
const commandPath = path.join(baseCommandsDir, flatName);
|
||||
await fs.ensureDir(path.dirname(commandPath));
|
||||
await fs.writeFile(commandPath, commandContent);
|
||||
generatedCount++;
|
||||
}
|
||||
|
||||
return {
|
||||
generated: generatedCount,
|
||||
tasks: (tasks || []).length,
|
||||
tools: (tools || []).length,
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Generate task and tool commands using underscore format (Windows-compatible)
|
||||
* Creates flat files like: bmad_bmm_help.md
|
||||
*
|
||||
* @param {string} projectDir - Project directory
|
||||
* @param {string} bmadDir - BMAD installation directory
|
||||
* @param {string} baseCommandsDir - Base commands directory for the IDE
|
||||
* @returns {Object} Generation results
|
||||
*/
|
||||
async generateDashTaskToolCommands(projectDir, bmadDir, baseCommandsDir) {
|
||||
const tasks = await this.loadTaskManifest(bmadDir);
|
||||
const tools = await this.loadToolManifest(bmadDir);
|
||||
|
||||
let generatedCount = 0;
|
||||
|
||||
// Generate command files for tasks
|
||||
for (const task of tasks || []) {
|
||||
const commandContent = this.generateCommandContent(task, 'task');
|
||||
// Use dash format: bmad-bmm-name.md
|
||||
const flatName = toDashPath(`${task.module}/tasks/${task.name}.md`);
|
||||
const commandPath = path.join(baseCommandsDir, flatName);
|
||||
await fs.ensureDir(path.dirname(commandPath));
|
||||
await fs.writeFile(commandPath, commandContent);
|
||||
generatedCount++;
|
||||
}
|
||||
|
||||
// Generate command files for tools
|
||||
for (const tool of tools || []) {
|
||||
const commandContent = this.generateCommandContent(tool, 'tool');
|
||||
// Use dash format: bmad-bmm-name.md
|
||||
const flatName = toDashPath(`${tool.module}/tools/${tool.name}.md`);
|
||||
const commandPath = path.join(baseCommandsDir, flatName);
|
||||
await fs.ensureDir(path.dirname(commandPath));
|
||||
await fs.writeFile(commandPath, commandContent);
|
||||
generatedCount++;
|
||||
}
|
||||
|
||||
return {
|
||||
generated: generatedCount,
|
||||
tasks: (tasks || []).length,
|
||||
tools: (tools || []).length,
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Write task/tool artifacts using underscore format (Windows-compatible)
|
||||
* Creates flat files like: bmad_bmm_help.md
|
||||
*
|
||||
* @param {string} baseCommandsDir - Base commands directory for the IDE
|
||||
* @param {Array} artifacts - Task/tool artifacts with relativePath
|
||||
* @returns {number} Count of commands written
|
||||
*/
|
||||
async writeColonArtifacts(baseCommandsDir, artifacts) {
|
||||
let writtenCount = 0;
|
||||
|
||||
for (const artifact of artifacts) {
|
||||
if (artifact.type === 'task' || artifact.type === 'tool') {
|
||||
const commandContent = this.generateCommandContent(artifact, artifact.type);
|
||||
// Use underscore format: bmad_module_name.md
|
||||
const flatName = toColonPath(artifact.relativePath);
|
||||
const commandPath = path.join(baseCommandsDir, flatName);
|
||||
await fs.ensureDir(path.dirname(commandPath));
|
||||
await fs.writeFile(commandPath, commandContent);
|
||||
writtenCount++;
|
||||
}
|
||||
}
|
||||
|
||||
return writtenCount;
|
||||
}
|
||||
|
||||
/**
|
||||
* Write task/tool artifacts using dash format (NEW STANDARD)
|
||||
* Creates flat files like: bmad-bmm-help.md
|
||||
*
|
||||
* Note: Tasks/tools do NOT have bmad-agent- prefix - only agents do.
|
||||
*
|
||||
* @param {string} baseCommandsDir - Base commands directory for the IDE
|
||||
* @param {Array} artifacts - Task/tool artifacts with relativePath
|
||||
* @returns {number} Count of commands written
|
||||
*/
|
||||
async writeDashArtifacts(baseCommandsDir, artifacts) {
|
||||
let writtenCount = 0;
|
||||
|
||||
for (const artifact of artifacts) {
|
||||
if (artifact.type === 'task' || artifact.type === 'tool') {
|
||||
const commandContent = this.generateCommandContent(artifact, artifact.type);
|
||||
// Use dash format: bmad-module-name.md
|
||||
const flatName = toDashPath(artifact.relativePath);
|
||||
const commandPath = path.join(baseCommandsDir, flatName);
|
||||
await fs.ensureDir(path.dirname(commandPath));
|
||||
await fs.writeFile(commandPath, commandContent);
|
||||
writtenCount++;
|
||||
}
|
||||
}
|
||||
|
||||
return writtenCount;
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = { TaskToolCommandGenerator };
|
||||
|
|
@ -1,179 +0,0 @@
|
|||
const path = require('node:path');
|
||||
const fs = require('fs-extra');
|
||||
const csv = require('csv-parse/sync');
|
||||
const { BMAD_FOLDER_NAME } = require('./path-utils');
|
||||
|
||||
/**
|
||||
* Generates command files for each workflow in the manifest
|
||||
*/
|
||||
class WorkflowCommandGenerator {
|
||||
constructor(bmadFolderName = BMAD_FOLDER_NAME) {
|
||||
this.bmadFolderName = bmadFolderName;
|
||||
}
|
||||
|
||||
async collectWorkflowArtifacts(bmadDir) {
|
||||
const workflows = await this.loadWorkflowManifest(bmadDir);
|
||||
|
||||
if (!workflows) {
|
||||
return { artifacts: [], counts: { commands: 0, launchers: 0 } };
|
||||
}
|
||||
|
||||
// ALL workflows now generate commands - no standalone filtering
|
||||
const allWorkflows = workflows;
|
||||
|
||||
const artifacts = [];
|
||||
|
||||
for (const workflow of allWorkflows) {
|
||||
// Calculate the relative workflow path (e.g., bmm/workflows/4-implementation/sprint-planning/workflow.md)
|
||||
let workflowRelPath = workflow.path || '';
|
||||
// Normalize path separators for cross-platform compatibility
|
||||
workflowRelPath = workflowRelPath.replaceAll('\\', '/');
|
||||
// Remove _bmad/ prefix if present to get relative path from project root
|
||||
// Handle both absolute paths (/path/to/_bmad/...) and relative paths (_bmad/...)
|
||||
if (workflowRelPath.includes('_bmad/')) {
|
||||
const parts = workflowRelPath.split(/_bmad\//);
|
||||
if (parts.length > 1) {
|
||||
workflowRelPath = parts.slice(1).join('/');
|
||||
}
|
||||
} else if (workflowRelPath.includes('/src/')) {
|
||||
// Normalize source paths (e.g. .../src/bmm/...) to relative module path (e.g. bmm/...)
|
||||
const match = workflowRelPath.match(/\/src\/([^/]+)\/(.+)/);
|
||||
if (match) {
|
||||
workflowRelPath = `${match[1]}/${match[2]}`;
|
||||
}
|
||||
}
|
||||
artifacts.push({
|
||||
type: 'workflow-command',
|
||||
name: workflow.name,
|
||||
description: workflow.description || `${workflow.name} workflow`,
|
||||
module: workflow.module,
|
||||
canonicalId: workflow.canonicalId || '',
|
||||
relativePath: path.join(workflow.module, 'workflows', `${workflow.name}.md`),
|
||||
workflowPath: workflowRelPath, // Relative path to actual workflow file
|
||||
sourcePath: workflow.path,
|
||||
});
|
||||
}
|
||||
|
||||
const groupedWorkflows = this.groupWorkflowsByModule(allWorkflows);
|
||||
for (const [module, launcherContent] of Object.entries(this.buildModuleWorkflowLaunchers(groupedWorkflows))) {
|
||||
artifacts.push({
|
||||
type: 'workflow-launcher',
|
||||
module,
|
||||
relativePath: path.join(module, 'workflows', 'README.md'),
|
||||
content: launcherContent,
|
||||
sourcePath: null,
|
||||
});
|
||||
}
|
||||
|
||||
return {
|
||||
artifacts,
|
||||
counts: {
|
||||
commands: allWorkflows.length,
|
||||
launchers: Object.keys(groupedWorkflows).length,
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Create workflow launcher files for each module
|
||||
*/
|
||||
async createModuleWorkflowLaunchers(baseCommandsDir, workflowsByModule) {
|
||||
for (const [module, moduleWorkflows] of Object.entries(workflowsByModule)) {
|
||||
const content = this.buildLauncherContent(module, moduleWorkflows);
|
||||
const moduleWorkflowsDir = path.join(baseCommandsDir, module, 'workflows');
|
||||
await fs.ensureDir(moduleWorkflowsDir);
|
||||
const launcherPath = path.join(moduleWorkflowsDir, 'README.md');
|
||||
await fs.writeFile(launcherPath, content);
|
||||
}
|
||||
}
|
||||
|
||||
groupWorkflowsByModule(workflows) {
|
||||
const workflowsByModule = {};
|
||||
|
||||
for (const workflow of workflows) {
|
||||
if (!workflowsByModule[workflow.module]) {
|
||||
workflowsByModule[workflow.module] = [];
|
||||
}
|
||||
|
||||
workflowsByModule[workflow.module].push({
|
||||
...workflow,
|
||||
displayPath: this.transformWorkflowPath(workflow.path),
|
||||
});
|
||||
}
|
||||
|
||||
return workflowsByModule;
|
||||
}
|
||||
|
||||
buildModuleWorkflowLaunchers(groupedWorkflows) {
|
||||
const launchers = {};
|
||||
|
||||
for (const [module, moduleWorkflows] of Object.entries(groupedWorkflows)) {
|
||||
launchers[module] = this.buildLauncherContent(module, moduleWorkflows);
|
||||
}
|
||||
|
||||
return launchers;
|
||||
}
|
||||
|
||||
buildLauncherContent(module, moduleWorkflows) {
|
||||
let content = `# ${module.toUpperCase()} Workflows
|
||||
|
||||
## Available Workflows in ${module}
|
||||
|
||||
`;
|
||||
|
||||
for (const workflow of moduleWorkflows) {
|
||||
content += `**${workflow.name}**\n`;
|
||||
content += `- Path: \`${workflow.displayPath}\`\n`;
|
||||
content += `- ${workflow.description}\n\n`;
|
||||
}
|
||||
|
||||
content += `
|
||||
## Execution
|
||||
|
||||
When running any workflow:
|
||||
1. LOAD the workflow.md file at the path shown above
|
||||
2. READ its entire contents and follow its directions exactly
|
||||
3. Save outputs after EACH section
|
||||
|
||||
## Modes
|
||||
- Normal: Full interaction
|
||||
- #yolo: Skip optional steps
|
||||
`;
|
||||
|
||||
return content;
|
||||
}
|
||||
|
||||
transformWorkflowPath(workflowPath) {
|
||||
let transformed = workflowPath;
|
||||
|
||||
if (workflowPath.includes('/src/bmm-skills/')) {
|
||||
const match = workflowPath.match(/\/src\/bmm-skills\/(.+)/);
|
||||
if (match) {
|
||||
transformed = `{project-root}/${this.bmadFolderName}/bmm/${match[1]}`;
|
||||
}
|
||||
} else if (workflowPath.includes('/src/core-skills/')) {
|
||||
const match = workflowPath.match(/\/src\/core-skills\/(.+)/);
|
||||
if (match) {
|
||||
transformed = `{project-root}/${this.bmadFolderName}/core/${match[1]}`;
|
||||
}
|
||||
}
|
||||
|
||||
return transformed;
|
||||
}
|
||||
|
||||
async loadWorkflowManifest(bmadDir) {
|
||||
const manifestPath = path.join(bmadDir, '_config', 'workflow-manifest.csv');
|
||||
|
||||
if (!(await fs.pathExists(manifestPath))) {
|
||||
return null;
|
||||
}
|
||||
|
||||
const csvContent = await fs.readFile(manifestPath, 'utf8');
|
||||
return csv.parse(csvContent, {
|
||||
columns: true,
|
||||
skip_empty_lines: true,
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = { WorkflowCommandGenerator };
|
||||
|
|
@ -45,7 +45,7 @@ export default defineConfig({
|
|||
title: 'BMAD Method',
|
||||
tagline: 'AI-driven agile development with specialized agents and workflows that scale from bug fixes to enterprise platforms.',
|
||||
|
||||
// i18n: English as root (no URL prefix), Chinese at /zh-cn/
|
||||
// i18n: English as root (no URL prefix), Chinese at /zh-cn/, French at /fr/
|
||||
defaultLocale: 'root',
|
||||
locales: {
|
||||
root: {
|
||||
|
|
@ -56,6 +56,10 @@ export default defineConfig({
|
|||
label: '简体中文',
|
||||
lang: 'zh-CN',
|
||||
},
|
||||
fr: {
|
||||
label: 'Français',
|
||||
lang: 'fr-FR',
|
||||
},
|
||||
},
|
||||
|
||||
logo: {
|
||||
|
|
@ -106,29 +110,29 @@ export default defineConfig({
|
|||
|
||||
// Sidebar configuration (Diataxis structure)
|
||||
sidebar: [
|
||||
{ label: 'Welcome', translations: { 'zh-CN': '欢迎' }, slug: 'index' },
|
||||
{ label: 'Roadmap', translations: { 'zh-CN': '路线图' }, slug: 'roadmap' },
|
||||
{ label: 'Welcome', translations: { 'zh-CN': '欢迎', 'fr-FR': 'Bienvenue' }, slug: 'index' },
|
||||
{ label: 'Roadmap', translations: { 'zh-CN': '路线图', 'fr-FR': 'Feuille de route' }, slug: 'roadmap' },
|
||||
{
|
||||
label: 'Tutorials',
|
||||
translations: { 'zh-CN': '教程' },
|
||||
translations: { 'zh-CN': '教程', 'fr-FR': 'Tutoriels' },
|
||||
collapsed: false,
|
||||
autogenerate: { directory: 'tutorials' },
|
||||
},
|
||||
{
|
||||
label: 'How-To Guides',
|
||||
translations: { 'zh-CN': '操作指南' },
|
||||
translations: { 'zh-CN': '操作指南', 'fr-FR': 'Guides pratiques' },
|
||||
collapsed: true,
|
||||
autogenerate: { directory: 'how-to' },
|
||||
},
|
||||
{
|
||||
label: 'Explanation',
|
||||
translations: { 'zh-CN': '概念说明' },
|
||||
translations: { 'zh-CN': '概念说明', 'fr-FR': 'Explications' },
|
||||
collapsed: true,
|
||||
autogenerate: { directory: 'explanation' },
|
||||
},
|
||||
{
|
||||
label: 'Reference',
|
||||
translations: { 'zh-CN': '参考' },
|
||||
translations: { 'zh-CN': '参考', 'fr-FR': 'Référence' },
|
||||
collapsed: true,
|
||||
autogenerate: { directory: 'reference' },
|
||||
},
|
||||
|
|
|
|||
Binary file not shown.
|
After Width: | Height: | Size: 86 KiB |
|
|
@ -0,0 +1,355 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="fr">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>Carte des Workflows - Méthode BMad</title>
|
||||
<style>
|
||||
:root {
|
||||
--analysis: #0ea5e9;
|
||||
--planning: #22c55e;
|
||||
--solutioning: #eab308;
|
||||
--implementation: #ef4444;
|
||||
--quickflow: #64748b;
|
||||
--bg: #0f172a;
|
||||
--card: #1e293b;
|
||||
--text: #f8fafc;
|
||||
--text-muted: #94a3b8;
|
||||
--border: #334155;
|
||||
--success: #10b981;
|
||||
--arrow: #f59e0b;
|
||||
}
|
||||
* { margin: 0; padding: 0; box-sizing: border-box; }
|
||||
body {
|
||||
font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif;
|
||||
background: var(--bg);
|
||||
color: var(--text);
|
||||
line-height: 1.4;
|
||||
padding: 12px;
|
||||
}
|
||||
.header { text-align: center; margin-bottom: 16px; }
|
||||
.header-badge {
|
||||
display: inline-flex; align-items: center; gap: 6px;
|
||||
background: linear-gradient(135deg, var(--analysis), var(--planning));
|
||||
padding: 4px 12px; border-radius: 20px;
|
||||
font-size: 0.75rem; font-weight: 600; margin-bottom: 8px;
|
||||
}
|
||||
h1 { font-size: 1.5rem; font-weight: 700; }
|
||||
.subtitle { color: var(--text-muted); font-size: 0.8rem; }
|
||||
|
||||
.flow-legend {
|
||||
background: rgba(245, 158, 11, 0.1); border: 1px solid rgba(245, 158, 11, 0.3);
|
||||
border-radius: 8px; padding: 8px 12px; margin-bottom: 16px; text-align: center;
|
||||
font-size: 0.7rem; color: var(--arrow);
|
||||
}
|
||||
|
||||
.flow-grid {
|
||||
display: grid;
|
||||
grid-template-columns: repeat(auto-fit, minmax(280px, 1fr));
|
||||
gap: 8px;
|
||||
margin-bottom: 16px;
|
||||
}
|
||||
|
||||
.phase {
|
||||
background: var(--card);
|
||||
border-radius: 10px;
|
||||
border: 1px solid var(--border);
|
||||
border-top: 3px solid;
|
||||
}
|
||||
.phase.analysis { border-top-color: var(--analysis); }
|
||||
.phase.planning { border-top-color: var(--planning); }
|
||||
.phase.solutioning { border-top-color: var(--solutioning); }
|
||||
.phase.implementation { border-top-color: var(--implementation); }
|
||||
|
||||
.phase-header { padding: 10px 12px 8px; border-bottom: 1px solid var(--border); display: flex; align-items: center; gap: 8px; }
|
||||
.phase-num { width: 22px; height: 22px; border-radius: 6px; display: flex; align-items: center; justify-content: center; font-size: 0.75rem; font-weight: 700; }
|
||||
.analysis .phase-num { background: var(--analysis); }
|
||||
.planning .phase-num { background: var(--planning); }
|
||||
.solutioning .phase-num { background: var(--solutioning); color: #000; }
|
||||
.implementation .phase-num { background: var(--implementation); }
|
||||
.phase-title { font-size: 0.95rem; font-weight: 700; }
|
||||
.phase-opt { font-size: 0.6rem; padding: 2px 6px; border-radius: 4px; background: rgba(14, 165, 233, 0.2); color: #7dd3fc; }
|
||||
|
||||
.workflows { padding: 8px 10px; }
|
||||
|
||||
.workflow {
|
||||
background: rgba(255,255,255,0.03); border-radius: 6px;
|
||||
padding: 8px; margin-bottom: 6px;
|
||||
font-size: 0.7rem;
|
||||
}
|
||||
.workflow-header {
|
||||
display: flex; justify-content: space-between; align-items: center;
|
||||
margin-bottom: 4px;
|
||||
}
|
||||
.workflow-name {
|
||||
font-family: monospace; color: var(--success);
|
||||
background: rgba(16, 185, 129, 0.1); padding: 2px 6px;
|
||||
border-radius: 3px; font-size: 0.65rem;
|
||||
}
|
||||
.workflow-meta { display: flex; justify-content: space-between; align-items: center; }
|
||||
.agent { display: flex; align-items: center; gap: 4px; }
|
||||
.agent-icon { width: 14px; height: 14px; border-radius: 3px; display: flex; align-items: center; justify-content: center; font-size: 0.55rem; font-weight: 700; }
|
||||
.agent-icon.mary { background: linear-gradient(135deg, #f472b6, #ec4899); }
|
||||
.agent-icon.john { background: linear-gradient(135deg, #60a5fa, #3b82f6); }
|
||||
.agent-icon.sally { background: linear-gradient(135deg, #fbbf24, #f59e0b); color: #000; }
|
||||
.agent-icon.winston { background: linear-gradient(135deg, #a78bfa, #8b5cf6); }
|
||||
.agent-icon.bob { background: linear-gradient(135deg, #34d399, #10b981); color: #000; }
|
||||
.agent-icon.amelia { background: linear-gradient(135deg, #fb7185, #ef4444); }
|
||||
.agent-icon.barry { background: linear-gradient(135deg, #94a3b8, #64748b); }
|
||||
.agent-name { font-size: 0.65rem; }
|
||||
.output { color: var(--success); font-family: monospace; font-size: 0.6rem; }
|
||||
.badge { font-size: 0.55rem; padding: 1px 4px; border-radius: 3px; }
|
||||
.badge.opt { background: rgba(251,191,36,0.15); color: #fbbf24; }
|
||||
.badge.iffy { background: rgba(168,85,247,0.15); color: #a855f7; }
|
||||
.badge.adhoc { background: rgba(59,130,246,0.15); color: #3b82f6; }
|
||||
|
||||
.arrow { display: flex; align-items: center; justify-content: center; color: var(--arrow); font-size: 0.9rem; margin: 6px 0; }
|
||||
|
||||
.decision { background: linear-gradient(135deg, #a855f7, #9333ea); padding: 4px 8px; border-radius: 4px; text-align: center; font-size: 0.65rem; font-weight: 600; margin: 6px 0; }
|
||||
|
||||
.quickflow {
|
||||
background: rgba(100, 116, 139, 0.2); border: 2px dashed var(--quickflow);
|
||||
border-radius: 10px; padding: 12px; margin-bottom: 16px;
|
||||
}
|
||||
.quickflow-header { display: flex; align-items: center; gap: 8px; margin-bottom: 8px; }
|
||||
.quickflow-header h2 { font-size: 0.95rem; }
|
||||
.quickflow-header span { font-size: 0.7rem; color: var(--text-muted); }
|
||||
.quickflow-body { display: flex; align-items: center; gap: 12px; }
|
||||
.quickflow-item { flex: 1; background: rgba(255,255,255,0.03); border-radius: 8px; padding: 10px; }
|
||||
.quickflow-item code { font-family: monospace; color: var(--success); background: rgba(16, 185, 129, 0.1); padding: 2px 6px; border-radius: 3px; font-size: 0.7rem; }
|
||||
|
||||
.context { background: rgba(14, 165, 233, 0.08); border-radius: 10px; padding: 12px; font-size: 0.75rem; }
|
||||
.context-header { display: flex; align-items: center; gap: 8px; margin-bottom: 6px; font-weight: 600; }
|
||||
.context-items { display: flex; flex-wrap: wrap; gap: 6px; }
|
||||
.context-items code { font-family: monospace; color: var(--success); background: rgba(16, 185, 129, 0.1); padding: 2px 5px; border-radius: 3px; font-size: 0.65rem; }
|
||||
.context-items span { color: var(--text-muted); }
|
||||
|
||||
.legend { display: flex; justify-content: center; gap: 12px; flex-wrap: wrap; font-size: 0.7rem; margin-top: 12px; }
|
||||
.legend-item { display: flex; align-items: center; gap: 4px; }
|
||||
.legend-dot { width: 12px; height: 3px; border-radius: 2px; }
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<div class="header">
|
||||
<div class="header-badge">⚡ Carte des Workflows V6</div>
|
||||
<h1>Méthode BMad</h1>
|
||||
<p class="subtitle">Ingénierie de contexte pour le développement piloté par l'IA</p>
|
||||
</div>
|
||||
|
||||
<div class="flow-legend">→ les flèches indiquent le flux des artefacts entre les workflows</div>
|
||||
|
||||
<div class="flow-grid">
|
||||
<!-- Phase 1: Analysis -->
|
||||
<div class="phase analysis">
|
||||
<div class="phase-header">
|
||||
<div class="phase-num">1</div>
|
||||
<div class="phase-title">Analyse</div>
|
||||
<span class="phase-opt">Optionnel</span>
|
||||
</div>
|
||||
<div class="workflows">
|
||||
<div class="workflow">
|
||||
<div class="workflow-header">
|
||||
<span class="workflow-name">brainstorm</span>
|
||||
<span class="badge opt">opt</span>
|
||||
</div>
|
||||
<div class="workflow-meta">
|
||||
<div class="agent"><div class="agent-icon mary">M</div><span class="agent-name">Mary</span></div>
|
||||
<span class="output">brainstorming-report.md</span>
|
||||
</div>
|
||||
</div>
|
||||
<div class="workflow">
|
||||
<div class="workflow-header">
|
||||
<span class="workflow-name">research</span>
|
||||
<span class="badge opt">opt</span>
|
||||
</div>
|
||||
<div class="workflow-meta">
|
||||
<div class="agent"><div class="agent-icon mary">M</div><span class="agent-name">Mary</span></div>
|
||||
<span class="output">conclusions</span>
|
||||
</div>
|
||||
</div>
|
||||
<div class="workflow">
|
||||
<div class="workflow-header">
|
||||
<span class="workflow-name">create-product-brief</span>
|
||||
</div>
|
||||
<div class="workflow-meta">
|
||||
<div class="agent"><div class="agent-icon mary">M</div><span class="agent-name">Mary</span></div>
|
||||
<span class="output">product-brief.md →</span>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="arrow">→</div>
|
||||
</div>
|
||||
|
||||
<!-- Phase 2: Planning -->
|
||||
<div class="phase planning">
|
||||
<div class="phase-header">
|
||||
<div class="phase-num">2</div>
|
||||
<div class="phase-title">Planification</div>
|
||||
</div>
|
||||
<div class="workflows">
|
||||
<div class="workflow">
|
||||
<div class="workflow-header">
|
||||
<span class="workflow-name">create-prd</span>
|
||||
</div>
|
||||
<div class="workflow-meta">
|
||||
<div class="agent"><div class="agent-icon john">J</div><span class="agent-name">John</span></div>
|
||||
<span class="output">PRD.md →</span>
|
||||
</div>
|
||||
</div>
|
||||
<div class="decision">Comporte une Interface Utilisateur ?</div>
|
||||
<div class="workflow">
|
||||
<div class="workflow-header">
|
||||
<span class="workflow-name">create-ux-design</span>
|
||||
<span class="badge iffy">si oui</span>
|
||||
</div>
|
||||
<div class="workflow-meta">
|
||||
<div class="agent"><div class="agent-icon sally">S</div><span class="agent-name">Sally</span></div>
|
||||
<span class="output">ux-spec.md →</span>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="arrow">→</div>
|
||||
</div>
|
||||
|
||||
<!-- Phase 3: Solutioning -->
|
||||
<div class="phase solutioning">
|
||||
<div class="phase-header">
|
||||
<div class="phase-num">3</div>
|
||||
<div class="phase-title">Solutioning</div>
|
||||
</div>
|
||||
<div class="workflows">
|
||||
<div class="workflow">
|
||||
<div class="workflow-header">
|
||||
<span class="workflow-name">create-architecture</span>
|
||||
</div>
|
||||
<div class="workflow-meta">
|
||||
<div class="agent"><div class="agent-icon winston">W</div><span class="agent-name">Winston</span></div>
|
||||
<span class="output">architecture.md →</span>
|
||||
</div>
|
||||
</div>
|
||||
<div class="workflow">
|
||||
<div class="workflow-header">
|
||||
<span class="workflow-name">create-epics-and-stories</span>
|
||||
</div>
|
||||
<div class="workflow-meta">
|
||||
<div class="agent"><div class="agent-icon john">J</div><span class="agent-name">John</span></div>
|
||||
<span class="output">epics.md →</span>
|
||||
</div>
|
||||
</div>
|
||||
<div class="workflow">
|
||||
<div class="workflow-header">
|
||||
<span class="workflow-name">check-implementation-readiness</span>
|
||||
</div>
|
||||
<div class="workflow-meta">
|
||||
<div class="agent"><div class="agent-icon john">J</div><span class="agent-name">John</span></div>
|
||||
<span class="output">vérification</span>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="arrow">→</div>
|
||||
</div>
|
||||
|
||||
<!-- Phase 4: Implementation -->
|
||||
<div class="phase implementation">
|
||||
<div class="phase-header">
|
||||
<div class="phase-num">4</div>
|
||||
<div class="phase-title">Implémentation</div>
|
||||
</div>
|
||||
<div class="workflows">
|
||||
<div class="workflow">
|
||||
<div class="workflow-header">
|
||||
<span class="workflow-name">sprint-planning</span>
|
||||
</div>
|
||||
<div class="workflow-meta">
|
||||
<div class="agent"><div class="agent-icon bob">B</div><span class="agent-name">Bob</span></div>
|
||||
<span class="output">sprint-status.yaml →</span>
|
||||
</div>
|
||||
</div>
|
||||
<div class="workflow">
|
||||
<div class="workflow-header">
|
||||
<span class="workflow-name">create-story</span>
|
||||
</div>
|
||||
<div class="workflow-meta">
|
||||
<div class="agent"><div class="agent-icon bob">B</div><span class="agent-name">Bob</span></div>
|
||||
<span class="output">story-[slug].md →</span>
|
||||
</div>
|
||||
</div>
|
||||
<div class="workflow">
|
||||
<div class="workflow-header">
|
||||
<span class="workflow-name">dev-story</span>
|
||||
</div>
|
||||
<div class="workflow-meta">
|
||||
<div class="agent"><div class="agent-icon amelia">A</div><span class="agent-name">Amelia</span></div>
|
||||
<span class="output">code →</span>
|
||||
</div>
|
||||
</div>
|
||||
<div class="workflow">
|
||||
<div class="workflow-header">
|
||||
<span class="workflow-name">code-review</span>
|
||||
</div>
|
||||
<div class="workflow-meta">
|
||||
<div class="agent"><div class="agent-icon amelia">A</div><span class="agent-name">Amelia</span></div>
|
||||
<span class="output">approbation</span>
|
||||
</div>
|
||||
</div>
|
||||
<div class="workflow">
|
||||
<div class="workflow-header">
|
||||
<span class="workflow-name">correct-course</span>
|
||||
<span class="badge adhoc">ad-hoc</span>
|
||||
</div>
|
||||
<div class="workflow-meta">
|
||||
<div class="agent"><div class="agent-icon john">J</div><span class="agent-name">John</span></div>
|
||||
<span class="output">plan mis à jour</span>
|
||||
</div>
|
||||
</div>
|
||||
<div class="workflow">
|
||||
<div class="workflow-header">
|
||||
<span class="workflow-name">retrospective</span>
|
||||
<span class="badge adhoc">par Epic</span>
|
||||
</div>
|
||||
<div class="workflow-meta">
|
||||
<div class="agent"><div class="agent-icon bob">B</div><span class="agent-name">Bob</span></div>
|
||||
<span class="output">leçons</span>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="quickflow">
|
||||
<div class="quickflow-header">
|
||||
<span>⚡</span>
|
||||
<div>
|
||||
<h2>Quick Dev (Parcours Rapide)</h2>
|
||||
<span>Pour les petites modifications bien comprises — sautez les phases 1-3</span>
|
||||
</div>
|
||||
</div>
|
||||
<div class="quickflow-body">
|
||||
<div class="quickflow-item">
|
||||
<div class="agent"><div class="agent-icon barry">B</div><span class="agent-name">Barry</span></div>
|
||||
<code>quick-dev</code>
|
||||
<div style="font-size: 0.65rem; color: var(--text-muted); margin-top: 4px;">intention → spec technique → code fonctionnel</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="context">
|
||||
<div class="context-header">📚 Flux de Contexte</div>
|
||||
<p style="margin-bottom: 8px; color: var(--text-muted);">Chaque document devient le contexte pour la phase suivante.</p>
|
||||
<div class="context-items">
|
||||
<span><code>create-story</code> <span>charge epics, PRD, architecture, UX</span></span>
|
||||
<span><code>dev-story</code> <span>charge le fichier story</span></span>
|
||||
<span><code>code-review</code> <span>charge architecture, story</span></span>
|
||||
<span><code>quick-dev</code> <span>clarifie, planifie, implémente, révise</span></span>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="legend">
|
||||
<div class="legend-item"><div class="legend-dot" style="background: var(--analysis);"></div>Analyse</div>
|
||||
<div class="legend-item"><div class="legend-dot" style="background: var(--planning);"></div>Planification</div>
|
||||
<div class="legend-item"><div class="legend-dot" style="background: var(--solutioning);"></div>Solutioning</div>
|
||||
<div class="legend-item"><div class="legend-dot" style="background: var(--implementation);"></div>Implémentation</div>
|
||||
<div class="legend-item"><div class="legend-dot" style="background: var(--quickflow);"></div>Quick Dev</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,28 @@
|
|||
{
|
||||
"skipLink.label": "Aller au contenu",
|
||||
"search.label": "Rechercher",
|
||||
"search.ctrlKey": "Ctrl",
|
||||
"search.cancelLabel": "Annuler",
|
||||
"themeSelect.accessibleLabel": "Choisir le thème",
|
||||
"themeSelect.dark": "Sombre",
|
||||
"themeSelect.light": "Clair",
|
||||
"themeSelect.auto": "Automatique",
|
||||
"languageSelect.accessibleLabel": "Choisir la langue",
|
||||
"menuButton.accessibleLabel": "Menu",
|
||||
"sidebarNav.accessibleLabel": "Navigation principale",
|
||||
"tableOfContents.onThisPage": "Sur cette page",
|
||||
"tableOfContents.overview": "Aperçu",
|
||||
"i18n.untranslatedContent": "Ce contenu n'est pas encore disponible en français.",
|
||||
"page.editLink": "Modifier la page",
|
||||
"page.lastUpdated": "Dernière mise à jour :",
|
||||
"page.previousLink": "Page précédente",
|
||||
"page.nextLink": "Page suivante",
|
||||
"page.draft": "Ce contenu est un brouillon et ne sera pas inclus dans la version finale.",
|
||||
"404.text": "Page non trouvée. Vérifiez l'URL ou utilisez la recherche.",
|
||||
"aside.note": "Note",
|
||||
"aside.tip": "Astuce",
|
||||
"aside.caution": "Attention",
|
||||
"aside.danger": "Danger",
|
||||
"fileTree.directory": "Répertoire",
|
||||
"builtWithStarlight.label": "Construit avec Starlight"
|
||||
}
|
||||
Loading…
Reference in New Issue