External/BMAD-METHOD
1
0
Fork 0
mirror of https://github.com/bmadcode/BMAD-METHOD.git synced 2025-12-29 16:14:59 +00:00
Code Issues Packages Projects Releases Wiki Activity
BMAD-METHOD/bmad/bmm/workflows/4-implementation/story-ready/instructions.md
Brian Madison cfedecbd53 docs: massive documentation overhaul + introduce Paige (Documentation Guide agent) 
## 📚 Complete Documentation Restructure

**BMM Documentation Hub Created:**
- New centralized documentation system at `src/modules/bmm/docs/`
- 18 comprehensive guides organized by topic (7000+ lines total)
- Clear learning paths for greenfield, brownfield, and quick spec flows
- Professional technical writing standards throughout

**New Documentation:**
- `README.md` - Complete documentation hub with navigation
- `quick-start.md` - 15-minute getting started guide
- `agents-guide.md` - Comprehensive 12-agent reference (45 min read)
- `party-mode.md` - Multi-agent collaboration guide (20 min read)
- `scale-adaptive-system.md` - Deep dive on Levels 0-4 (42 min read)
- `brownfield-guide.md` - Existing codebase development (53 min read)
- `quick-spec-flow.md` - Rapid Level 0-1 development (26 min read)
- `workflows-analysis.md` - Phase 1 workflows (12 min read)
- `workflows-planning.md` - Phase 2 workflows (19 min read)
- `workflows-solutioning.md` - Phase 3 workflows (13 min read)
- `workflows-implementation.md` - Phase 4 workflows (33 min read)
- `workflows-testing.md` - Testing & QA workflows (29 min read)
- `workflow-architecture-reference.md` - Architecture workflow deep-dive
- `workflow-document-project-reference.md` - Document-project workflow reference
- `enterprise-agentic-development.md` - Team collaboration patterns
- `faq.md` - Comprehensive Q&A covering all topics
- `glossary.md` - Complete terminology reference
- `troubleshooting.md` - Common issues and solutions

**Documentation Improvements:**
- Removed all version/date footers (git handles versioning)
- Agent customization docs now include full rebuild process
- Cross-referenced links between all guides
- Reading time estimates for all major docs
- Consistent professional formatting and structure

**Consolidated & Streamlined:**
- Module README (`src/modules/bmm/README.md`) streamlined to lean signpost
- Root README polished with better hierarchy and clear CTAs
- Moved docs from root `docs/` to module-specific locations
- Better separation of user docs vs. developer reference

## 🤖 New Agent: Paige (Documentation Guide)

**Role:** Technical documentation specialist and information architect

**Expertise:**
- Professional technical writing standards
- Documentation structure and organization
- Information architecture and navigation
- User-focused content design
- Style guide enforcement

**Status:** Work in progress - Paige will evolve as documentation needs grow

**Integration:**
- Listed in agents-guide.md, glossary.md, FAQ
- Available for all phases (documentation is continuous)
- Can be customized like all BMM agents

## 🔧 Additional Changes

- Updated agent manifest with Paige
- Updated workflow manifest with new documentation workflows
- Fixed workflow-to-agent mappings across all guides
- Improved root README with clearer Quick Start section
- Better module structure explanations
- Enhanced community links with Discord channel names

**Total Impact:**
- 18 new/restructured documentation files
- 7000+ lines of professional technical documentation
- Complete navigation system with cross-references
- Clear learning paths for all user types
- Foundation for knowledge base (coming in beta)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-02 21:18:33 -06:00

4.4 KiB
Raw Blame History

Story Ready Workflow Instructions (SM Agent)

The workflow execution engine is governed by: {project_root}/bmad/core/tasks/workflow.xml You MUST have already loaded and processed: {installed_path}/workflow.yaml Communicate all responses in {communication_language} and language MUST be tailored to {user_skill_level} Generate all documents in {document_output_language}

This workflow is run by SM agent AFTER user reviews a drafted story and confirms it's ready for development Simple workflow: Update story file status to Ready

If {{story_path}} is provided → use it directly; extract story_key from filename or metadata; GOTO mark_ready

MUST read COMPLETE sprint-status.yaml file from start to end to preserve order Load the FULL file: {{output_folder}}/sprint-status.yaml Read ALL lines from beginning to end - do not skip any content Parse the development_status section completely

Find ALL stories (reading in order from top to bottom) where:

  • Key matches pattern: number-number-name (e.g., "1-2-user-auth")
  • NOT an epic key (epic-X) or retrospective (epic-X-retrospective)
  • Status value equals "drafted"

Collect up to 10 drafted story keys in order (limit for display purposes) Count total drafted stories found

📋 No drafted stories found in sprint-status.yaml

All stories are either still in backlog or already marked ready/in-progress/done.

Options:

  1. Run create-story to draft more stories
  2. Run sprint-planning to refresh story tracking HALT

Display available drafted stories:

Drafted Stories Available ({{drafted_count}} found):

{{list_of_drafted_story_keys}}

Select the drafted story to mark as Ready (enter story key or number): Auto-select first story from the list

Resolve selected story_key from user input or auto-selection Find matching story file in {{story_dir}} using story_key pattern

Read the story file from resolved path Extract story_id and story_title from the file

Find the "Status:" line (usually at the top) Update story file: Change Status to "ready-for-dev" Save the story file

Load the FULL file: {{output_folder}}/sprint-status.yaml Find development_status key matching {{story_key}} Verify current status is "drafted" (expected previous state) Update development_status[{{story_key}}] = "ready-for-dev" Save file, preserving ALL comments and structure including STATUS DEFINITIONS ⚠️ Story file updated, but could not update sprint-status: {{story_key}} not found

You may need to run sprint-planning to refresh tracking.

Story Marked Ready for Development, {user_name}!

✅ Story file updated: {{story_file}} → Status: ready-for-dev ✅ Sprint status updated: drafted → ready-for-dev

Story Details:

  • ID: {{story_id}}
  • Key: {{story_key}}
  • Title: {{story_title}}
  • File: {{story_file}}
  • Status: ready-for-dev

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