BMAD-METHOD/quick-spec.md at cc7635172bc69d7d24f87f8fe570bd36fa8692dc

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

Files

forcetrainer e535f94325 docs: comprehensive style guide update with reference and glossary standards

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>

2026-01-12 00:23:05 -05:00

3.3 KiB

Raw Blame History

title, description

title	description
How to Use Quick Spec	How to create a technical specification using Quick Spec workflow

Use the quick-spec workflow for Quick Flow projects to go directly from idea to implementation-ready specification.

When to Use This

Bug fixes and small enhancements
Small features with clear scope (1-15 stories)
Rapid prototyping
Adding to existing brownfield codebase
Quick Flow track projects

:::note[Prerequisites]

BMad Method installed
PM agent or Quick Flow Solo Dev agent available
Project directory (can be empty for greenfield) :::

Steps

1. Load the PM Agent

Start a fresh chat and load the PM agent (or Quick Flow Solo Dev agent).

2. Run the Tech Spec Workflow

*quick-spec

Or simply describe what you want to build:

I want to fix the login validation bug

3. Answer Discovery Questions

The workflow will ask:

What problem are you solving?
What's the scope of the change?
Any specific constraints?

4. Review Detected Context

For brownfield projects, the agent will:

Detect your project stack
Analyze existing code patterns
Detect test frameworks
Ask: "Should I follow these existing conventions?"

5. Get Your Tech Spec

The agent generates a comprehensive tech-spec with ready-to-implement stories.

What You Get

tech-spec.md:

Problem statement and solution
Detected framework versions and dependencies
Brownfield code patterns (if applicable)
Existing test patterns to follow
Specific file paths to modify
Complete implementation guidance

Story Files:

Single changes: story-[slug].md
Small features: epics.md + story-[epic-slug]-1.md, etc.

Example: Bug Fix

You: "I want to fix the login validation bug that allows empty passwords"

Agent:

Asks clarifying questions about the issue
Detects your Node.js stack (Express 4.18.2, Jest for testing)
Analyzes existing UserService code patterns
Asks: "Should I follow your existing conventions?" → Yes
Generates tech-spec.md with specific file paths
Creates story-login-fix.md

Example: Small Feature

You: "I want to add OAuth social login (Google, GitHub)"