update docs

This commit is contained in:
Brian Madison
2025-05-11 23:35:01 -05:00
parent da9824fd32
commit cea1919ba5
9 changed files with 346 additions and 253 deletions

View File

@@ -101,7 +101,7 @@ Welcome to the BMAD (Brian Madison) Method! This advisor is here to help you nav
3. **Populates Story:** Uses `docs/templates/story-template.md` to structure the story. It generates detailed, sequential tasks and injects precise technical context (e.g., specific data model definitions, API endpoint details, or references) directly into the story.
4. **Deviation Analysis:** Compares the generated story content against the original epic requirements. If any deviations are found (e.g., modified ACs, adjusted requirements due to technical constraints), it documents these with justifications in a dedicated "Deviations from Epic" section.
- **User Interaction & Approval (Critical for `sm-agent.md`):**
1. The story is initially saved as `Status: Draft` (e.g., in `ai/stories/{epicNumber}.{storyNumber}.story.md`).
1. The story is initially saved as `Status: Draft` (e.g., in `docs/stories/{epicNumber}.{storyNumber}.story.md`).
2. The agent then interactively reviews this draft story with **you (the user)**, using a validation checklist (from `docs/checklists/story-draft-checklist.md`). This presentation includes any deviation summaries, project structure alignment notes, and flags any missing information or unresolved conflicts requiring your decisions.
3. **Only after your explicit confirmation** during this review is the story status updated to `Status: Approved` and becomes ready for a developer agent. If issues remain, it stays as `Status: Draft (Needs Input)` with clear indications of what user input is required.
- _Input (for `sm-agent.md`): `docs/epic-{n}.md` files, `docs/index.md`, various technical documents (architecture, tech stack, etc.), `docs/templates/story-template.md`, `docs/checklists/story-draft-checklist.md`._