Files
Brian cf54f4d76d refactor(bmm): consolidate sprint skills — one owner for the sprint-status artifact (#2659)
* refactor(bmm): move sprint-planning and sprint-status to plan/

They sit at the plan/ship boundary and their outputs are planning
artifacts of the dev cycle; next commit makes sprint-planning the
readiness gate, which is plan-side work.

* refactor(bmm): fold readiness gate into sprint-planning, retire check-implementation-readiness

The old skill was 1,154 lines of legacy numbered-step ceremony whose
document discovery hardcoded filename globs (*prd*, *ux*, *epic*) that
miss what current skills produce (SPEC.md, DESIGN.md) and still treated
retired sharded docs as first-class. Sprint-planning now opens with a
lean readiness gate: generic artifact discovery by content, forward/back
traceability, PASS/CONCERNS/FAIL, stop on FAIL with findings. The IR
trigger on John's and Winston's menus dispatches sprint-planning, so
'check implementation readiness' still works everywhere it used to.

* refactor(bmm): modernize sprint-planning with deterministic script core

SKILL.md drops the legacy XML step dialect for the product-brief style
(~100 lines, uv run, headless contract). New scripts/sprint_plan.py owns
the mechanical work — epic parsing, key derivation, ordering, preserve-
never-downgrade merge, story-file detection, action_items carry-over,
atomic writes, drift checks — with 11 tests wired in as
test:sprint-planning. Judgment stays with the LLM: epic discovery, the
readiness gate, and reconciling script-reported orphans and unparsed
headings. checklist.md retired (the script performs that checklist);
sprint-status-template.yaml is the single source for the status
vocabulary. Output stays byte-compatible with build's sprint sync and
retrospective's tooling.

* refactor(bmm): fold sprint-status into sprint-planning's status view

sprint_plan.py gains a status subcommand: counts (legacy values mapped),
risk flags, open action items, and a priority-ordered next-action
recommendation — the old skill's inference-driven summary, computed
deterministically and covered by 9 new tests. bmad-sprint-status becomes
a v6-shims husk that forwards with status-view intent and a deprecation
notice; its dead data/validate modes had zero callers and are gone. If
a hand-edited status file defeats the script, the skill falls back to
reading it directly and summarizing by best judgment. New explanation
page docs/explanation/sprint-planning.md covers the consolidated skill;
workflow maps and references updated across all languages.

* docs: changelog entries for skill reorg and sprint consolidation

* fix(bmm): harden sprint_plan.py per review; add validate/fix intents with full progressive disclosure

Review fixes (PR #2659 findings, bot + internal review):
- Normalize legacy v6 statuses (drafted/contexted) on every read — merged by
  meaning and reported, never treated as illegal or reset
- dropped_orphans carry their old status; transplant renames via --set
- project_key/tracking_system/story_location preserved from the existing file
  unless overridden; refresh round-trips custom keys and user comments
- Hardened write path: dump-to-bytes, fsync, permission-preserving atomic
  write inside the guarded block, explicit checks (no asserts), atomic restore
- JSON-only argparse (errors and -h emit JSON); unicode-aware slugs with hash
  fallback; fenced code blocks ignored when parsing epics
- Odd retro keys, date-typed stamps, and non-mapping YAML report cleanly
  instead of crashing; unparseable timestamps warn instead of silently
  disabling the staleness check; malformed action items flagged, not dropped
- Dead check subcommand removed; generate --dry-run reports drift/in_sync
- test:sprint-planning wired into quality and CI (was test-only)
- Retro tests use a vendored template fixture (PATH-05); repo-level
  test-template-sync.js keeps it byte-identical to the source; template
  example timestamps and story_location fixed; header block pinned to the
  template by test

New capability:
- validate subcommand + reference: structural validation, never writes
- fix flow: evidence-gathering subagents -> user-confirmed state table ->
  generate --fresh --set writes a pristine file (the one path allowed to
  downgrade); universal script-failure fallback to inference for every intent
- SKILL.md is now a lean router: gate, tracking, status, fix, and validate
  each load as progressive-disclosure references

Docs: explanation page gains Repair section; workflow-map and getting-started
across all five languages mention the status view; headless payload nests
under 'report' to avoid the status key collision; changelog updated.

Test suite grows 20 -> 37; retro suite 91/91; docs build and validators green.

* docs: mention repair in sprint-planning explanation description
2026-08-01 16:21:38 -05:00

299 lines
17 KiB
Markdown
Raw Permalink Blame History

This file contains invisible Unicode characters
This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
---
title: "Premiers pas"
description: Installer BMad et développer votre premier projet
---
Accélérez le développement de vos applications grâce à des workflows alimentés par lIA et des agents spécialisés qui vous guident dans la planification, larchitecture et limplé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 profondeur de planification adaptée à votre travail
- Progresser dans les phases, de la définition des exigences au code fonctionnel
- Utiliser efficacement les agents et les workflows
:::note[Prérequis]
- **Node.js 20.12+** — Nécessaire pour linstallation
- **Git** — Recommandé pour la gestion de versions
- **IDE avec IA intégrée** — Claude Code, Cursor ou équivalent
- **Une idée de projet** — Même simple, elle fera laffaire pour commencer
:::
:::tip[Le chemin le plus rapide]
**Installer**`npx bmad-method install`
**Demander**`bmad-help que dois-je faire en premier ?`
**Développez** → 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.** Pas besoin de mémoriser les workflows ou les phases — posez simplement votre question et BMad-Help saura :
- **Inspecter votre projet** pour voir ce qui a déjà été fait
- **Vous présenter vos options** en fonction des modules installés
- **Vous recommander la prochaine étape** — y compris la première tâche obligatoire
- **Répondre à vos questions**, par exemple : «Jai une idée de SaaS, par où commencer? »
### Comment utiliser BMad-Help
Dans votre IDE IA, invoquez le skill :
```
bmad-help
```
Ou accompagnez-le dune question pour obtenir des conseils contextualisés :
```
bmad-help Jai une idée de produit SaaS, je connais déjà toutes les fonctionnalités que je veux. Par où dois-je commencer ?
```
BMad-Help vous indiquera :
- Ce qui est recommandé pour votre situation
- Quelle est la première tâche obligatoire
- À quoi ressemble le reste du processus
### Il intervient aussi dans les workflows
BMad-Help ne se contente pas de répondre aux questions — **il se lance automatiquement à la fin de chaque workflow** pour vous indiquer exactement la suite. Finies les devinettes et les recherches dans la doc : vous recevez des instructions claires sur le prochain workflow à exécuter.
:::tip[Commencez ici]
Après avoir installé BMad, invoquez immédiatement le skill `bmad-help`. Il détectera les modules que vous avez installés et vous orientera vers le bon point de départ pour votre projet.
:::
## Comprendre BMad
BMad vous aide à développer des logiciels grâce à des workflows guidés par des agents IA spécialisés. Le processus sarticule en quatre phases :
| Phase | Nom | Ce qui se passe |
|-------|----------------|----------------------------------------------------------------|
| 1 | Analyse | Brainstorming, recherche, product brief ou PRFAQ _(optionnel)_ |
| 2 | Planification | Définir les exigences (PRD[^1] ou spécification technique) |
| 3 | Solutioning | Concevoir larchitecture selon les besoins |
| 4 | Implémentation | Implémenter chaque changement ou story planifiée, éventuellement via une orchestration automatisée |
**[Ouvrez la carte des workflows](../reference/workflow-map.md)** pour explorer les phases, les workflows et la gestion du contexte.
La profondeur de planification reste flexible :
| Profondeur | Idéal pour | Contexte disponible avant limplémentation |
|---|---|---|
| **Directe** | Corrections, fonctionnalités, issues ou spécifications claires | Intention, issue ou spécification |
| **Planification produit** | Produits, plateformes et fonctionnalités complexes | PRD et conception UX optionnelle |
| **Solutioning complet** | Initiatives coordonnées, risquées ou multi-systèmes | PRD, UX, architecture, epics, stories et plan de sprint |
:::note
Il ne sagit pas de voies dimplémentation distinctes. Tous les points dentrée convergent vers `bmad-build`; la planification ne change que la quantité de contexte disponible.
:::
## Installation
Ouvrez un terminal dans le répertoire de votre projet et exécutez :
```bash
npx bmad-method install
```
Si vous préférez la dernière version préliminaire au lieu du canal de publication par défaut, utilisez `npx bmad-method@next install`.
À linvite de sélection des modules, choisissez **BMad Method**.
Linstallateur crée deux dossiers :
- `_bmad/` — agents, workflows, tâches et configuration
- `_bmad-output/` — vide pour le moment, mais cest là que seront enregistrés vos artefacts
:::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 déjà accompli et vous recommandera exactement la suite. Vous pouvez aussi lui poser des questions comme «Quelles sont mes options? » ou «Jai 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 son nom dans votre IDE (par ex. `bmad-prd`). Votre outil IA reconnaîtra le nom `bmad-*` et lexécutera — pas besoin de charger les agents séparément. Vous pouvez aussi invoquer directement une skill dagent pour une conversation générale (par ex. `bmad-agent-pm` pour lagent PM).
:::
:::caution[Nouveaux chats]
Démarrez toujours un nouveau chat pour chaque workflow. Cela évite les problèmes liés aux limites de contexte de lIA.
:::
## Étape 1 : Choisir la profondeur de planification
Utilisez les phases 1 à 3 selon les besoins du travail. Pour un changement clair et délimité, vous pouvez passer directement à l[Étape 2](#étape-2-développer-votre-projet). **Utilisez un nouveau chat pour chaque workflow.**
:::tip[Contexte projet (optionnel)]
Avant de commencer, pensez à créer `project-context.md` pour documenter vos préférences techniques et vos règles dimplémentation. Ainsi, tous les agents IA respecteront vos conventions tout au long du projet.
Créez-le manuellement à lemplacement `_bmad-output/project-context.md`, ou générez-le après larchitecture avec `bmad-generate-project-context`. [En savoir plus](../explanation/project-context.md).
:::
### Phase 1 : Analyse (optionnelle)
Tous les workflows de cette phase sont optionnels. [**Vous ne savez pas lequel choisir?**](../explanation/analysis-phase.md)
- **brainstorming** (`bmad-brainstorming`) — Idéation guidée
- **research** (`bmad-deep-recon`) — Rédigez un prompt de recherche approfondie pour votre propre outil IA, transformez un rapport terminé en synthèse exploitable en aval, ou menez la recherche ici — marché, domaine, technique, concurrentiel, voix des utilisateurs et académique — avec vérification des affirmations et cycle de rafraîchissement
- **product-brief** (`bmad-product-brief`) — Document fondateur recommandé une fois votre concept bien défini
- **prfaq** (`bmad-prfaq`) — Exercice Working Backwards pour tester et affiner votre concept produit
### Phase 2 : Planification (selon les besoins)
Pour les travaux qui bénéficient dune planification produit :
1. Exécutez `bmad-prd` dans un nouveau chat — précisez votre intention (Create / Update / Validate) ou laissez le skill vous la demander
2. Résultat : `prd.md`, `addendum.md`, `.memlog.md`
:::note[Intentions de `bmad-prd`]
- **Create** — exploration guidée à partir de zéro; le skill nomme le dossier de travail et vous accompagne jusquà lobtention dun PRD dont vous serez fier
- **Update** — pointez vers un PRD existant et un changement à apporter; le skill met en évidence les conflits avant dappliquer les modifications
- **Validate** — critiquez un PRD finalisé à laide dune liste de contrôle et générez un rapport HTML des constatations
:::
:::note[Design UX (optionnel)]
Si votre projet comporte une interface utilisateur, invoquez l'**agent UX Designer** (`bmad-agent-ux-designer`) et lancez le workflow de design UX (`bmad-ux`) après avoir créé votre PRD.
:::
### Phase 3 : Solutioning (selon les besoins)
**Créer larchitecture**
1. Invoquez l'**agent Architecte** (`bmad-agent-architect`) dans un nouveau chat
2. Exécutez `bmad-architecture` (`bmad-architecture`)
3. Résultat : document darchitecture avec les décisions techniques
**Créer les epics et les stories**
:::tip[Amélioration V6]
Les epics et stories sont désormais créés *après* larchitecture. Cela produit des stories de meilleure qualité, car les décisions darchitecture (choix de la base de données, patterns dAPI, pile technologique) influencent directement la façon dont le travail doit être découpé.
:::
1. Invoquez l'**agent PM** (`bmad-agent-pm`) dans un nouveau chat
2. Exécutez `bmad-create-epics-and-stories` (`bmad-create-epics-and-stories`)
3. Le workflow sappuie sur le PRD et larchitecture pour créer des stories techniquement fondées
**Vérification de la préparation à limplémentation** *(fortement recommandée)*
1. Invoquez l'**agent Architecte** (`bmad-agent-architect`) dans un nouveau chat
2. Exécutez `bmad-sprint-planning` (`bmad-sprint-planning`) — il souvre sur le jalon de préparation
3. Valide la cohérence de lensemble des documents de planification
## Étape 2 : Développer votre projet
Passez à limplémentation avec le contexte disponible : demande directe, issue, spécification ou story entièrement planifiée. **Chaque workflow doit être exécuté dans un nouveau chat.**
Pour un travail planifié, invoquez `bmad-build` et indiquez la story ou lélément de sprint sélectionné, par exemple : `Implémente la story 2.3 depuis _bmad-output/planning-artifacts/epics.md`.
### Initialiser la planification de sprint (pour le travail planifié)
Invoquez l'**agent Développeur** (`bmad-agent-dev`) et exécutez `bmad-sprint-planning` (`bmad-sprint-planning`). Cette commande crée `sprint-status.yaml` pour suivre tous les epics et stories.
Lorsque Build retrouve la story sélectionnée dans ce fichier, il la passe à `in-progress` pendant limplémentation, puis à `review` quand limplémentation est terminée.
### Le cycle de développement
Pour chaque changement direct ou story planifiée, répétez ce cycle dans de nouveaux chats :
| Étape | Agent | Workflow | Commande | Objectif |
|-------|-------|---------------------|---------------------|--------------------------------------|
| 1 | DEV | `bmad-build` | `bmad-build` | Clarifier, planifier, implémenter, réviser et présenter |
| 2 | DEV | `bmad-code-review` | `bmad-code-review` | Validation qualité supplémentaire *(recommandée)* |
La revue de Build fait partie de chaque exécution. `bmad-code-review` est une couche facultative de validation indépendante dans un contexte neuf.
Après avoir terminé toutes les stories dun epic, invoquez l'**agent Développeur** (`bmad-agent-dev`) et exécutez `bmad-retrospective` (`bmad-retrospective`).
## Ce que vous avez accompli
Vous maîtrisez maintenant les bases du développement avec BMad :
- Installation et configuration de BMad pour votre IDE
- Choix dune profondeur de planification adaptée au travail
- Création des documents de planification (PRD, Architecture, Epics & Stories)
- Compréhension du cycle de développement pour limplémentation
Votre projet contient désormais :
```text
your-project/
├── _bmad/ # Configuration BMad
├── _bmad-output/
│ ├── planning-artifacts/
│ │ ├── PRD.md # Document dexigences
│ │ ├── architecture.md # Décisions techniques
│ │ └── epics/ # Fichiers epic et story
│ ├── implementation-artifacts/
│ │ └── sprint-status.yaml # Suivi de sprint
│ └── project-context.md # Règles dimplémentation (optionnel)
└── ...
```
## Référence rapide
| Workflow | Commande | Agent | Objectif |
|---------------------------------------|---------------------------------------|-----------|-----------------------------------------------------------------|
| **`bmad-help`** ⭐ | `bmad-help` | Tous | **Votre guide intelligent — posez nimporte quelle question!** |
| `bmad-prd` | `bmad-prd` | Tous | Créer, mettre à jour ou valider un PRD |
| `bmad-architecture` | `bmad-architecture` | Architect | Créer le document darchitecture |
| `bmad-generate-project-context` | `bmad-generate-project-context` | Analyst | Créer le fichier de contexte projet |
| `bmad-create-epics-and-stories` | `bmad-create-epics-and-stories` | PM | Décomposer le PRD en epics |
| `bmad-sprint-planning` | `bmad-sprint-planning` | DEV | Jalon de préparation + initialisation du suivi de sprint + vue détat |
| `bmad-build` | `bmad-build` | DEV | Implémenter une intention, une issue, une fonctionnalité, un correctif ou une story |
| `bmad-code-review` | `bmad-code-review` | DEV | Revoir le code implémenté |
## Questions fréquentes
**Ai-je toujours besoin dune architecture?**
Non. Utilisez larchitecture lorsque les décisions techniques ou contraintes multi-systèmes doivent être explicites. Un travail clair peut entrer directement dans `bmad-build`; une initiative plus vaste fournit ses artefacts de planification au même workflow.
**Puis-je modifier mon plan en cours de route?**
Oui. Le workflow `bmad-correct-course` gère les changements de périmètre en cours dimplémentation.
**Et si je veux dabord brainstormer?**
Invoquez lagent Analyste (`bmad-agent-analyst`) et exécutez `bmad-brainstorming` (`bmad-brainstorming`) avant de commencer votre PRD.
**Dois-je suivre un ordre strict?**
Pas strictement. Une fois le flux maîtrisé, vous pouvez exécuter les workflows directement en vous référant au tableau ci-dessus.
## Obtenir de laide
:::tip[Premier réflexe : BMad-Help]
**Invoquez `bmad-help` à tout moment** — cest le moyen le plus rapide de vous débloquer. Posez-lui nimporte quelle question :
- «Que dois-je faire après linstallation? »
- «Je suis bloqué sur le workflow X»
- «Quelles sont mes options pour Y? »
- «Montre-moi ce qui a été fait jusquici»
BMad-Help inspecte votre projet, détecte ce que vous avez accompli et vous indique exactement la prochaine étape.
:::
- **Pendant les workflows** — Les agents vous guident à laide de questions et dexplications
- **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 profondeur de planification varie** — une intention directe et une story entièrement planifiée entrent toutes deux dans `bmad-build`
- **BMad-Help se lance 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 accompagner.
## 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 daligner 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 dune fonctionnalité du point de vue de lutilisateur 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 lensemble des interactions et perceptions dun utilisateur face à un produit. Le design UX vise à créer des interfaces intuitives, efficaces et agréables en tenant compte des besoins, des comportements et du contexte dutilisation.
[^5]: Multi-tenant : architecture logicielle où une seule instance de lapplication sert plusieurs clients (tenants) tout en maintenant leurs données isolées et sécurisées les unes des autres.