BMAD-METHOD/create-prd.md at 12d3492e0c81793ce09c057688c5828870fbe27c

mirror of https://github.com/bmad-code-org/BMAD-METHOD.git synced 2026-01-30 04:32:02 +00:00

Files

forcetrainer 12d3492e0c Add link auditor, reorganize documentation, and README update (#1277 )

* 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>

2026-01-10 02:55:33 +08:00

2.9 KiB

Raw Blame History

title, description

title	description
How to Create a PRD	How to create a Product Requirements Document using the BMad Method

Use the prd workflow to create a strategic Product Requirements Document with Functional Requirements (FRs) and Non-Functional Requirements (NFRs).

When to Use This

Medium to large feature sets
Multi-screen user experiences
Complex business logic
Multiple system integrations
Phased delivery required

Prerequisites

BMad Method installed
PM agent available
Optional: Product brief from Phase 1

Steps

1. Load the PM Agent

Start a fresh chat and load the PM agent.

2. Run the PRD Workflow

*create-prd

3. Provide Context

The workflow will:

Load any existing product brief
Ask about your project scope
Gather requirements through conversation

4. Define Requirements

Work with the agent to define:

Functional Requirements (FRs) - What the system should do
Non-Functional Requirements (NFRs) - How well it should do it

5. Review the PRD

The agent produces a comprehensive PRD scaled to your project.

What You Get

A PRD.md document containing:

Executive summary
Problem statement
User personas
Functional requirements (FRs)
Non-functional requirements (NFRs)
Success metrics
Risks and assumptions

Scale-Adaptive Structure

The PRD adapts to your project complexity:

Scale	Pages	Focus
Light	10-15	Focused FRs/NFRs, simplified analysis
Standard	20-30	Comprehensive FRs/NFRs, thorough analysis
Comprehensive	30-50+	Extensive FRs/NFRs, multi-phase, stakeholder analysis

V6 Improvement

In V6, the PRD focuses on WHAT to build (requirements). Epic and Stories are created AFTER architecture via the create-epics-and-stories workflow for better quality.

Example

E-commerce checkout → PRD with:

15 FRs (user account, cart management, payment flow)
8 NFRs (performance, security, scalability)

Best Practices

1. Do Product Brief First

Run product-brief from Phase 1 to kickstart the PRD for better results.

2. Focus on "What" Not "How"

Planning defines what to build and why. Leave how (technical design) to Phase 3 (Solutioning).

3. Document-Project First for Brownfield

Always run document-project before planning brownfield projects. AI agents need existing codebase context.

Next Steps

After PRD:

Create UX Design (optional) - If UX is critical
Create Architecture - Technical design
Create Epics and Stories - After architecture

Create Product Brief - Input for PRD
Create UX Design - Optional UX workflow
Create Architecture - Next step after PRD

2.9 KiB Raw Blame History