mirror of
https://github.com/bmad-code-org/BMAD-METHOD.git
synced 2026-01-30 04:32:02 +00:00
Style Guide Additions: - Add Reference Structure section with 6 document types (Index, Catalog, Deep-Dive, Configuration, Glossary, Comprehensive) - Add Glossary Structure section with table-based format leveraging Starlight's right-nav for navigation - Include checklists for both new document types Reference Docs Updated: - agents/index.md: Catalog format, universal commands tip admonition - configuration/core-tasks.md: Configuration format with admonitions - configuration/global-config.md: Table-based config reference - workflows/index.md: Minimal index format - workflows/core-workflows.md: Catalog format - workflows/document-project.md: Deep-dive with Quick Facts admonition - workflows/bmgd-workflows.md: Comprehensive format, removed ~30 hr rules Glossary Rewritten: - Converted from 373 lines with ### headers to 123 lines with tables - Right nav now shows 9 categories instead of 50+ terms - Added italic context markers (*BMGD.*, *Brownfield.*, etc.) - Alphabetized terms within categories - Removed redundant inline TOC All Docs: - Remove horizontal rules (---) per style guide - Remove "Related" sections (sidebar handles navigation) - Standardize admonition usage - Archive deleted workflow customization docs Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2.5 KiB
2.5 KiB
title, description
| title | description |
|---|---|
| How to Create a Story | How to create implementation-ready stories from epic backlog |
Use the create-story workflow to prepare the next story from the epic backlog for implementation.
When to Use This
- Before implementing each story
- When moving to the next story in an epic
- After sprint-planning has been run
:::note[Prerequisites]
- BMad Method installed
- SM (Scrum Master) agent available
- Sprint-status.yaml created by sprint-planning
- Architecture and PRD available for context :::
Steps
1. Load the SM Agent
Start a fresh chat and load the SM (Scrum Master) agent.
2. Run the Workflow
*create-story
3. Specify the Story
The agent will:
- Read the sprint-status.yaml
- Identify the next story to work on
- Or let you specify a particular story
4. Review the Story File
The agent creates a comprehensive story file ready for development.
What You Get
A story-[slug].md file containing:
- Story objective and scope
- Acceptance criteria (specific, testable)
- Technical implementation notes
- References to architecture decisions
- Dependencies on other stories
- Definition of Done
Story Content Sources
The create-story workflow pulls from:
- PRD — Requirements and acceptance criteria
- Architecture — Technical approach and ADRs
- Epic file — Story context and dependencies
- Existing code — Patterns to follow (brownfield)
Example Output
## Objective
Implement email verification flow for new user registrations.
## Acceptance Criteria
- [ ] User receives verification email within 30 seconds
- [ ] Email contains unique verification link
- [ ] Link expires after 24 hours
- [ ] User can request new verification email
## Technical Notes
- Use SendGrid API per ADR-003
- Store verification tokens in Redis per architecture
- Follow existing email template patterns in /templates
## Dependencies
- Story 1.1 (User Registration) - DONE
## Definition of Done
- All acceptance criteria pass
- Tests written and passing
- Code review approved
Tips
- Complete one story before creating the next — Focus on finishing
- Ensure dependencies are DONE — Don't start blocked stories
- Review technical notes — Align with architecture
- Use the story file as context — Pass to dev-story workflow
Next Steps
After creating a story:
- Implement Story — Run dev-story with the DEV agent
- Code Review — Run code-review after implementation