mirror of
https://github.com/bmad-code-org/BMAD-METHOD.git
synced 2026-01-30 04:32:02 +00:00
12d3492e0c
* feat: add link auditor tools and fix broken docs links - Add audit-doc-links.js to scan docs for broken links with auto-resolution - Add fix-doc-links.js to apply suggested fixes (dry-run by default) - Remove stale "Back to Core Concepts" breadcrumb links - Update BMad acronym to "Breakthrough Method of Agile AI Driven Development" - Update README links to docs.bmad-method.org - Simplify upgrade callout in getting-started tutorial Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * docs: reorganize docs structure and archive v4 tutorial - Remove unused section index files (tutorials, how-to, explanation, reference) - Move getting-started-bmadv4.md to _archive - Update quick-start-bmgd.md to remove archived file reference - Update upgrade-to-v6.md - Update astro.config.mjs for new structure Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix: ignore underscore directories in link checker Update check-doc-links.js to skip _archive, _planning, and other underscore-prefixed directories when validating links. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * docs: add v4 users section to README Add links to v4 documentation archive and upgrade guide for users migrating from previous versions. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * feat: convert docs to site-relative links and add validation tools - Convert all relative links (./ ../) to site-relative paths (/path/) - Strip .md extensions and use trailing slashes for Astro/Starlight - Add fix-doc-links.js to convert relative links to site-relative - Add validate-doc-links.js to check links point to existing files - Remove old audit-doc-links.js and check-doc-links.js - Update build-docs.js to use new validation script - Add npm scripts: docs:fix-links, docs:validate-links - Update style guide with validation steps Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * docs: standardize acronym to BMad across documentation Replace incorrect "BMAD" with correct "BMad" in text and frontmatter while preserving "BMAD-METHOD" in GitHub URLs. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * docs: fix BMad acronym and remove draft README - Correct acronym to "Breakthrough Method of Agile AI Driven Development" - Remove unused README-draft.md Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * docs: standardize BMad acronym in README Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * docs: standardize FAQ format across all FAQ pages - Add TOC with jump links under "## Questions" - Use ### headers for questions (no Q: prefix) - Direct answers without **A:** prefix - Remove horizontal rules and "Related Documentation" sections - End each FAQ with issue/Discord CTA - Update style guide with new FAQ guidelines - Delete redundant faq/index.md (sidebar handles navigation) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix: use repo-relative links with .md for GitHub compatibility Convert all documentation links to repo-relative format (/docs/path/file.md) so they work when browsing on GitHub. The rehype plugin strips /docs/ prefix and converts .md to trailing slash at build time for Astro/Starlight. - Update rehype-markdown-links.js to strip /docs/ prefix from absolute paths - Update fix-doc-links.js to generate /docs/ prefixed paths with .md extension - Convert 217 links across 64 files to new format Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix: handle /docs/ prefix in link validator Update resolveLink to strip /docs/ prefix from repo-relative links before checking if files exist. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * docs: restore FAQ index page Re-add the FAQ index page that was accidentally deleted, with updated repo-relative link format. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com> Co-authored-by: Alex Verkhovsky <alexey.verkhovsky@gmail.com>
3.1 KiB
3.1 KiB
title, description
| title | description |
|---|---|
| How to Create Epics and Stories | How to break PRD requirements into epics and stories using BMad Method |
Use the create-epics-and-stories workflow to transform PRD requirements into bite-sized stories organized into deliverable epics.
When to Use This
- After architecture workflow completes
- When PRD contains FRs/NFRs ready for implementation breakdown
- Before implementation-readiness gate check
Prerequisites
- BMad Method installed
- PM agent available
- PRD completed
- Architecture completed
Why After Architecture?
This workflow runs AFTER architecture because:
- Informed Story Sizing - Architecture decisions affect story complexity
- Dependency Awareness - Architecture reveals technical dependencies
- Technical Feasibility - Stories can be properly scoped knowing the tech stack
- Consistency - All stories align with documented architectural patterns
Steps
1. Load the PM Agent
Start a fresh chat and load the PM agent.
2. Run the Workflow
*create-epics-and-stories
3. Provide Context
Point the agent to:
- Your PRD (FRs/NFRs)
- Your architecture document
- Optional: UX design artifacts
4. Review Epic Breakdown
The agent organizes requirements into logical epics with user stories.
5. Validate Story Quality
Ensure each story has:
- Clear acceptance criteria
- Appropriate priority
- Identified dependencies
- Technical notes from architecture
What You Get
Epic files (one per epic) containing:
- Epic objective and scope
- User stories with acceptance criteria
- Story priorities (P0/P1/P2/P3)
- Dependencies between stories
- Technical notes referencing architecture decisions
Example
E-commerce PRD with FR-001 (User Registration), FR-002 (Product Catalog) produces:
-
Epic 1: User Management (3 stories)
- Story 1.1: User registration form
- Story 1.2: Email verification
- Story 1.3: Login/logout
-
Epic 2: Product Display (4 stories)
- Story 2.1: Product listing page
- Story 2.2: Product detail page
- Story 2.3: Search functionality
- Story 2.4: Category filtering
Each story references relevant ADRs from architecture.
Story Priority Levels
| Priority | Meaning |
|---|---|
| P0 | Critical - Must have for MVP |
| P1 | High - Important for release |
| P2 | Medium - Nice to have |
| P3 | Low - Future consideration |
Tips
- Keep stories small enough to complete in a session
- Ensure acceptance criteria are testable
- Document dependencies clearly
- Reference architecture decisions in technical notes
Next Steps
After creating epics and stories:
- Implementation Readiness - Validate alignment before Phase 4
- Sprint Planning - Organize work for implementation
Related
- Create Architecture - Do this first
- Run Implementation Readiness - Gate check
- Run Sprint Planning - Start implementation