mirror of
https://github.com/bmad-code-org/BMAD-METHOD.git
synced 2026-01-30 04:32:02 +00:00
* 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>
163 lines
3.7 KiB
Markdown
163 lines
3.7 KiB
Markdown
---
|
|
title: "How to Run Implementation Readiness"
|
|
description: How to validate planning and solutioning before implementation
|
|
---
|
|
|
|
|
|
Use the `implementation-readiness` workflow to validate that planning and solutioning are complete and aligned before Phase 4 implementation.
|
|
|
|
---
|
|
|
|
## When to Use This
|
|
|
|
- **Always** before Phase 4 for BMad Method and Enterprise projects
|
|
- After create-epics-and-stories workflow completes
|
|
- Before sprint-planning workflow
|
|
- When stakeholders request readiness check
|
|
|
|
---
|
|
|
|
## When to Skip This
|
|
|
|
- Quick Flow (no solutioning phase)
|
|
- BMad Method Simple (no gate check required)
|
|
|
|
---
|
|
|
|
## Prerequisites
|
|
|
|
- BMad Method installed
|
|
- Architect agent available
|
|
- PRD, Architecture, and Epics completed
|
|
|
|
---
|
|
|
|
## Steps
|
|
|
|
### 1. Load the Architect Agent
|
|
|
|
Start a fresh chat and load the Architect agent.
|
|
|
|
### 2. Run the Workflow
|
|
|
|
```
|
|
*implementation-readiness
|
|
```
|
|
|
|
### 3. Let the Agent Validate
|
|
|
|
The workflow systematically checks:
|
|
- PRD completeness
|
|
- Architecture completeness
|
|
- Epic/Story completeness
|
|
- Alignment between all documents
|
|
|
|
### 4. Review the Gate Decision
|
|
|
|
The agent produces a gate decision with rationale.
|
|
|
|
---
|
|
|
|
## Gate Decision Outcomes
|
|
|
|
### ✅ PASS
|
|
|
|
- All critical criteria met
|
|
- Minor gaps acceptable with documented plan
|
|
- **Action:** Proceed to Phase 4
|
|
|
|
### ⚠️ CONCERNS
|
|
|
|
- Some criteria not met but not blockers
|
|
- Gaps identified with clear resolution path
|
|
- **Action:** Proceed with caution, address gaps in parallel
|
|
|
|
### ❌ FAIL
|
|
|
|
- Critical gaps or contradictions
|
|
- Architecture missing key decisions
|
|
- Epics conflict with PRD/architecture
|
|
- **Action:** BLOCK Phase 4, resolve issues first
|
|
|
|
---
|
|
|
|
## What Gets Checked
|
|
|
|
### PRD/GDD Completeness
|
|
- Problem statement clear and evidence-based
|
|
- Success metrics defined
|
|
- User personas identified
|
|
- Functional requirements (FRs) complete
|
|
- Non-functional requirements (NFRs) specified
|
|
- Risks and assumptions documented
|
|
|
|
### Architecture Completeness
|
|
- System architecture defined
|
|
- Data architecture specified
|
|
- API architecture decided
|
|
- Key ADRs documented
|
|
- Security architecture addressed
|
|
- FR/NFR-specific guidance provided
|
|
- Standards and conventions defined
|
|
|
|
### Epic/Story Completeness
|
|
- All PRD features mapped to stories
|
|
- Stories have acceptance criteria
|
|
- Stories prioritized (P0/P1/P2/P3)
|
|
- Dependencies identified
|
|
- Story sequencing logical
|
|
|
|
### Alignment Checks
|
|
- Architecture addresses all PRD FRs/NFRs
|
|
- Epics align with architecture decisions
|
|
- No contradictions between epics
|
|
- NFRs have technical approach
|
|
- Integration points clear
|
|
|
|
---
|
|
|
|
## What You Get
|
|
|
|
An `implementation-readiness.md` document containing:
|
|
|
|
1. **Executive Summary** (PASS/CONCERNS/FAIL)
|
|
2. **Completeness Assessment** (scores for PRD, Architecture, Epics)
|
|
3. **Alignment Assessment** (PRD↔Architecture, Architecture↔Epics)
|
|
4. **Quality Assessment** (story quality, dependencies, risks)
|
|
5. **Gaps and Recommendations** (critical/minor gaps, remediation)
|
|
6. **Gate Decision** with rationale
|
|
7. **Next Steps**
|
|
|
|
---
|
|
|
|
## Example
|
|
|
|
E-commerce platform → CONCERNS ⚠️
|
|
|
|
**Gaps identified:**
|
|
- Missing security architecture section
|
|
- Undefined payment gateway
|
|
|
|
**Recommendation:**
|
|
- Complete security section
|
|
- Add payment gateway ADR
|
|
|
|
**Action:** Proceed with caution, address before payment epic.
|
|
|
|
---
|
|
|
|
## Tips
|
|
|
|
- Run this before every Phase 4 start
|
|
- Take FAIL decisions seriously - fix issues first
|
|
- Use CONCERNS as a checklist for parallel work
|
|
- Document why you proceed despite concerns
|
|
|
|
---
|
|
|
|
## Related
|
|
|
|
- [Create Architecture](/docs/how-to/workflows/create-architecture.md) - Architecture workflow
|
|
- [Create Epics and Stories](/docs/how-to/workflows/create-epics-and-stories.md) - Work breakdown
|
|
- [Run Sprint Planning](/docs/how-to/workflows/run-sprint-planning.md) - Start implementation
|