Files
BMAD-METHOD/src/modules/bmm/workflows/4-implementation/story-ready/instructions.md
2025-10-12 22:19:28 -05:00

5.6 KiB

Story Ready Workflow Instructions (SM Agent)

This workflow is run by SM agent AFTER user reviews a drafted story and confirms it's ready for development NO SEARCHING - SM agent reads status file TODO section to know which story was drafted Simple workflow: Update story file status, move story TODO → IN PROGRESS, move next story BACKLOG → TODO

Read {output_folder}/project-workflow-status.md Navigate to "### Implementation Progress (Phase 4 Only)" section Find "#### TODO (Needs Drafting)" section

Extract story information:

  • todo_story_id: The story ID (e.g., "1.1", "auth-feature-1", "login-fix")
  • todo_story_title: The story title
  • todo_story_file: The exact story file path

DO NOT SEARCH for stories - the status file tells you exactly which story is in TODO

Read the story file: {story_dir}/{todo_story_file}

Find the "Status:" line (usually at the top)

Update story file:

  • Change: Status: Draft
  • To: Status: Ready

Save the story file

Open {output_folder}/project-workflow-status.md

Update "#### TODO (Needs Drafting)" section:

Read the BACKLOG section to get the next story. If BACKLOG is empty:

TODO (Needs Drafting)

(No more stories to draft - all stories are drafted or complete)

If BACKLOG has stories, move the first BACKLOG story to TODO:

TODO (Needs Drafting)

  • Story ID: {{next_backlog_story_id}}
  • Story Title: {{next_backlog_story_title}}
  • Story File: {{next_backlog_story_file}}
  • Status: Not created OR Draft (needs review)
  • Action: SM should run create-story workflow to draft this story

Update "#### IN PROGRESS (Approved for Development)" section:

Move the TODO story here:

IN PROGRESS (Approved for Development)

  • Story ID: {{todo_story_id}}
  • Story Title: {{todo_story_title}}
  • Story File: {{todo_story_file}}
  • Story Status: Ready
  • Context File: {{context_file_path}} (if exists, otherwise note "Context not yet generated")
  • Action: DEV should run dev-story workflow to implement this story

Update "#### BACKLOG (Not Yet Drafted)" section:

Remove the first story from the BACKLOG table (the one we just moved to TODO).

If BACKLOG had 1 story and is now empty:

Epic Story ID Title File
(empty - all stories drafted)

Total in backlog: 0 stories

Update story counts in "#### Epic/Story Summary" section:

  • Decrement backlog_count by 1 (if story was moved from BACKLOG → TODO)
  • Keep in_progress_count = 1
  • Keep todo_count = 1 or 0 (depending on if there's a next story)

Add to "## Decision Log" section:

- **{{date}}**: Story {{todo_story_id}} ({{todo_story_title}}) marked ready for development by SM agent. Moved from TODO → IN PROGRESS. {{#if next_story}}Next story {{next_story_id}} moved from BACKLOG → TODO.{{/if}}

current_step Set to: "story-ready (Story {{todo_story_id}})"

current_workflow Set to: "story-ready (Story {{todo_story_id}}) - Complete"

progress_percentage Calculate per-story weight: remaining_40_percent / total_stories / 5 Increment by: {{per_story_weight}} * 1 (story-ready weight is ~1% per story)

Update "### Next Action Required" section:

**What to do next:** Generate context for story {{todo_story_id}}, then implement it

**Command to run:** Run 'story-context' workflow to generate implementation context (or skip to dev-story)

**Agent to load:** bmad/bmm/agents/sm.md (for story-context) OR bmad/bmm/agents/dev.md (for dev-story)

Save project-workflow-status.md

Display summary

Story Marked Ready for Development!

Story file updated: {{todo_story_file}} → Status: Ready Status file updated: Story moved TODO → IN PROGRESS {{#if next_story}} Next story moved: BACKLOG → TODO ({{next_story_id}}: {{next_story_title}}){{/if}} {{#if no_more_stories}} All stories have been drafted - backlog is empty{{/if}}

Current Story (IN PROGRESS):

  • ID: {{todo_story_id}}
  • Title: {{todo_story_title}}
  • File: {{todo_story_file}}
  • Status: Ready for development

Next Steps:

  1. Recommended: Run story-context workflow to generate implementation context

    • This creates a comprehensive context XML for the DEV agent
    • Includes relevant architecture, dependencies, and existing code
  2. Alternative: Skip context generation and go directly to dev-story workflow

    • Faster, but DEV agent will have less context
    • Only recommended for simple, well-understood stories

To proceed:

  • For context generation: Stay with SM agent and run story-context workflow
  • For direct implementation: Load DEV agent and run dev-story workflow