Compare commits
15 Commits
08488bfb91
...
0376db7f53
| Author | SHA1 | Date |
|---|---|---|
|
|
0376db7f53 | |
|
|
d419ac8a70 | |
|
|
568249e985 | |
|
|
c0f6401902 | |
|
|
e535f94325 | |
|
|
e465ce4bb5 | |
|
|
9d328082eb | |
|
|
9f85dade25 | |
|
|
5870651bad | |
|
|
eff826eef9 | |
|
|
6c3a0f6452 | |
|
|
65d89e660b | |
|
|
6769c57021 | |
|
|
64174310a7 | |
|
|
8835b0ef6d |
|
|
@ -10,6 +10,11 @@ package-lock.json
|
||||||
test-output/*
|
test-output/*
|
||||||
coverage/
|
coverage/
|
||||||
|
|
||||||
|
# Python cache
|
||||||
|
__pycache__/
|
||||||
|
*.py[cod]
|
||||||
|
*.pyo
|
||||||
|
|
||||||
# Logs
|
# Logs
|
||||||
logs/
|
logs/
|
||||||
*.log
|
*.log
|
||||||
|
|
|
||||||
14
README.md
14
README.md
|
|
@ -7,6 +7,8 @@
|
||||||
|
|
||||||
**Build More, Architect Dreams** — An AI-driven agile development framework with 21 specialized agents, 50+ guided workflows, and scale-adaptive intelligence that adjusts from bug fixes to enterprise systems.
|
**Build More, Architect Dreams** — An AI-driven agile development framework with 21 specialized agents, 50+ guided workflows, and scale-adaptive intelligence that adjusts from bug fixes to enterprise systems.
|
||||||
|
|
||||||
|
**100% free and open source.** No paywalls. No gated content. No gated Discord. We believe in empowering everyone, not just those who can pay.
|
||||||
|
|
||||||
## Why BMad?
|
## Why BMad?
|
||||||
|
|
||||||
Traditional AI tools do the thinking for you, producing average results. BMad agents act as expert collaborators who guide you through structured workflows to bring out your best thinking.
|
Traditional AI tools do the thinking for you, producing average results. BMad agents act as expert collaborators who guide you through structured workflows to bring out your best thinking.
|
||||||
|
|
@ -60,10 +62,20 @@ This analyzes your project and recommends a track:
|
||||||
## Community
|
## Community
|
||||||
|
|
||||||
- [Discord](https://discord.gg/gk8jAdXWmj) — Get help, share ideas, collaborate
|
- [Discord](https://discord.gg/gk8jAdXWmj) — Get help, share ideas, collaborate
|
||||||
- [YouTube](https://www.youtube.com/@BMadCode) — Video tutorials and updates
|
- [YouTube](https://www.youtube.com/@BMadCode) — Tutorials, master class, and podcast (launching Feb 2025)
|
||||||
- [GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues) — Bug reports and feature requests
|
- [GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues) — Bug reports and feature requests
|
||||||
- [Discussions](https://github.com/bmad-code-org/BMAD-METHOD/discussions) — Community conversations
|
- [Discussions](https://github.com/bmad-code-org/BMAD-METHOD/discussions) — Community conversations
|
||||||
|
|
||||||
|
## Support BMad
|
||||||
|
|
||||||
|
BMad is free for everyone — and always will be. If you'd like to support development:
|
||||||
|
|
||||||
|
- ⭐ [Star us on GitHub](https://github.com/bmad-code-org/BMAD-METHOD/) — Helps others discover BMad
|
||||||
|
- 📺 [Subscribe on YouTube](https://www.youtube.com/@BMadCode) — Master class launching Feb 2026
|
||||||
|
- ☕ [Buy Me a Coffee](https://buymeacoffee.com/bmad) — Fuel the development
|
||||||
|
- 🏢 Corporate sponsorship — DM on Discord
|
||||||
|
- 🎤 Speaking & Media — Available for conferences, podcasts, interviews (Discord)
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
|
We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,6 @@
|
||||||
# Documentation Style Guide
|
---
|
||||||
|
title: "Documentation Style Guide"
|
||||||
|
---
|
||||||
|
|
||||||
Internal guidelines for maintaining consistent, high-quality documentation across the BMad Method project. This document is not included in the Starlight sidebar — it's for contributors and maintainers, not end users.
|
Internal guidelines for maintaining consistent, high-quality documentation across the BMad Method project. This document is not included in the Starlight sidebar — it's for contributors and maintainers, not end users.
|
||||||
|
|
||||||
|
|
@ -54,6 +56,423 @@ Every tutorial should follow this structure:
|
||||||
|
|
||||||
Not all sections are required for every tutorial, but this is the standard flow.
|
Not all sections are required for every tutorial, but this is the standard flow.
|
||||||
|
|
||||||
|
## How-To Structure
|
||||||
|
|
||||||
|
How-to guides are task-focused and shorter than tutorials. They answer "How do I do X?" for users who already understand the basics.
|
||||||
|
|
||||||
|
```
|
||||||
|
1. Title + Hook (one sentence: "Use the `X` workflow to...")
|
||||||
|
2. When to Use This (bullet list of scenarios)
|
||||||
|
3. When to Skip This (optional - for workflows that aren't always needed)
|
||||||
|
4. Prerequisites (note admonition)
|
||||||
|
5. Steps (numbered ### subsections)
|
||||||
|
6. What You Get (output/artifacts produced)
|
||||||
|
7. Example (optional - concrete usage scenario)
|
||||||
|
8. Tips (optional - best practices, common pitfalls)
|
||||||
|
9. Next Steps (optional - what to do after completion)
|
||||||
|
```
|
||||||
|
|
||||||
|
Include sections only when they add value. A simple how-to might only need Hook, Prerequisites, Steps, and What You Get.
|
||||||
|
|
||||||
|
### How-To vs Tutorial
|
||||||
|
|
||||||
|
| Aspect | How-To | Tutorial |
|
||||||
|
|--------|--------|----------|
|
||||||
|
| **Length** | 50-150 lines | 200-400 lines |
|
||||||
|
| **Audience** | Users who know the basics | New users learning concepts |
|
||||||
|
| **Focus** | Complete a specific task | Understand a workflow end-to-end |
|
||||||
|
| **Sections** | 5-8 sections | 12-15 sections |
|
||||||
|
| **Examples** | Brief, inline | Detailed, step-by-step |
|
||||||
|
|
||||||
|
### How-To Visual Elements
|
||||||
|
|
||||||
|
Use admonitions strategically in how-to guides:
|
||||||
|
|
||||||
|
| Admonition | Use In How-To |
|
||||||
|
|------------|---------------|
|
||||||
|
| `:::note[Prerequisites]` | Required dependencies, agents, prior steps |
|
||||||
|
| `:::tip[Pro Tip]` | Optional shortcuts or best practices |
|
||||||
|
| `:::caution[Common Mistake]` | Pitfalls to avoid |
|
||||||
|
| `:::note[Example]` | Brief usage example inline with steps |
|
||||||
|
|
||||||
|
**Guidelines:**
|
||||||
|
- **1-2 admonitions max** per how-to (they're shorter than tutorials)
|
||||||
|
- **Prerequisites as admonition** makes scanning easier
|
||||||
|
- **Tips section** can be a flat list instead of admonition if there are multiple tips
|
||||||
|
- **Skip admonitions entirely** for very simple how-tos
|
||||||
|
|
||||||
|
### How-To Checklist
|
||||||
|
|
||||||
|
Before submitting a how-to:
|
||||||
|
|
||||||
|
- [ ] Hook is one clear sentence starting with "Use the `X` workflow to..."
|
||||||
|
- [ ] When to Use This has 3-5 bullet points
|
||||||
|
- [ ] Prerequisites listed (admonition or flat list)
|
||||||
|
- [ ] Steps are numbered `###` subsections with action verbs
|
||||||
|
- [ ] What You Get describes output artifacts
|
||||||
|
- [ ] No horizontal rules (`---`)
|
||||||
|
- [ ] No `####` headers
|
||||||
|
- [ ] No "Related" section (sidebar handles navigation)
|
||||||
|
- [ ] 1-2 admonitions maximum
|
||||||
|
|
||||||
|
## Explanation Structure
|
||||||
|
|
||||||
|
Explanation documents help users understand concepts, features, and design decisions. They answer "What is X?" and "Why does X matter?" rather than "How do I do X?"
|
||||||
|
|
||||||
|
### Types of Explanation Documents
|
||||||
|
|
||||||
|
| Type | Purpose | Example |
|
||||||
|
|------|---------|---------|
|
||||||
|
| **Index/Landing** | Overview of a topic area with navigation | `core-concepts/index.md` |
|
||||||
|
| **Concept** | Define and explain a core concept | `what-are-agents.md` |
|
||||||
|
| **Feature** | Deep dive into a specific capability | `quick-flow.md` |
|
||||||
|
| **Philosophy** | Explain design decisions and rationale | `why-solutioning-matters.md` |
|
||||||
|
| **FAQ** | Answer common questions (see FAQ Sections below) | `brownfield-faq.md` |
|
||||||
|
|
||||||
|
### General Explanation Structure
|
||||||
|
|
||||||
|
```
|
||||||
|
1. Title + Hook (1-2 sentences explaining the topic)
|
||||||
|
2. Overview/Definition (what it is, why it matters)
|
||||||
|
3. Key Concepts (### subsections for main ideas)
|
||||||
|
4. Comparison Table (optional - when comparing options)
|
||||||
|
5. When to Use / When Not to Use (optional - decision guidance)
|
||||||
|
6. Diagram (optional - mermaid for processes/flows)
|
||||||
|
7. Next Steps (optional - where to go from here)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Index/Landing Pages
|
||||||
|
|
||||||
|
Index pages orient users within a topic area.
|
||||||
|
|
||||||
|
```
|
||||||
|
1. Title + Hook (one sentence overview)
|
||||||
|
2. Content Table (links with descriptions)
|
||||||
|
3. Getting Started (numbered list for new users)
|
||||||
|
4. Choose Your Path (optional - decision tree for different goals)
|
||||||
|
```
|
||||||
|
|
||||||
|
**Example hook:** "Understanding the fundamental building blocks of the BMad Method."
|
||||||
|
|
||||||
|
### Concept Explainers
|
||||||
|
|
||||||
|
Concept pages define and explain core ideas.
|
||||||
|
|
||||||
|
```
|
||||||
|
1. Title + Hook (what it is in one sentence)
|
||||||
|
2. Types/Categories (if applicable, with ### subsections)
|
||||||
|
3. Key Differences Table (comparing types/options)
|
||||||
|
4. Components/Parts (breakdown of elements)
|
||||||
|
5. Which Should You Use? (decision guidance)
|
||||||
|
6. Creating/Customizing (brief pointer to how-to guides)
|
||||||
|
```
|
||||||
|
|
||||||
|
**Example hook:** "Agents are AI assistants that help you accomplish tasks. Each agent has a unique personality, specialized capabilities, and an interactive menu."
|
||||||
|
|
||||||
|
### Feature Explainers
|
||||||
|
|
||||||
|
Feature pages provide deep dives into specific capabilities.
|
||||||
|
|
||||||
|
```
|
||||||
|
1. Title + Hook (what the feature does)
|
||||||
|
2. Quick Facts (optional - "Perfect for:", "Time to:")
|
||||||
|
3. When to Use / When Not to Use (with bullet lists)
|
||||||
|
4. How It Works (process overview, mermaid diagram if helpful)
|
||||||
|
5. Key Benefits (what makes it valuable)
|
||||||
|
6. Comparison Table (vs alternatives if applicable)
|
||||||
|
7. When to Graduate/Upgrade (optional - when to use something else)
|
||||||
|
```
|
||||||
|
|
||||||
|
**Example hook:** "Quick Spec Flow is a streamlined alternative to the full BMad Method for Quick Flow track projects."
|
||||||
|
|
||||||
|
### Philosophy/Rationale Documents
|
||||||
|
|
||||||
|
Philosophy pages explain design decisions and reasoning.
|
||||||
|
|
||||||
|
```
|
||||||
|
1. Title + Hook (the principle or decision)
|
||||||
|
2. The Problem (what issue this addresses)
|
||||||
|
3. The Solution (how this approach solves it)
|
||||||
|
4. Key Principles (### subsections for main ideas)
|
||||||
|
5. Benefits (what users gain)
|
||||||
|
6. When This Applies (scope of the principle)
|
||||||
|
```
|
||||||
|
|
||||||
|
**Example hook:** "Phase 3 (Solutioning) translates **what** to build (from Planning) into **how** to build it (technical design)."
|
||||||
|
|
||||||
|
### Explanation Visual Elements
|
||||||
|
|
||||||
|
Use these elements strategically in explanation documents:
|
||||||
|
|
||||||
|
| Element | Use For |
|
||||||
|
|---------|---------|
|
||||||
|
| **Comparison tables** | Contrasting types, options, or approaches |
|
||||||
|
| **Mermaid diagrams** | Process flows, phase sequences, decision trees |
|
||||||
|
| **"Best for:" lists** | Quick decision guidance |
|
||||||
|
| **Code examples** | Illustrating concepts (keep brief) |
|
||||||
|
|
||||||
|
**Guidelines:**
|
||||||
|
- **Use diagrams sparingly** — one mermaid diagram per document maximum
|
||||||
|
- **Tables over prose** — for any comparison of 3+ items
|
||||||
|
- **Avoid step-by-step instructions** — point to how-to guides instead
|
||||||
|
|
||||||
|
### Explanation Checklist
|
||||||
|
|
||||||
|
Before submitting an explanation document:
|
||||||
|
|
||||||
|
- [ ] Hook clearly states what the document explains
|
||||||
|
- [ ] Content organized into scannable `##` sections
|
||||||
|
- [ ] Comparison tables used for contrasting options
|
||||||
|
- [ ] No horizontal rules (`---`)
|
||||||
|
- [ ] No `####` headers
|
||||||
|
- [ ] No "Related" section (sidebar handles navigation)
|
||||||
|
- [ ] No "Next:" navigation links (sidebar handles navigation)
|
||||||
|
- [ ] Diagrams have clear labels and flow
|
||||||
|
- [ ] Links to how-to guides for "how do I do this?" questions
|
||||||
|
- [ ] 2-3 admonitions maximum
|
||||||
|
|
||||||
|
## Reference Structure
|
||||||
|
|
||||||
|
Reference documents provide quick lookup information for users who know what they're looking for. They answer "What are the options?" and "What does X do?" rather than explaining concepts or teaching skills.
|
||||||
|
|
||||||
|
### Types of Reference Documents
|
||||||
|
|
||||||
|
| Type | Purpose | Example |
|
||||||
|
|------|---------|---------|
|
||||||
|
| **Index/Landing** | Navigation to reference content | `workflows/index.md` |
|
||||||
|
| **Catalog** | Quick-reference list of items | `agents/index.md` |
|
||||||
|
| **Deep-Dive** | Detailed single-item reference | `document-project.md` |
|
||||||
|
| **Configuration** | Settings and config documentation | `core-tasks.md` |
|
||||||
|
| **Glossary** | Term definitions | `glossary/index.md` |
|
||||||
|
| **Comprehensive** | Extensive multi-item reference | `bmgd-workflows.md` |
|
||||||
|
|
||||||
|
### Reference Index Pages
|
||||||
|
|
||||||
|
For navigation landing pages:
|
||||||
|
|
||||||
|
```
|
||||||
|
1. Title + Hook (one sentence describing scope)
|
||||||
|
2. Content Sections (## for each category)
|
||||||
|
- Bullet list with links and brief descriptions
|
||||||
|
```
|
||||||
|
|
||||||
|
Keep these minimal — their job is navigation, not explanation.
|
||||||
|
|
||||||
|
### Catalog Reference (Item Lists)
|
||||||
|
|
||||||
|
For quick-reference lists of items:
|
||||||
|
|
||||||
|
```
|
||||||
|
1. Title + Hook (one sentence)
|
||||||
|
2. Items (## for each item)
|
||||||
|
- Brief description (one sentence)
|
||||||
|
- **Commands:** or **Key Info:** as flat list
|
||||||
|
3. Universal/Shared (## section if applicable)
|
||||||
|
```
|
||||||
|
|
||||||
|
**Guidelines:**
|
||||||
|
- Use `##` for items, not `###`
|
||||||
|
- No horizontal rules between items — whitespace is sufficient
|
||||||
|
- No "Related" section — sidebar handles navigation
|
||||||
|
- Keep descriptions to 1 sentence per item
|
||||||
|
|
||||||
|
### Item Deep-Dive Reference
|
||||||
|
|
||||||
|
For detailed single-item documentation:
|
||||||
|
|
||||||
|
```
|
||||||
|
1. Title + Hook (one sentence purpose)
|
||||||
|
2. Quick Facts (optional note admonition)
|
||||||
|
- Module, Command, Input, Output as list
|
||||||
|
3. Purpose/Overview (## section)
|
||||||
|
4. How to Invoke (code block)
|
||||||
|
5. Key Sections (## for each major aspect)
|
||||||
|
- Use ### for sub-options within sections
|
||||||
|
6. Notes/Caveats (tip or caution admonition)
|
||||||
|
```
|
||||||
|
|
||||||
|
**Guidelines:**
|
||||||
|
- Start with "quick facts" so readers immediately know scope
|
||||||
|
- Use admonitions for important caveats
|
||||||
|
- No "Related Documentation" section — sidebar handles this
|
||||||
|
|
||||||
|
### Configuration Reference
|
||||||
|
|
||||||
|
For settings, tasks, and config documentation:
|
||||||
|
|
||||||
|
```
|
||||||
|
1. Title + Hook (one sentence explaining what these configure)
|
||||||
|
2. Table of Contents (jump links if 4+ items)
|
||||||
|
3. Items (## for each config/task)
|
||||||
|
- **Bold summary** — one sentence describing what it does
|
||||||
|
- **Use it when:** bullet list of scenarios
|
||||||
|
- **How it works:** numbered steps
|
||||||
|
- **Output:** expected result (if applicable)
|
||||||
|
```
|
||||||
|
|
||||||
|
**Guidelines:**
|
||||||
|
- Table of contents only needed for 4+ items
|
||||||
|
- Keep "How it works" to 3-5 steps maximum
|
||||||
|
- No horizontal rules between items
|
||||||
|
|
||||||
|
### Glossary Reference
|
||||||
|
|
||||||
|
For term definitions:
|
||||||
|
|
||||||
|
```
|
||||||
|
1. Title + Hook (one sentence)
|
||||||
|
2. Navigation (jump links to categories)
|
||||||
|
3. Categories (## for each category)
|
||||||
|
- Terms (### for each term)
|
||||||
|
- Definition (1-3 sentences, no prefix)
|
||||||
|
- Related context or example (optional)
|
||||||
|
```
|
||||||
|
|
||||||
|
**Guidelines:**
|
||||||
|
- Group related terms into categories
|
||||||
|
- Keep definitions concise — link to explanation docs for depth
|
||||||
|
- Use `###` for terms (makes them linkable and scannable)
|
||||||
|
- No horizontal rules between terms
|
||||||
|
|
||||||
|
### Comprehensive Reference Guide
|
||||||
|
|
||||||
|
For extensive multi-item references:
|
||||||
|
|
||||||
|
```
|
||||||
|
1. Title + Hook (one sentence)
|
||||||
|
2. Overview (## section)
|
||||||
|
- Diagram or table showing organization
|
||||||
|
3. Major Sections (## for each phase/category)
|
||||||
|
- Items (### for each item)
|
||||||
|
- Standardized fields: Command, Agent, Input, Output, Description
|
||||||
|
- Optional: Steps, Features, Use when
|
||||||
|
4. Next Steps (optional — only if genuinely helpful)
|
||||||
|
```
|
||||||
|
|
||||||
|
**Guidelines:**
|
||||||
|
- Standardize item fields across all items in the guide
|
||||||
|
- Use tables for comparing multiple items at once
|
||||||
|
- One diagram maximum per document
|
||||||
|
- No horizontal rules — use `##` sections for separation
|
||||||
|
|
||||||
|
### General Reference Guidelines
|
||||||
|
|
||||||
|
These apply to all reference documents:
|
||||||
|
|
||||||
|
| Do | Don't |
|
||||||
|
|----|-------|
|
||||||
|
| Use `##` for major sections, `###` for items within | Use `####` headers |
|
||||||
|
| Use whitespace for separation | Use horizontal rules (`---`) |
|
||||||
|
| Link to explanation docs for "why" | Explain concepts inline |
|
||||||
|
| Use tables for structured data | Use nested lists |
|
||||||
|
| Use admonitions for important notes | Use bold paragraphs for callouts |
|
||||||
|
| Keep descriptions to 1-2 sentences | Write paragraphs of explanation |
|
||||||
|
|
||||||
|
### Reference Admonitions
|
||||||
|
|
||||||
|
Use sparingly — 1-2 maximum per reference document:
|
||||||
|
|
||||||
|
| Admonition | Use In Reference |
|
||||||
|
|------------|------------------|
|
||||||
|
| `:::note[Prerequisites]` | Dependencies needed before using |
|
||||||
|
| `:::tip[Pro Tip]` | Shortcuts or advanced usage |
|
||||||
|
| `:::caution[Important]` | Critical caveats or warnings |
|
||||||
|
|
||||||
|
### Reference Checklist
|
||||||
|
|
||||||
|
Before submitting a reference document:
|
||||||
|
|
||||||
|
- [ ] Hook clearly states what the document references
|
||||||
|
- [ ] Appropriate structure for reference type (catalog, deep-dive, etc.)
|
||||||
|
- [ ] No horizontal rules (`---`)
|
||||||
|
- [ ] No `####` headers
|
||||||
|
- [ ] No "Related" section (sidebar handles navigation)
|
||||||
|
- [ ] Items use consistent structure throughout
|
||||||
|
- [ ] Descriptions are 1-2 sentences maximum
|
||||||
|
- [ ] Tables used for structured/comparative data
|
||||||
|
- [ ] 1-2 admonitions maximum
|
||||||
|
- [ ] Links to explanation docs for conceptual depth
|
||||||
|
|
||||||
|
## Glossary Structure
|
||||||
|
|
||||||
|
Glossaries provide quick-reference definitions for project terminology. Unlike other reference documents, glossaries prioritize compact scanability over narrative explanation.
|
||||||
|
|
||||||
|
### Layout Strategy
|
||||||
|
|
||||||
|
Starlight auto-generates a right-side "On this page" navigation from headers. Use this to your advantage:
|
||||||
|
|
||||||
|
- **Categories as `##` headers** — Appear in right nav for quick jumping
|
||||||
|
- **Terms in tables** — Compact rows, not individual headers
|
||||||
|
- **No inline TOC** — Right sidebar handles navigation; inline TOC is redundant
|
||||||
|
- **Right nav shows categories only** — Cleaner than listing every term
|
||||||
|
|
||||||
|
This approach reduces content length by ~70% while improving navigation.
|
||||||
|
|
||||||
|
### Table Format
|
||||||
|
|
||||||
|
Each category uses a two-column table:
|
||||||
|
|
||||||
|
```md
|
||||||
|
## Category Name
|
||||||
|
|
||||||
|
| Term | Definition |
|
||||||
|
|------|------------|
|
||||||
|
| **Agent** | Specialized AI persona with specific expertise that guides users through workflows. |
|
||||||
|
| **Workflow** | Multi-step guided process that orchestrates AI agent activities to produce deliverables. |
|
||||||
|
```
|
||||||
|
|
||||||
|
### Definition Guidelines
|
||||||
|
|
||||||
|
| Do | Don't |
|
||||||
|
|----|-------|
|
||||||
|
| Start with what it IS or DOES | Start with "This is..." or "A [term] is..." |
|
||||||
|
| Keep to 1-2 sentences | Write multi-paragraph explanations |
|
||||||
|
| Bold the term name in the cell | Use plain text for terms |
|
||||||
|
| Link to docs for deep dives | Explain full concepts inline |
|
||||||
|
|
||||||
|
### Context Markers
|
||||||
|
|
||||||
|
For terms with limited scope, add italic context at the start of the definition:
|
||||||
|
|
||||||
|
```md
|
||||||
|
| **Tech-Spec** | *Quick Flow only.* Comprehensive technical plan for small changes. |
|
||||||
|
| **PRD** | *BMad Method/Enterprise.* Product-level planning document with vision and goals. |
|
||||||
|
```
|
||||||
|
|
||||||
|
Standard markers:
|
||||||
|
- `*Quick Flow only.*`
|
||||||
|
- `*BMad Method/Enterprise.*`
|
||||||
|
- `*Phase N.*`
|
||||||
|
- `*BMGD.*`
|
||||||
|
- `*Brownfield.*`
|
||||||
|
|
||||||
|
### Cross-References
|
||||||
|
|
||||||
|
Link related terms when helpful. Reference the category anchor since individual terms aren't headers:
|
||||||
|
|
||||||
|
```md
|
||||||
|
| **Tech-Spec** | *Quick Flow only.* Technical plan for small changes. See [PRD](#planning-documents). |
|
||||||
|
```
|
||||||
|
|
||||||
|
### Organization
|
||||||
|
|
||||||
|
- **Alphabetize terms** within each category table
|
||||||
|
- **Alphabetize categories** or order by logical progression (foundational → specific)
|
||||||
|
- **No catch-all sections** — Every term belongs in a specific category
|
||||||
|
|
||||||
|
### Glossary Checklist
|
||||||
|
|
||||||
|
Before submitting glossary changes:
|
||||||
|
|
||||||
|
- [ ] Terms in tables, not individual headers
|
||||||
|
- [ ] Terms alphabetized within each category
|
||||||
|
- [ ] No inline TOC (right nav handles navigation)
|
||||||
|
- [ ] No horizontal rules (`---`)
|
||||||
|
- [ ] Definitions are 1-2 sentences
|
||||||
|
- [ ] Context markers italicized at definition start
|
||||||
|
- [ ] Term names bolded in table cells
|
||||||
|
- [ ] No "A [term] is..." definitions
|
||||||
|
|
||||||
## Visual Hierarchy
|
## Visual Hierarchy
|
||||||
|
|
||||||
### Avoid
|
### Avoid
|
||||||
|
|
|
||||||
|
|
@ -2,12 +2,13 @@
|
||||||
title: "Workflow Customization Guide"
|
title: "Workflow Customization Guide"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
Customize and optimize workflows with step replacement and hooks.
|
Customize and optimize workflows with step replacement and hooks.
|
||||||
|
|
||||||
## Status
|
## Status
|
||||||
|
|
||||||
> **Coming Soon:** Workflow customization is an upcoming capability. This guide will be updated when the feature is available.
|
:::note[Coming Soon]
|
||||||
|
Workflow customization is an upcoming capability. This guide will be updated when the feature is available.
|
||||||
|
:::
|
||||||
|
|
||||||
## What to Expect
|
## What to Expect
|
||||||
|
|
||||||
|
|
@ -26,8 +27,4 @@ While workflow customization is in development, you can:
|
||||||
- **Customize Agents** - Modify agent behavior using [Agent Customization](/docs/how-to/customization/customize-agents.md)
|
- **Customize Agents** - Modify agent behavior using [Agent Customization](/docs/how-to/customization/customize-agents.md)
|
||||||
- **Provide Feedback** - Share your workflow customization needs with the community
|
- **Provide Feedback** - Share your workflow customization needs with the community
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
**In the meantime:** Learn how to [create custom workflows](/docs/explanation/bmad-builder/index.md) from scratch.
|
**In the meantime:** Learn how to [create custom workflows](/docs/explanation/bmad-builder/index.md) from scratch.
|
||||||
|
|
||||||
[← Back to Customization](/docs/how-to/customization/index.md)
|
|
||||||
|
|
@ -1,9 +1,8 @@
|
||||||
---
|
---
|
||||||
title: "Workflow Vendoring, Customization, and Inheritance (Official Support Coming Soon)"
|
title: "Workflow Vendoring, Customization, and Inheritance"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
Use workflow vendoring and inheritance to share or reutilize workflows across modules.
|
||||||
Vendoring and Inheritance of workflows are 2 ways of sharing or reutilizing workflows - but with some key distinctions and use cases.
|
|
||||||
|
|
||||||
## Workflow Vendoring
|
## Workflow Vendoring
|
||||||
|
|
||||||
|
|
@ -24,7 +23,11 @@ From your modules agent definition, you would implement the menu item as follows
|
||||||
|
|
||||||
At install time, it will clone the workflow and all of its required assets, and the agent that gets built will have an exec to a path installed in its own module. The content gets added to the folder you specify in exec. While it does not have to exactly match the source path, you will want to ensure you are specifying the workflow.md to be in a new location (in other words in this example, dev-story would not already be the path of another custom module workflow that already exists.)
|
At install time, it will clone the workflow and all of its required assets, and the agent that gets built will have an exec to a path installed in its own module. The content gets added to the folder you specify in exec. While it does not have to exactly match the source path, you will want to ensure you are specifying the workflow.md to be in a new location (in other words in this example, dev-story would not already be the path of another custom module workflow that already exists.)
|
||||||
|
|
||||||
## Workflow Inheritance (Official Support Coming Post Beta)
|
## Workflow Inheritance
|
||||||
|
|
||||||
|
:::note[Coming Soon]
|
||||||
|
Official support for workflow inheritance is coming post beta.
|
||||||
|
:::
|
||||||
|
|
||||||
Workflow Inheritance is a different concept, that allows you to modify or extend existing workflow.
|
Workflow Inheritance is a different concept, that allows you to modify or extend existing workflow.
|
||||||
|
|
||||||
|
|
@ -36,7 +39,11 @@ Some possible examples could be:
|
||||||
- Sprint Planning
|
- Sprint Planning
|
||||||
- Collaborative Brainstorming Sessions
|
- Collaborative Brainstorming Sessions
|
||||||
|
|
||||||
## Workflow Customization (Official Support Coming Post Beta)
|
## Workflow Customization
|
||||||
|
|
||||||
|
:::note[Coming Soon]
|
||||||
|
Official support for workflow customization is coming post beta.
|
||||||
|
:::
|
||||||
|
|
||||||
Similar to Workflow Inheritance, Workflow Customization will soon be allowed for certain workflows that are meant to be user customized - similar in process to how agents are customized now.
|
Similar to Workflow Inheritance, Workflow Customization will soon be allowed for certain workflows that are meant to be user customized - similar in process to how agents are customized now.
|
||||||
|
|
||||||
|
|
@ -2,12 +2,13 @@
|
||||||
title: "Quick Flow Solo Dev Agent (Barry)"
|
title: "Quick Flow Solo Dev Agent (Barry)"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
Barry is the elite solo developer who takes projects from concept to deployment with ruthless efficiency — no handoffs, no delays, just pure focused development.
|
||||||
|
|
||||||
**Agent ID:** `_bmad/bmm/agents/quick-flow-solo-dev.md`
|
:::note[Agent Info]
|
||||||
**Icon:** 🚀
|
- **Agent ID:** `_bmad/bmm/agents/quick-flow-solo-dev.md`
|
||||||
**Module:** BMM
|
- **Icon:** 🚀
|
||||||
|
- **Module:** BMM
|
||||||
---
|
:::
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
|
|
@ -31,8 +32,6 @@ Barry is the elite solo developer who lives and breathes the BMad Quick Flow wor
|
||||||
- Documentation happens alongside development, not after
|
- Documentation happens alongside development, not after
|
||||||
- Ship early, ship often
|
- Ship early, ship often
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Menu Commands
|
## Menu Commands
|
||||||
|
|
||||||
Barry owns the entire BMad Quick Flow path, providing a streamlined 3-step development process that eliminates handoffs and maximizes velocity.
|
Barry owns the entire BMad Quick Flow path, providing a streamlined 3-step development process that eliminates handoffs and maximizes velocity.
|
||||||
|
|
@ -61,8 +60,6 @@ Barry owns the entire BMad Quick Flow path, providing a streamlined 3-step devel
|
||||||
- **Description:** Bring in other experts when I need specialized backup
|
- **Description:** Bring in other experts when I need specialized backup
|
||||||
- **Use when:** You need collaborative problem-solving or specialized expertise
|
- **Use when:** You need collaborative problem-solving or specialized expertise
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Use Barry
|
## When to Use Barry
|
||||||
|
|
||||||
### Ideal Scenarios
|
### Ideal Scenarios
|
||||||
|
|
@ -81,8 +78,6 @@ Barry owns the entire BMad Quick Flow path, providing a streamlined 3-step devel
|
||||||
- **Proof of Concepts** - Rapid prototyping with production-quality code
|
- **Proof of Concepts** - Rapid prototyping with production-quality code
|
||||||
- **Performance Optimizations** - System improvements and scalability work
|
- **Performance Optimizations** - System improvements and scalability work
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## The BMad Quick Flow Process
|
## The BMad Quick Flow Process
|
||||||
|
|
||||||
Barry orchestrates a simple, efficient 3-step process:
|
Barry orchestrates a simple, efficient 3-step process:
|
||||||
|
|
@ -180,8 +175,6 @@ flowchart LR
|
||||||
- Security considerations
|
- Security considerations
|
||||||
- Maintainability and documentation
|
- Maintainability and documentation
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Collaboration with Other Agents
|
## Collaboration with Other Agents
|
||||||
|
|
||||||
### Natural Partnerships
|
### Natural Partnerships
|
||||||
|
|
@ -201,8 +194,6 @@ In party mode, Barry often acts as:
|
||||||
- **Performance Optimizer** - Ensuring scalable solutions
|
- **Performance Optimizer** - Ensuring scalable solutions
|
||||||
- **Code Review Authority** - Validating technical approaches
|
- **Code Review Authority** - Validating technical approaches
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Tips for Working with Barry
|
## Tips for Working with Barry
|
||||||
|
|
||||||
### For Best Results
|
### For Best Results
|
||||||
|
|
@ -228,8 +219,6 @@ In party mode, Barry often acts as:
|
||||||
4. **Over-planning** - I excel at rapid, pragmatic development
|
4. **Over-planning** - I excel at rapid, pragmatic development
|
||||||
5. **Not Using Party Mode** - Missing collaborative insights for complex problems
|
5. **Not Using Party Mode** - Missing collaborative insights for complex problems
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Example Workflow
|
## Example Workflow
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
|
@ -306,35 +295,34 @@ Implement OAuth 2.0 authentication with JWT tokens and role-based access control
|
||||||
- [ ] Given admin role, when accessing admin endpoint, then allow access
|
- [ ] Given admin role, when accessing admin endpoint, then allow access
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
## Common Questions
|
||||||
|
|
||||||
## Related Documentation
|
- [When should I use Barry vs other agents?](#when-should-i-use-barry-vs-other-agents)
|
||||||
|
- [Is the code review step mandatory?](#is-the-code-review-step-mandatory)
|
||||||
|
- [Can I skip the tech spec step?](#can-i-skip-the-tech-spec-step)
|
||||||
|
- [How does Barry differ from the Dev agent?](#how-does-barry-differ-from-the-dev-agent)
|
||||||
|
- [Can Barry handle enterprise-scale projects?](#can-barry-handle-enterprise-scale-projects)
|
||||||
|
|
||||||
- **[Quick Start Guide](/docs/tutorials/getting-started/getting-started-bmadv6.md)** - Getting started with BMM
|
### When should I use Barry vs other agents?
|
||||||
- **[Agents Guide](/docs/explanation/core-concepts/agent-roles.md)** - Complete agent reference
|
|
||||||
- **[Four Phases](/docs/explanation/architecture/four-phases.md)** - Understanding development tracks
|
|
||||||
- **[Workflow Implementation](/docs/how-to/workflows/run-sprint-planning.md)** - Implementation workflows
|
|
||||||
- **[Party Mode](/docs/explanation/features/party-mode.md)** - Multi-agent collaboration
|
|
||||||
|
|
||||||
---
|
Use Barry for Quick Flow development (small to medium features), rapid prototyping, or when you need elite solo development. For large, complex projects requiring full team collaboration, consider the full BMad Method with specialized agents.
|
||||||
|
|
||||||
## Frequently Asked Questions
|
### Is the code review step mandatory?
|
||||||
|
|
||||||
**Q: When should I use Barry vs other agents?**
|
No, it's optional but highly recommended for critical features, team projects, or when learning best practices.
|
||||||
A: Use Barry for Quick Flow development (small to medium features), rapid prototyping, or when you need elite solo development. For large, complex projects requiring full team collaboration, consider the full BMad Method with specialized agents.
|
|
||||||
|
|
||||||
**Q: Is the code review step mandatory?**
|
### Can I skip the tech spec step?
|
||||||
A: No, it's optional but highly recommended for critical features, team projects, or when learning best practices.
|
|
||||||
|
|
||||||
**Q: Can I skip the tech spec step?**
|
Yes, the quick-dev workflow accepts direct instructions. However, tech specs are recommended for complex features or team collaboration.
|
||||||
A: Yes, the quick-dev workflow accepts direct instructions. However, tech specs are recommended for complex features or team collaboration.
|
|
||||||
|
|
||||||
**Q: How does Barry differ from the Dev agent?**
|
### How does Barry differ from the Dev agent?
|
||||||
A: Barry handles the complete Quick Flow process (spec → dev → review) with elite architectural expertise, while the Dev agent specializes in pure implementation tasks. Barry is your autonomous end-to-end solution.
|
|
||||||
|
|
||||||
**Q: Can Barry handle enterprise-scale projects?**
|
Barry handles the complete Quick Flow process (spec → dev → review) with elite architectural expertise, while the Dev agent specializes in pure implementation tasks. Barry is your autonomous end-to-end solution.
|
||||||
A: For enterprise-scale projects requiring full team collaboration, consider using the Enterprise Method track. Barry is optimized for rapid delivery in the Quick Flow track where solo execution wins.
|
|
||||||
|
|
||||||
---
|
### Can Barry handle enterprise-scale projects?
|
||||||
|
|
||||||
**Ready to ship some code?** → Start with `/bmad:bmm:agents:quick-flow-solo-dev`
|
For enterprise-scale projects requiring full team collaboration, consider using the Enterprise Method track. Barry is optimized for rapid delivery in the Quick Flow track where solo execution wins.
|
||||||
|
|
||||||
|
:::tip[Ready to Ship?]
|
||||||
|
Start with `/bmad:bmm:agents:quick-flow-solo-dev`
|
||||||
|
:::
|
||||||
|
|
|
||||||
|
|
@ -3,26 +3,18 @@ title: "Understanding Agents"
|
||||||
description: Understanding BMad agents and their roles
|
description: Understanding BMad agents and their roles
|
||||||
---
|
---
|
||||||
|
|
||||||
|
Comprehensive guides to BMad's AI agents — their roles, capabilities, and how to work with them effectively.
|
||||||
Comprehensive guides to BMad's AI agents - their roles, capabilities, and how to work with them effectively.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Agent Guides
|
## Agent Guides
|
||||||
|
|
||||||
### BMM Agents
|
| Agent | Description |
|
||||||
|
|-------|-------------|
|
||||||
|
| **[Agent Roles](/docs/explanation/core-concepts/agent-roles.md)** | Overview of all BMM agent roles and responsibilities |
|
||||||
|
| **[Quick Flow Solo Dev (Barry)](/docs/explanation/agents/barry-quick-flow.md)** | The dedicated agent for rapid development |
|
||||||
|
| **[Game Development Agents](/docs/explanation/game-dev/agents.md)** | Complete guide to BMGD's specialized game dev agents |
|
||||||
|
|
||||||
- **[Agent Roles](/docs/explanation/core-concepts/agent-roles.md)** - Overview of all BMM agent roles and responsibilities
|
## Getting Started
|
||||||
- **[Quick Flow Solo Dev (Barry)](/docs/explanation/agents/barry-quick-flow.md)** - The dedicated agent for rapid development
|
|
||||||
|
|
||||||
### BMGD Agents
|
1. Read **[What Are Agents?](/docs/explanation/core-concepts/what-are-agents.md)** for the core concept explanation
|
||||||
|
2. Review **[Agent Roles](/docs/explanation/core-concepts/agent-roles.md)** to understand available agents
|
||||||
- **[Game Development Agents](/docs/explanation/game-dev/agents.md)** - Complete guide to BMGD's specialized game dev agents
|
3. Choose an agent that fits your workflow needs
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Related
|
|
||||||
|
|
||||||
- **[What Are Agents?](/docs/explanation/core-concepts/what-are-agents.md)** - Core concept explanation
|
|
||||||
- **[Party Mode](/docs/explanation/features/party-mode.md)** - Multi-agent collaboration
|
|
||||||
- **[Customize Agents](/docs/how-to/customization/customize-agents.md)** - How to customize agent behavior
|
|
||||||
|
|
|
||||||
|
|
@ -6,8 +6,6 @@ description: Understanding the four phases of the BMad Method
|
||||||
|
|
||||||
BMad Method uses a four-phase approach that adapts to project complexity while ensuring consistent quality.
|
BMad Method uses a four-phase approach that adapts to project complexity while ensuring consistent quality.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase Overview
|
## Phase Overview
|
||||||
|
|
||||||
| Phase | Name | Purpose | Required? |
|
| Phase | Name | Purpose | Required? |
|
||||||
|
|
@ -17,8 +15,6 @@ BMad Method uses a four-phase approach that adapts to project complexity while e
|
||||||
| **Phase 3** | Solutioning | Technical design | Track-dependent |
|
| **Phase 3** | Solutioning | Technical design | Track-dependent |
|
||||||
| **Phase 4** | Implementation | Building the software | Required |
|
| **Phase 4** | Implementation | Building the software | Required |
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 1: Analysis (Optional)
|
## Phase 1: Analysis (Optional)
|
||||||
|
|
||||||
Exploration and discovery workflows that help validate ideas and understand markets before planning.
|
Exploration and discovery workflows that help validate ideas and understand markets before planning.
|
||||||
|
|
@ -38,8 +34,6 @@ Exploration and discovery workflows that help validate ideas and understand mark
|
||||||
- Well-defined features
|
- Well-defined features
|
||||||
- Continuing existing work
|
- Continuing existing work
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 2: Planning (Required)
|
## Phase 2: Planning (Required)
|
||||||
|
|
||||||
Requirements definition using the scale-adaptive system to match planning depth to project complexity.
|
Requirements definition using the scale-adaptive system to match planning depth to project complexity.
|
||||||
|
|
@ -52,8 +46,6 @@ Requirements definition using the scale-adaptive system to match planning depth
|
||||||
**Key principle:**
|
**Key principle:**
|
||||||
Define **what** to build and **why**. Leave **how** to Phase 3.
|
Define **what** to build and **why**. Leave **how** to Phase 3.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 3: Solutioning (Track-Dependent)
|
## Phase 3: Solutioning (Track-Dependent)
|
||||||
|
|
||||||
Technical architecture and design decisions that prevent agent conflicts during implementation.
|
Technical architecture and design decisions that prevent agent conflicts during implementation.
|
||||||
|
|
@ -73,8 +65,6 @@ Technical architecture and design decisions that prevent agent conflicts during
|
||||||
**Key principle:**
|
**Key principle:**
|
||||||
Make technical decisions explicit so all agents implement consistently.
|
Make technical decisions explicit so all agents implement consistently.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 4: Implementation (Required)
|
## Phase 4: Implementation (Required)
|
||||||
|
|
||||||
Iterative sprint-based development with story-centric workflow.
|
Iterative sprint-based development with story-centric workflow.
|
||||||
|
|
@ -86,10 +76,9 @@ Iterative sprint-based development with story-centric workflow.
|
||||||
- `code-review` - Quality assurance
|
- `code-review` - Quality assurance
|
||||||
- `retrospective` - Continuous improvement
|
- `retrospective` - Continuous improvement
|
||||||
|
|
||||||
**Key principle:**
|
:::tip[Key Principle]
|
||||||
One story at a time, complete each story's full lifecycle before starting the next.
|
One story at a time — complete each story's full lifecycle before starting the next.
|
||||||
|
:::
|
||||||
---
|
|
||||||
|
|
||||||
## Phase Flow by Track
|
## Phase Flow by Track
|
||||||
|
|
||||||
|
|
@ -116,11 +105,3 @@ Phase 1 → Phase 2 (PRD) → Phase 3 (architecture + extended) → Phase 4 (imp
|
||||||
```
|
```
|
||||||
|
|
||||||
Same as BMad Method with optional extended workflows.
|
Same as BMad Method with optional extended workflows.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Related
|
|
||||||
|
|
||||||
- [Why Solutioning Matters](/docs/explanation/architecture/why-solutioning-matters.md)
|
|
||||||
- [Preventing Agent Conflicts](/docs/explanation/architecture/preventing-agent-conflicts.md)
|
|
||||||
- [Quick Start Guide](/docs/tutorials/getting-started/getting-started-bmadv6.md)
|
|
||||||
|
|
|
||||||
|
|
@ -6,8 +6,6 @@ description: How architecture prevents conflicts when multiple agents implement
|
||||||
|
|
||||||
When multiple AI agents implement different parts of a system, they can make conflicting technical decisions. Architecture documentation prevents this by establishing shared standards.
|
When multiple AI agents implement different parts of a system, they can make conflicting technical decisions. Architecture documentation prevents this by establishing shared standards.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Common Conflict Types
|
## Common Conflict Types
|
||||||
|
|
||||||
### API Style Conflicts
|
### API Style Conflicts
|
||||||
|
|
@ -43,8 +41,6 @@ With architecture:
|
||||||
- ADR specifies state management approach
|
- ADR specifies state management approach
|
||||||
- All agents implement consistently
|
- All agents implement consistently
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## How Architecture Prevents Conflicts
|
## How Architecture Prevents Conflicts
|
||||||
|
|
||||||
### 1. Explicit Decisions via ADRs
|
### 1. Explicit Decisions via ADRs
|
||||||
|
|
@ -70,8 +66,6 @@ Explicit documentation of:
|
||||||
- Code organization
|
- Code organization
|
||||||
- Testing patterns
|
- Testing patterns
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Architecture as Shared Context
|
## Architecture as Shared Context
|
||||||
|
|
||||||
Think of architecture as the shared context that all agents read before implementing:
|
Think of architecture as the shared context that all agents read before implementing:
|
||||||
|
|
@ -88,8 +82,6 @@ Agent C reads architecture → implements Epic 3
|
||||||
Result: Consistent implementation
|
Result: Consistent implementation
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Key ADR Topics
|
## Key ADR Topics
|
||||||
|
|
||||||
Common decisions that prevent conflicts:
|
Common decisions that prevent conflicts:
|
||||||
|
|
@ -103,36 +95,17 @@ Common decisions that prevent conflicts:
|
||||||
| Styling | CSS Modules vs Tailwind vs Styled Components |
|
| Styling | CSS Modules vs Tailwind vs Styled Components |
|
||||||
| Testing | Jest + Playwright vs Vitest + Cypress |
|
| Testing | Jest + Playwright vs Vitest + Cypress |
|
||||||
|
|
||||||
---
|
## Anti-Patterns to Avoid
|
||||||
|
|
||||||
## Anti-Patterns
|
:::caution[Common Mistakes]
|
||||||
|
- **Implicit Decisions** — "We'll figure out the API style as we go" leads to inconsistency
|
||||||
### ❌ Implicit Decisions
|
- **Over-Documentation** — Documenting every minor choice causes analysis paralysis
|
||||||
|
- **Stale Architecture** — Documents written once and never updated cause agents to follow outdated patterns
|
||||||
"We'll figure out the API style as we go"
|
:::
|
||||||
→ Leads to inconsistency
|
|
||||||
|
|
||||||
### ❌ Over-Documentation
|
|
||||||
|
|
||||||
Every minor choice documented
|
|
||||||
→ Analysis paralysis, wasted time
|
|
||||||
|
|
||||||
### ❌ Stale Architecture
|
|
||||||
|
|
||||||
Document written once, never updated
|
|
||||||
→ Agents follow outdated patterns
|
|
||||||
|
|
||||||
### ✅ Correct Approach
|
|
||||||
|
|
||||||
|
:::tip[Correct Approach]
|
||||||
- Document decisions that cross epic boundaries
|
- Document decisions that cross epic boundaries
|
||||||
- Focus on conflict-prone areas
|
- Focus on conflict-prone areas
|
||||||
- Update architecture as you learn
|
- Update architecture as you learn
|
||||||
- Use `correct-course` for significant changes
|
- Use `correct-course` for significant changes
|
||||||
|
:::
|
||||||
---
|
|
||||||
|
|
||||||
## Related
|
|
||||||
|
|
||||||
- [Why Solutioning Matters](/docs/explanation/architecture/why-solutioning-matters.md)
|
|
||||||
- [Four Phases](/docs/explanation/architecture/four-phases.md)
|
|
||||||
- [Create Architecture](/docs/how-to/workflows/create-architecture.md)
|
|
||||||
|
|
|
||||||
|
|
@ -6,8 +6,6 @@ description: Understanding why the solutioning phase is critical for multi-epic
|
||||||
|
|
||||||
Phase 3 (Solutioning) translates **what** to build (from Planning) into **how** to build it (technical design). This phase prevents agent conflicts in multi-epic projects by documenting architectural decisions before implementation begins.
|
Phase 3 (Solutioning) translates **what** to build (from Planning) into **how** to build it (technical design). This phase prevents agent conflicts in multi-epic projects by documenting architectural decisions before implementation begins.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## The Problem Without Solutioning
|
## The Problem Without Solutioning
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
@ -18,8 +16,6 @@ Result: Inconsistent API design, integration nightmare
|
||||||
|
|
||||||
When multiple agents implement different parts of a system without shared architectural guidance, they make independent technical decisions that may conflict.
|
When multiple agents implement different parts of a system without shared architectural guidance, they make independent technical decisions that may conflict.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## The Solution With Solutioning
|
## The Solution With Solutioning
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
@ -30,8 +26,6 @@ Result: Consistent implementation, no conflicts
|
||||||
|
|
||||||
By documenting technical decisions explicitly, all agents implement consistently and integration becomes straightforward.
|
By documenting technical decisions explicitly, all agents implement consistently and integration becomes straightforward.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Solutioning vs Planning
|
## Solutioning vs Planning
|
||||||
|
|
||||||
| Aspect | Planning (Phase 2) | Solutioning (Phase 3) |
|
| Aspect | Planning (Phase 2) | Solutioning (Phase 3) |
|
||||||
|
|
@ -43,8 +37,6 @@ By documenting technical decisions explicitly, all agents implement consistently
|
||||||
| Document | PRD (FRs/NFRs) | Architecture + Epic Files |
|
| Document | PRD (FRs/NFRs) | Architecture + Epic Files |
|
||||||
| Level | Business logic | Technical design + Work breakdown |
|
| Level | Business logic | Technical design + Work breakdown |
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Key Principle
|
## Key Principle
|
||||||
|
|
||||||
**Make technical decisions explicit and documented** so all agents implement consistently.
|
**Make technical decisions explicit and documented** so all agents implement consistently.
|
||||||
|
|
@ -56,8 +48,6 @@ This prevents:
|
||||||
- Naming convention mismatches
|
- Naming convention mismatches
|
||||||
- Security approach variations
|
- Security approach variations
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When Solutioning is Required
|
## When Solutioning is Required
|
||||||
|
|
||||||
| Track | Solutioning Required? |
|
| Track | Solutioning Required? |
|
||||||
|
|
@ -67,9 +57,9 @@ This prevents:
|
||||||
| BMad Method Complex | Yes |
|
| BMad Method Complex | Yes |
|
||||||
| Enterprise | Yes |
|
| Enterprise | Yes |
|
||||||
|
|
||||||
**Rule of thumb:** If you have multiple epics that could be implemented by different agents, you need solutioning.
|
:::tip[Rule of Thumb]
|
||||||
|
If you have multiple epics that could be implemented by different agents, you need solutioning.
|
||||||
---
|
:::
|
||||||
|
|
||||||
## The Cost of Skipping
|
## The Cost of Skipping
|
||||||
|
|
||||||
|
|
@ -80,12 +70,6 @@ Skipping solutioning on complex projects leads to:
|
||||||
- **Longer development time** overall
|
- **Longer development time** overall
|
||||||
- **Technical debt** from inconsistent patterns
|
- **Technical debt** from inconsistent patterns
|
||||||
|
|
||||||
|
:::caution[Cost Multiplier]
|
||||||
Catching alignment issues in solutioning is 10× faster than discovering them during implementation.
|
Catching alignment issues in solutioning is 10× faster than discovering them during implementation.
|
||||||
|
:::
|
||||||
---
|
|
||||||
|
|
||||||
## Related
|
|
||||||
|
|
||||||
- [Four Phases](/docs/explanation/architecture/four-phases.md) - Overview of all phases
|
|
||||||
- [Preventing Agent Conflicts](/docs/explanation/architecture/preventing-agent-conflicts.md) - Detailed conflict prevention
|
|
||||||
- [Create Architecture](/docs/how-to/workflows/create-architecture.md) - How to do it
|
|
||||||
|
|
|
||||||
|
|
@ -2,10 +2,13 @@
|
||||||
title: "Custom Content"
|
title: "Custom Content"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
BMad supports several categories of custom content that extend the platform's capabilities — from simple personal agents to full-featured professional modules.
|
||||||
|
|
||||||
BMad supports several categories of officially supported custom content that extend the platform's capabilities. Custom content can be created manually or with the recommended assistance of the BMad Builder (BoMB) Module. The BoMB Agents provides workflows and expertise to plan and build any custom content you can imagine.
|
:::tip[Recommended Approach]
|
||||||
|
Use the BMad Builder (BoMB) Module for guided workflows and expertise when creating custom content.
|
||||||
|
:::
|
||||||
|
|
||||||
This flexibility transforms the platform beyond its current capabilities, enabling:
|
This flexibility enables:
|
||||||
|
|
||||||
- Extensions and add-ons for existing modules (BMad Method, Creative Intelligence Suite)
|
- Extensions and add-ons for existing modules (BMad Method, Creative Intelligence Suite)
|
||||||
- Completely new modules, workflows, templates, and agents outside software engineering
|
- Completely new modules, workflows, templates, and agents outside software engineering
|
||||||
|
|
@ -96,7 +99,9 @@ The distinction between simple and expert agents lies in their structure:
|
||||||
- When installed, the sidecar folder (`[agentname]-sidecar`) is placed in the user memory location
|
- When installed, the sidecar folder (`[agentname]-sidecar`) is placed in the user memory location
|
||||||
- has metadata type: expert
|
- has metadata type: expert
|
||||||
|
|
||||||
|
:::note[Key Distinction]
|
||||||
The key distinction is the presence of a sidecar folder. As web and consumer agent tools evolve to support common memory mechanisms, storage formats, and MCP, the writable memory files will adapt to support these evolving standards.
|
The key distinction is the presence of a sidecar folder. As web and consumer agent tools evolve to support common memory mechanisms, storage formats, and MCP, the writable memory files will adapt to support these evolving standards.
|
||||||
|
:::
|
||||||
|
|
||||||
Custom agents can be:
|
Custom agents can be:
|
||||||
|
|
||||||
|
|
@ -117,4 +122,6 @@ A custom workflow created outside of a larger module can still be distributed an
|
||||||
- Slash commands
|
- Slash commands
|
||||||
- Manual command/prompt execution when supported by tools
|
- Manual command/prompt execution when supported by tools
|
||||||
|
|
||||||
|
:::tip[Core Concept]
|
||||||
At its core, a custom workflow is a single or series of prompts designed to achieve a specific outcome.
|
At its core, a custom workflow is a single or series of prompts designed to achieve a specific outcome.
|
||||||
|
:::
|
||||||
|
|
|
||||||
|
|
@ -3,64 +3,43 @@ title: "BMad Builder (BMB)"
|
||||||
description: Create custom agents, workflows, and modules for BMad
|
description: Create custom agents, workflows, and modules for BMad
|
||||||
---
|
---
|
||||||
|
|
||||||
|
Create custom agents, workflows, and modules for BMad — from simple personal assistants to full-featured professional tools.
|
||||||
Create custom agents, workflows, and modules for BMad.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Quick Start
|
## Quick Start
|
||||||
|
|
||||||
- **[Agent Creation Guide](/docs/tutorials/advanced/create-custom-agent.md)** - Step-by-step guide to building your first agent
|
| Resource | Description |
|
||||||
|
|----------|-------------|
|
||||||
---
|
| **[Agent Creation Guide](/docs/tutorials/advanced/create-custom-agent.md)** | Step-by-step guide to building your first agent |
|
||||||
|
| **[Install Custom Modules](/docs/how-to/installation/install-custom-modules.md)** | Installing standalone simple and expert agents |
|
||||||
|
|
||||||
## Agent Architecture
|
## Agent Architecture
|
||||||
|
|
||||||
Comprehensive guides for each agent type:
|
| Type | Description |
|
||||||
|
|------|-------------|
|
||||||
- **Simple Agent Architecture** - Self-contained, optimized, personality-driven
|
| **Simple Agent** | Self-contained, optimized, personality-driven |
|
||||||
- **Expert Agent Architecture** - Memory, sidecar files, domain restrictions
|
| **Expert Agent** | Memory, sidecar files, domain restrictions |
|
||||||
- **Module Agent Architecture** - Workflow integration, professional tools
|
| **Module Agent** | Workflow integration, professional tools |
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Key Concepts
|
## Key Concepts
|
||||||
|
|
||||||
### YAML to XML Compilation
|
|
||||||
|
|
||||||
Agents are authored in YAML with Handlebars templating. The compiler auto-injects:
|
Agents are authored in YAML with Handlebars templating. The compiler auto-injects:
|
||||||
|
|
||||||
1. **Frontmatter** - Name and description from metadata
|
1. **Frontmatter** — Name and description from metadata
|
||||||
2. **Activation Block** - Steps, menu handlers, rules
|
2. **Activation Block** — Steps, menu handlers, rules
|
||||||
3. **Menu Enhancement** - `*help` and `*exit` commands added automatically
|
3. **Menu Enhancement** — `*help` and `*exit` commands added automatically
|
||||||
4. **Trigger Prefixing** - Your triggers auto-prefixed with `*`
|
4. **Trigger Prefixing** — Your triggers auto-prefixed with `*`
|
||||||
|
|
||||||
---
|
:::note[Learn More]
|
||||||
|
See [Custom Content Types](/docs/explanation/bmad-builder/custom-content-types.md) for detailed explanations of all content categories.
|
||||||
|
:::
|
||||||
|
|
||||||
## Reference Examples
|
## Reference Examples
|
||||||
|
|
||||||
Production-ready examples available in the BMB reference folder:
|
Production-ready examples available in the BMB reference folder:
|
||||||
|
|
||||||
### Simple Agents
|
| Agent | Type | Description |
|
||||||
- **commit-poet** - Commit message artisan with style customization
|
|-------|------|-------------|
|
||||||
|
| **commit-poet** | Simple | Commit message artisan with style customization |
|
||||||
### Expert Agents
|
| **journal-keeper** | Expert | Personal journal companion with memory and pattern recognition |
|
||||||
- **journal-keeper** - Personal journal companion with memory and pattern recognition
|
| **security-engineer** | Module | BMM security specialist with threat modeling |
|
||||||
|
| **trend-analyst** | Module | CIS trend intelligence expert |
|
||||||
### Module Agents
|
|
||||||
- **security-engineer** - BMM security specialist with threat modeling
|
|
||||||
- **trend-analyst** - CIS trend intelligence expert
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Installation Guide
|
|
||||||
|
|
||||||
For installing standalone simple and expert agents, see:
|
|
||||||
- [Install Custom Modules](/docs/how-to/installation/install-custom-modules.md)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Related
|
|
||||||
|
|
||||||
- [Custom Content Types](/docs/explanation/bmad-builder/custom-content-types.md) - Understanding content types
|
|
||||||
- [Create Custom Agent](/docs/tutorials/advanced/create-custom-agent.md) - Tutorial
|
|
||||||
|
|
|
||||||
|
|
@ -2,28 +2,22 @@
|
||||||
title: "BMM Documentation"
|
title: "BMM Documentation"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
Complete guides for the BMad Method Module (BMM) — AI-powered agile development workflows that adapt to your project's complexity.
|
||||||
|
|
||||||
Complete guides for the BMad Method Module (BMM) - AI-powered agile development workflows that adapt to your project's complexity.
|
## Getting Started
|
||||||
|
|
||||||
---
|
:::tip[Quick Path]
|
||||||
|
Install → workflow-init → Follow agent guidance
|
||||||
## 🚀 Getting Started
|
:::
|
||||||
|
|
||||||
**New to BMM?** Start here:
|
**New to BMM?** Start here:
|
||||||
|
|
||||||
- **[Quick Start Guide](/docs/tutorials/getting-started/getting-started-bmadv6.md)** - Step-by-step guide to building your first project
|
| Resource | Description |
|
||||||
- Installation and setup
|
|----------|-------------|
|
||||||
- Understanding the four phases
|
| **[Quick Start Guide](/docs/tutorials/getting-started/getting-started-bmadv6.md)** | Step-by-step guide to building your first project |
|
||||||
- Running your first workflows
|
| **[Complete Workflow Diagram](../../tutorials/getting-started/images/workflow-method-greenfield.svg)** | Visual flowchart showing all phases, agents, and decision points |
|
||||||
- Agent-based development flow
|
|
||||||
|
|
||||||
**Quick Path:** Install → workflow-init → Follow agent guidance
|
## Core Concepts
|
||||||
|
|
||||||
### 📊 Visual Overview
|
|
||||||
|
|
||||||
**[Complete Workflow Diagram](../../tutorials/getting-started/images/workflow-method-greenfield.svg)** - Visual flowchart showing all phases, agents (color-coded), and decision points for the BMad Method standard greenfield track.
|
|
||||||
|
|
||||||
## 📖 Core Concepts
|
|
||||||
|
|
||||||
The BMad Method is meant to be adapted and customized to your specific needs. In this realm there is no one size fits all - your needs are unique, and BMad Method is meant to support this (and if it does not, can be further customized or extended with new modules).
|
The BMad Method is meant to be adapted and customized to your specific needs. In this realm there is no one size fits all - your needs are unique, and BMad Method is meant to support this (and if it does not, can be further customized or extended with new modules).
|
||||||
|
|
||||||
|
|
@ -45,7 +39,7 @@ First know there is the full BMad Method Process and then there is a Quick Flow
|
||||||
|
|
||||||
- **TEA engagement (optional)** - Choose TEA engagement: none, TEA-only (standalone), or integrated by track. See **[Test Architect Guide](/docs/explanation/features/tea-overview.md)**.
|
- **TEA engagement (optional)** - Choose TEA engagement: none, TEA-only (standalone), or integrated by track. See **[Test Architect Guide](/docs/explanation/features/tea-overview.md)**.
|
||||||
|
|
||||||
## 🤖 Agents and Collaboration
|
## Agents and Collaboration
|
||||||
|
|
||||||
Complete guide to BMM's AI agent team:
|
Complete guide to BMM's AI agent team:
|
||||||
|
|
||||||
|
|
@ -63,7 +57,7 @@ Complete guide to BMM's AI agent team:
|
||||||
- Agent customization in party mode
|
- Agent customization in party mode
|
||||||
- Best practices
|
- Best practices
|
||||||
|
|
||||||
## 🔧 Working with Existing Code
|
## Working with Existing Code
|
||||||
|
|
||||||
Comprehensive guide for brownfield development:
|
Comprehensive guide for brownfield development:
|
||||||
|
|
||||||
|
|
@ -74,14 +68,14 @@ Comprehensive guide for brownfield development:
|
||||||
- Phase-by-phase workflow guidance
|
- Phase-by-phase workflow guidance
|
||||||
- Common scenarios
|
- Common scenarios
|
||||||
|
|
||||||
## 📚 Quick References
|
## Quick References
|
||||||
|
|
||||||
Essential reference materials:
|
Essential reference materials:
|
||||||
|
|
||||||
- **[Glossary](/docs/reference/glossary/index.md)** - Key terminology and concepts
|
- **[Glossary](/docs/reference/glossary/index.md)** - Key terminology and concepts
|
||||||
- **[FAQ](/docs/explanation/faq/index.md)** - Frequently asked questions across all topics
|
- **[FAQ](/docs/explanation/faq/index.md)** - Frequently asked questions across all topics
|
||||||
|
|
||||||
## 🎯 Choose Your Path
|
## Choose Your Path
|
||||||
|
|
||||||
### I need to...
|
### I need to...
|
||||||
|
|
||||||
|
|
@ -95,7 +89,7 @@ Essential reference materials:
|
||||||
→ Read [Brownfield Development Guide](/docs/how-to/brownfield/index.md)
|
→ Read [Brownfield Development Guide](/docs/how-to/brownfield/index.md)
|
||||||
→ Pay special attention to documentation requirements for brownfield projects
|
→ Pay special attention to documentation requirements for brownfield projects
|
||||||
|
|
||||||
## 📋 Workflow Guides
|
## Workflow Guides
|
||||||
|
|
||||||
Comprehensive documentation for all BMM workflows organized by phase:
|
Comprehensive documentation for all BMM workflows organized by phase:
|
||||||
|
|
||||||
|
|
@ -124,7 +118,7 @@ Comprehensive documentation for all BMM workflows organized by phase:
|
||||||
- Test strategy, automation, quality gates
|
- Test strategy, automation, quality gates
|
||||||
- TEA agent and test healing
|
- TEA agent and test healing
|
||||||
|
|
||||||
## 🌐 External Resources
|
## External Resources
|
||||||
|
|
||||||
### Community and Support
|
### Community and Support
|
||||||
|
|
||||||
|
|
@ -132,4 +126,6 @@ Comprehensive documentation for all BMM workflows organized by phase:
|
||||||
- **[GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues)** - Report bugs or request features
|
- **[GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues)** - Report bugs or request features
|
||||||
- **[YouTube Channel](https://www.youtube.com/@BMadCode)** - Video tutorials and walkthroughs
|
- **[YouTube Channel](https://www.youtube.com/@BMadCode)** - Video tutorials and walkthroughs
|
||||||
|
|
||||||
**Ready to begin?** → [Start with the Quick Start Guide](/docs/tutorials/getting-started/getting-started-bmadv6.md)
|
:::tip[Ready to Begin?]
|
||||||
|
[Start with the Quick Start Guide](/docs/tutorials/getting-started/getting-started-bmadv6.md)
|
||||||
|
:::
|
||||||
|
|
|
||||||
|
|
@ -3,11 +3,8 @@ title: "Agent Roles in BMad Method"
|
||||||
description: Understanding the different agent roles in BMad Method
|
description: Understanding the different agent roles in BMad Method
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
BMad Method uses specialized AI agents, each with a distinct role, expertise, and personality. Understanding these roles helps you know which agent to use for each task.
|
BMad Method uses specialized AI agents, each with a distinct role, expertise, and personality. Understanding these roles helps you know which agent to use for each task.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Core Agents Overview
|
## Core Agents Overview
|
||||||
|
|
||||||
| Agent | Role | Primary Phase |
|
| Agent | Role | Primary Phase |
|
||||||
|
|
@ -21,8 +18,6 @@ BMad Method uses specialized AI agents, each with a distinct role, expertise, an
|
||||||
| **UX Designer** | User experience | Phase 2-3 |
|
| **UX Designer** | User experience | Phase 2-3 |
|
||||||
| **Quick Flow Solo Dev** | Fast solo development | All phases (Quick Flow) |
|
| **Quick Flow Solo Dev** | Fast solo development | All phases (Quick Flow) |
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 1: Analysis
|
## Phase 1: Analysis
|
||||||
|
|
||||||
### Analyst (Mary)
|
### Analyst (Mary)
|
||||||
|
|
@ -43,8 +38,6 @@ Business analysis and research specialist.
|
||||||
|
|
||||||
**When to use:** Starting new projects, exploring ideas, validating market fit, documenting existing codebases.
|
**When to use:** Starting new projects, exploring ideas, validating market fit, documenting existing codebases.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 2: Planning
|
## Phase 2: Planning
|
||||||
|
|
||||||
### PM (John)
|
### PM (John)
|
||||||
|
|
@ -80,8 +73,6 @@ User experience and UI design specialist.
|
||||||
|
|
||||||
**When to use:** When UX is a primary differentiator, complex user workflows, design system creation.
|
**When to use:** When UX is a primary differentiator, complex user workflows, design system creation.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 3: Solutioning
|
## Phase 3: Solutioning
|
||||||
|
|
||||||
### Architect (Winston)
|
### Architect (Winston)
|
||||||
|
|
@ -100,8 +91,6 @@ System architecture and technical design expert.
|
||||||
|
|
||||||
**When to use:** Multi-epic projects, cross-cutting technical decisions, preventing agent conflicts.
|
**When to use:** Multi-epic projects, cross-cutting technical decisions, preventing agent conflicts.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 4: Implementation
|
## Phase 4: Implementation
|
||||||
|
|
||||||
### SM (Bob)
|
### SM (Bob)
|
||||||
|
|
@ -138,8 +127,6 @@ Story implementation and code review specialist.
|
||||||
|
|
||||||
**When to use:** Writing code, implementing stories, reviewing quality.
|
**When to use:** Writing code, implementing stories, reviewing quality.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Cross-Phase Agents
|
## Cross-Phase Agents
|
||||||
|
|
||||||
### TEA (Murat)
|
### TEA (Murat)
|
||||||
|
|
@ -159,8 +146,6 @@ Test architecture and quality strategy expert.
|
||||||
|
|
||||||
**When to use:** Setting up testing, creating test plans, quality gates.
|
**When to use:** Setting up testing, creating test plans, quality gates.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Quick Flow
|
## Quick Flow
|
||||||
|
|
||||||
### Quick Flow Solo Dev (Barry)
|
### Quick Flow Solo Dev (Barry)
|
||||||
|
|
@ -179,8 +164,6 @@ Fast solo development without handoffs.
|
||||||
|
|
||||||
**When to use:** Bug fixes, small features, rapid prototyping.
|
**When to use:** Bug fixes, small features, rapid prototyping.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Choosing the Right Agent
|
## Choosing the Right Agent
|
||||||
|
|
||||||
| Task | Agent |
|
| Task | Agent |
|
||||||
|
|
@ -194,11 +177,3 @@ Fast solo development without handoffs.
|
||||||
| Writing code | DEV |
|
| Writing code | DEV |
|
||||||
| Setting up tests | TEA |
|
| Setting up tests | TEA |
|
||||||
| Quick bug fix | Quick Flow Solo Dev |
|
| Quick bug fix | Quick Flow Solo Dev |
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Related
|
|
||||||
|
|
||||||
- [What Are Agents](/docs/explanation/core-concepts/what-are-agents.md) - Foundational concepts
|
|
||||||
- [Agent Reference](/docs/reference/agents/index.md) - Complete command reference
|
|
||||||
- [Quick Start Guide](/docs/tutorials/getting-started/getting-started-bmadv6.md)
|
|
||||||
|
|
|
||||||
|
|
@ -2,7 +2,6 @@
|
||||||
title: "BMad Core Concepts"
|
title: "BMad Core Concepts"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
Understanding the fundamental building blocks of the BMad Method.
|
Understanding the fundamental building blocks of the BMad Method.
|
||||||
|
|
||||||
## The Essentials
|
## The Essentials
|
||||||
|
|
@ -34,7 +33,3 @@ Start here to understand what BMad is and how it works:
|
||||||
### Advanced
|
### Advanced
|
||||||
|
|
||||||
- **[Web Bundles](/docs/explanation/features/web-bundles.md)** - Use BMad in Gemini Gems and Custom GPTs
|
- **[Web Bundles](/docs/explanation/features/web-bundles.md)** - Use BMad in Gemini Gems and Custom GPTs
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
**Next:** Read the [Agents Guide](/docs/explanation/core-concepts/what-are-agents.md) to understand the core building block of BMad.
|
|
||||||
|
|
|
||||||
|
|
@ -2,7 +2,6 @@
|
||||||
title: "Agents"
|
title: "Agents"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
Agents are AI assistants that help you accomplish tasks. Each agent has a unique personality, specialized capabilities, and an interactive menu.
|
Agents are AI assistants that help you accomplish tasks. Each agent has a unique personality, specialized capabilities, and an interactive menu.
|
||||||
|
|
||||||
## Agent Types
|
## Agent Types
|
||||||
|
|
@ -72,6 +71,10 @@ All agents share these building blocks:
|
||||||
|
|
||||||
## Which Should You Use?
|
## Which Should You Use?
|
||||||
|
|
||||||
|
:::tip[Quick Decision]
|
||||||
|
Choose **Simple** for focused, one-off tasks with no memory needs. Choose **Expert** when you need persistent context and complex workflows.
|
||||||
|
:::
|
||||||
|
|
||||||
**Choose Simple when:**
|
**Choose Simple when:**
|
||||||
- You need a task done quickly and reliably
|
- You need a task done quickly and reliably
|
||||||
- The scope is well-defined and won't change much
|
- The scope is well-defined and won't change much
|
||||||
|
|
@ -90,7 +93,3 @@ BMad provides the **BMad Builder (BMB)** module for creating your own agents. Se
|
||||||
## Customizing Existing Agents
|
## Customizing Existing Agents
|
||||||
|
|
||||||
You can modify any agent's behavior without editing core files. See [BMad Customization](/docs/how-to/customization/index.md) for details. It is critical to never modify an installed agents .md file directly and follow the customization process, this way future updates to the agent or module its part of will continue to be updated and recompiled with the installer tool, and your customizations will still be retained.
|
You can modify any agent's behavior without editing core files. See [BMad Customization](/docs/how-to/customization/index.md) for details. It is critical to never modify an installed agents .md file directly and follow the customization process, this way future updates to the agent or module its part of will continue to be updated and recompiled with the installer tool, and your customizations will still be retained.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
**Next:** Learn about [Workflows](/docs/explanation/core-concepts/what-are-workflows.md) to see how agents accomplish complex tasks.
|
|
||||||
|
|
|
||||||
|
|
@ -2,7 +2,6 @@
|
||||||
title: "Modules"
|
title: "Modules"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
Modules are organized collections of agents and workflows that solve specific problems or address particular domains.
|
Modules are organized collections of agents and workflows that solve specific problems or address particular domains.
|
||||||
|
|
||||||
## What is a Module?
|
## What is a Module?
|
||||||
|
|
@ -16,6 +15,10 @@ A module is a self-contained package that includes:
|
||||||
|
|
||||||
## Official Modules
|
## Official Modules
|
||||||
|
|
||||||
|
:::note[Core is Always Installed]
|
||||||
|
The Core module is automatically included with every BMad installation. It provides the foundation that other modules build upon.
|
||||||
|
:::
|
||||||
|
|
||||||
### Core Module
|
### Core Module
|
||||||
Always installed, provides shared functionality:
|
Always installed, provides shared functionality:
|
||||||
- Global configuration
|
- Global configuration
|
||||||
|
|
@ -73,7 +76,3 @@ Custom modules are installed the same way as official modules.
|
||||||
During BMad installation, you choose which modules to install. You can also add or remove modules later by re-running the installer.
|
During BMad installation, you choose which modules to install. You can also add or remove modules later by re-running the installer.
|
||||||
|
|
||||||
See [Installation Guide](/docs/how-to/installation/index.md) for details.
|
See [Installation Guide](/docs/how-to/installation/index.md) for details.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
**Next:** Read the [Installation Guide](/docs/how-to/installation/index.md) to set up BMad with the modules you need.
|
|
||||||
|
|
|
||||||
|
|
@ -2,13 +2,10 @@
|
||||||
title: "Workflows"
|
title: "Workflows"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
Workflows are like prompts on steroids. They harness the untapped power and control of LLMs through progressive disclosure—breaking complex tasks into focused steps that execute sequentially. Instead of random AI slop where you hope for the best, workflows give you repeatable, reliable, high-quality outputs.
|
Workflows are like prompts on steroids. They harness the untapped power and control of LLMs through progressive disclosure—breaking complex tasks into focused steps that execute sequentially. Instead of random AI slop where you hope for the best, workflows give you repeatable, reliable, high-quality outputs.
|
||||||
|
|
||||||
This guide explains what workflows are, why they're powerful, and how to think about designing them.
|
This guide explains what workflows are, why they're powerful, and how to think about designing them.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## What Is a Workflow?
|
## What Is a Workflow?
|
||||||
|
|
||||||
A workflow is a structured process where the AI executes steps sequentially to accomplish a task. Each step has a specific purpose, and the AI moves through them methodically—whether that involves extensive collaboration or minimal user interaction.
|
A workflow is a structured process where the AI executes steps sequentially to accomplish a task. Each step has a specific purpose, and the AI moves through them methodically—whether that involves extensive collaboration or minimal user interaction.
|
||||||
|
|
@ -71,9 +68,9 @@ When workflows involve users, they should be **facilitative, not directive**. Th
|
||||||
|
|
||||||
The AI figures out exact wording and question order based on conversation context. This makes interactions feel natural and responsive rather than robotic and interrogative.
|
The AI figures out exact wording and question order based on conversation context. This makes interactions feel natural and responsive rather than robotic and interrogative.
|
||||||
|
|
||||||
**When to be prescriptive**: Some workflows require exact scripts—medical intake, legal compliance, safety-critical procedures. But these are the exception, not the rule. Default to facilitative intent-based approaches unless compliance or regulation demands otherwise.
|
:::caution[When to Be Prescriptive]
|
||||||
|
Some workflows require exact scripts—medical intake, legal compliance, safety-critical procedures. But these are the exception. Default to facilitative intent-based approaches unless compliance or regulation demands otherwise.
|
||||||
---
|
:::
|
||||||
|
|
||||||
## Why Workflows Matter
|
## Why Workflows Matter
|
||||||
|
|
||||||
|
|
@ -85,8 +82,6 @@ Workflows solve three fundamental problems with AI interactions:
|
||||||
|
|
||||||
**Quality**: Sequential enforcement prevents shortcuts. The AI must complete each step fully before moving on, ensuring thorough, complete outputs instead of rushed, half-baked results.
|
**Quality**: Sequential enforcement prevents shortcuts. The AI must complete each step fully before moving on, ensuring thorough, complete outputs instead of rushed, half-baked results.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## How Workflows Work
|
## How Workflows Work
|
||||||
|
|
||||||
### The Basic Structure
|
### The Basic Structure
|
||||||
|
|
@ -150,8 +145,6 @@ All BMad planning workflows and the BMB module (will) use this tri-modal pattern
|
||||||
|
|
||||||
This tri-modal approach gives you the best of both worlds: the creativity and flexibility to build what you need, the quality assurance of validation that can run anytime, and the ability to iterate while staying true to standards that make the artifacts valuable across sessions and team members.
|
This tri-modal approach gives you the best of both worlds: the creativity and flexibility to build what you need, the quality assurance of validation that can run anytime, and the ability to iterate while staying true to standards that make the artifacts valuable across sessions and team members.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Design Decisions
|
## Design Decisions
|
||||||
|
|
||||||
Before building a workflow, answer these questions:
|
Before building a workflow, answer these questions:
|
||||||
|
|
@ -166,8 +159,6 @@ Before building a workflow, answer these questions:
|
||||||
|
|
||||||
**Intent or prescriptive?**: Is this intent-based facilitation (most workflows) or prescriptive compliance (medical, legal, regulated)?
|
**Intent or prescriptive?**: Is this intent-based facilitation (most workflows) or prescriptive compliance (medical, legal, regulated)?
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Learning from Examples
|
## Learning from Examples
|
||||||
|
|
||||||
The best way to understand workflows is to study real examples. Look at the official BMad modules:
|
The best way to understand workflows is to study real examples. Look at the official BMad modules:
|
||||||
|
|
@ -181,8 +172,6 @@ Study the workflow.md files to understand how each workflow starts. Examine step
|
||||||
|
|
||||||
Copy patterns that work. Adapt them to your domain. The structure is consistent across all workflows—the content and steps change, but the architecture stays the same.
|
Copy patterns that work. Adapt them to your domain. The structure is consistent across all workflows—the content and steps change, but the architecture stays the same.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Use Workflows
|
## When to Use Workflows
|
||||||
|
|
||||||
Use workflows when:
|
Use workflows when:
|
||||||
|
|
@ -206,8 +195,6 @@ Modified BMad Workflows
|
||||||
If there's only one thing to do and it can be explained in under about 300 lines - don't bother with step files. Instead, you can still have
|
If there's only one thing to do and it can be explained in under about 300 lines - don't bother with step files. Instead, you can still have
|
||||||
a short single file workflow.md file.
|
a short single file workflow.md file.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## The Bottom Line
|
## The Bottom Line
|
||||||
|
|
||||||
Workflows transform AI from a tool that gives variable, unpredictable results into a reliable system for complex, multi-step processes. Through progressive disclosure, sequential execution, guided facilitation, and thoughtful design, workflows give you control and repeatability that ad-hoc prompting alone can't match.
|
Workflows transform AI from a tool that gives variable, unpredictable results into a reliable system for complex, multi-step processes. Through progressive disclosure, sequential execution, guided facilitation, and thoughtful design, workflows give you control and repeatability that ad-hoc prompting alone can't match.
|
||||||
|
|
|
||||||
|
|
@ -14,5 +14,5 @@ The Core Module is installed with all installations of BMad modules and provides
|
||||||
- [Advanced Elicitation](/docs/explanation/features/advanced-elicitation.md) — LLM rethinking with 50+ reasoning methods
|
- [Advanced Elicitation](/docs/explanation/features/advanced-elicitation.md) — LLM rethinking with 50+ reasoning methods
|
||||||
- **[Core Tasks](/docs/reference/configuration/core-tasks.md)** — Common tasks available across modules
|
- **[Core Tasks](/docs/reference/configuration/core-tasks.md)** — Common tasks available across modules
|
||||||
- [Index Docs](/docs/reference/configuration/core-tasks.md#index-docs) — Generate directory index files
|
- [Index Docs](/docs/reference/configuration/core-tasks.md#index-docs) — Generate directory index files
|
||||||
- [Adversarial Review](/docs/reference/configuration/core-tasks.md#adversarial-review-general) — Critical content review
|
- [Adversarial Review](/docs/reference/configuration/core-tasks.md#adversarial-review) — Critical content review
|
||||||
- [Shard Document](/docs/reference/configuration/core-tasks.md#shard-document) — Split large documents into sections
|
- [Shard Document](/docs/reference/configuration/core-tasks.md#shard-document) — Split large documents into sections
|
||||||
|
|
|
||||||
|
|
@ -3,17 +3,12 @@ title: "Creative Intelligence Suite (CIS)"
|
||||||
description: AI-powered creative facilitation with the Creative Intelligence Suite
|
description: AI-powered creative facilitation with the Creative Intelligence Suite
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
AI-powered creative facilitation transforming strategic thinking through expert coaching across five specialized domains.
|
AI-powered creative facilitation transforming strategic thinking through expert coaching across five specialized domains.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Core Capabilities
|
## Core Capabilities
|
||||||
|
|
||||||
CIS provides structured creative methodologies through distinctive agent personas who act as master facilitators, drawing out insights through strategic questioning rather than generating solutions directly.
|
CIS provides structured creative methodologies through distinctive agent personas who act as master facilitators, drawing out insights through strategic questioning rather than generating solutions directly.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Specialized Agents
|
## Specialized Agents
|
||||||
|
|
||||||
- **Carson** - Brainstorming Specialist (energetic facilitator)
|
- **Carson** - Brainstorming Specialist (energetic facilitator)
|
||||||
|
|
@ -22,8 +17,6 @@ CIS provides structured creative methodologies through distinctive agent persona
|
||||||
- **Victor** - Innovation Oracle (bold strategic precision)
|
- **Victor** - Innovation Oracle (bold strategic precision)
|
||||||
- **Sophia** - Master Storyteller (whimsical narrator)
|
- **Sophia** - Master Storyteller (whimsical narrator)
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Interactive Workflows
|
## Interactive Workflows
|
||||||
|
|
||||||
**5 Workflows** with **150+ Creative Techniques:**
|
**5 Workflows** with **150+ Creative Techniques:**
|
||||||
|
|
@ -63,8 +56,6 @@ Business model disruption:
|
||||||
- Story circles
|
- Story circles
|
||||||
- Compelling pitch structures
|
- Compelling pitch structures
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Quick Start
|
## Quick Start
|
||||||
|
|
||||||
### Direct Workflow
|
### Direct Workflow
|
||||||
|
|
@ -83,8 +74,6 @@ agent cis/brainstorming-coach
|
||||||
> *brainstorm
|
> *brainstorm
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Key Differentiators
|
## Key Differentiators
|
||||||
|
|
||||||
- **Facilitation Over Generation** - Guides discovery through questions
|
- **Facilitation Over Generation** - Guides discovery through questions
|
||||||
|
|
@ -93,8 +82,6 @@ agent cis/brainstorming-coach
|
||||||
- **Persona-Driven** - Unique communication styles
|
- **Persona-Driven** - Unique communication styles
|
||||||
- **Rich Method Libraries** - 150+ proven techniques
|
- **Rich Method Libraries** - 150+ proven techniques
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Integration Points
|
## Integration Points
|
||||||
|
|
||||||
CIS workflows integrate with:
|
CIS workflows integrate with:
|
||||||
|
|
@ -103,8 +90,6 @@ CIS workflows integrate with:
|
||||||
- **BMB** - Creative module design
|
- **BMB** - Creative module design
|
||||||
- **Custom Modules** - Shared creative resource
|
- **Custom Modules** - Shared creative resource
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Best Practices
|
## Best Practices
|
||||||
|
|
||||||
1. **Set clear objectives** before starting sessions
|
1. **Set clear objectives** before starting sessions
|
||||||
|
|
@ -113,9 +98,6 @@ CIS workflows integrate with:
|
||||||
4. **Take breaks** when energy flags
|
4. **Take breaks** when energy flags
|
||||||
5. **Document insights** as they emerge
|
5. **Document insights** as they emerge
|
||||||
|
|
||||||
---
|
:::tip[Learn More]
|
||||||
|
See [Facilitation Over Generation](/docs/explanation/philosophy/facilitation-over-generation.md) for the core philosophy behind CIS.
|
||||||
## Related
|
:::
|
||||||
|
|
||||||
- [Facilitation Over Generation](/docs/explanation/philosophy/facilitation-over-generation.md) - Core philosophy
|
|
||||||
- [Brainstorming Techniques](/docs/explanation/features/brainstorming-techniques.md) - Technique reference
|
|
||||||
|
|
|
||||||
|
|
@ -7,12 +7,17 @@ Quick answers to common questions about getting started with the BMad Method.
|
||||||
|
|
||||||
## Questions
|
## Questions
|
||||||
|
|
||||||
|
- [Why does BMad use so many tokens?](#why-does-bmad-use-so-many-tokens)
|
||||||
- [Do I always need to run workflow-init?](#do-i-always-need-to-run-workflow-init)
|
- [Do I always need to run workflow-init?](#do-i-always-need-to-run-workflow-init)
|
||||||
- [Why do I need fresh chats for each workflow?](#why-do-i-need-fresh-chats-for-each-workflow)
|
- [Why do I need fresh chats for each workflow?](#why-do-i-need-fresh-chats-for-each-workflow)
|
||||||
- [Can I skip workflow-status and just start working?](#can-i-skip-workflow-status-and-just-start-working)
|
- [Can I skip workflow-status and just start working?](#can-i-skip-workflow-status-and-just-start-working)
|
||||||
- [What's the minimum I need to get started?](#whats-the-minimum-i-need-to-get-started)
|
- [What's the minimum I need to get started?](#whats-the-minimum-i-need-to-get-started)
|
||||||
- [How do I know if I'm in Phase 1, 2, 3, or 4?](#how-do-i-know-if-im-in-phase-1-2-3-or-4)
|
- [How do I know if I'm in Phase 1, 2, 3, or 4?](#how-do-i-know-if-im-in-phase-1-2-3-or-4)
|
||||||
|
|
||||||
|
### Why does BMad use so many tokens?
|
||||||
|
|
||||||
|
BMad is not always the most token efficient approach, and that's by design. The checkpoints, story files, and retrospectives keep you in the loop so you can apply taste, judgment, and accumulated context that no agent has. Fully automated coding loops optimize for code velocity; BMad optimizes for decision quality. If you're building something you'll maintain for years, where user experience matters, where architectural choices compound—that tradeoff pays for itself.
|
||||||
|
|
||||||
### Do I always need to run workflow-init?
|
### Do I always need to run workflow-init?
|
||||||
|
|
||||||
No, once you learn the flow you can go directly to workflows. However, workflow-init is helpful because it:
|
No, once you learn the flow you can go directly to workflows. However, workflow-init is helpful because it:
|
||||||
|
|
|
||||||
|
|
@ -2,13 +2,10 @@
|
||||||
title: "Advanced Elicitation"
|
title: "Advanced Elicitation"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
Push the LLM to rethink its work through 50+ reasoning methods — essentially, LLM brainstorming.
|
||||||
**Push the LLM to rethink its work through 50+ reasoning methods—essentially, LLM brainstorming.**
|
|
||||||
|
|
||||||
Advanced Elicitation is the inverse of Brainstorming. Instead of pulling ideas out of you, the LLM applies sophisticated reasoning techniques to re-examine and enhance content it has just generated. It's the LLM brainstorming with itself to find better approaches, uncover hidden issues, and discover improvements it missed on the first pass.
|
Advanced Elicitation is the inverse of Brainstorming. Instead of pulling ideas out of you, the LLM applies sophisticated reasoning techniques to re-examine and enhance content it has just generated. It's the LLM brainstorming with itself to find better approaches, uncover hidden issues, and discover improvements it missed on the first pass.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Use It
|
## When to Use It
|
||||||
|
|
||||||
- After a workflow generates a section of content and you want to explore alternatives
|
- After a workflow generates a section of content and you want to explore alternatives
|
||||||
|
|
@ -17,8 +14,6 @@ Advanced Elicitation is the inverse of Brainstorming. Instead of pulling ideas o
|
||||||
- To stress-test assumptions, explore edge cases, or find weaknesses in generated plans
|
- To stress-test assumptions, explore edge cases, or find weaknesses in generated plans
|
||||||
- When you want the LLM to "think again" but with structured reasoning methods
|
- When you want the LLM to "think again" but with structured reasoning methods
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## How It Works
|
## How It Works
|
||||||
|
|
||||||
### 1. Context Analysis
|
### 1. Context Analysis
|
||||||
|
|
@ -44,8 +39,6 @@ Based on context, 5 methods are intelligently selected from a library of 50+ tec
|
||||||
### 4. Party Mode Integration (Optional)
|
### 4. Party Mode Integration (Optional)
|
||||||
If Party Mode is active, BMad agents participate randomly in the elicitation process, adding their unique perspectives to the methods.
|
If Party Mode is active, BMad agents participate randomly in the elicitation process, adding their unique perspectives to the methods.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Method Categories
|
## Method Categories
|
||||||
|
|
||||||
| Category | Focus | Example Methods |
|
| Category | Focus | Example Methods |
|
||||||
|
|
@ -62,8 +55,6 @@ If Party Mode is active, BMad agents participate randomly in the elicitation pro
|
||||||
| **Philosophical** | Conceptual clarity | Occam's Razor, Ethical Dilemmas |
|
| **Philosophical** | Conceptual clarity | Occam's Razor, Ethical Dilemmas |
|
||||||
| **Retrospective** | Reflection and lessons | Hindsight Reflection, Lessons Learned Extraction |
|
| **Retrospective** | Reflection and lessons | Hindsight Reflection, Lessons Learned Extraction |
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Key Features
|
## Key Features
|
||||||
|
|
||||||
- **50+ reasoning methods** — Spanning core logic to advanced multi-step reasoning frameworks
|
- **50+ reasoning methods** — Spanning core logic to advanced multi-step reasoning frameworks
|
||||||
|
|
@ -72,8 +63,6 @@ If Party Mode is active, BMad agents participate randomly in the elicitation pro
|
||||||
- **User control** — Accept or discard each enhancement before proceeding
|
- **User control** — Accept or discard each enhancement before proceeding
|
||||||
- **Party Mode integration** — Agents can participate when Party Mode is active
|
- **Party Mode integration** — Agents can participate when Party Mode is active
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Workflow Integration
|
## Workflow Integration
|
||||||
|
|
||||||
Advanced Elicitation is a core workflow designed to be invoked by other workflows during content generation:
|
Advanced Elicitation is a core workflow designed to be invoked by other workflows during content generation:
|
||||||
|
|
@ -96,8 +85,6 @@ When called from a workflow:
|
||||||
|
|
||||||
A specification generation workflow could invoke Advanced Elicitation after producing each major section (requirements, architecture, implementation plan). The workflow would pass the generated section, and Advanced Elicitation would offer methods like "Stakeholder Round Table" to gather diverse perspectives on requirements, or "Red Team vs Blue Team" to stress-test the architecture for vulnerabilities.
|
A specification generation workflow could invoke Advanced Elicitation after producing each major section (requirements, architecture, implementation plan). The workflow would pass the generated section, and Advanced Elicitation would offer methods like "Stakeholder Round Table" to gather diverse perspectives on requirements, or "Red Team vs Blue Team" to stress-test the architecture for vulnerabilities.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Advanced Elicitation vs. Brainstorming
|
## Advanced Elicitation vs. Brainstorming
|
||||||
|
|
||||||
| | **Advanced Elicitation** | **Brainstorming** |
|
| | **Advanced Elicitation** | **Brainstorming** |
|
||||||
|
|
|
||||||
|
|
@ -2,14 +2,13 @@
|
||||||
title: "Brainstorming"
|
title: "Brainstorming"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
Facilitate structured creative sessions using 60+ proven ideation techniques.
|
||||||
|
|
||||||
**Facilitate structured creative sessions using 60+ proven ideation techniques.**
|
The Brainstorming workflow is an interactive facilitation system that helps you unlock your own creativity. The AI acts as coach, guide, and creative partner — using proven techniques to draw out ideas and insights that are already within you.
|
||||||
|
|
||||||
The Brainstorming workflow is an interactive facilitation system that helps you unlock your own creativity. The AI acts as coach, guide, and creative partner—using proven techniques to draw out ideas and insights that are already within you.
|
:::note[Important]
|
||||||
|
Every idea comes from you. The workflow creates the conditions for your best thinking to emerge through guided exploration, but you are the source.
|
||||||
**Important:** Every idea comes from you. The workflow creates the conditions for your best thinking to emerge through guided exploration, but you are the source.
|
:::
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Use It
|
## When to Use It
|
||||||
|
|
||||||
|
|
@ -19,8 +18,6 @@ The Brainstorming workflow is an interactive facilitation system that helps you
|
||||||
- Systematically developing ideas from raw concepts to actionable plans
|
- Systematically developing ideas from raw concepts to actionable plans
|
||||||
- Team ideation (with collaborative techniques) or personal creative exploration
|
- Team ideation (with collaborative techniques) or personal creative exploration
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## How It Works
|
## How It Works
|
||||||
|
|
||||||
### 1. Session Setup
|
### 1. Session Setup
|
||||||
|
|
@ -44,8 +41,6 @@ All your generated ideas are organized into themes and prioritized.
|
||||||
### 5. Action Planning
|
### 5. Action Planning
|
||||||
Top ideas get concrete next steps, resource requirements, and success metrics.
|
Top ideas get concrete next steps, resource requirements, and success metrics.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## What You Get
|
## What You Get
|
||||||
|
|
||||||
A comprehensive session document that captures the entire journey:
|
A comprehensive session document that captures the entire journey:
|
||||||
|
|
@ -57,9 +52,7 @@ A comprehensive session document that captures the entire journey:
|
||||||
- Prioritized ideas with action plans
|
- Prioritized ideas with action plans
|
||||||
- Session highlights and key breakthroughs
|
- Session highlights and key breakthroughs
|
||||||
|
|
||||||
This document becomes a permanent record of your creative process—valuable for future reference, sharing with stakeholders, or continuing the session later.
|
This document becomes a permanent record of your creative process — valuable for future reference, sharing with stakeholders, or continuing the session later.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Technique Categories
|
## Technique Categories
|
||||||
|
|
||||||
|
|
@ -76,8 +69,6 @@ This document becomes a permanent record of your creative process—valuable for
|
||||||
| **Cultural** | Traditional knowledge and cross-cultural approaches |
|
| **Cultural** | Traditional knowledge and cross-cultural approaches |
|
||||||
| **Introspective Delight** | Inner wisdom and authentic exploration |
|
| **Introspective Delight** | Inner wisdom and authentic exploration |
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Key Features
|
## Key Features
|
||||||
|
|
||||||
- **Interactive coaching** — Pulls ideas *out* of you, doesn't generate them for you
|
- **Interactive coaching** — Pulls ideas *out* of you, doesn't generate them for you
|
||||||
|
|
@ -85,8 +76,6 @@ This document becomes a permanent record of your creative process—valuable for
|
||||||
- **Session preservation** — Every step, insight, and action plan is documented
|
- **Session preservation** — Every step, insight, and action plan is documented
|
||||||
- **Continuation support** — Pause sessions and return later, or extend with additional techniques
|
- **Continuation support** — Pause sessions and return later, or extend with additional techniques
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Workflow Integration
|
## Workflow Integration
|
||||||
|
|
||||||
Brainstorming is a core workflow designed to be invoked and configured by other modules. When called from another workflow, it accepts contextual parameters:
|
Brainstorming is a core workflow designed to be invoked and configured by other modules. When called from another workflow, it accepts contextual parameters:
|
||||||
|
|
|
||||||
|
|
@ -2,8 +2,7 @@
|
||||||
title: "Party Mode: Multi-Agent Collaboration"
|
title: "Party Mode: Multi-Agent Collaboration"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
Get all your AI agents in one conversation.
|
||||||
**Get all your AI agents in one conversation**
|
|
||||||
|
|
||||||
## What is Party Mode?
|
## What is Party Mode?
|
||||||
|
|
||||||
|
|
@ -20,8 +19,6 @@ Type `/bmad:core:workflows:party-mode` (or `*party-mode` from any agent or at ke
|
||||||
- **Sprint retrospectives** - Party mode powers the retrospective workflow
|
- **Sprint retrospectives** - Party mode powers the retrospective workflow
|
||||||
- **Sprint planning** - Multi-agent collaboration for planning sessions
|
- **Sprint planning** - Multi-agent collaboration for planning sessions
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## How It Works
|
## How It Works
|
||||||
|
|
||||||
**The basics:**
|
**The basics:**
|
||||||
|
|
@ -34,8 +31,6 @@ Type `/bmad:core:workflows:party-mode` (or `*party-mode` from any agent or at ke
|
||||||
|
|
||||||
**That's it.** No complex merging, no runtime magic. Just agents talking.
|
**That's it.** No complex merging, no runtime magic. Just agents talking.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Quick Start
|
## Quick Start
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
|
@ -51,8 +46,6 @@ Ask questions, respond to agents, direct the conversation
|
||||||
Type: exit
|
Type: exit
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Fun Examples
|
## Fun Examples
|
||||||
|
|
||||||
### Example 1: Calling Out Bad Architecture
|
### Example 1: Calling Out Bad Architecture
|
||||||
|
|
@ -69,8 +62,6 @@ Type: exit
|
||||||
|
|
||||||
_(Watch them debate whose fault it really was - it's therapeutic)_
|
_(Watch them debate whose fault it really was - it's therapeutic)_
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Example 2: Creative Brainstorming
|
### Example 2: Creative Brainstorming
|
||||||
|
|
||||||
**You:** "How do we make onboarding feel magical instead of boring?"
|
**You:** "How do we make onboarding feel magical instead of boring?"
|
||||||
|
|
@ -85,8 +76,6 @@ _(Watch them debate whose fault it really was - it's therapeutic)_
|
||||||
|
|
||||||
_(Ideas cross-pollinate and evolve)_
|
_(Ideas cross-pollinate and evolve)_
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Example 3: Technical Decision
|
### Example 3: Technical Decision
|
||||||
|
|
||||||
**You:** "Monolith or microservices for MVP?"
|
**You:** "Monolith or microservices for MVP?"
|
||||||
|
|
@ -101,12 +90,6 @@ _(Ideas cross-pollinate and evolve)_
|
||||||
|
|
||||||
_(Multiple perspectives reveal the right answer)_
|
_(Multiple perspectives reveal the right answer)_
|
||||||
|
|
||||||
## Related Documentation
|
:::tip[Better Decisions]
|
||||||
|
Better decisions through diverse perspectives. Welcome to party mode.
|
||||||
- [Agents Reference](/docs/reference/agents/index.md) - Complete agent reference
|
:::
|
||||||
- [Quick Start Guide](/docs/tutorials/getting-started/getting-started-bmadv6.md) - Getting started with BMM
|
|
||||||
- [Setup Party Mode](/docs/how-to/workflows/setup-party-mode.md) - How to use it
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
_Better decisions through diverse perspectives. Welcome to party mode._
|
|
||||||
|
|
|
||||||
|
|
@ -3,18 +3,14 @@ title: "Quick Spec Flow"
|
||||||
description: Understanding Quick Spec Flow for rapid development in BMad Method
|
description: Understanding Quick Spec Flow for rapid development in BMad Method
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
Quick Spec Flow is a streamlined alternative to the full BMad Method for Quick Flow track projects. Instead of going through Product Brief → PRD → Architecture, you go straight to a context-aware technical specification and start coding.
|
Quick Spec Flow is a streamlined alternative to the full BMad Method for Quick Flow track projects. Instead of going through Product Brief → PRD → Architecture, you go straight to a context-aware technical specification and start coding.
|
||||||
|
|
||||||
**Perfect for:** Bug fixes, small features, rapid prototyping, and quick enhancements
|
- **Perfect for:** Bug fixes, small features, rapid prototyping, and quick enhancements
|
||||||
|
- **Time to implementation:** Minutes, not hours
|
||||||
**Time to implementation:** Minutes, not hours
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Use Quick Flow
|
## When to Use Quick Flow
|
||||||
|
|
||||||
### ✅ Use Quick Flow when:
|
### Use Quick Flow when:
|
||||||
|
|
||||||
- Single bug fix or small enhancement
|
- Single bug fix or small enhancement
|
||||||
- Small feature with clear scope (typically 1-15 stories)
|
- Small feature with clear scope (typically 1-15 stories)
|
||||||
|
|
@ -22,16 +18,16 @@ Quick Spec Flow is a streamlined alternative to the full BMad Method for Quick F
|
||||||
- Adding to existing brownfield codebase
|
- Adding to existing brownfield codebase
|
||||||
- You know exactly what you want to build
|
- You know exactly what you want to build
|
||||||
|
|
||||||
### ❌ Use BMad Method or Enterprise when:
|
### Use BMad Method or Enterprise when:
|
||||||
|
|
||||||
- Building new products or major features
|
- Building new products or major features
|
||||||
- Need stakeholder alignment
|
- Need stakeholder alignment
|
||||||
- Complex multi-team coordination
|
- Complex multi-team coordination
|
||||||
- Requires extensive planning and architecture
|
- Requires extensive planning and architecture
|
||||||
|
|
||||||
💡 **Not sure?** Run `workflow-init` to get a recommendation based on your project's needs!
|
:::tip[Not Sure?]
|
||||||
|
Run `workflow-init` to get a recommendation based on your project's needs.
|
||||||
---
|
:::
|
||||||
|
|
||||||
## Quick Flow Overview
|
## Quick Flow Overview
|
||||||
|
|
||||||
|
|
@ -61,19 +57,15 @@ flowchart TD
|
||||||
style DONE fill:#f9f,stroke:#333,stroke-width:3px
|
style DONE fill:#f9f,stroke:#333,stroke-width:3px
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## What Makes It Quick
|
## What Makes It Quick
|
||||||
|
|
||||||
- ✅ No Product Brief needed
|
- No Product Brief needed
|
||||||
- ✅ No PRD needed
|
- No PRD needed
|
||||||
- ✅ No Architecture doc needed
|
- No Architecture doc needed
|
||||||
- ✅ Auto-detects your stack
|
- Auto-detects your stack
|
||||||
- ✅ Auto-analyzes brownfield code
|
- Auto-analyzes brownfield code
|
||||||
- ✅ Auto-validates quality
|
- Auto-validates quality
|
||||||
- ✅ Story context optional (tech-spec is comprehensive!)
|
- Story context optional (tech-spec is comprehensive)
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Smart Context Discovery
|
## Smart Context Discovery
|
||||||
|
|
||||||
|
|
@ -119,19 +111,15 @@ Should I follow these existing conventions? (yes/no)
|
||||||
|
|
||||||
**You decide:** Conform to existing patterns or establish new standards!
|
**You decide:** Conform to existing patterns or establish new standards!
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Auto-Validation
|
## Auto-Validation
|
||||||
|
|
||||||
Quick Spec Flow **automatically validates** everything:
|
Quick Spec Flow **automatically validates** everything:
|
||||||
|
|
||||||
- ✅ Context gathering completeness
|
- Context gathering completeness
|
||||||
- ✅ Definitiveness (no "use X or Y" statements)
|
- Definitiveness (no "use X or Y" statements)
|
||||||
- ✅ Brownfield integration quality
|
- Brownfield integration quality
|
||||||
- ✅ Stack alignment
|
- Stack alignment
|
||||||
- ✅ Implementation readiness
|
- Implementation readiness
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Comparison: Quick Flow vs Full BMM
|
## Comparison: Quick Flow vs Full BMM
|
||||||
|
|
||||||
|
|
@ -145,25 +133,17 @@ Quick Spec Flow **automatically validates** everything:
|
||||||
| **Validation** | Auto-validates everything | Manual validation steps |
|
| **Validation** | Auto-validates everything | Manual validation steps |
|
||||||
| **Brownfield** | Auto-analyzes and conforms | Manual documentation required |
|
| **Brownfield** | Auto-analyzes and conforms | Manual documentation required |
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Graduate to BMad Method
|
## When to Graduate to BMad Method
|
||||||
|
|
||||||
Start with Quick Flow, but switch to BMad Method when:
|
Start with Quick Flow, but switch to BMad Method when:
|
||||||
|
|
||||||
- ❌ Project grows beyond initial scope
|
- Project grows beyond initial scope
|
||||||
- ❌ Multiple teams need coordination
|
- Multiple teams need coordination
|
||||||
- ❌ Stakeholders need formal documentation
|
- Stakeholders need formal documentation
|
||||||
- ❌ Product vision is unclear
|
- Product vision is unclear
|
||||||
- ❌ Architectural decisions need deep analysis
|
- Architectural decisions need deep analysis
|
||||||
- ❌ Compliance/regulatory requirements exist
|
- Compliance/regulatory requirements exist
|
||||||
|
|
||||||
💡 **Tip:** You can always run `workflow-init` later to transition from Quick Flow to BMad Method!
|
:::tip[Transition Tip]
|
||||||
|
You can always run `workflow-init` later to transition from Quick Flow to BMad Method.
|
||||||
---
|
:::
|
||||||
|
|
||||||
## Related
|
|
||||||
|
|
||||||
- [Quick Spec](/docs/how-to/workflows/quick-spec.md) - How to use Quick Flow
|
|
||||||
- [Quick Start Guide](/docs/tutorials/getting-started/getting-started-bmadv6.md) - Getting started
|
|
||||||
- [Four Phases](/docs/explanation/architecture/four-phases.md) - Understanding the full methodology
|
|
||||||
|
|
|
||||||
|
|
@ -16,8 +16,6 @@ TEA was built to solve AI-generated tests that rot in review. For the problem st
|
||||||
- **Mission:** Deliver actionable quality strategies, automation coverage, and gate decisions that scale with project complexity and compliance demands.
|
- **Mission:** Deliver actionable quality strategies, automation coverage, and gate decisions that scale with project complexity and compliance demands.
|
||||||
- **Use When:** BMad Method or Enterprise track projects, integration risk is non-trivial, brownfield regression risk exists, or compliance/NFR evidence is required. (Quick Flow projects typically don't require TEA)
|
- **Use When:** BMad Method or Enterprise track projects, integration risk is non-trivial, brownfield regression risk exists, or compliance/NFR evidence is required. (Quick Flow projects typically don't require TEA)
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Choose Your TEA Engagement Model
|
## Choose Your TEA Engagement Model
|
||||||
|
|
||||||
BMad does not mandate TEA. There are five valid ways to use it (or skip it). Pick one intentionally.
|
BMad does not mandate TEA. There are five valid ways to use it (or skip it). Pick one intentionally.
|
||||||
|
|
@ -50,8 +48,6 @@ BMad does not mandate TEA. There are five valid ways to use it (or skip it). Pic
|
||||||
|
|
||||||
If you are unsure, default to the integrated path for your track and adjust later.
|
If you are unsure, default to the integrated path for your track and adjust later.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## TEA Workflow Lifecycle
|
## TEA Workflow Lifecycle
|
||||||
|
|
||||||
TEA integrates into the BMad development lifecycle during Solutioning (Phase 3) and Implementation (Phase 4):
|
TEA integrates into the BMad development lifecycle during Solutioning (Phase 3) and Implementation (Phase 4):
|
||||||
|
|
@ -153,8 +149,6 @@ Quick Flow track skips Phases 1 and 3.
|
||||||
BMad Method and Enterprise use all phases based on project needs.
|
BMad Method and Enterprise use all phases based on project needs.
|
||||||
When an ADR or architecture draft is produced, run `*test-design` in **system-level** mode before the implementation-readiness gate. This ensures the ADR has an attached testability review and ADR → test mapping. Keep the test-design updated if ADRs change.
|
When an ADR or architecture draft is produced, run `*test-design` in **system-level** mode before the implementation-readiness gate. This ensures the ADR has an attached testability review and ADR → test mapping. Keep the test-design updated if ADRs change.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Why TEA is Different from Other BMM Agents
|
## Why TEA is Different from Other BMM Agents
|
||||||
|
|
||||||
TEA is the only BMM agent that operates in **multiple phases** (Phase 3 and Phase 4) and has its own **knowledge base architecture**.
|
TEA is the only BMM agent that operates in **multiple phases** (Phase 3 and Phase 4) and has its own **knowledge base architecture**.
|
||||||
|
|
@ -209,9 +203,6 @@ TEA uniquely requires:
|
||||||
|
|
||||||
This architecture enables TEA to maintain consistent, production-ready testing patterns across all BMad projects while operating across multiple development phases.
|
This architecture enables TEA to maintain consistent, production-ready testing patterns across all BMad projects while operating across multiple development phases.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
|
|
||||||
## High-Level Cheat Sheets
|
## High-Level Cheat Sheets
|
||||||
|
|
||||||
These cheat sheets map TEA workflows to the **BMad Method and Enterprise tracks** across the **4-Phase Methodology** (Phase 1: Analysis, Phase 2: Planning, Phase 3: Solutioning, Phase 4: Implementation).
|
These cheat sheets map TEA workflows to the **BMad Method and Enterprise tracks** across the **4-Phase Methodology** (Phase 1: Analysis, Phase 2: Planning, Phase 3: Solutioning, Phase 4: Implementation).
|
||||||
|
|
@ -366,8 +357,6 @@ These cheat sheets map TEA workflows to the **BMad Method and Enterprise tracks*
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## TEA Command Catalog
|
## TEA Command Catalog
|
||||||
|
|
||||||
| Command | Primary Outputs | Notes | With Playwright MCP Enhancements |
|
| Command | Primary Outputs | Notes | With Playwright MCP Enhancements |
|
||||||
|
|
@ -381,8 +370,6 @@ These cheat sheets map TEA workflows to the **BMad Method and Enterprise tracks*
|
||||||
| `*nfr-assess` | NFR assessment report with actions | Focus on security/performance/reliability | - |
|
| `*nfr-assess` | NFR assessment report with actions | Focus on security/performance/reliability | - |
|
||||||
| `*trace` | Phase 1: Coverage matrix, recommendations. Phase 2: Gate decision (PASS/CONCERNS/FAIL/WAIVED) | Two-phase workflow: traceability + gate decision | - |
|
| `*trace` | Phase 1: Coverage matrix, recommendations. Phase 2: Gate decision (PASS/CONCERNS/FAIL/WAIVED) | Two-phase workflow: traceability + gate decision | - |
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Playwright Utils Integration
|
## Playwright Utils Integration
|
||||||
|
|
||||||
TEA optionally integrates with `@seontechnologies/playwright-utils`, an open-source library providing fixture-based utilities for Playwright tests. This integration enhances TEA's test generation and review workflows with production-ready patterns.
|
TEA optionally integrates with `@seontechnologies/playwright-utils`, an open-source library providing fixture-based utilities for Playwright tests. This integration enhances TEA's test generation and review workflows with production-ready patterns.
|
||||||
|
|
@ -431,8 +418,6 @@ TEA optionally integrates with `@seontechnologies/playwright-utils`, an open-sou
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Playwright MCP Enhancements
|
## Playwright MCP Enhancements
|
||||||
|
|
||||||
TEA can leverage Playwright MCP servers to enhance test generation with live browser verification. MCP provides interactive capabilities on top of TEA's default AI-based approach.
|
TEA can leverage Playwright MCP servers to enhance test generation with live browser verification. MCP provides interactive capabilities on top of TEA's default AI-based approach.
|
||||||
|
|
@ -488,10 +473,3 @@ TEA can leverage Playwright MCP servers to enhance test generation with live bro
|
||||||
Benefit: Visual failure context, live DOM inspection, root cause discovery
|
Benefit: Visual failure context, live DOM inspection, root cause discovery
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Related Documentation
|
|
||||||
|
|
||||||
- [Setup Test Framework](/docs/how-to/workflows/setup-test-framework.md) - How to set up testing infrastructure
|
|
||||||
- [Run Test Design](/docs/how-to/workflows/run-test-design.md) - Creating test plans
|
|
||||||
|
|
|
||||||
|
|
@ -2,12 +2,11 @@
|
||||||
title: "Web Bundles"
|
title: "Web Bundles"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
Use BMad agents in Gemini Gems and Custom GPTs.
|
Use BMad agents in Gemini Gems and Custom GPTs.
|
||||||
|
|
||||||
## Status
|
:::caution[Status]
|
||||||
|
The Web Bundling Feature is being rebuilt from the ground up. Current v6 bundles may be incomplete or missing functionality.
|
||||||
> **Note:** The Web Bundling Feature is being rebuilt from the ground up. Current v6 bundles may be incomplete or missing functionality.
|
:::
|
||||||
|
|
||||||
## What Are Web Bundles?
|
## What Are Web Bundles?
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,27 +2,22 @@
|
||||||
title: "BMGD Agents Guide"
|
title: "BMGD Agents Guide"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
Complete reference for BMGD's six specialized game development agents.
|
Complete reference for BMGD's six specialized game development agents.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Agent Overview
|
## Agent Overview
|
||||||
|
|
||||||
BMGD provides six agents, each with distinct expertise:
|
BMGD provides six agents, each with distinct expertise:
|
||||||
|
|
||||||
| Agent | Name | Role | Phase Focus |
|
| Agent | Name | Role | Phase Focus |
|
||||||
| ------------------------ | ---------------- | ----------------------------------------------------------- | ----------- |
|
|-------|------|------|-------------|
|
||||||
| 🎲 **Game Designer** | Samus Shepard | Lead Game Designer + Creative Vision Architect | Phases 1-2 |
|
| **Game Designer** | Samus Shepard | Lead Game Designer + Creative Vision Architect | Phases 1-2 |
|
||||||
| 🏛️ **Game Architect** | Cloud Dragonborn | Principal Game Systems Architect + Technical Director | Phase 3 |
|
| **Game Architect** | Cloud Dragonborn | Principal Game Systems Architect + Technical Director | Phase 3 |
|
||||||
| 🕹️ **Game Developer** | Link Freeman | Senior Game Developer + Technical Implementation Specialist | Phase 4 |
|
| **Game Developer** | Link Freeman | Senior Game Developer + Technical Implementation Specialist | Phase 4 |
|
||||||
| 🎯 **Game Scrum Master** | Max | Game Development Scrum Master + Sprint Orchestrator | Phase 4 |
|
| **Game Scrum Master** | Max | Game Development Scrum Master + Sprint Orchestrator | Phase 4 |
|
||||||
| 🧪 **Game QA** | GLaDOS | Game QA Architect + Test Automation Specialist | All Phases |
|
| **Game QA** | GLaDOS | Game QA Architect + Test Automation Specialist | All Phases |
|
||||||
| 🎮 **Game Solo Dev** | Indie | Elite Indie Game Developer + Quick Flow Specialist | All Phases |
|
| **Game Solo Dev** | Indie | Elite Indie Game Developer + Quick Flow Specialist | All Phases |
|
||||||
|
|
||||||
---
|
## Game Designer (Samus Shepard)
|
||||||
|
|
||||||
## 🎲 Game Designer (Samus Shepard)
|
|
||||||
|
|
||||||
### Role
|
### Role
|
||||||
|
|
||||||
|
|
@ -62,9 +57,7 @@ Talks like an excited streamer - enthusiastic, asks about player motivations, ce
|
||||||
| `party-mode` | Multi-agent collaboration |
|
| `party-mode` | Multi-agent collaboration |
|
||||||
| `advanced-elicitation` | Deep exploration (web only) |
|
| `advanced-elicitation` | Deep exploration (web only) |
|
||||||
|
|
||||||
---
|
## Game Architect (Cloud Dragonborn)
|
||||||
|
|
||||||
## 🏛️ Game Architect (Cloud Dragonborn)
|
|
||||||
|
|
||||||
### Role
|
### Role
|
||||||
|
|
||||||
|
|
@ -102,9 +95,7 @@ Speaks like a wise sage from an RPG - calm, measured, uses architectural metapho
|
||||||
| `party-mode` | Multi-agent collaboration |
|
| `party-mode` | Multi-agent collaboration |
|
||||||
| `advanced-elicitation` | Deep exploration (web only) |
|
| `advanced-elicitation` | Deep exploration (web only) |
|
||||||
|
|
||||||
---
|
## Game Developer (Link Freeman)
|
||||||
|
|
||||||
## 🕹️ Game Developer (Link Freeman)
|
|
||||||
|
|
||||||
### Role
|
### Role
|
||||||
|
|
||||||
|
|
@ -144,9 +135,7 @@ Speaks like a speedrunner - direct, milestone-focused, always optimizing for the
|
||||||
| `party-mode` | Multi-agent collaboration |
|
| `party-mode` | Multi-agent collaboration |
|
||||||
| `advanced-elicitation` | Deep exploration (web only) |
|
| `advanced-elicitation` | Deep exploration (web only) |
|
||||||
|
|
||||||
---
|
## Game Scrum Master (Max)
|
||||||
|
|
||||||
## 🎯 Game Scrum Master (Max)
|
|
||||||
|
|
||||||
### Role
|
### Role
|
||||||
|
|
||||||
|
|
@ -190,9 +179,7 @@ Talks in game terminology - milestones are save points, handoffs are level trans
|
||||||
| `party-mode` | Multi-agent collaboration |
|
| `party-mode` | Multi-agent collaboration |
|
||||||
| `advanced-elicitation` | Deep exploration (web only) |
|
| `advanced-elicitation` | Deep exploration (web only) |
|
||||||
|
|
||||||
---
|
## Game QA (GLaDOS)
|
||||||
|
|
||||||
## 🧪 Game QA (GLaDOS)
|
|
||||||
|
|
||||||
### Role
|
### Role
|
||||||
|
|
||||||
|
|
@ -265,9 +252,7 @@ GLaDOS has access to a comprehensive game testing knowledge base (`gametest/qa-i
|
||||||
- Smoke testing
|
- Smoke testing
|
||||||
- Test prioritization (P0-P3)
|
- Test prioritization (P0-P3)
|
||||||
|
|
||||||
---
|
## Game Solo Dev (Indie)
|
||||||
|
|
||||||
## 🎮 Game Solo Dev (Indie)
|
|
||||||
|
|
||||||
### Role
|
### Role
|
||||||
|
|
||||||
|
|
@ -324,8 +309,6 @@ Use **Full BMGD workflow** when:
|
||||||
- You're working with stakeholders/publishers
|
- You're working with stakeholders/publishers
|
||||||
- Long-term maintainability is critical
|
- Long-term maintainability is critical
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Agent Selection Guide
|
## Agent Selection Guide
|
||||||
|
|
||||||
### By Phase
|
### By Phase
|
||||||
|
|
@ -359,8 +342,6 @@ Use **Full BMGD workflow** when:
|
||||||
| "Quick prototype this idea" | Game Solo Dev |
|
| "Quick prototype this idea" | Game Solo Dev |
|
||||||
| "Ship this feature fast" | Game Solo Dev |
|
| "Ship this feature fast" | Game Solo Dev |
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Multi-Agent Collaboration
|
## Multi-Agent Collaboration
|
||||||
|
|
||||||
### Party Mode
|
### Party Mode
|
||||||
|
|
@ -391,8 +372,6 @@ Game QA integrates at multiple points:
|
||||||
- During Implementation: Create automated tests
|
- During Implementation: Create automated tests
|
||||||
- Before Release: Performance and certification testing
|
- Before Release: Performance and certification testing
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Project Context
|
## Project Context
|
||||||
|
|
||||||
All agents share the principle:
|
All agents share the principle:
|
||||||
|
|
@ -401,8 +380,6 @@ All agents share the principle:
|
||||||
|
|
||||||
The `project-context.md` file (if present) serves as the authoritative source for project decisions and constraints.
|
The `project-context.md` file (if present) serves as the authoritative source for project decisions and constraints.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Next Steps
|
## Next Steps
|
||||||
|
|
||||||
- **[Quick Start Guide](/docs/tutorials/getting-started/quick-start-bmgd.md)** - Get started with BMGD
|
- **[Quick Start Guide](/docs/tutorials/getting-started/quick-start-bmgd.md)** - Get started with BMGD
|
||||||
|
|
|
||||||
|
|
@ -3,11 +3,8 @@ title: "BMGD vs BMM"
|
||||||
description: Understanding the differences between BMGD and BMM
|
description: Understanding the differences between BMGD and BMM
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
BMGD (BMad Game Development) extends BMM (BMad Method) with game-specific capabilities. This page explains the key differences.
|
BMGD (BMad Game Development) extends BMM (BMad Method) with game-specific capabilities. This page explains the key differences.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Quick Comparison
|
## Quick Comparison
|
||||||
|
|
||||||
| Aspect | BMM | BMGD |
|
| Aspect | BMM | BMGD |
|
||||||
|
|
@ -20,8 +17,6 @@ BMGD (BMad Game Development) extends BMM (BMad Method) with game-specific capabi
|
||||||
| **Testing** | Web-focused | Engine-specific (Unity, Unreal, Godot) |
|
| **Testing** | Web-focused | Engine-specific (Unity, Unreal, Godot) |
|
||||||
| **Production** | BMM workflows | BMM workflows with game overrides |
|
| **Production** | BMM workflows | BMM workflows with game overrides |
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Agent Differences
|
## Agent Differences
|
||||||
|
|
||||||
### BMM Agents
|
### BMM Agents
|
||||||
|
|
@ -46,8 +41,6 @@ BMGD agents understand game-specific concepts like:
|
||||||
- Engine-specific patterns
|
- Engine-specific patterns
|
||||||
- Playtesting and QA
|
- Playtesting and QA
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Planning Documents
|
## Planning Documents
|
||||||
|
|
||||||
### BMM Planning
|
### BMM Planning
|
||||||
|
|
@ -65,8 +58,6 @@ The GDD (Game Design Document) includes:
|
||||||
- Art and audio direction
|
- Art and audio direction
|
||||||
- Genre-specific sections
|
- Genre-specific sections
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Game Type Templates
|
## Game Type Templates
|
||||||
|
|
||||||
BMGD includes 24 game type templates that auto-configure GDD sections:
|
BMGD includes 24 game type templates that auto-configure GDD sections:
|
||||||
|
|
@ -83,8 +74,6 @@ Each template provides:
|
||||||
- Testing considerations
|
- Testing considerations
|
||||||
- Common pitfalls to avoid
|
- Common pitfalls to avoid
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Narrative Support
|
## Narrative Support
|
||||||
|
|
||||||
BMGD includes full narrative workflow for story-driven games:
|
BMGD includes full narrative workflow for story-driven games:
|
||||||
|
|
@ -97,8 +86,6 @@ BMGD includes full narrative workflow for story-driven games:
|
||||||
|
|
||||||
BMM has no equivalent for narrative design.
|
BMM has no equivalent for narrative design.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Testing Differences
|
## Testing Differences
|
||||||
|
|
||||||
### BMM Testing (TEA)
|
### BMM Testing (TEA)
|
||||||
|
|
@ -113,8 +100,6 @@ BMM has no equivalent for narrative design.
|
||||||
- Playtest planning
|
- Playtest planning
|
||||||
- Balance validation
|
- Balance validation
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Production Workflow
|
## Production Workflow
|
||||||
|
|
||||||
BMGD production workflows **inherit from BMM** and add game-specific:
|
BMGD production workflows **inherit from BMM** and add game-specific:
|
||||||
|
|
@ -125,8 +110,6 @@ BMGD production workflows **inherit from BMM** and add game-specific:
|
||||||
|
|
||||||
This means you get all of BMM's implementation structure plus game-specific enhancements.
|
This means you get all of BMM's implementation structure plus game-specific enhancements.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Use Each
|
## When to Use Each
|
||||||
|
|
||||||
### Use BMM when:
|
### Use BMM when:
|
||||||
|
|
@ -140,11 +123,3 @@ This means you get all of BMM's implementation structure plus game-specific enha
|
||||||
- Creating interactive experiences
|
- Creating interactive experiences
|
||||||
- Game prototyping
|
- Game prototyping
|
||||||
- Game jams
|
- Game jams
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Related
|
|
||||||
|
|
||||||
- [BMGD Overview](/docs/explanation/game-dev/index.md) - Getting started with BMGD
|
|
||||||
- [Game Types Guide](/docs/explanation/game-dev/game-types.md) - Understanding game templates
|
|
||||||
- [Quick Start BMGD](/docs/tutorials/getting-started/quick-start-bmgd.md) - Tutorial
|
|
||||||
|
|
|
||||||
|
|
@ -2,17 +2,12 @@
|
||||||
title: "BMGD Game Types Guide"
|
title: "BMGD Game Types Guide"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
Reference for selecting and using BMGD's 24 supported game type templates.
|
Reference for selecting and using BMGD's 24 supported game type templates.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
When creating a GDD, BMGD offers game type templates that provide genre-specific sections. This ensures your design document covers mechanics and systems relevant to your game's genre.
|
When creating a GDD, BMGD offers game type templates that provide genre-specific sections. This ensures your design document covers mechanics and systems relevant to your game's genre.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Supported Game Types
|
## Supported Game Types
|
||||||
|
|
||||||
### Action & Combat
|
### Action & Combat
|
||||||
|
|
@ -30,8 +25,6 @@ Side-scrolling or 3D platforming with combat mechanics. Think Hollow Knight, Cel
|
||||||
- Level design patterns
|
- Level design patterns
|
||||||
- Boss design
|
- Boss design
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### Shooter
|
#### Shooter
|
||||||
|
|
||||||
**Tags:** shooter, combat, aiming, fps, tps
|
**Tags:** shooter, combat, aiming, fps, tps
|
||||||
|
|
@ -46,8 +39,6 @@ Projectile combat with aiming mechanics. Covers FPS, TPS, and arena shooters.
|
||||||
- Level/arena design
|
- Level/arena design
|
||||||
- Multiplayer considerations
|
- Multiplayer considerations
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### Fighting
|
#### Fighting
|
||||||
|
|
||||||
**Tags:** fighting, combat, competitive, combos, pvp
|
**Tags:** fighting, combat, competitive, combos, pvp
|
||||||
|
|
@ -62,8 +53,6 @@ Projectile combat with aiming mechanics. Covers FPS, TPS, and arena shooters.
|
||||||
- Competitive balance
|
- Competitive balance
|
||||||
- Netcode requirements
|
- Netcode requirements
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Strategy & Tactics
|
### Strategy & Tactics
|
||||||
|
|
||||||
#### Strategy
|
#### Strategy
|
||||||
|
|
@ -80,8 +69,6 @@ Resource management with tactical decisions. RTS, 4X, and grand strategy.
|
||||||
- Map/scenario design
|
- Map/scenario design
|
||||||
- Victory conditions
|
- Victory conditions
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### Turn-Based Tactics
|
#### Turn-Based Tactics
|
||||||
|
|
||||||
**Tags:** tactics, turn-based, grid, positioning
|
**Tags:** tactics, turn-based, grid, positioning
|
||||||
|
|
@ -96,8 +83,6 @@ Grid-based movement with turn order. XCOM-likes and tactical RPGs.
|
||||||
- Unit progression
|
- Unit progression
|
||||||
- Procedural mission generation
|
- Procedural mission generation
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### Tower Defense
|
#### Tower Defense
|
||||||
|
|
||||||
**Tags:** tower-defense, waves, placement, strategy
|
**Tags:** tower-defense, waves, placement, strategy
|
||||||
|
|
@ -112,8 +97,6 @@ Wave-based defense with tower placement.
|
||||||
- Map design patterns
|
- Map design patterns
|
||||||
- Meta-progression
|
- Meta-progression
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### RPG & Progression
|
### RPG & Progression
|
||||||
|
|
||||||
#### RPG
|
#### RPG
|
||||||
|
|
@ -130,8 +113,6 @@ Character progression with stats, inventory, and quests.
|
||||||
- Combat system (action/turn-based)
|
- Combat system (action/turn-based)
|
||||||
- Skill trees and builds
|
- Skill trees and builds
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### Roguelike
|
#### Roguelike
|
||||||
|
|
||||||
**Tags:** roguelike, procedural, permadeath, runs
|
**Tags:** roguelike, procedural, permadeath, runs
|
||||||
|
|
@ -146,8 +127,6 @@ Procedural generation with permadeath and run-based progression.
|
||||||
- Item/ability synergies
|
- Item/ability synergies
|
||||||
- Meta-progression systems
|
- Meta-progression systems
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### Metroidvania
|
#### Metroidvania
|
||||||
|
|
||||||
**Tags:** metroidvania, exploration, abilities, interconnected
|
**Tags:** metroidvania, exploration, abilities, interconnected
|
||||||
|
|
@ -162,8 +141,6 @@ Interconnected world with ability gating.
|
||||||
- Secret and collectible placement
|
- Secret and collectible placement
|
||||||
- Power-up progression
|
- Power-up progression
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Narrative & Story
|
### Narrative & Story
|
||||||
|
|
||||||
#### Adventure
|
#### Adventure
|
||||||
|
|
@ -180,8 +157,6 @@ Story-driven exploration and narrative. Point-and-click and narrative adventures
|
||||||
- Dialogue systems
|
- Dialogue systems
|
||||||
- Story branching
|
- Story branching
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### Visual Novel
|
#### Visual Novel
|
||||||
|
|
||||||
**Tags:** visual-novel, narrative, choices, story
|
**Tags:** visual-novel, narrative, choices, story
|
||||||
|
|
@ -196,8 +171,6 @@ Narrative choices with branching story.
|
||||||
- UI/presentation
|
- UI/presentation
|
||||||
- Save/load states
|
- Save/load states
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### Text-Based
|
#### Text-Based
|
||||||
|
|
||||||
**Tags:** text, parser, interactive-fiction, mud
|
**Tags:** text, parser, interactive-fiction, mud
|
||||||
|
|
@ -212,8 +185,6 @@ Text input/output games. Parser games, choice-based IF, MUDs.
|
||||||
- Text presentation
|
- Text presentation
|
||||||
- Save state management
|
- Save state management
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Simulation & Management
|
### Simulation & Management
|
||||||
|
|
||||||
#### Simulation
|
#### Simulation
|
||||||
|
|
@ -230,8 +201,6 @@ Realistic systems with management and building. Includes tycoons and sim games.
|
||||||
- Building/construction
|
- Building/construction
|
||||||
- Failure states
|
- Failure states
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### Sandbox
|
#### Sandbox
|
||||||
|
|
||||||
**Tags:** sandbox, creative, building, freedom
|
**Tags:** sandbox, creative, building, freedom
|
||||||
|
|
@ -246,8 +215,6 @@ Creative freedom with building and minimal objectives.
|
||||||
- Sharing/community features
|
- Sharing/community features
|
||||||
- Optional objectives
|
- Optional objectives
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Sports & Racing
|
### Sports & Racing
|
||||||
|
|
||||||
#### Racing
|
#### Racing
|
||||||
|
|
@ -264,8 +231,6 @@ Vehicle control with tracks and lap times.
|
||||||
- Progression/career mode
|
- Progression/career mode
|
||||||
- Multiplayer racing
|
- Multiplayer racing
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### Sports
|
#### Sports
|
||||||
|
|
||||||
**Tags:** sports, teams, realistic, physics
|
**Tags:** sports, teams, realistic, physics
|
||||||
|
|
@ -280,8 +245,6 @@ Team-based or individual sports simulation.
|
||||||
- Season/career modes
|
- Season/career modes
|
||||||
- Multiplayer modes
|
- Multiplayer modes
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Multiplayer
|
### Multiplayer
|
||||||
|
|
||||||
#### MOBA
|
#### MOBA
|
||||||
|
|
@ -298,8 +261,6 @@ Multiplayer team battles with hero selection.
|
||||||
- Matchmaking
|
- Matchmaking
|
||||||
- Economy (gold/items)
|
- Economy (gold/items)
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### Party Game
|
#### Party Game
|
||||||
|
|
||||||
**Tags:** party, multiplayer, minigames, casual
|
**Tags:** party, multiplayer, minigames, casual
|
||||||
|
|
@ -314,8 +275,6 @@ Local multiplayer with minigames.
|
||||||
- Scoring systems
|
- Scoring systems
|
||||||
- Player count flexibility
|
- Player count flexibility
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Horror & Survival
|
### Horror & Survival
|
||||||
|
|
||||||
#### Survival
|
#### Survival
|
||||||
|
|
@ -332,8 +291,6 @@ Resource gathering with crafting and persistent threats.
|
||||||
- Threat systems
|
- Threat systems
|
||||||
- Base building
|
- Base building
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### Horror
|
#### Horror
|
||||||
|
|
||||||
**Tags:** horror, atmosphere, tension, fear
|
**Tags:** horror, atmosphere, tension, fear
|
||||||
|
|
@ -348,8 +305,6 @@ Atmosphere and tension with limited resources.
|
||||||
- Lighting and visibility
|
- Lighting and visibility
|
||||||
- Enemy/threat design
|
- Enemy/threat design
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Casual & Progression
|
### Casual & Progression
|
||||||
|
|
||||||
#### Puzzle
|
#### Puzzle
|
||||||
|
|
@ -366,8 +321,6 @@ Logic-based challenges and problem-solving.
|
||||||
- Level structure
|
- Level structure
|
||||||
- Scoring/rating
|
- Scoring/rating
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### Idle/Incremental
|
#### Idle/Incremental
|
||||||
|
|
||||||
**Tags:** idle, incremental, automation, progression
|
**Tags:** idle, incremental, automation, progression
|
||||||
|
|
@ -382,8 +335,6 @@ Passive progression with upgrades and automation.
|
||||||
- Number scaling
|
- Number scaling
|
||||||
- Offline progress
|
- Offline progress
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### Card Game
|
#### Card Game
|
||||||
|
|
||||||
**Tags:** card, deck-building, strategy, turns
|
**Tags:** card, deck-building, strategy, turns
|
||||||
|
|
@ -398,8 +349,6 @@ Deck building with card mechanics.
|
||||||
- Rarity and collection
|
- Rarity and collection
|
||||||
- Competitive balance
|
- Competitive balance
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Rhythm
|
### Rhythm
|
||||||
|
|
||||||
#### Rhythm
|
#### Rhythm
|
||||||
|
|
@ -416,8 +365,6 @@ Music synchronization with timing-based gameplay.
|
||||||
- Music licensing
|
- Music licensing
|
||||||
- Input methods
|
- Input methods
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Hybrid Game Types
|
## Hybrid Game Types
|
||||||
|
|
||||||
Many games combine multiple genres. BMGD supports hybrid selection:
|
Many games combine multiple genres. BMGD supports hybrid selection:
|
||||||
|
|
@ -449,8 +396,6 @@ You: It's a roguelike with card game combat
|
||||||
Agent: I'll include sections for both Roguelike and Card Game...
|
Agent: I'll include sections for both Roguelike and Card Game...
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Game Type Selection Tips
|
## Game Type Selection Tips
|
||||||
|
|
||||||
### 1. Start with Core Fantasy
|
### 1. Start with Core Fantasy
|
||||||
|
|
@ -482,8 +427,6 @@ One type should be primary (most gameplay time). Others add flavor:
|
||||||
- **Primary:** Platformer (core movement and exploration)
|
- **Primary:** Platformer (core movement and exploration)
|
||||||
- **Secondary:** Metroidvania (ability gating structure)
|
- **Secondary:** Metroidvania (ability gating structure)
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## GDD Section Mapping
|
## GDD Section Mapping
|
||||||
|
|
||||||
When you select a game type, BMGD adds these GDD sections:
|
When you select a game type, BMGD adds these GDD sections:
|
||||||
|
|
@ -497,8 +440,6 @@ When you select a game type, BMGD adds these GDD sections:
|
||||||
| Multiplayer | Matchmaking, Netcode, Balance |
|
| Multiplayer | Matchmaking, Netcode, Balance |
|
||||||
| Simulation | Systems, Economy, AI |
|
| Simulation | Systems, Economy, AI |
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Next Steps
|
## Next Steps
|
||||||
|
|
||||||
- **[Quick Start Guide](/docs/tutorials/getting-started/quick-start-bmgd.md)** - Get started with BMGD
|
- **[Quick Start Guide](/docs/tutorials/getting-started/quick-start-bmgd.md)** - Get started with BMGD
|
||||||
|
|
|
||||||
|
|
@ -3,10 +3,7 @@ title: "BMGD - Game Development Module"
|
||||||
description: AI-powered workflows for game design and development with BMGD
|
description: AI-powered workflows for game design and development with BMGD
|
||||||
---
|
---
|
||||||
|
|
||||||
|
Complete guides for the BMad Game Development Module (BMGD) — AI-powered workflows for game design and development that adapt to your project's needs.
|
||||||
Complete guides for the BMad Game Development Module (BMGD) - AI-powered workflows for game design and development that adapt to your project's needs.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Getting Started
|
## Getting Started
|
||||||
|
|
||||||
|
|
@ -18,17 +15,15 @@ Complete guides for the BMad Game Development Module (BMGD) - AI-powered workflo
|
||||||
- Running your first workflows
|
- Running your first workflows
|
||||||
- Agent-based development flow
|
- Agent-based development flow
|
||||||
|
|
||||||
**Quick Path:** Install BMGD module → Game Brief → GDD → Architecture → Build
|
:::tip[Quick Path]
|
||||||
|
Install BMGD module → Game Brief → GDD → Architecture → Build
|
||||||
---
|
:::
|
||||||
|
|
||||||
## Core Documentation
|
## Core Documentation
|
||||||
|
|
||||||
- **[Game Types Guide](/docs/explanation/game-dev/game-types.md)** - Selecting and using game type templates (24 supported types)
|
- **[Game Types Guide](/docs/explanation/game-dev/game-types.md)** - Selecting and using game type templates (24 supported types)
|
||||||
- **[BMGD vs BMM](/docs/explanation/game-dev/bmgd-vs-bmm.md)** - Understanding the differences
|
- **[BMGD vs BMM](/docs/explanation/game-dev/bmgd-vs-bmm.md)** - Understanding the differences
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Game Development Phases
|
## Game Development Phases
|
||||||
|
|
||||||
BMGD follows four phases aligned with game development:
|
BMGD follows four phases aligned with game development:
|
||||||
|
|
@ -51,8 +46,6 @@ BMGD follows four phases aligned with game development:
|
||||||
- **Testing** - Automated tests, playtesting, performance
|
- **Testing** - Automated tests, playtesting, performance
|
||||||
- **Retrospective** - Continuous improvement
|
- **Retrospective** - Continuous improvement
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Choose Your Path
|
## Choose Your Path
|
||||||
|
|
||||||
### I need to...
|
### I need to...
|
||||||
|
|
@ -75,11 +68,3 @@ BMGD follows four phases aligned with game development:
|
||||||
|
|
||||||
**Quickly test an idea**
|
**Quickly test an idea**
|
||||||
→ Use [Quick-Flow](/docs/how-to/workflows/bmgd-quick-flow.md) for rapid prototyping
|
→ Use [Quick-Flow](/docs/how-to/workflows/bmgd-quick-flow.md) for rapid prototyping
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Related
|
|
||||||
|
|
||||||
- [Game Types Guide](/docs/explanation/game-dev/game-types.md) - Understanding game type templates
|
|
||||||
- [BMGD vs BMM](/docs/explanation/game-dev/bmgd-vs-bmm.md) - Comparison with core method
|
|
||||||
- [Glossary](/docs/reference/glossary/index.md) - Terminology reference
|
|
||||||
|
|
|
||||||
|
|
@ -6,16 +6,15 @@ description: Understanding CIS's facilitation-first approach to creative work
|
||||||
|
|
||||||
The Creative Intelligence Suite (CIS) takes a fundamentally different approach from typical AI tools. Instead of generating solutions directly, CIS agents act as master facilitators who guide you to discover insights yourself.
|
The Creative Intelligence Suite (CIS) takes a fundamentally different approach from typical AI tools. Instead of generating solutions directly, CIS agents act as master facilitators who guide you to discover insights yourself.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## The Problem with Generation
|
## The Problem with Generation
|
||||||
|
|
||||||
Traditional AI approaches to creative work:
|
Traditional AI approaches to creative work:
|
||||||
|
|
||||||
```
|
:::note[Generation Example]
|
||||||
User: "Give me marketing ideas"
|
**User:** "Give me marketing ideas"
|
||||||
AI: "Here are 10 marketing ideas..."
|
|
||||||
```
|
**AI:** "Here are 10 marketing ideas..."
|
||||||
|
:::
|
||||||
|
|
||||||
This approach:
|
This approach:
|
||||||
- Produces generic, predictable outputs
|
- Produces generic, predictable outputs
|
||||||
|
|
@ -23,20 +22,19 @@ This approach:
|
||||||
- Misses context and nuance
|
- Misses context and nuance
|
||||||
- Limits creative exploration
|
- Limits creative exploration
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## The Facilitation Approach
|
## The Facilitation Approach
|
||||||
|
|
||||||
CIS agents use strategic questioning:
|
CIS agents use strategic questioning:
|
||||||
|
|
||||||
```
|
:::note[Facilitation Example]
|
||||||
User: "I need marketing ideas"
|
**User:** "I need marketing ideas"
|
||||||
CIS: "What makes your customers choose you over alternatives?
|
|
||||||
What's the one thing they always mention?"
|
**CIS:** "What makes your customers choose you over alternatives? What's the one thing they always mention?"
|
||||||
User: "They say our support is exceptional"
|
|
||||||
CIS: "Interesting! How might you make that exceptional
|
**User:** "They say our support is exceptional"
|
||||||
support visible before they become customers?"
|
|
||||||
```
|
**CIS:** "Interesting! How might you make that exceptional support visible before they become customers?"
|
||||||
|
:::
|
||||||
|
|
||||||
This approach:
|
This approach:
|
||||||
- Draws out insights already within you
|
- Draws out insights already within you
|
||||||
|
|
@ -44,8 +42,6 @@ This approach:
|
||||||
- Captures context and nuance
|
- Captures context and nuance
|
||||||
- Enables deeper creative exploration
|
- Enables deeper creative exploration
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Key Principles
|
## Key Principles
|
||||||
|
|
||||||
### 1. Questions Over Answers
|
### 1. Questions Over Answers
|
||||||
|
|
@ -85,8 +81,6 @@ Each CIS agent has a distinct personality:
|
||||||
|
|
||||||
These personas create engaging experiences that maintain creative flow.
|
These personas create engaging experiences that maintain creative flow.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When Generation is Appropriate
|
## When Generation is Appropriate
|
||||||
|
|
||||||
CIS does generate when appropriate:
|
CIS does generate when appropriate:
|
||||||
|
|
@ -97,8 +91,6 @@ CIS does generate when appropriate:
|
||||||
|
|
||||||
But the core creative work happens through facilitated discovery.
|
But the core creative work happens through facilitated discovery.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Benefits
|
## Benefits
|
||||||
|
|
||||||
### For Individuals
|
### For Individuals
|
||||||
|
|
@ -112,10 +104,3 @@ But the core creative work happens through facilitated discovery.
|
||||||
- Aligned understanding
|
- Aligned understanding
|
||||||
- Documented rationale
|
- Documented rationale
|
||||||
- Stronger buy-in to outcomes
|
- Stronger buy-in to outcomes
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Related
|
|
||||||
|
|
||||||
- [Creative Intelligence Suite](/docs/explanation/creative-intelligence/index.md) - CIS overview
|
|
||||||
- [Brainstorming Techniques](/docs/explanation/features/brainstorming-techniques.md) - Available techniques
|
|
||||||
|
|
|
||||||
|
|
@ -110,10 +110,3 @@ The three-part stack addresses each gap:
|
||||||
| No review | TEA `*test-review` audits quality with scoring |
|
| No review | TEA `*test-review` audits quality with scoring |
|
||||||
|
|
||||||
This approach is sometimes called *context engineering*—loading domain-specific standards into AI context automatically rather than relying on prompts alone. TEA's `tea-index.csv` manifest loads relevant knowledge fragments so the AI doesn't relearn testing patterns each session.
|
This approach is sometimes called *context engineering*—loading domain-specific standards into AI context automatically rather than relying on prompts alone. TEA's `tea-index.csv` manifest loads relevant knowledge fragments so the AI doesn't relearn testing patterns each session.
|
||||||
|
|
||||||
## Related
|
|
||||||
|
|
||||||
- [TEA Overview](/docs/explanation/features/tea-overview.md) — Workflow details and cheat sheets
|
|
||||||
- [Setup Test Framework](/docs/how-to/workflows/setup-test-framework.md) — Implementation guide
|
|
||||||
- [The Testing Meta Most Teams Have Not Caught Up To Yet](https://dev.to/muratkeremozcan/the-testing-meta-most-teams-have-not-caught-up-to-yet-5765) — Original article by Murat K Ozcan
|
|
||||||
- [Playwright-Utils Repository](https://github.com/seontechnologies/playwright-utils) — Source and documentation
|
|
||||||
|
|
|
||||||
|
|
@ -3,10 +3,7 @@ title: "How to Add a Feature to an Existing Project"
|
||||||
description: How to add new features to an existing brownfield project
|
description: How to add new features to an existing brownfield project
|
||||||
---
|
---
|
||||||
|
|
||||||
|
Use the `workflow-init` workflow to add new functionality to your brownfield codebase while respecting existing patterns and architecture.
|
||||||
Add new functionality to your brownfield codebase while respecting existing patterns and architecture.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Use This
|
## When to Use This
|
||||||
|
|
||||||
|
|
@ -14,15 +11,11 @@ Add new functionality to your brownfield codebase while respecting existing patt
|
||||||
- Major enhancements that need proper planning
|
- Major enhancements that need proper planning
|
||||||
- Features that touch multiple parts of the system
|
- Features that touch multiple parts of the system
|
||||||
|
|
||||||
---
|
:::note[Prerequisites]
|
||||||
|
|
||||||
## Prerequisites
|
|
||||||
|
|
||||||
- BMad Method installed
|
- BMad Method installed
|
||||||
- Existing project documentation (run `document-project` first if needed)
|
- Existing project documentation (run `document-project` first if needed)
|
||||||
- Clear understanding of what you want to build
|
- Clear understanding of what you want to build
|
||||||
|
:::
|
||||||
---
|
|
||||||
|
|
||||||
## Steps
|
## Steps
|
||||||
|
|
||||||
|
|
@ -73,19 +66,9 @@ Follow the standard Phase 4 implementation workflows:
|
||||||
3. `dev-story` - Implement with tests
|
3. `dev-story` - Implement with tests
|
||||||
4. `code-review` - Quality assurance
|
4. `code-review` - Quality assurance
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Tips
|
## Tips
|
||||||
|
|
||||||
- Always ensure agents read your existing documentation
|
- Always ensure agents read your existing documentation
|
||||||
- Pay attention to integration points with existing code
|
- Pay attention to integration points with existing code
|
||||||
- Follow existing conventions unless deliberately changing them
|
- Follow existing conventions unless deliberately changing them
|
||||||
- Document why you're adding new patterns (if any)
|
- Document why you're adding new patterns (if any)
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Related
|
|
||||||
|
|
||||||
- [Brownfield Development Guide](/docs/how-to/brownfield/index.md)
|
|
||||||
- [Document Existing Project](/docs/how-to/brownfield/document-existing-project.md)
|
|
||||||
- [Quick Fix in Brownfield](/docs/how-to/brownfield/quick-fix-in-brownfield.md)
|
|
||||||
|
|
|
||||||
|
|
@ -3,11 +3,8 @@ title: "How to Document an Existing Project"
|
||||||
description: How to document an existing brownfield codebase using BMad Method
|
description: How to document an existing brownfield codebase using BMad Method
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
Use the `document-project` workflow to scan your entire codebase and generate comprehensive documentation about its current state.
|
Use the `document-project` workflow to scan your entire codebase and generate comprehensive documentation about its current state.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Use This
|
## When to Use This
|
||||||
|
|
||||||
- Starting work on an undocumented legacy project
|
- Starting work on an undocumented legacy project
|
||||||
|
|
@ -15,14 +12,10 @@ Use the `document-project` workflow to scan your entire codebase and generate co
|
||||||
- AI agents need context about existing code patterns
|
- AI agents need context about existing code patterns
|
||||||
- Onboarding new team members
|
- Onboarding new team members
|
||||||
|
|
||||||
---
|
:::note[Prerequisites]
|
||||||
|
|
||||||
## Prerequisites
|
|
||||||
|
|
||||||
- BMad Method installed in your project
|
- BMad Method installed in your project
|
||||||
- Access to the codebase you want to document
|
- Access to the codebase you want to document
|
||||||
|
:::
|
||||||
---
|
|
||||||
|
|
||||||
## Steps
|
## Steps
|
||||||
|
|
||||||
|
|
@ -58,8 +51,6 @@ Review the documentation for:
|
||||||
- Completeness of architecture description
|
- Completeness of architecture description
|
||||||
- Any missing business rules or intent
|
- Any missing business rules or intent
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## What You Get
|
## What You Get
|
||||||
|
|
||||||
- **Project overview** - High-level description of what the project does
|
- **Project overview** - High-level description of what the project does
|
||||||
|
|
@ -68,17 +59,8 @@ Review the documentation for:
|
||||||
- **Business rules** - Logic extracted from the codebase
|
- **Business rules** - Logic extracted from the codebase
|
||||||
- **Integration points** - External APIs and services
|
- **Integration points** - External APIs and services
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Tips
|
## Tips
|
||||||
|
|
||||||
- Run this before any major brownfield work
|
- Run this before any major brownfield work
|
||||||
- Keep the documentation updated as the project evolves
|
- Keep the documentation updated as the project evolves
|
||||||
- Use it as input for future PRD creation
|
- Use it as input for future PRD creation
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Related
|
|
||||||
|
|
||||||
- [Brownfield Development Guide](/docs/how-to/brownfield/index.md)
|
|
||||||
- [Add Feature to Existing Project](/docs/how-to/brownfield/add-feature-to-existing.md)
|
|
||||||
|
|
|
||||||
|
|
@ -3,24 +3,19 @@ title: "Brownfield Development"
|
||||||
description: How to use BMad Method on existing codebases
|
description: How to use BMad Method on existing codebases
|
||||||
---
|
---
|
||||||
|
|
||||||
|
Use BMad Method effectively when working on existing projects and legacy codebases.
|
||||||
How to effectively use BMad Method when working on existing projects and legacy codebases.
|
|
||||||
|
|
||||||
## What is Brownfield Development?
|
## What is Brownfield Development?
|
||||||
|
|
||||||
**Brownfield** refers to working on existing projects with established codebases and patterns, as opposed to **greenfield** which means starting from scratch with a clean slate.
|
**Brownfield** refers to working on existing projects with established codebases and patterns, as opposed to **greenfield** which means starting from scratch with a clean slate.
|
||||||
|
|
||||||
This tutorial covers the essential workflow for onboarding to brownfield projects with BMad Method.
|
This guide covers the essential workflow for onboarding to brownfield projects with BMad Method.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Prerequisites
|
|
||||||
|
|
||||||
|
:::note[Prerequisites]
|
||||||
- BMad Method installed (`npx bmad-method install`)
|
- BMad Method installed (`npx bmad-method install`)
|
||||||
- An existing codebase you want to work on
|
- An existing codebase you want to work on
|
||||||
- Access to an AI-powered IDE (Claude Code, Cursor, or Windsurf)
|
- Access to an AI-powered IDE (Claude Code, Cursor, or Windsurf)
|
||||||
|
:::
|
||||||
---
|
|
||||||
|
|
||||||
## Step 1: Clean Up Completed Planning Artifacts
|
## Step 1: Clean Up Completed Planning Artifacts
|
||||||
|
|
||||||
|
|
@ -30,8 +25,6 @@ If you have completed all PRD epics and stories through the BMad process, clean
|
||||||
- `_bmad-output/planning-artifacts/`
|
- `_bmad-output/planning-artifacts/`
|
||||||
- `_bmad-output/implementation-artifacts/`
|
- `_bmad-output/implementation-artifacts/`
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Step 2: Maintain Quality Project Documentation
|
## Step 2: Maintain Quality Project Documentation
|
||||||
|
|
||||||
Your `docs/` folder should contain succinct, well-organized documentation that accurately represents your project:
|
Your `docs/` folder should contain succinct, well-organized documentation that accurately represents your project:
|
||||||
|
|
@ -43,8 +36,6 @@ Your `docs/` folder should contain succinct, well-organized documentation that a
|
||||||
|
|
||||||
For complex projects, consider using the `document-project` workflow. It offers runtime variants that will scan your entire project and document its actual current state.
|
For complex projects, consider using the `document-project` workflow. It offers runtime variants that will scan your entire project and document its actual current state.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Step 3: Initialize for Brownfield Work
|
## Step 3: Initialize for Brownfield Work
|
||||||
|
|
||||||
Run `workflow-init`. It should recognize you are in an existing project. If not, explicitly clarify that this is brownfield development for a new feature.
|
Run `workflow-init`. It should recognize you are in an existing project. If not, explicitly clarify that this is brownfield development for a new feature.
|
||||||
|
|
@ -85,18 +76,9 @@ When doing architecture, ensure the architect:
|
||||||
|
|
||||||
Pay close attention here to prevent reinventing the wheel or making decisions that misalign with your existing architecture.
|
Pay close attention here to prevent reinventing the wheel or making decisions that misalign with your existing architecture.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Next Steps
|
## Next Steps
|
||||||
|
|
||||||
- **[Document Existing Project](/docs/how-to/brownfield/document-existing-project.md)** - How to document your brownfield codebase
|
- **[Document Existing Project](/docs/how-to/brownfield/document-existing-project.md)** - How to document your brownfield codebase
|
||||||
- **[Add Feature to Existing Project](/docs/how-to/brownfield/add-feature-to-existing.md)** - Adding new functionality
|
- **[Add Feature to Existing Project](/docs/how-to/brownfield/add-feature-to-existing.md)** - Adding new functionality
|
||||||
- **[Quick Fix in Brownfield](/docs/how-to/brownfield/quick-fix-in-brownfield.md)** - Bug fixes and ad-hoc changes
|
- **[Quick Fix in Brownfield](/docs/how-to/brownfield/quick-fix-in-brownfield.md)** - Bug fixes and ad-hoc changes
|
||||||
- **[Brownfield FAQ](/docs/explanation/faq/brownfield-faq.md)** - Common questions about brownfield development
|
- **[Brownfield FAQ](/docs/explanation/faq/brownfield-faq.md)** - Common questions about brownfield development
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Related Documentation
|
|
||||||
|
|
||||||
- [Quick Start Guide](/docs/tutorials/getting-started/getting-started-bmadv6.md) - Getting started with BMM
|
|
||||||
- [Quick Spec Flow](/docs/explanation/features/quick-flow.md) - Fast path for small changes
|
|
||||||
|
|
|
||||||
|
|
@ -3,10 +3,7 @@ title: "How to Make Quick Fixes in Brownfield Projects"
|
||||||
description: How to make quick fixes and ad-hoc changes in brownfield projects
|
description: How to make quick fixes and ad-hoc changes in brownfield projects
|
||||||
---
|
---
|
||||||
|
|
||||||
|
Use the **DEV agent** directly for bug fixes, refactorings, or small targeted changes that don't require the full BMad method or Quick Flow.
|
||||||
Not everything requires the full BMad method or even Quick Flow. For bug fixes, refactorings, or small targeted changes, you can work directly with the agent.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Use This
|
## When to Use This
|
||||||
|
|
||||||
|
|
@ -16,8 +13,6 @@ Not everything requires the full BMad method or even Quick Flow. For bug fixes,
|
||||||
- Learning about your codebase
|
- Learning about your codebase
|
||||||
- One-off changes that don't need planning
|
- One-off changes that don't need planning
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Steps
|
## Steps
|
||||||
|
|
||||||
### 1. Load an Agent
|
### 1. Load an Agent
|
||||||
|
|
@ -54,8 +49,6 @@ The agent will:
|
||||||
|
|
||||||
Review the changes made and commit when satisfied.
|
Review the changes made and commit when satisfied.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Learning Your Codebase
|
## Learning Your Codebase
|
||||||
|
|
||||||
This approach is also excellent for exploring unfamiliar code:
|
This approach is also excellent for exploring unfamiliar code:
|
||||||
|
|
@ -74,8 +67,6 @@ LLMs are excellent at interpreting and analyzing code—whether it was AI-genera
|
||||||
- Understand how things are built
|
- Understand how things are built
|
||||||
- Explore unfamiliar parts of the codebase
|
- Explore unfamiliar parts of the codebase
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Upgrade to Formal Planning
|
## When to Upgrade to Formal Planning
|
||||||
|
|
||||||
Consider using Quick Flow or full BMad Method when:
|
Consider using Quick Flow or full BMad Method when:
|
||||||
|
|
@ -84,11 +75,3 @@ Consider using Quick Flow or full BMad Method when:
|
||||||
- You're unsure about the scope
|
- You're unsure about the scope
|
||||||
- The fix keeps growing in complexity
|
- The fix keeps growing in complexity
|
||||||
- You need documentation for the change
|
- You need documentation for the change
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Related
|
|
||||||
|
|
||||||
- [Brownfield Development Guide](/docs/how-to/brownfield/index.md)
|
|
||||||
- [Add Feature to Existing Project](/docs/how-to/brownfield/add-feature-to-existing.md)
|
|
||||||
- [Quick Spec Flow](/docs/explanation/features/quick-flow.md)
|
|
||||||
|
|
|
||||||
|
|
@ -2,8 +2,14 @@
|
||||||
title: "Agent Customization Guide"
|
title: "Agent Customization Guide"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
Use `.customize.yaml` files to customize BMad agents without modifying core files. All customizations persist through updates.
|
||||||
|
|
||||||
Customize BMad agents without modifying core files. All customizations persist through updates.
|
## When to Use This
|
||||||
|
|
||||||
|
- Change agent names or personas
|
||||||
|
- Add project-specific memories or context
|
||||||
|
- Add custom menu items and workflows
|
||||||
|
- Define critical actions for consistent behavior
|
||||||
|
|
||||||
## Quick Start
|
## Quick Start
|
||||||
|
|
||||||
|
|
@ -204,5 +210,3 @@ memories:
|
||||||
- **[Learn about Agents](/docs/explanation/core-concepts/what-are-agents.md)** - Understand Simple vs Expert agents
|
- **[Learn about Agents](/docs/explanation/core-concepts/what-are-agents.md)** - Understand Simple vs Expert agents
|
||||||
- **[Agent Creation Guide](/docs/tutorials/advanced/create-custom-agent.md)** - Build completely custom agents
|
- **[Agent Creation Guide](/docs/tutorials/advanced/create-custom-agent.md)** - Build completely custom agents
|
||||||
- **[BMM Complete Documentation](/docs/explanation/bmm/index.md)** - Full BMad Method reference
|
- **[BMM Complete Documentation](/docs/explanation/bmm/index.md)** - Full BMad Method reference
|
||||||
|
|
||||||
[← Back to Customization](/docs/how-to/customization/index.md)
|
|
||||||
|
|
|
||||||
|
|
@ -2,7 +2,6 @@
|
||||||
title: "BMad Customization"
|
title: "BMad Customization"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
Personalize agents and workflows to match your needs.
|
Personalize agents and workflows to match your needs.
|
||||||
|
|
||||||
## Guides
|
## Guides
|
||||||
|
|
@ -10,18 +9,15 @@ Personalize agents and workflows to match your needs.
|
||||||
| Guide | Description |
|
| Guide | Description |
|
||||||
|-------|-------------|
|
|-------|-------------|
|
||||||
| **[Agent Customization](/docs/how-to/customization/customize-agents.md)** | Modify agent behavior without editing core files |
|
| **[Agent Customization](/docs/how-to/customization/customize-agents.md)** | Modify agent behavior without editing core files |
|
||||||
| **[Workflow Customization](/docs/how-to/customization/customize-workflows.md)** | Customize and optimize workflows |
|
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
BMad provides two main customization approaches:
|
BMad provides two main customization approaches:
|
||||||
|
|
||||||
### Agent Customization
|
### Agent Customization
|
||||||
|
|
||||||
Modify any agent's persona, name, capabilities, or menu items using `.customize.yaml` files in `_bmad/_config/agents/`. Your customizations persist through updates.
|
Modify any agent's persona, name, capabilities, or menu items using `.customize.yaml` files in `_bmad/_config/agents/`. Your customizations persist through updates.
|
||||||
|
|
||||||
### Workflow Customization
|
### Workflow Customization
|
||||||
|
|
||||||
Replace or extend workflow steps to create tailored processes. (Coming soon)
|
Replace or extend workflow steps to create tailored processes. (Coming soon)
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
**Next:** Read the [Agent Customization Guide](/docs/how-to/customization/customize-agents.md) to start personalizing your agents.
|
|
||||||
|
|
|
||||||
|
|
@ -2,16 +2,14 @@
|
||||||
title: "Document Sharding Guide"
|
title: "Document Sharding Guide"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
Use the `shard-doc` tool to split large markdown files into smaller, organized files for better context management.
|
||||||
|
|
||||||
Comprehensive guide to BMad Method's document sharding system for managing large planning and architecture documents.
|
## When to Use This
|
||||||
|
|
||||||
## Table of Contents
|
- Very large complex PRDs
|
||||||
|
- Architecture documents with multiple system layers
|
||||||
- [What is Document Sharding?](#what-is-document-sharding)
|
- Epic files with 4+ epics (especially for Phase 4)
|
||||||
- [When to Use Sharding](#when-to-use-sharding)
|
- UX design specs covering multiple subsystems
|
||||||
- [How Sharding Works](#how-sharding-works)
|
|
||||||
- [Using the Shard-Doc Tool](#using-the-shard-doc-tool)
|
|
||||||
- [Workflow Support](#workflow-support)
|
|
||||||
|
|
||||||
## What is Document Sharding?
|
## What is Document Sharding?
|
||||||
|
|
||||||
|
|
@ -39,43 +37,15 @@ docs/
|
||||||
└── ... # Additional sections
|
└── ... # Additional sections
|
||||||
```
|
```
|
||||||
|
|
||||||
## When to Use Sharding
|
## Steps
|
||||||
|
|
||||||
### Ideal Candidates
|
### 1. Run the Shard-Doc Tool
|
||||||
|
|
||||||
**Large Multi-Epic Projects:**
|
|
||||||
|
|
||||||
- Very large complex PRDs
|
|
||||||
- Architecture documents with multiple system layers
|
|
||||||
- Epic files with 4+ epics (especially for Phase 4)
|
|
||||||
- UX design specs covering multiple subsystems
|
|
||||||
|
|
||||||
## How Sharding Works
|
|
||||||
|
|
||||||
### Sharding Process
|
|
||||||
|
|
||||||
1. **Tool Execution**: Run `npx @kayvan/markdown-tree-parser source.md destination/` - this is abstracted with the core shard-doc task which is installed as a slash command or manual task rule depending on your tools.
|
|
||||||
2. **Section Extraction**: Tool splits by level 2 headings
|
|
||||||
3. **File Creation**: Each section becomes a separate file
|
|
||||||
4. **Index Generation**: `index.md` created with structure and descriptions
|
|
||||||
|
|
||||||
### Workflow Discovery
|
|
||||||
|
|
||||||
BMad workflows use a **dual discovery system**:
|
|
||||||
|
|
||||||
1. **Try whole document first** - Look for `document-name.md`
|
|
||||||
2. **Check for sharded version** - Look for `document-name/index.md`
|
|
||||||
3. **Priority rule** - Whole document takes precedence if both exist - remove the whole document if you want the sharded to be used instead.
|
|
||||||
|
|
||||||
## Using the Shard-Doc Tool
|
|
||||||
|
|
||||||
### CLI Command
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
/bmad:core:tools:shard-doc
|
/bmad:core:tools:shard-doc
|
||||||
```
|
```
|
||||||
|
|
||||||
### Interactive Process
|
### 2. Follow the Interactive Process
|
||||||
|
|
||||||
```
|
```
|
||||||
Agent: Which document would you like to shard?
|
Agent: Which document would you like to shard?
|
||||||
|
|
@ -91,7 +61,7 @@ Agent: Sharding PRD.md...
|
||||||
✓ Complete!
|
✓ Complete!
|
||||||
```
|
```
|
||||||
|
|
||||||
### What Gets Created
|
## What You Get
|
||||||
|
|
||||||
**index.md structure:**
|
**index.md structure:**
|
||||||
|
|
||||||
|
|
@ -113,13 +83,19 @@ Agent: Sharding PRD.md...
|
||||||
- Preserves all markdown formatting
|
- Preserves all markdown formatting
|
||||||
- Can be read independently
|
- Can be read independently
|
||||||
|
|
||||||
|
## How Workflow Discovery Works
|
||||||
|
|
||||||
|
BMad workflows use a **dual discovery system**:
|
||||||
|
|
||||||
|
1. **Try whole document first** - Look for `document-name.md`
|
||||||
|
2. **Check for sharded version** - Look for `document-name/index.md`
|
||||||
|
3. **Priority rule** - Whole document takes precedence if both exist - remove the whole document if you want the sharded to be used instead
|
||||||
|
|
||||||
## Workflow Support
|
## Workflow Support
|
||||||
|
|
||||||
### Universal Support
|
All BMM workflows support both formats:
|
||||||
|
|
||||||
**All BMM workflows support both formats:**
|
- Whole documents
|
||||||
|
- Sharded documents
|
||||||
- ✅ Whole documents
|
- Automatic detection
|
||||||
- ✅ Sharded documents
|
- Transparent to user
|
||||||
- ✅ Automatic detection
|
|
||||||
- ✅ Transparent to user
|
|
||||||
|
|
|
||||||
|
|
@ -3,41 +3,38 @@ title: "How to Get Answers About BMad"
|
||||||
description: Use an LLM to quickly answer your own BMad questions
|
description: Use an LLM to quickly answer your own BMad questions
|
||||||
---
|
---
|
||||||
|
|
||||||
Point an LLM at BMad's source files and ask your question. That's the technique—the rest of this guide shows you how.
|
Use your AI tool to get answers about BMad by pointing it at the source files.
|
||||||
|
|
||||||
## See It Work
|
## When to Use This
|
||||||
|
|
||||||
:::note[Example]
|
- You have a question about how BMad works
|
||||||
**Q:** "Tell me the fastest way to build something with BMad"
|
- You want to understand a specific agent or workflow
|
||||||
|
- You need quick answers without waiting for Discord
|
||||||
|
|
||||||
**A:** Use Quick Flow: Run `quick-spec` to write a technical specification, then `quick-dev` to implement it—skipping the full planning phases. This gets small features shipped in a single focused session instead of going through the full 4-phase BMM workflow.
|
:::note[Prerequisites]
|
||||||
|
An AI tool (Claude Code, Cursor, ChatGPT, Claude.ai, etc.) and either BMad installed in your project or access to the GitHub repo.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
## Why This Works
|
## Steps
|
||||||
|
|
||||||
BMad's prompts are written in plain English, not code. The `_bmad` folder contains readable instructions, workflows, and agent definitions—exactly what LLMs are good at processing. You're not asking the LLM to guess; you're giving it the actual source material.
|
### 1. Choose Your Source
|
||||||
|
|
||||||
## How to Do It
|
|
||||||
|
|
||||||
### What Each Source Gives You
|
|
||||||
|
|
||||||
| Source | Best For | Examples |
|
| Source | Best For | Examples |
|
||||||
|--------|----------|----------|
|
|--------|----------|----------|
|
||||||
| **`_bmad` folder** (installed) | How BMad works in detail—agents, workflows, prompts | "What does the PM agent do?" "How does the PRD workflow work?" |
|
| **`_bmad` folder** | How BMad works—agents, workflows, prompts | "What does the PM agent do?" |
|
||||||
| **Full GitHub repo** (cloned) | Why things are the way they are—history, installer, architecture | "Why is the installer structured this way?" "What changed in v6?" |
|
| **Full GitHub repo** | History, installer, architecture | "What changed in v6?" |
|
||||||
| **`llms-full.txt`** | Quick overview from documentation perspective | "Explain BMad's four phases" "What's the difference between levels?" |
|
| **`llms-full.txt`** | Quick overview from docs | "Explain BMad's four phases" |
|
||||||
|
|
||||||
:::note[What's `_bmad`?]
|
The `_bmad` folder is created when you install BMad. If you don't have it yet, clone the repo instead.
|
||||||
The `_bmad` folder is created when you install BMad. It contains all the agent definitions, workflows, and prompts. If you don't have this folder yet, you haven't installed BMad—see the "clone the repo" option below.
|
|
||||||
:::
|
|
||||||
|
|
||||||
### If Your AI Can Read Files (Claude Code, Cursor, etc.)
|
### 2. Point Your AI at the Source
|
||||||
|
|
||||||
**BMad installed:** Point your LLM at the `_bmad` folder and ask directly.
|
**If your AI can read files (Claude Code, Cursor, etc.):**
|
||||||
|
|
||||||
**Want deeper context:** Clone the [full repo](https://github.com/bmad-code-org/BMAD-METHOD) for git history and installer details.
|
- **BMad installed:** Point at the `_bmad` folder and ask directly
|
||||||
|
- **Want deeper context:** Clone the [full repo](https://github.com/bmad-code-org/BMAD-METHOD)
|
||||||
|
|
||||||
### If You Use ChatGPT or Claude.ai
|
**If you use ChatGPT or Claude.ai:**
|
||||||
|
|
||||||
Fetch `llms-full.txt` into your session:
|
Fetch `llms-full.txt` into your session:
|
||||||
|
|
||||||
|
|
@ -45,12 +42,25 @@ Fetch `llms-full.txt` into your session:
|
||||||
https://bmad-code-org.github.io/BMAD-METHOD/llms-full.txt
|
https://bmad-code-org.github.io/BMAD-METHOD/llms-full.txt
|
||||||
```
|
```
|
||||||
|
|
||||||
You can also find this and other downloadable resources on the [Downloads page](/docs/downloads.md).
|
See the [Downloads page](/docs/downloads.md) for other downloadable resources.
|
||||||
|
|
||||||
:::tip[Verify Surprising Answers]
|
### 3. Ask Your Question
|
||||||
LLMs occasionally get things wrong. If an answer seems off, check the source file it referenced or ask on Discord.
|
|
||||||
|
:::note[Example]
|
||||||
|
**Q:** "Tell me the fastest way to build something with BMad"
|
||||||
|
|
||||||
|
**A:** Use Quick Flow: Run `quick-spec` to write a technical specification, then `quick-dev` to implement it—skipping the full planning phases.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
|
## What You Get
|
||||||
|
|
||||||
|
Direct answers about BMad—how agents work, what workflows do, why things are structured the way they are—without waiting for someone else to respond.
|
||||||
|
|
||||||
|
## Tips
|
||||||
|
|
||||||
|
- **Verify surprising answers** — LLMs occasionally get things wrong. Check the source file or ask on Discord.
|
||||||
|
- **Be specific** — "What does step 3 of the PRD workflow do?" beats "How does PRD work?"
|
||||||
|
|
||||||
## Still Stuck?
|
## Still Stuck?
|
||||||
|
|
||||||
Tried the LLM approach and still need help? You now have a much better question to ask.
|
Tried the LLM approach and still need help? You now have a much better question to ask.
|
||||||
|
|
@ -64,13 +74,7 @@ Tried the LLM approach and still need help? You now have a much better question
|
||||||
|
|
||||||
**Discord:** [discord.gg/gk8jAdXWmj](https://discord.gg/gk8jAdXWmj)
|
**Discord:** [discord.gg/gk8jAdXWmj](https://discord.gg/gk8jAdXWmj)
|
||||||
|
|
||||||
## Found a Bug?
|
**GitHub Issues:** [github.com/bmad-code-org/BMAD-METHOD/issues](https://github.com/bmad-code-org/BMAD-METHOD/issues) (for clear bugs)
|
||||||
|
|
||||||
If it's clearly a bug in BMad itself, skip Discord and go straight to GitHub Issues:
|
|
||||||
|
|
||||||
**GitHub Issues:** [github.com/bmad-code-org/BMAD-METHOD/issues](https://github.com/bmad-code-org/BMAD-METHOD/issues)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
*You!*
|
*You!*
|
||||||
*Stuck*
|
*Stuck*
|
||||||
|
|
|
||||||
|
|
@ -3,13 +3,10 @@ title: "Installation Guides"
|
||||||
description: How to install and upgrade BMad Method
|
description: How to install and upgrade BMad Method
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
How-to guides for installing and configuring the BMad Method.
|
How-to guides for installing and configuring the BMad Method.
|
||||||
|
|
||||||
## Available Guides
|
|
||||||
|
|
||||||
| Guide | Description |
|
| Guide | Description |
|
||||||
|-------|-------------|
|
|-------|-------------|
|
||||||
| **[Install BMad](/docs/how-to/installation/install-bmad.md)** | Step-by-step installation instructions |
|
| [Install BMad](/docs/how-to/installation/install-bmad.md) | Step-by-step installation instructions |
|
||||||
| **[Install Custom Modules](/docs/how-to/installation/install-custom-modules.md)** | Add custom agents, workflows, and modules |
|
| [Install Custom Modules](/docs/how-to/installation/install-custom-modules.md) | Add custom agents, workflows, and modules |
|
||||||
| **[Upgrade to v6](/docs/how-to/installation/upgrade-to-v6.md)** | Migrate from BMad v4 to v6 |
|
| [Upgrade to v6](/docs/how-to/installation/upgrade-to-v6.md) | Migrate from BMad v4 to v6 |
|
||||||
|
|
|
||||||
|
|
@ -3,18 +3,19 @@ title: "How to Install BMad"
|
||||||
description: Step-by-step guide to installing BMad in your project
|
description: Step-by-step guide to installing BMad in your project
|
||||||
---
|
---
|
||||||
|
|
||||||
|
Use the `npx bmad-method install` command to set up BMad in your project with your choice of modules and AI tools.
|
||||||
|
|
||||||
Complete guide to installing BMad in your project.
|
## When to Use This
|
||||||
|
|
||||||
---
|
- Starting a new project with BMad
|
||||||
|
- Adding BMad to an existing codebase
|
||||||
## Prerequisites
|
- Setting up BMad on a new machine
|
||||||
|
|
||||||
|
:::note[Prerequisites]
|
||||||
- **Node.js** 20+ (required for the installer)
|
- **Node.js** 20+ (required for the installer)
|
||||||
- **Git** (recommended)
|
- **Git** (recommended)
|
||||||
- **AI-powered IDE** (Claude Code, Cursor, Windsurf, or similar)
|
- **AI-powered IDE** (Claude Code, Cursor, Windsurf, or similar)
|
||||||
|
:::
|
||||||
---
|
|
||||||
|
|
||||||
## Steps
|
## Steps
|
||||||
|
|
||||||
|
|
@ -26,7 +27,8 @@ npx bmad-method install
|
||||||
|
|
||||||
### 2. Choose Installation Location
|
### 2. Choose Installation Location
|
||||||
|
|
||||||
The installer will ask where to install BMad files. Options:
|
The installer will ask where to install BMad files:
|
||||||
|
|
||||||
- Current directory (recommended for new projects)
|
- Current directory (recommended for new projects)
|
||||||
- Subdirectory
|
- Subdirectory
|
||||||
- Custom path
|
- Custom path
|
||||||
|
|
@ -34,6 +36,7 @@ The installer will ask where to install BMad files. Options:
|
||||||
### 3. Select Your AI Tools
|
### 3. Select Your AI Tools
|
||||||
|
|
||||||
Choose which AI tools you'll be using:
|
Choose which AI tools you'll be using:
|
||||||
|
|
||||||
- Claude Code
|
- Claude Code
|
||||||
- Cursor
|
- Cursor
|
||||||
- Windsurf
|
- Windsurf
|
||||||
|
|
@ -54,29 +57,13 @@ Select which modules to install:
|
||||||
|
|
||||||
### 5. Add Custom Content (Optional)
|
### 5. Add Custom Content (Optional)
|
||||||
|
|
||||||
If you have custom agents, workflows, or modules:
|
If you have custom agents, workflows, or modules, point to their location and the installer will integrate them.
|
||||||
- Point to their location
|
|
||||||
- The installer will integrate them
|
|
||||||
|
|
||||||
### 6. Configure Settings
|
### 6. Configure Settings
|
||||||
|
|
||||||
For each module, either:
|
For each module, either accept recommended defaults (faster) or customize settings (more control).
|
||||||
- Accept recommended defaults (faster)
|
|
||||||
- Customize settings (more control)
|
|
||||||
|
|
||||||
---
|
## What You Get
|
||||||
|
|
||||||
## Verify Installation
|
|
||||||
|
|
||||||
After installation, verify by:
|
|
||||||
|
|
||||||
1. Checking the `_bmad/` directory exists
|
|
||||||
2. Loading an agent in your AI tool
|
|
||||||
3. Running `*menu` to see available commands
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Directory Structure
|
|
||||||
|
|
||||||
```
|
```
|
||||||
your-project/
|
your-project/
|
||||||
|
|
@ -91,7 +78,11 @@ your-project/
|
||||||
└── .claude/ # IDE configuration
|
└── .claude/ # IDE configuration
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
## Verify Installation
|
||||||
|
|
||||||
|
1. Check the `_bmad/` directory exists
|
||||||
|
2. Load an agent in your AI tool
|
||||||
|
3. Run `*menu` to see available commands
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
|
|
@ -103,36 +94,19 @@ user_name: Your Name
|
||||||
communication_language: english
|
communication_language: english
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Troubleshooting
|
## Troubleshooting
|
||||||
|
|
||||||
### "Command not found: npx"
|
**"Command not found: npx"** — Install Node.js 20+:
|
||||||
|
|
||||||
Install Node.js 20+:
|
|
||||||
```bash
|
```bash
|
||||||
brew install node
|
brew install node
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### "Permission denied"
|
**"Permission denied"** — Check npm permissions:
|
||||||
|
|
||||||
Check npm permissions:
|
|
||||||
```bash
|
```bash
|
||||||
npm config set prefix ~/.npm-global
|
npm config set prefix ~/.npm-global
|
||||||
```
|
```
|
||||||
|
|
||||||
### Installer hangs
|
**Installer hangs** — Try running with verbose output:
|
||||||
|
|
||||||
Try running with verbose output:
|
|
||||||
```bash
|
```bash
|
||||||
npx bmad-method install --verbose
|
npx bmad-method install --verbose
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Related
|
|
||||||
|
|
||||||
- [Quick Start Guide](/docs/tutorials/getting-started/getting-started-bmadv6.md) - Getting started with BMM
|
|
||||||
- [Upgrade to V6](/docs/how-to/installation/upgrade-to-v6.md) - Upgrading from previous versions
|
|
||||||
- [Install Custom Modules](/docs/how-to/installation/install-custom-modules.md) - Adding custom content
|
|
||||||
|
|
|
||||||
|
|
@ -1,152 +1,118 @@
|
||||||
---
|
---
|
||||||
title: "Custom Content Installation"
|
title: "How to Install Custom Modules"
|
||||||
|
description: Add custom agents, workflows, and modules to BMad
|
||||||
---
|
---
|
||||||
|
|
||||||
|
Use the BMad installer to add custom agents, workflows, and modules that extend BMad's functionality.
|
||||||
|
|
||||||
This guide explains how to create and install custom BMad content including agents, workflows, and modules. Custom content extends BMad's functionality with specialized tools and workflows that can be shared across projects or teams.
|
## When to Use This
|
||||||
|
|
||||||
For detailed information about the different types of custom content available, see [Custom Content Types](/docs/explanation/bmad-builder/custom-content-types.md).
|
- Adding third-party BMad modules to your project
|
||||||
|
- Installing your own custom agents or workflows
|
||||||
|
- Sharing custom content across projects or teams
|
||||||
|
|
||||||
You can find example custom modules in the `samples/sample-custom-modules/` folder of the repository. Download either of the sample folders to try them out.
|
:::note[Prerequisites]
|
||||||
|
- BMad installed in your project
|
||||||
|
- Custom content with a valid `module.yaml` file
|
||||||
|
:::
|
||||||
|
|
||||||
## Content Types Overview
|
## Steps
|
||||||
|
|
||||||
BMad Core supports several categories of custom content:
|
### 1. Prepare Your Custom Content
|
||||||
|
|
||||||
- Custom Stand Alone Modules
|
Your custom content needs a `module.yaml` file. Choose the appropriate structure:
|
||||||
- Custom Add On Modules
|
|
||||||
- Custom Global Modules
|
|
||||||
- Custom Agents
|
|
||||||
- Custom Workflows
|
|
||||||
|
|
||||||
## Making Custom Content Installable
|
**For a cohesive module** (agents and workflows that work together):
|
||||||
|
|
||||||
### Custom Modules
|
```
|
||||||
|
module-code/
|
||||||
|
module.yaml
|
||||||
|
agents/
|
||||||
|
workflows/
|
||||||
|
tools/
|
||||||
|
templates/
|
||||||
|
```
|
||||||
|
|
||||||
To create an installable custom module:
|
**For standalone items** (unrelated agents/workflows):
|
||||||
|
|
||||||
1. **Folder Structure**
|
```
|
||||||
- Create a folder with a short, abbreviated name (e.g., `cis` for Creative Intelligence Suite)
|
module-name/
|
||||||
- The folder name serves as the module code
|
module.yaml # Contains unitary: true
|
||||||
|
agents/
|
||||||
|
larry/larry.agent.md
|
||||||
|
curly/curly.agent.md
|
||||||
|
workflows/
|
||||||
|
```
|
||||||
|
|
||||||
2. **Required File**
|
Add `unitary: true` in your `module.yaml` to indicate items don't depend on each other.
|
||||||
- Include a `module.yaml` file in the root folder (this drives questions for the final generated config.yaml at install target)
|
|
||||||
|
|
||||||
3. **Folder Organization**
|
### 2. Run the Installer
|
||||||
Follow these conventions for optimal compatibility:
|
|
||||||
|
|
||||||
```
|
**New project:**
|
||||||
module-code/
|
|
||||||
module.yaml
|
|
||||||
agents/
|
|
||||||
workflows/
|
|
||||||
tools/
|
|
||||||
templates/
|
|
||||||
...
|
|
||||||
```
|
|
||||||
|
|
||||||
- `agents/` - Agent definitions
|
```bash
|
||||||
- `workflows/` - Workflow definitions
|
npx bmad-method install
|
||||||
- Additional custom folders are supported but following conventions is recommended for agent and workflow discovery
|
```
|
||||||
|
|
||||||
**Note:** Full documentation for global modules and add-on modules will be available as support is finalized.
|
When prompted "Would you like to install a local custom module?", select 'y' and provide the path to your module folder.
|
||||||
|
|
||||||
### Standalone Content (Agents, Workflows, Tasks, Tools, Templates, Prompts)
|
**Existing project:**
|
||||||
|
|
||||||
For standalone content that isn't part of a cohesive module collection, follow this structure:
|
```bash
|
||||||
|
npx bmad-method install
|
||||||
|
```
|
||||||
|
|
||||||
1. **Module Configuration**
|
1. Select `Modify BMad Installation`
|
||||||
- Create a folder with a `module.yaml` file (similar to custom modules)
|
2. Choose the option to add, modify, or update custom modules
|
||||||
- Add the property `unitary: true` in the module.yaml
|
3. Provide the path to your module folder
|
||||||
- The `unitary: true` property indicates this is a collection of potentially unrelated items that don't depend on each other
|
|
||||||
- Any content you add to this folder should still be nested under workflows and agents - but the key with stand alone content is they do not rely on each other.
|
|
||||||
- Agents do not reference other workflows even if stored in a unitary:true module. But unitary Agents can have their own workflows in their sidecar, or reference workflows as requirements from other modules - with a process known as workflow vendoring. Keep in mind, this will require that the workflow referenced from the other module would need to be available for the end user to install, so its recommended to only vendor workflows from the core module, or official bmm modules.
|
|
||||||
|
|
||||||
2. **Folder Structure**
|
### 3. Verify Installation
|
||||||
Organize content in specific named folders:
|
|
||||||
|
|
||||||
```
|
Check that your custom content appears in the `_bmad/` directory and is accessible from your AI tool.
|
||||||
module-name/
|
|
||||||
module.yaml # Contains unitary: true
|
|
||||||
agents/
|
|
||||||
workflows/
|
|
||||||
templates/
|
|
||||||
tools/
|
|
||||||
tasks/
|
|
||||||
prompts/
|
|
||||||
```
|
|
||||||
|
|
||||||
3. **Individual Item Organization**
|
## What You Get
|
||||||
Each item should have its own subfolder:
|
|
||||||
```text
|
|
||||||
my-custom-stuff/
|
|
||||||
module.yaml
|
|
||||||
agents/
|
|
||||||
larry/larry.agent.md
|
|
||||||
curly/curly.agent.md
|
|
||||||
moe/moe.agent.md
|
|
||||||
moe/moe-sidecar/memories.csv
|
|
||||||
```
|
|
||||||
|
|
||||||
**Future Feature:** Unitary modules will support selective installation, allowing users to pick and choose which specific items to install.
|
- Custom agents available in your AI tool
|
||||||
|
- Custom workflows accessible via `*workflow-name`
|
||||||
|
- Content integrated with BMad's update system
|
||||||
|
|
||||||
**Note:** Documentation explaining the distinctions between these content types and their specific use cases will be available soon.
|
## Content Types
|
||||||
|
|
||||||
## Installation Process
|
BMad supports several categories of custom content:
|
||||||
|
|
||||||
### Prerequisites
|
| Type | Description |
|
||||||
|
|------|-------------|
|
||||||
|
| **Stand Alone Modules** | Complete modules with their own agents and workflows |
|
||||||
|
| **Add On Modules** | Extensions that add to existing modules |
|
||||||
|
| **Global Modules** | Content available across all modules |
|
||||||
|
| **Custom Agents** | Individual agent definitions |
|
||||||
|
| **Custom Workflows** | Individual workflow definitions |
|
||||||
|
|
||||||
Ensure your content follows the proper conventions and includes a `module.yaml` file (only one per top-level folder).
|
For detailed information about content types, see [Custom Content Types](/docs/explanation/bmad-builder/custom-content-types.md).
|
||||||
|
|
||||||
### New Project Installation
|
## Updating Custom Content
|
||||||
|
|
||||||
When setting up a new BMad project:
|
When BMad Core or module updates are available, the quick update process:
|
||||||
|
|
||||||
1. The installer will prompt: `Would you like to install a local custom module (this includes custom agents and workflows also)? (y/N)`
|
1. Applies updates to core modules
|
||||||
2. Select 'y' to specify the path to your module folder containing `module.yaml`
|
2. Recompiles all agents with your customizations
|
||||||
|
3. Retains your custom content from cache
|
||||||
|
4. Preserves your configurations
|
||||||
|
|
||||||
### Existing Project Modification
|
You don't need to keep source module files locally—just point to the updated location during updates.
|
||||||
|
|
||||||
To add custom content to an existing BMad project:
|
## Tips
|
||||||
|
|
||||||
1. Run the installer against your project location
|
- **Use unique module codes** — Don't use `bmm` or other existing module codes
|
||||||
2. Select `Modify BMad Installation`
|
- **Avoid naming conflicts** — Each module needs a distinct code
|
||||||
3. Choose the option to add, modify, or update custom modules
|
- **Document dependencies** — Note any modules your custom content requires
|
||||||
|
- **Test in isolation** — Verify custom modules work before sharing
|
||||||
|
- **Version your content** — Track updates with version numbers
|
||||||
|
|
||||||
### Upcoming Features
|
:::caution[Naming Conflicts]
|
||||||
|
Don't create custom modules with codes like `bmm` (already used by BMad Method). Each custom module needs a unique code.
|
||||||
|
:::
|
||||||
|
|
||||||
- **Unitary Module Selection:** For modules with `type: unitary` (instead of `type: module`), you'll be able to select specific items to install
|
## Example Modules
|
||||||
- **Add-on Module Dependencies:** The installer will verify and install dependencies for add-on modules automatically
|
|
||||||
|
|
||||||
## Quick Updates
|
Find example custom modules in the `samples/sample-custom-modules/` folder of the [BMad repository](https://github.com/bmad-code-org/BMAD-METHOD). Download either sample folder to try them out.
|
||||||
|
|
||||||
When updates to BMad Core or core modules (BMM, CIS, etc.) become available, the quick update process will:
|
|
||||||
|
|
||||||
1. Apply available updates to core modules
|
|
||||||
2. Recompile all agents with customizations from the `_config/agents` folder
|
|
||||||
3. Retain your custom content from a cached location
|
|
||||||
4. Preserve your existing configurations and customizations
|
|
||||||
|
|
||||||
This means you don't need to keep the source module files locally. When updates are available, simply point to the updated module location during the update process.
|
|
||||||
|
|
||||||
## Important Considerations
|
|
||||||
|
|
||||||
### Module Naming Conflicts
|
|
||||||
|
|
||||||
When installing unofficial modules, ensure unique identification to avoid conflicts:
|
|
||||||
|
|
||||||
1. **Module Codes:** Each module must have a unique code (e.g., don't use `bmm` for custom modules)
|
|
||||||
2. **Module Names:** Avoid using names that conflict with existing modules
|
|
||||||
3. **Multiple Custom Modules:** If creating multiple custom modules, use distinct codes for each
|
|
||||||
|
|
||||||
**Examples of conflicts to avoid:**
|
|
||||||
|
|
||||||
- Don't create a custom module with code `bmm` (already used by BMad Method)
|
|
||||||
- Don't name multiple custom modules with the same code like `mca`
|
|
||||||
|
|
||||||
### Best Practices
|
|
||||||
|
|
||||||
- Use descriptive, unique codes for your modules
|
|
||||||
- Document any dependencies your custom modules have
|
|
||||||
- Test custom modules in isolation before sharing
|
|
||||||
- Consider version numbering for your custom content to track updates
|
|
||||||
|
|
|
||||||
|
|
@ -1,147 +1,131 @@
|
||||||
---
|
---
|
||||||
title: "Upgrading from Previous Versions"
|
title: "How to Upgrade to v6"
|
||||||
|
description: Migrate from BMad v4 to v6
|
||||||
---
|
---
|
||||||
|
|
||||||
|
Use the BMad installer to upgrade from v4 to v6, which includes automatic detection of legacy installations and migration assistance.
|
||||||
|
|
||||||
## Overview
|
## When to Use This
|
||||||
|
|
||||||
The latest version of BMad represents a complete ground-up rewrite with significant architectural changes. This guide will help you migrate from version 4.
|
- You have BMad v4 installed (`.bmad-method` folder)
|
||||||
|
- You want to migrate to the new v6 architecture
|
||||||
|
- You have existing planning artifacts to preserve
|
||||||
|
|
||||||
---
|
:::note[Prerequisites]
|
||||||
|
- Node.js 20+
|
||||||
|
- Existing BMad v4 installation
|
||||||
|
:::
|
||||||
|
|
||||||
## Automatic V4 Detection
|
## Steps
|
||||||
|
|
||||||
When you run `npm run install:bmad` on a project, the installer automatically detects:
|
### 1. Run the Installer
|
||||||
|
|
||||||
- **Legacy v4 installation folder**: `.bmad-method`
|
```bash
|
||||||
- **IDE command artifacts**: Legacy bmad folders in IDE configuration directories (`.claude/commands/`, `.cursor/commands/`, etc.)
|
npx bmad-method install
|
||||||
|
|
||||||
### What Happens During Detection
|
|
||||||
|
|
||||||
1. **Automatic Detection of v4 Modules**
|
|
||||||
1. Installer will suggest removal or backup of your .bmad-method folder. You can choose to exit the installer and handle this cleanup, or allow the install to continue. Technically you can have both v4 and v6 installed, but it is not recommended. All BMad content and modules will be installed under a .bmad folder, fully segregated.
|
|
||||||
|
|
||||||
2. **IDE Command Cleanup Recommended**: Legacy v4 IDE commands should be manually removed
|
|
||||||
- Located in IDE config folders, for example claude: `.claude/commands/BMad/agents`, `.claude/commands/BMad/tasks`, etc.
|
|
||||||
- NOTE: if the upgrade and install of v6 finished, the new commands will be under `.claude/commands/bmad/<module>/agents|workflows`
|
|
||||||
- Note 2: If you accidentally delete the wrong/new bmad commands - you can easily restore them by rerunning the installer, and choose quick update option, and all will be reapplied properly.
|
|
||||||
|
|
||||||
## Module Migration
|
|
||||||
|
|
||||||
### Deprecated Modules from v4
|
|
||||||
|
|
||||||
| v4 Module | v6 Status |
|
|
||||||
| ----------------------------- | ---------------------------------------------- |
|
|
||||||
| `_bmad-2d-phaser-game-dev` | Integrated into new BMGD Module |
|
|
||||||
| `_bmad-2d-unity-game-dev` | Integrated into new BMGD Module |
|
|
||||||
| `_bmad-godot-game-dev` | Integrated into new BMGD Module |
|
|
||||||
| `_bmad-*-game-dev` (any) | Integrated into new BMGD Module |
|
|
||||||
| `_bmad-infrastructure-devops` | Deprecated - New core devops agent coming soon |
|
|
||||||
| `_bmad-creative-writing` | Not adapted - New v6 module coming soon |
|
|
||||||
|
|
||||||
Aside from .bmad-method - if you have any of these others installed also, again its recommended to remove them and use the V6 equivalents, but its also fine if you decide to keep both. But it is not recommended to use both on the same project long term.
|
|
||||||
|
|
||||||
## Architecture Changes
|
|
||||||
|
|
||||||
### Folder Structure
|
|
||||||
|
|
||||||
**v4 "Expansion Packs" Structure:**
|
|
||||||
|
|
||||||
```
|
|
||||||
your-project/
|
|
||||||
├── .bmad-method/
|
|
||||||
├── .bmad-game-dev/
|
|
||||||
├── .bmad-creative-writing/
|
|
||||||
└── .bmad-infrastructure-devops/
|
|
||||||
```
|
```
|
||||||
|
|
||||||
**v6 Unified Structure:**
|
The installer automatically detects:
|
||||||
|
|
||||||
```
|
- **Legacy v4 folder**: `.bmad-method`
|
||||||
your-project/
|
- **IDE command artifacts**: Legacy bmad folders in `.claude/commands/`, `.cursor/commands/`, etc.
|
||||||
└── _bmad/ # Single installation folder is _bmad
|
|
||||||
└── _config/ # Your customizations
|
|
||||||
| └── agents/ # Agent customization files
|
|
||||||
├── core/ # Real core framework (applies to all modules)
|
|
||||||
├── bmm/ # BMad Method (software/game dev)
|
|
||||||
├── bmb/ # BMad Builder (create agents/workflows)
|
|
||||||
├── cis/ # Creative Intelligence Suite
|
|
||||||
├── _bmad_output # Default bmad output folder (was doc folder in v4)
|
|
||||||
|
|
||||||
```
|
### 2. Handle Legacy Installation
|
||||||
|
|
||||||
### Key Concept Changes
|
When v4 is detected, you can:
|
||||||
|
|
||||||
- **v4 `_bmad-core and _bmad-method`**: Was actually the BMad Method
|
- Allow the installer to back up and remove `.bmad-method`
|
||||||
- **v6 `_bmad/core/`**: Is the real universal core framework
|
- Exit and handle cleanup manually
|
||||||
- **v6 `_bmad/bmm/`**: Is the BMad Method module
|
- Keep both (not recommended for same project)
|
||||||
- **Module identification**: All modules now have a `config.yaml` file once installed at the root of the modules installed folder
|
|
||||||
|
|
||||||
## Project Progress Migration
|
### 3. Clean Up IDE Commands
|
||||||
|
|
||||||
### If You've Completed Some or all Planning Phases (Brief/PRD/UX/Architecture) with the BMad Method:
|
Manually remove legacy v4 IDE commands:
|
||||||
|
|
||||||
After running the v6 installer, if you kept the paths the same as the installation suggested, you will need to move a few files, or run the installer again. It is recommended to stick with these defaults as it will be easier to adapt if things change in the future.
|
- `.claude/commands/BMad/agents`
|
||||||
|
- `.claude/commands/BMad/tasks`
|
||||||
|
|
||||||
If you have any planning artifacts, put them in a folder called _bmad-output/planning-artifacts at the root of your project, ensuring that:
|
New v6 commands will be at `.claude/commands/bmad/<module>/agents|workflows`.
|
||||||
PRD has PRD in the file name or folder name if sharded.
|
|
||||||
Similar for 'brief', 'architecture', 'ux-design'.
|
|
||||||
|
|
||||||
If you have other long term docs that will not be as ephemeral as these project docs, you can put them in the /docs folder, ideally with a index.md file.
|
:::tip[Accidentally Deleted Commands?]
|
||||||
|
If you delete the wrong commands, rerun the installer and choose "quick update" to restore them.
|
||||||
|
:::
|
||||||
|
|
||||||
HIGHLY RECOMMENDED NOTE: If you are only partway through planning, its highly recommended to restart and do the PRD, UX and ARCHITECTURE steps. You could even use your existing documents as inputs letting the agent know you want to redo them with the new workflows. These optimized v6 progressive discovery workflows that also will utilize web search at key moments, while offering better advanced elicitation and part mode in the IDE will produce superior results. And then once all are complete, an epics with stories is generated after the architecture step now - ensuring it uses input from all planing documents.
|
### 4. Migrate Planning Artifacts
|
||||||
|
|
||||||
### If You're Mid-Development (Stories Created/Implemented)
|
**If you have planning documents (Brief/PRD/UX/Architecture):**
|
||||||
|
|
||||||
1. Complete the v6 installation as above
|
Move them to `_bmad-output/planning-artifacts/` with descriptive names:
|
||||||
2. Ensure you have a file called epics.md or epics/epic*.md - these need to be located under the _bmad-output/planning-artifacts folder.
|
|
||||||
3. Run the scrum masters `sprint-planning` workflow to generate the implementation tracking plan in _bmad-output/implementation-artifacts.
|
|
||||||
4. Inform the SM after the output is complete which epics and stories were completed already and should be parked properly in the file.
|
|
||||||
|
|
||||||
## Agent Customization Migration
|
- Include `PRD` in filename for PRD documents
|
||||||
|
- Include `brief`, `architecture`, or `ux-design` accordingly
|
||||||
|
- Sharded documents can be in named subfolders
|
||||||
|
|
||||||
### v4 Agent Customization
|
**If you're mid-planning:** Consider restarting with v6 workflows. Use your existing documents as inputs—the new progressive discovery workflows with web search and IDE plan mode produce better results.
|
||||||
|
|
||||||
In v4, you may have modified agent files directly in `_bmad-*` folders.
|
### 5. Migrate In-Progress Development
|
||||||
|
|
||||||
### v6 Agent Customization
|
If you have stories created or implemented:
|
||||||
|
|
||||||
**All customizations** now go in `_bmad/_config/agents/` using customize files:
|
1. Complete the v6 installation
|
||||||
|
2. Place `epics.md` or `epics/epic*.md` in `_bmad-output/planning-artifacts/`
|
||||||
|
3. Run the Scrum Master's `sprint-planning` workflow
|
||||||
|
4. Tell the SM which epics/stories are already complete
|
||||||
|
|
||||||
**Example: Renaming an agent and changing communication style**
|
### 6. Migrate Agent Customizations
|
||||||
|
|
||||||
File: `_bmad/_config/agents/bmm-pm.customize.yaml`
|
**v4:** Modified agent files directly in `_bmad-*` folders
|
||||||
|
|
||||||
|
**v6:** All customizations go in `_bmad/_config/agents/` using customize files:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Customize the PM agent
|
# _bmad/_config/agents/bmm-pm.customize.yaml
|
||||||
persona:
|
persona:
|
||||||
name: 'Captain Jack' # Override agent name
|
name: 'Captain Jack'
|
||||||
role: 'Swashbuckling Product Owner'
|
role: 'Swashbuckling Product Owner'
|
||||||
communication_style: |
|
communication_style: |
|
||||||
- Talk like a pirate
|
- Talk like a pirate
|
||||||
- Use nautical metaphors for software concepts
|
- Use nautical metaphors
|
||||||
- Always upbeat and adventurous
|
|
||||||
```
|
```
|
||||||
|
|
||||||
There is a lot more that is possible with agent customization, which is covered in detail in the [Agent Customization Guide](/docs/how-to/customization/customize-agents.md)
|
After modifying customization files, rerun the installer and choose "rebuild all agents" or "quick update".
|
||||||
|
|
||||||
CRITICAL NOTE: After you modify the customization file, you need to run the npx installer against your installed location, and choose the option to rebuild all agents, or just do a quick update again. This always builds agents fresh and applies customizations.
|
## What You Get
|
||||||
|
|
||||||
**How it works:**
|
**v6 unified structure:**
|
||||||
|
|
||||||
- Base agent: `_bmad/bmm/agents/pm.md`
|
```
|
||||||
- Customization: `_bmad/_config/agents/bmm-pm.customize.yaml`
|
your-project/
|
||||||
- Rebuild all agents -> Result: Agent uses your custom name and style
|
└── _bmad/ # Single installation folder
|
||||||
|
├── _config/ # Your customizations
|
||||||
|
│ └── agents/ # Agent customization files
|
||||||
|
├── core/ # Universal core framework
|
||||||
|
├── bmm/ # BMad Method module
|
||||||
|
├── bmb/ # BMad Builder
|
||||||
|
└── cis/ # Creative Intelligence Suite
|
||||||
|
├── _bmad-output/ # Output folder (was doc folder in v4)
|
||||||
|
```
|
||||||
|
|
||||||
## Document Compatibility
|
## Module Migration
|
||||||
|
|
||||||
### Sharded vs Unsharded Documents
|
| v4 Module | v6 Status |
|
||||||
|
|-----------|-----------|
|
||||||
|
| `_bmad-2d-phaser-game-dev` | Integrated into BMGD Module |
|
||||||
|
| `_bmad-2d-unity-game-dev` | Integrated into BMGD Module |
|
||||||
|
| `_bmad-godot-game-dev` | Integrated into BMGD Module |
|
||||||
|
| `_bmad-infrastructure-devops` | Deprecated — new DevOps agent coming soon |
|
||||||
|
| `_bmad-creative-writing` | Not adapted — new v6 module coming soon |
|
||||||
|
|
||||||
**Good news**: Unlike v4, v6 workflows are **fully flexible** with document structure:
|
## Key Changes
|
||||||
|
|
||||||
- ✅ Sharded documents (split into multiple files)
|
| Concept | v4 | v6 |
|
||||||
- ✅ Unsharded documents (single file per section)
|
|---------|----|----|
|
||||||
- ✅ Custom sections for your project type
|
| **Core** | `_bmad-core` was actually BMad Method | `_bmad/core/` is universal framework |
|
||||||
- ✅ Mixed approaches
|
| **Method** | `_bmad-method` | `_bmad/bmm/` |
|
||||||
|
| **Config** | Modified files directly | `config.yaml` per module |
|
||||||
|
| **Documents** | Sharded or unsharded required setup | Fully flexible, auto-scanned |
|
||||||
|
|
||||||
All workflow files are scanned automatically. No manual configuration needed.
|
## Tips
|
||||||
|
|
||||||
|
- **Back up first** — Keep your v4 installation until you verify v6 works
|
||||||
|
- **Use v6 workflows** — Even partial planning docs benefit from v6's improved discovery
|
||||||
|
- **Rebuild after customizing** — Always run the installer after changing customize files
|
||||||
|
|
|
||||||
|
|
@ -2,10 +2,7 @@
|
||||||
title: "BMGD Troubleshooting"
|
title: "BMGD Troubleshooting"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
Use this guide to resolve common issues when using BMGD workflows.
|
||||||
Common issues and solutions when using BMGD workflows.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Installation Issues
|
## Installation Issues
|
||||||
|
|
||||||
|
|
@ -19,8 +16,6 @@ Common issues and solutions when using BMGD workflows.
|
||||||
2. Check `_bmad/bmgd/` folder exists in your project
|
2. Check `_bmad/bmgd/` folder exists in your project
|
||||||
3. Re-run installer with `--add-module bmgd`
|
3. Re-run installer with `--add-module bmgd`
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Config file missing
|
### Config file missing
|
||||||
|
|
||||||
**Symptom:** Workflows fail with "config not found" errors.
|
**Symptom:** Workflows fail with "config not found" errors.
|
||||||
|
|
@ -36,8 +31,6 @@ document_output_language: 'English'
|
||||||
game_dev_experience: 'intermediate'
|
game_dev_experience: 'intermediate'
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Workflow Issues
|
## Workflow Issues
|
||||||
|
|
||||||
### "GDD not found" in Narrative workflow
|
### "GDD not found" in Narrative workflow
|
||||||
|
|
@ -50,8 +43,6 @@ game_dev_experience: 'intermediate'
|
||||||
2. Check GDD filename contains "gdd" (e.g., `game-gdd.md`, `my-gdd.md`)
|
2. Check GDD filename contains "gdd" (e.g., `game-gdd.md`, `my-gdd.md`)
|
||||||
3. If using sharded GDD, verify `{output_folder}/gdd/index.md` exists
|
3. If using sharded GDD, verify `{output_folder}/gdd/index.md` exists
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Workflow state not persisting
|
### Workflow state not persisting
|
||||||
|
|
||||||
**Symptom:** Returning to a workflow starts from the beginning.
|
**Symptom:** Returning to a workflow starts from the beginning.
|
||||||
|
|
@ -62,8 +53,6 @@ game_dev_experience: 'intermediate'
|
||||||
2. Ensure document was saved before ending session
|
2. Ensure document was saved before ending session
|
||||||
3. Use "Continue existing" option when re-entering workflow
|
3. Use "Continue existing" option when re-entering workflow
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Wrong game type sections in GDD
|
### Wrong game type sections in GDD
|
||||||
|
|
||||||
**Symptom:** GDD includes irrelevant sections for your game type.
|
**Symptom:** GDD includes irrelevant sections for your game type.
|
||||||
|
|
@ -74,8 +63,6 @@ game_dev_experience: 'intermediate'
|
||||||
2. You can select multiple types for hybrid games
|
2. You can select multiple types for hybrid games
|
||||||
3. Irrelevant sections can be marked N/A or removed
|
3. Irrelevant sections can be marked N/A or removed
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Agent Issues
|
## Agent Issues
|
||||||
|
|
||||||
### Agent not recognizing commands
|
### Agent not recognizing commands
|
||||||
|
|
@ -88,8 +75,6 @@ game_dev_experience: 'intermediate'
|
||||||
2. Check exact command spelling (case-sensitive)
|
2. Check exact command spelling (case-sensitive)
|
||||||
3. Try `workflow-status` to verify agent is loaded correctly
|
3. Try `workflow-status` to verify agent is loaded correctly
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Agent using wrong persona
|
### Agent using wrong persona
|
||||||
|
|
||||||
**Symptom:** Agent responses don't match expected personality.
|
**Symptom:** Agent responses don't match expected personality.
|
||||||
|
|
@ -100,8 +85,6 @@ game_dev_experience: 'intermediate'
|
||||||
2. Check `_bmad/bmgd/agents/` for agent definitions
|
2. Check `_bmad/bmgd/agents/` for agent definitions
|
||||||
3. Start a fresh chat session with the correct agent
|
3. Start a fresh chat session with the correct agent
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Document Issues
|
## Document Issues
|
||||||
|
|
||||||
### Document too large for context
|
### Document too large for context
|
||||||
|
|
@ -114,8 +97,6 @@ game_dev_experience: 'intermediate'
|
||||||
2. Request specific sections rather than full document
|
2. Request specific sections rather than full document
|
||||||
3. GDD workflow supports automatic sharding for large documents
|
3. GDD workflow supports automatic sharding for large documents
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Template placeholders not replaced
|
### Template placeholders not replaced
|
||||||
|
|
||||||
**Symptom:** Output contains `{{placeholder}}` text.
|
**Symptom:** Output contains `{{placeholder}}` text.
|
||||||
|
|
@ -126,8 +107,6 @@ game_dev_experience: 'intermediate'
|
||||||
2. Re-run the specific step that generates that section
|
2. Re-run the specific step that generates that section
|
||||||
3. Manually edit the document to fill in missing values
|
3. Manually edit the document to fill in missing values
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Frontmatter parsing errors
|
### Frontmatter parsing errors
|
||||||
|
|
||||||
**Symptom:** YAML errors when loading documents.
|
**Symptom:** YAML errors when loading documents.
|
||||||
|
|
@ -138,8 +117,6 @@ game_dev_experience: 'intermediate'
|
||||||
2. Check for tabs vs spaces (YAML requires spaces)
|
2. Check for tabs vs spaces (YAML requires spaces)
|
||||||
3. Ensure frontmatter is bounded by `---` markers
|
3. Ensure frontmatter is bounded by `---` markers
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 4 (Production) Issues
|
## Phase 4 (Production) Issues
|
||||||
|
|
||||||
### Sprint status not updating
|
### Sprint status not updating
|
||||||
|
|
@ -152,8 +129,6 @@ game_dev_experience: 'intermediate'
|
||||||
2. Check file permissions on sprint-status.yaml
|
2. Check file permissions on sprint-status.yaml
|
||||||
3. Verify workflow-install files exist in `_bmad/bmgd/workflows/4-production/`
|
3. Verify workflow-install files exist in `_bmad/bmgd/workflows/4-production/`
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Story context missing code references
|
### Story context missing code references
|
||||||
|
|
||||||
**Symptom:** Generated story context doesn't include relevant code.
|
**Symptom:** Generated story context doesn't include relevant code.
|
||||||
|
|
@ -164,8 +139,6 @@ game_dev_experience: 'intermediate'
|
||||||
2. Check that architecture document references correct file paths
|
2. Check that architecture document references correct file paths
|
||||||
3. Story may need more specific file references in acceptance criteria
|
3. Story may need more specific file references in acceptance criteria
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Code review not finding issues
|
### Code review not finding issues
|
||||||
|
|
||||||
**Symptom:** Code review passes but bugs exist.
|
**Symptom:** Code review passes but bugs exist.
|
||||||
|
|
@ -176,8 +149,6 @@ game_dev_experience: 'intermediate'
|
||||||
2. Always run actual tests before marking story done
|
2. Always run actual tests before marking story done
|
||||||
3. Consider manual review for critical code paths
|
3. Consider manual review for critical code paths
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Performance Issues
|
## Performance Issues
|
||||||
|
|
||||||
### Workflows running slowly
|
### Workflows running slowly
|
||||||
|
|
@ -190,8 +161,6 @@ game_dev_experience: 'intermediate'
|
||||||
2. Keep documents concise (avoid unnecessary detail)
|
2. Keep documents concise (avoid unnecessary detail)
|
||||||
3. Use sharded documents for large projects
|
3. Use sharded documents for large projects
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Context limit reached mid-workflow
|
### Context limit reached mid-workflow
|
||||||
|
|
||||||
**Symptom:** Workflow stops or loses context partway through.
|
**Symptom:** Workflow stops or loses context partway through.
|
||||||
|
|
@ -202,8 +171,6 @@ game_dev_experience: 'intermediate'
|
||||||
2. Break complex sections into multiple sessions
|
2. Break complex sections into multiple sessions
|
||||||
3. Use step-file architecture (workflows resume from last step)
|
3. Use step-file architecture (workflows resume from last step)
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Common Error Messages
|
## Common Error Messages
|
||||||
|
|
||||||
### "Input file not found"
|
### "Input file not found"
|
||||||
|
|
@ -212,24 +179,18 @@ game_dev_experience: 'intermediate'
|
||||||
|
|
||||||
**Fix:** Complete prerequisite workflow first (e.g., Game Brief before GDD).
|
**Fix:** Complete prerequisite workflow first (e.g., Game Brief before GDD).
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### "Invalid game type"
|
### "Invalid game type"
|
||||||
|
|
||||||
**Cause:** Selected game type not in supported list.
|
**Cause:** Selected game type not in supported list.
|
||||||
|
|
||||||
**Fix:** Check `game-types.csv` for valid type IDs.
|
**Fix:** Check `game-types.csv` for valid type IDs.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### "Validation failed"
|
### "Validation failed"
|
||||||
|
|
||||||
**Cause:** Document doesn't meet checklist requirements.
|
**Cause:** Document doesn't meet checklist requirements.
|
||||||
|
|
||||||
**Fix:** Review the validation output and address flagged items.
|
**Fix:** Review the validation output and address flagged items.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Getting Help
|
## Getting Help
|
||||||
|
|
||||||
### Community Support
|
### Community Support
|
||||||
|
|
@ -252,8 +213,6 @@ When reporting issues, include:
|
||||||
3. Relevant document frontmatter
|
3. Relevant document frontmatter
|
||||||
4. Steps to reproduce
|
4. Steps to reproduce
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Next Steps
|
## Next Steps
|
||||||
|
|
||||||
- **[Quick Start Guide](/docs/tutorials/getting-started/quick-start-bmgd.md)** - Getting started
|
- **[Quick Start Guide](/docs/tutorials/getting-started/quick-start-bmgd.md)** - Getting started
|
||||||
|
|
|
||||||
|
|
@ -1,52 +1,41 @@
|
||||||
---
|
---
|
||||||
title: "BMGD Quick-Flow Guide"
|
title: "BMGD Quick-Flow Guide"
|
||||||
|
description: Fast-track workflows for rapid game prototyping and flexible development
|
||||||
---
|
---
|
||||||
|
|
||||||
|
Use BMGD Quick-Flow workflows for rapid game prototyping and flexible development when you need to move fast.
|
||||||
|
|
||||||
Fast-track workflows for rapid game prototyping and flexible development.
|
## When to Use This
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Game Solo Dev Agent
|
|
||||||
|
|
||||||
For dedicated quick-flow development, use the **Game Solo Dev** agent (Indie). This agent is optimized for solo developers and small teams who want to skip the full planning phases and ship fast.
|
|
||||||
|
|
||||||
**Switch to Game Solo Dev:** Type `@game-solo-dev` or select the agent from your IDE.
|
|
||||||
|
|
||||||
The Game Solo Dev agent includes:
|
|
||||||
|
|
||||||
- `quick-prototype` - Rapid mechanic testing
|
|
||||||
- `quick-dev` - Flexible feature implementation
|
|
||||||
- `quick-spec` - Create implementation-ready specs
|
|
||||||
- `code-review` - Quality checks
|
|
||||||
- `test-framework` - Automated testing setup
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Overview
|
|
||||||
|
|
||||||
Quick-flow workflows skip the full BMGD planning phases when you need to move fast. Use them for:
|
|
||||||
|
|
||||||
- Testing a game mechanic idea
|
- Testing a game mechanic idea
|
||||||
- Implementing a small feature
|
- Implementing a small feature
|
||||||
- Rapid prototyping before committing to design
|
- Rapid prototyping before committing to design
|
||||||
- Bug fixes and tweaks
|
- Bug fixes and tweaks
|
||||||
|
|
||||||
```
|
## When to Use Full BMGD Instead
|
||||||
Full BMGD Flow:
|
|
||||||
Brief → GDD → Architecture → Sprint Planning → Stories → Implementation
|
|
||||||
|
|
||||||
Quick-Flow:
|
- Building a major feature or system
|
||||||
Idea → Quick-Prototype → Quick-Dev → Done
|
- The scope is unclear or large
|
||||||
```
|
- Multiple team members need alignment
|
||||||
|
- The work affects game pillars or core loop
|
||||||
|
- You need documentation for future reference
|
||||||
|
|
||||||
---
|
:::note[Prerequisites]
|
||||||
|
- BMad Method installed with BMGD module
|
||||||
|
- Game Solo Dev agent (Indie) or other BMGD agent available
|
||||||
|
:::
|
||||||
|
|
||||||
|
## Game Solo Dev Agent
|
||||||
|
|
||||||
|
For dedicated quick-flow development, use the **Game Solo Dev** agent. This agent is optimized for solo developers and small teams who want to skip the full planning phases.
|
||||||
|
|
||||||
|
**Switch to Game Solo Dev:** Type `@game-solo-dev` or select from your IDE.
|
||||||
|
|
||||||
|
Includes: `quick-prototype`, `quick-dev`, `quick-spec`, `code-review`, `test-framework`
|
||||||
|
|
||||||
## Quick-Prototype
|
## Quick-Prototype
|
||||||
|
|
||||||
**Command:** `quick-prototype`
|
Use `quick-prototype` to rapidly test gameplay ideas with minimal setup.
|
||||||
**Agent:** Game Designer, Game Developer
|
|
||||||
**Purpose:** Rapidly test gameplay ideas with minimal setup
|
|
||||||
|
|
||||||
### When to Use
|
### When to Use
|
||||||
|
|
||||||
|
|
@ -55,60 +44,31 @@ Idea → Quick-Prototype → Quick-Dev → Done
|
||||||
- You want to experiment before committing to design
|
- You want to experiment before committing to design
|
||||||
- You need a proof of concept
|
- You need a proof of concept
|
||||||
|
|
||||||
### Workflow Steps
|
### Steps
|
||||||
|
|
||||||
1. **Define Scope** - What are you prototyping? (mechanic, feature, system)
|
1. Run `quick-prototype`
|
||||||
2. **Set Success Criteria** - How will you know if it works?
|
2. Define what you're prototyping (mechanic, feature, system)
|
||||||
3. **Rapid Implementation** - Build the minimum to test the idea
|
3. Set success criteria (2-3 items)
|
||||||
4. **Playtest and Evaluate** - Does it feel right?
|
4. Build the minimum to test the idea
|
||||||
|
5. Playtest and evaluate
|
||||||
|
|
||||||
### Prototype Principles
|
### Prototype Principles
|
||||||
|
|
||||||
- **Minimum Viable Prototype** - Only what's needed to test the idea
|
- **Minimum Viable Prototype** — Only what's needed to test the idea
|
||||||
- **Hardcode First** - Magic numbers are fine, extract later
|
- **Hardcode First** — Magic numbers are fine, extract later
|
||||||
- **Skip Edge Cases** - Happy path only for now
|
- **Skip Edge Cases** — Happy path only for now
|
||||||
- **Placeholder Everything** - Cubes, debug text, temp sounds
|
- **Placeholder Everything** — Cubes, debug text, temp sounds
|
||||||
- **Comment Intent** - Mark what's temporary vs keeper code
|
- **Comment Intent** — Mark what's temporary vs keeper code
|
||||||
|
|
||||||
### Example Session
|
|
||||||
|
|
||||||
```
|
|
||||||
You: quick-prototype
|
|
||||||
|
|
||||||
Agent: What are you prototyping?
|
|
||||||
|
|
||||||
You: I want to test a grappling hook mechanic. Player should be
|
|
||||||
able to aim at surfaces and pull themselves toward the hook point.
|
|
||||||
|
|
||||||
Agent: What makes this prototype successful?
|
|
||||||
|
|
||||||
You: 1. Aiming feels responsive and intuitive
|
|
||||||
2. The pull movement feels satisfying, not floaty
|
|
||||||
3. Player can chain hooks without awkward pauses
|
|
||||||
|
|
||||||
Agent: [Implements minimal grappling hook]
|
|
||||||
|
|
||||||
Agent: Prototype complete! Playtest results:
|
|
||||||
- Aiming: Works, consider adding aim assist
|
|
||||||
- Movement: Pull is smooth, might need speed curve
|
|
||||||
- Chaining: Currently has 0.2s delay, feels sluggish
|
|
||||||
|
|
||||||
Next: [d] Develop further | [i] Iterate | [a] Archive
|
|
||||||
```
|
|
||||||
|
|
||||||
### After Prototyping
|
### After Prototyping
|
||||||
|
|
||||||
- **Develop** (`d`) - Use `quick-dev` to build production code
|
- **Develop** (`d`) — Use `quick-dev` to build production code
|
||||||
- **Iterate** (`i`) - Adjust and re-test the prototype
|
- **Iterate** (`i`) — Adjust and re-test the prototype
|
||||||
- **Archive** (`a`) - Keep as reference, move on to other ideas
|
- **Archive** (`a`) — Keep as reference, move on to other ideas
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Quick-Dev
|
## Quick-Dev
|
||||||
|
|
||||||
**Command:** `quick-dev`
|
Use `quick-dev` for flexible development with game-specific considerations.
|
||||||
**Agent:** Game Developer
|
|
||||||
**Purpose:** Flexible development with game-specific considerations
|
|
||||||
|
|
||||||
### When to Use
|
### When to Use
|
||||||
|
|
||||||
|
|
@ -120,172 +80,77 @@ Agent: Prototype complete! Playtest results:
|
||||||
### Workflow Modes
|
### Workflow Modes
|
||||||
|
|
||||||
**Mode A: Tech-Spec Driven**
|
**Mode A: Tech-Spec Driven**
|
||||||
|
|
||||||
```
|
```
|
||||||
You: quick-dev tech-spec-combat.md
|
quick-dev tech-spec-combat.md
|
||||||
Agent: [Loads spec, extracts tasks, implements]
|
|
||||||
```
|
```
|
||||||
|
|
||||||
**Mode B: Direct Instructions**
|
**Mode B: Direct Instructions**
|
||||||
|
|
||||||
```
|
```
|
||||||
You: quick-dev implement double-jump for the player
|
quick-dev implement double-jump for the player
|
||||||
Agent: [Evaluates complexity, offers planning options]
|
|
||||||
```
|
```
|
||||||
|
|
||||||
**Mode C: From Prototype**
|
**Mode C: From Prototype**
|
||||||
|
|
||||||
```
|
```
|
||||||
You: quick-dev from the grappling hook prototype
|
quick-dev from the grappling hook prototype
|
||||||
Agent: [Loads prototype, productionizes code]
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### Game-Specific Checks
|
### Game-Specific Checks
|
||||||
|
|
||||||
Quick-dev includes automatic consideration of:
|
Quick-dev includes automatic consideration of:
|
||||||
|
- **Performance** — No allocations in hot paths, object pooling
|
||||||
- **Performance** - No allocations in hot paths, object pooling
|
- **Feel** — Input responsiveness, visual/audio feedback
|
||||||
- **Feel** - Input responsiveness, visual/audio feedback
|
- **Integration** — Save/load, multiplayer sync, platform testing
|
||||||
- **Integration** - Save/load, multiplayer sync, platform testing
|
|
||||||
|
|
||||||
### Example Session
|
|
||||||
|
|
||||||
```
|
|
||||||
You: quick-dev implement enemy patrol behavior
|
|
||||||
|
|
||||||
Agent: This looks like a focused feature. Options:
|
|
||||||
[t] Plan first - Create tech-spec (recommended)
|
|
||||||
[r] Prototype first - Test the idea
|
|
||||||
[e] Execute directly
|
|
||||||
|
|
||||||
You: e
|
|
||||||
|
|
||||||
Agent: Any additional guidance? (patterns, files, constraints)
|
|
||||||
|
|
||||||
You: Use the existing AIController base class. Enemies should
|
|
||||||
patrol between waypoints and return if player leaves range.
|
|
||||||
|
|
||||||
Agent: [Implements patrol behavior]
|
|
||||||
|
|
||||||
Agent: Implementation Complete!
|
|
||||||
Files Modified: EnemyAI.cs, PatrolBehavior.cs
|
|
||||||
Tests: Unit tests added for patrol state machine
|
|
||||||
Performance: No per-frame allocations
|
|
||||||
|
|
||||||
Recommended: Playtest the changes
|
|
||||||
```
|
|
||||||
|
|
||||||
### Complexity Routing
|
### Complexity Routing
|
||||||
|
|
||||||
Quick-dev automatically detects complex requests and offers alternatives:
|
| Signals | Recommendation |
|
||||||
|
|---------|----------------|
|
||||||
| Signals | Recommendation |
|
| Single mechanic, bug fix, tweak | Execute directly |
|
||||||
| -------------------------------------- | ---------------------- |
|
|
||||||
| Single mechanic, bug fix, tweak | Execute directly |
|
|
||||||
| Multiple systems, performance-critical | Plan first (tech-spec) |
|
| Multiple systems, performance-critical | Plan first (tech-spec) |
|
||||||
| Platform/system level work | Use full BMGD workflow |
|
| Platform/system level work | Use full BMGD workflow |
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Choosing Between Quick-Flows
|
## Choosing Between Quick-Flows
|
||||||
|
|
||||||
| Scenario | Use |
|
| Scenario | Use |
|
||||||
| ----------------------- | ------------------------------- |
|
|----------|-----|
|
||||||
| "Will this be fun?" | `quick-prototype` |
|
| "Will this be fun?" | `quick-prototype` |
|
||||||
| "How should this feel?" | `quick-prototype` |
|
| "How should this feel?" | `quick-prototype` |
|
||||||
| "Build this feature" | `quick-dev` |
|
| "Build this feature" | `quick-dev` |
|
||||||
| "Fix this bug" | `quick-dev` |
|
| "Fix this bug" | `quick-dev` |
|
||||||
| "Test then build" | `quick-prototype` → `quick-dev` |
|
| "Test then build" | `quick-prototype` → `quick-dev` |
|
||||||
|
|
||||||
---
|
## Flow Comparison
|
||||||
|
|
||||||
## Quick-Flow vs Full BMGD
|
```
|
||||||
|
Full BMGD Flow:
|
||||||
|
Brief → GDD → Architecture → Sprint Planning → Stories → Implementation
|
||||||
|
|
||||||
### Use Quick-Flow When
|
Quick-Flow:
|
||||||
|
Idea → Quick-Prototype → Quick-Dev → Done
|
||||||
- The scope is small and well-understood
|
```
|
||||||
- You're experimenting or prototyping
|
|
||||||
- You have a clear tech-spec already
|
|
||||||
- The work doesn't affect core game systems significantly
|
|
||||||
|
|
||||||
### Use Full BMGD When
|
|
||||||
|
|
||||||
- Building a major feature or system
|
|
||||||
- The scope is unclear or large
|
|
||||||
- Multiple team members need alignment
|
|
||||||
- The work affects game pillars or core loop
|
|
||||||
- You need documentation for future reference
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Checklists
|
## Checklists
|
||||||
|
|
||||||
### Quick-Prototype Checklist
|
**Quick-Prototype:**
|
||||||
|
|
||||||
**Before:**
|
|
||||||
|
|
||||||
- [ ] Prototype scope defined
|
- [ ] Prototype scope defined
|
||||||
- [ ] Success criteria established (2-3 items)
|
- [ ] Success criteria established (2-3 items)
|
||||||
|
|
||||||
**During:**
|
|
||||||
|
|
||||||
- [ ] Minimum viable code written
|
- [ ] Minimum viable code written
|
||||||
- [ ] Placeholder assets used
|
- [ ] Placeholder assets used
|
||||||
- [ ] Core functionality testable
|
|
||||||
|
|
||||||
**After:**
|
|
||||||
|
|
||||||
- [ ] Each criterion evaluated
|
- [ ] Each criterion evaluated
|
||||||
- [ ] Decision made (develop/iterate/archive)
|
- [ ] Decision made (develop/iterate/archive)
|
||||||
|
|
||||||
### Quick-Dev Checklist
|
**Quick-Dev:**
|
||||||
|
|
||||||
**Before:**
|
|
||||||
|
|
||||||
- [ ] Context loaded (spec, prototype, or guidance)
|
- [ ] Context loaded (spec, prototype, or guidance)
|
||||||
- [ ] Files to modify identified
|
- [ ] Files to modify identified
|
||||||
- [ ] Patterns understood
|
|
||||||
|
|
||||||
**During:**
|
|
||||||
|
|
||||||
- [ ] All tasks completed
|
- [ ] All tasks completed
|
||||||
- [ ] No allocations in hot paths
|
- [ ] No allocations in hot paths
|
||||||
- [ ] Frame rate maintained
|
|
||||||
|
|
||||||
**After:**
|
|
||||||
|
|
||||||
- [ ] Game runs without errors
|
- [ ] Game runs without errors
|
||||||
- [ ] Feature works as specified
|
|
||||||
- [ ] Manual playtest completed
|
- [ ] Manual playtest completed
|
||||||
|
|
||||||
---
|
## Tips
|
||||||
|
|
||||||
## Tips for Success
|
- **Timebox prototypes** — Set a limit (e.g., 2 hours). If it's not working, step back
|
||||||
|
- **Embrace programmer art** — Focus on feel, not visuals
|
||||||
### 1. Timebox Prototypes
|
- **Test on target hardware** — What feels right on dev machine might not on target
|
||||||
|
- **Document learnings** — Even failed prototypes teach something
|
||||||
Set a limit (e.g., 2 hours) for prototyping. If it's not working by then, step back and reconsider.
|
- **Know when to graduate** — If quick-dev keeps expanding scope, create proper stories
|
||||||
|
|
||||||
### 2. Embrace Programmer Art
|
|
||||||
|
|
||||||
Prototypes don't need to look good. Focus on feel, not visuals.
|
|
||||||
|
|
||||||
### 3. Test on Target Hardware
|
|
||||||
|
|
||||||
What feels right on your dev machine might not feel right on target platform.
|
|
||||||
|
|
||||||
### 4. Document Learnings
|
|
||||||
|
|
||||||
Even failed prototypes teach something. Note what you learned.
|
|
||||||
|
|
||||||
### 5. Know When to Graduate
|
|
||||||
|
|
||||||
If quick-dev keeps expanding scope, stop and create proper stories.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Next Steps
|
|
||||||
|
|
||||||
- **[Workflows Guide](/docs/reference/workflows/bmgd-workflows.md)** - Full workflow reference
|
|
||||||
- **[Agents Guide](/docs/explanation/game-dev/agents.md)** - Agent capabilities
|
|
||||||
- **[Quick Start Guide](/docs/tutorials/getting-started/quick-start-bmgd.md)** - Getting started with BMGD
|
|
||||||
|
|
|
||||||
|
|
@ -3,11 +3,8 @@ title: "How to Conduct Research"
|
||||||
description: How to conduct market, technical, and competitive research using BMad Method
|
description: How to conduct market, technical, and competitive research using BMad Method
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
Use the `research` workflow to perform comprehensive multi-type research for validating ideas, understanding markets, and making informed decisions.
|
Use the `research` workflow to perform comprehensive multi-type research for validating ideas, understanding markets, and making informed decisions.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Use This
|
## When to Use This
|
||||||
|
|
||||||
- Need market viability validation
|
- Need market viability validation
|
||||||
|
|
@ -17,14 +14,10 @@ Use the `research` workflow to perform comprehensive multi-type research for val
|
||||||
- Understanding domain or industry
|
- Understanding domain or industry
|
||||||
- Need deeper AI-assisted research
|
- Need deeper AI-assisted research
|
||||||
|
|
||||||
---
|
:::note[Prerequisites]
|
||||||
|
|
||||||
## Prerequisites
|
|
||||||
|
|
||||||
- BMad Method installed
|
- BMad Method installed
|
||||||
- Analyst agent available
|
- Analyst agent available
|
||||||
|
:::
|
||||||
---
|
|
||||||
|
|
||||||
## Steps
|
## Steps
|
||||||
|
|
||||||
|
|
@ -42,14 +35,14 @@ Start a fresh chat and load the Analyst agent.
|
||||||
|
|
||||||
Select the type of research you need:
|
Select the type of research you need:
|
||||||
|
|
||||||
| Type | Purpose | Use When |
|
| Type | Purpose | Use When |
|
||||||
| --------------- | ------------------------------------------------------ | ----------------------------------- |
|
|------|---------|----------|
|
||||||
| **market** | TAM/SAM/SOM, competitive analysis | Need market viability validation |
|
| **market** | TAM/SAM/SOM, competitive analysis | Need market viability validation |
|
||||||
| **technical** | Technology evaluation, ADRs | Choosing frameworks/platforms |
|
| **technical** | Technology evaluation, ADRs | Choosing frameworks/platforms |
|
||||||
| **competitive** | Deep competitor analysis | Understanding competitive landscape |
|
| **competitive** | Deep competitor analysis | Understanding competitive landscape |
|
||||||
| **user** | Customer insights, personas, JTBD | Need user understanding |
|
| **user** | Customer insights, personas, JTBD | Need user understanding |
|
||||||
| **domain** | Industry deep dives, trends | Understanding domain/industry |
|
| **domain** | Industry deep dives, trends | Understanding domain/industry |
|
||||||
| **deep_prompt** | Generate AI research prompts (ChatGPT, Claude, Gemini) | Need deeper AI-assisted research |
|
| **deep_prompt** | Generate AI research prompts | Need deeper AI-assisted research |
|
||||||
|
|
||||||
### 4. Provide Context
|
### 4. Provide Context
|
||||||
|
|
||||||
|
|
@ -63,38 +56,24 @@ Give the agent details about what you're researching:
|
||||||
|
|
||||||
Choose your depth level:
|
Choose your depth level:
|
||||||
|
|
||||||
- **Quick** - Fast overview
|
- **Quick** — Fast overview
|
||||||
- **Standard** - Balanced depth
|
- **Standard** — Balanced depth
|
||||||
- **Comprehensive** - Deep analysis
|
- **Comprehensive** — Deep analysis
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## What You Get
|
## What You Get
|
||||||
|
|
||||||
### Market Research Example
|
Research output varies by type:
|
||||||
|
|
||||||
```
|
**Market Research:**
|
||||||
TAM: $50B
|
- TAM/SAM/SOM analysis
|
||||||
SAM: $5B
|
- Top competitors
|
||||||
SOM: $50M
|
- Positioning recommendation
|
||||||
|
|
||||||
Top Competitors:
|
**Technical Research:**
|
||||||
- Asana
|
|
||||||
- Monday
|
|
||||||
- etc.
|
|
||||||
|
|
||||||
Positioning Recommendation: ...
|
|
||||||
```
|
|
||||||
|
|
||||||
### Technical Research Example
|
|
||||||
|
|
||||||
Technology evaluation with:
|
|
||||||
- Comparison matrix
|
- Comparison matrix
|
||||||
- Trade-off analysis
|
- Trade-off analysis
|
||||||
- Recommendations with rationale
|
- Recommendations with rationale
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Key Features
|
## Key Features
|
||||||
|
|
||||||
- Real-time web research
|
- Real-time web research
|
||||||
|
|
@ -102,29 +81,17 @@ Technology evaluation with:
|
||||||
- Platform-specific optimization for deep_prompt type
|
- Platform-specific optimization for deep_prompt type
|
||||||
- Configurable research depth
|
- Configurable research depth
|
||||||
|
|
||||||
---
|
## Tips
|
||||||
|
|
||||||
|
- **Use market research early** — Validates new product ideas
|
||||||
|
- **Technical research helps architecture** — Inform ADRs with data
|
||||||
|
- **Competitive research informs positioning** — Differentiate your product
|
||||||
|
- **Domain research for specialized industries** — Fintech, healthcare, etc.
|
||||||
|
|
||||||
## Next Steps
|
## Next Steps
|
||||||
|
|
||||||
After research:
|
After research:
|
||||||
|
|
||||||
1. **Product Brief** - Capture strategic vision informed by research
|
1. **Product Brief** — Capture strategic vision informed by research
|
||||||
2. **PRD** - Use findings as context for requirements
|
2. **PRD** — Use findings as context for requirements
|
||||||
3. **Architecture** - Use technical research in ADRs
|
3. **Architecture** — Use technical research in ADRs
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Tips
|
|
||||||
|
|
||||||
- Use market research early for new products
|
|
||||||
- Technical research helps with architecture decisions
|
|
||||||
- Competitive research informs positioning
|
|
||||||
- Domain research is valuable for specialized industries
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Related
|
|
||||||
|
|
||||||
- [Run Brainstorming Session](/docs/how-to/workflows/run-brainstorming-session.md) - Explore ideas before research
|
|
||||||
- [Create Product Brief](/docs/how-to/workflows/create-product-brief.md) - Capture strategic vision
|
|
||||||
- [Create PRD](/docs/how-to/workflows/create-prd.md) - Move to formal planning
|
|
||||||
|
|
|
||||||
|
|
@ -3,11 +3,8 @@ title: "How to Create Architecture"
|
||||||
description: How to create system architecture using the BMad Method
|
description: How to create system architecture using the BMad Method
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
Use the `architecture` workflow to make technical decisions explicit and prevent agent conflicts during implementation.
|
Use the `architecture` workflow to make technical decisions explicit and prevent agent conflicts during implementation.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Use This
|
## When to Use This
|
||||||
|
|
||||||
- Multi-epic projects (BMad Method, Enterprise)
|
- Multi-epic projects (BMad Method, Enterprise)
|
||||||
|
|
@ -16,23 +13,17 @@ Use the `architecture` workflow to make technical decisions explicit and prevent
|
||||||
- Integration complexity exists
|
- Integration complexity exists
|
||||||
- Technology choices need alignment
|
- Technology choices need alignment
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Skip This
|
## When to Skip This
|
||||||
|
|
||||||
- Quick Flow (simple changes)
|
- Quick Flow (simple changes)
|
||||||
- BMad Method Simple with straightforward tech stack
|
- BMad Method Simple with straightforward tech stack
|
||||||
- Single epic with clear technical approach
|
- Single epic with clear technical approach
|
||||||
|
|
||||||
---
|
:::note[Prerequisites]
|
||||||
|
|
||||||
## Prerequisites
|
|
||||||
|
|
||||||
- BMad Method installed
|
- BMad Method installed
|
||||||
- Architect agent available
|
- Architect agent available
|
||||||
- PRD completed
|
- PRD completed
|
||||||
|
:::
|
||||||
---
|
|
||||||
|
|
||||||
## Steps
|
## Steps
|
||||||
|
|
||||||
|
|
@ -63,25 +54,21 @@ Work with the agent to create Architecture Decision Records (ADRs) for significa
|
||||||
|
|
||||||
The agent produces a decision-focused architecture document.
|
The agent produces a decision-focused architecture document.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## What You Get
|
## What You Get
|
||||||
|
|
||||||
An `architecture.md` document containing:
|
An `architecture.md` document containing:
|
||||||
|
|
||||||
1. **Architecture Overview** - System context, principles, style
|
1. **Architecture Overview** — System context, principles, style
|
||||||
2. **System Architecture** - High-level diagram, component interactions
|
2. **System Architecture** — High-level diagram, component interactions
|
||||||
3. **Data Architecture** - Database design, state management, caching
|
3. **Data Architecture** — Database design, state management, caching
|
||||||
4. **API Architecture** - API style (REST/GraphQL/gRPC), auth, versioning
|
4. **API Architecture** — API style (REST/GraphQL/gRPC), auth, versioning
|
||||||
5. **Frontend Architecture** - Framework, state management, components
|
5. **Frontend Architecture** — Framework, state management, components
|
||||||
6. **Integration Architecture** - Third-party integrations, messaging
|
6. **Integration Architecture** — Third-party integrations, messaging
|
||||||
7. **Security Architecture** - Auth/authorization, data protection
|
7. **Security Architecture** — Auth/authorization, data protection
|
||||||
8. **Deployment Architecture** - CI/CD, environments, monitoring
|
8. **Deployment Architecture** — CI/CD, environments, monitoring
|
||||||
9. **ADRs** - Key decisions with context, options, rationale
|
9. **ADRs** — Key decisions with context, options, rationale
|
||||||
10. **FR/NFR-Specific Guidance** - Technical approach per requirement
|
10. **FR/NFR-Specific Guidance** — Technical approach per requirement
|
||||||
11. **Standards and Conventions** - Directory structure, naming, testing
|
11. **Standards and Conventions** — Directory structure, naming, testing
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## ADR Format
|
## ADR Format
|
||||||
|
|
||||||
|
|
@ -110,8 +97,6 @@ An `architecture.md` document containing:
|
||||||
- Mitigation: Use DataLoader for batching
|
- Mitigation: Use DataLoader for batching
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Example
|
## Example
|
||||||
|
|
||||||
E-commerce platform produces:
|
E-commerce platform produces:
|
||||||
|
|
@ -119,29 +104,16 @@ E-commerce platform produces:
|
||||||
- ADRs explaining each choice
|
- ADRs explaining each choice
|
||||||
- FR/NFR-specific implementation guidance
|
- FR/NFR-specific implementation guidance
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Tips
|
## Tips
|
||||||
|
|
||||||
- Focus on decisions that prevent agent conflicts
|
- **Focus on decisions that prevent conflicts** — Multiple agents need alignment
|
||||||
- Use ADRs for every significant technology choice
|
- **Use ADRs for every significant choice** — Document the "why"
|
||||||
- Keep it practical - don't over-architect
|
- **Keep it practical** — Don't over-architect
|
||||||
- Architecture is living - update as you learn
|
- **Architecture is living** — Update as you learn
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Next Steps
|
## Next Steps
|
||||||
|
|
||||||
After architecture:
|
After architecture:
|
||||||
|
|
||||||
1. **Create Epics and Stories** - Work breakdown informed by architecture
|
1. **Create Epics and Stories** — Work breakdown informed by architecture
|
||||||
2. **Implementation Readiness** - Gate check before Phase 4
|
2. **Implementation Readiness** — Gate check before Phase 4
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Related
|
|
||||||
|
|
||||||
- [Create PRD](/docs/how-to/workflows/create-prd.md) - Requirements before architecture
|
|
||||||
- [Create Epics and Stories](/docs/how-to/workflows/create-epics-and-stories.md) - Next step
|
|
||||||
- [Run Implementation Readiness](/docs/how-to/workflows/run-implementation-readiness.md) - Gate check
|
|
||||||
- [Why Solutioning Matters](/docs/explanation/architecture/why-solutioning-matters.md)
|
|
||||||
|
|
|
||||||
|
|
@ -3,38 +3,29 @@ title: "How to Create Epics and Stories"
|
||||||
description: How to break PRD requirements into epics and stories using BMad Method
|
description: 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.
|
Use the `create-epics-and-stories` workflow to transform PRD requirements into bite-sized stories organized into deliverable epics.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Use This
|
## When to Use This
|
||||||
|
|
||||||
- After architecture workflow completes
|
- After architecture workflow completes
|
||||||
- When PRD contains FRs/NFRs ready for implementation breakdown
|
- When PRD contains FRs/NFRs ready for implementation breakdown
|
||||||
- Before implementation-readiness gate check
|
- Before implementation-readiness gate check
|
||||||
|
|
||||||
---
|
:::note[Prerequisites]
|
||||||
|
|
||||||
## Prerequisites
|
|
||||||
|
|
||||||
- BMad Method installed
|
- BMad Method installed
|
||||||
- PM agent available
|
- PM agent available
|
||||||
- PRD completed
|
- PRD completed
|
||||||
- Architecture completed
|
- Architecture completed
|
||||||
|
:::
|
||||||
---
|
|
||||||
|
|
||||||
## Why After Architecture?
|
## Why After Architecture?
|
||||||
|
|
||||||
This workflow runs AFTER architecture because:
|
This workflow runs AFTER architecture because:
|
||||||
|
|
||||||
1. **Informed Story Sizing** - Architecture decisions affect story complexity
|
1. **Informed Story Sizing** — Architecture decisions affect story complexity
|
||||||
2. **Dependency Awareness** - Architecture reveals technical dependencies
|
2. **Dependency Awareness** — Architecture reveals technical dependencies
|
||||||
3. **Technical Feasibility** - Stories can be properly scoped knowing the tech stack
|
3. **Technical Feasibility** — Stories can be properly scoped knowing the tech stack
|
||||||
4. **Consistency** - All stories align with documented architectural patterns
|
4. **Consistency** — All stories align with documented architectural patterns
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Steps
|
## Steps
|
||||||
|
|
||||||
|
|
@ -67,8 +58,6 @@ Ensure each story has:
|
||||||
- Identified dependencies
|
- Identified dependencies
|
||||||
- Technical notes from architecture
|
- Technical notes from architecture
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## What You Get
|
## What You Get
|
||||||
|
|
||||||
Epic files (one per epic) containing:
|
Epic files (one per epic) containing:
|
||||||
|
|
@ -79,8 +68,6 @@ Epic files (one per epic) containing:
|
||||||
4. **Dependencies between stories**
|
4. **Dependencies between stories**
|
||||||
5. **Technical notes** referencing architecture decisions
|
5. **Technical notes** referencing architecture decisions
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Example
|
## Example
|
||||||
|
|
||||||
E-commerce PRD with FR-001 (User Registration), FR-002 (Product Catalog) produces:
|
E-commerce PRD with FR-001 (User Registration), FR-002 (Product Catalog) produces:
|
||||||
|
|
@ -98,39 +85,25 @@ E-commerce PRD with FR-001 (User Registration), FR-002 (Product Catalog) produce
|
||||||
|
|
||||||
Each story references relevant ADRs from architecture.
|
Each story references relevant ADRs from architecture.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Story Priority Levels
|
## Story Priority Levels
|
||||||
|
|
||||||
| Priority | Meaning |
|
| Priority | Meaning |
|
||||||
|----------|---------|
|
|----------|---------|
|
||||||
| **P0** | Critical - Must have for MVP |
|
| **P0** | Critical — Must have for MVP |
|
||||||
| **P1** | High - Important for release |
|
| **P1** | High — Important for release |
|
||||||
| **P2** | Medium - Nice to have |
|
| **P2** | Medium — Nice to have |
|
||||||
| **P3** | Low - Future consideration |
|
| **P3** | Low — Future consideration |
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Tips
|
## Tips
|
||||||
|
|
||||||
- Keep stories small enough to complete in a session
|
- **Keep stories small** — Complete in a single session
|
||||||
- Ensure acceptance criteria are testable
|
- **Make criteria testable** — Acceptance criteria should be verifiable
|
||||||
- Document dependencies clearly
|
- **Document dependencies clearly** — Know what blocks what
|
||||||
- Reference architecture decisions in technical notes
|
- **Reference architecture** — Include ADR references in technical notes
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Next Steps
|
## Next Steps
|
||||||
|
|
||||||
After creating epics and stories:
|
After creating epics and stories:
|
||||||
|
|
||||||
1. **Implementation Readiness** - Validate alignment before Phase 4
|
1. **Implementation Readiness** — Validate alignment before Phase 4
|
||||||
2. **Sprint Planning** - Organize work for implementation
|
2. **Sprint Planning** — Organize work for implementation
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Related
|
|
||||||
|
|
||||||
- [Create Architecture](/docs/how-to/workflows/create-architecture.md) - Do this first
|
|
||||||
- [Run Implementation Readiness](/docs/how-to/workflows/run-implementation-readiness.md) - Gate check
|
|
||||||
- [Run Sprint Planning](/docs/how-to/workflows/run-sprint-planning.md) - Start implementation
|
|
||||||
|
|
|
||||||
|
|
@ -3,11 +3,8 @@ title: "How to Create a PRD"
|
||||||
description: How to create a Product Requirements Document using the BMad Method
|
description: 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).
|
Use the `prd` workflow to create a strategic Product Requirements Document with Functional Requirements (FRs) and Non-Functional Requirements (NFRs).
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Use This
|
## When to Use This
|
||||||
|
|
||||||
- Medium to large feature sets
|
- Medium to large feature sets
|
||||||
|
|
@ -16,15 +13,11 @@ Use the `prd` workflow to create a strategic Product Requirements Document with
|
||||||
- Multiple system integrations
|
- Multiple system integrations
|
||||||
- Phased delivery required
|
- Phased delivery required
|
||||||
|
|
||||||
---
|
:::note[Prerequisites]
|
||||||
|
|
||||||
## Prerequisites
|
|
||||||
|
|
||||||
- BMad Method installed
|
- BMad Method installed
|
||||||
- PM agent available
|
- PM agent available
|
||||||
- Optional: Product brief from Phase 1
|
- Optional: Product brief from Phase 1
|
||||||
|
:::
|
||||||
---
|
|
||||||
|
|
||||||
## Steps
|
## Steps
|
||||||
|
|
||||||
|
|
@ -48,15 +41,13 @@ The workflow will:
|
||||||
### 4. Define Requirements
|
### 4. Define Requirements
|
||||||
|
|
||||||
Work with the agent to define:
|
Work with the agent to define:
|
||||||
- Functional Requirements (FRs) - What the system should do
|
- Functional Requirements (FRs) — What the system should do
|
||||||
- Non-Functional Requirements (NFRs) - How well it should do it
|
- Non-Functional Requirements (NFRs) — How well it should do it
|
||||||
|
|
||||||
### 5. Review the PRD
|
### 5. Review the PRD
|
||||||
|
|
||||||
The agent produces a comprehensive PRD scaled to your project.
|
The agent produces a comprehensive PRD scaled to your project.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## What You Get
|
## What You Get
|
||||||
|
|
||||||
A `PRD.md` document containing:
|
A `PRD.md` document containing:
|
||||||
|
|
@ -69,8 +60,6 @@ A `PRD.md` document containing:
|
||||||
- Success metrics
|
- Success metrics
|
||||||
- Risks and assumptions
|
- Risks and assumptions
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Scale-Adaptive Structure
|
## Scale-Adaptive Structure
|
||||||
|
|
||||||
The PRD adapts to your project complexity:
|
The PRD adapts to your project complexity:
|
||||||
|
|
@ -81,50 +70,22 @@ The PRD adapts to your project complexity:
|
||||||
| **Standard** | 20-30 | Comprehensive FRs/NFRs, thorough analysis |
|
| **Standard** | 20-30 | Comprehensive FRs/NFRs, thorough analysis |
|
||||||
| **Comprehensive** | 30-50+ | Extensive FRs/NFRs, multi-phase, stakeholder 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
|
## Example
|
||||||
|
|
||||||
E-commerce checkout → PRD with:
|
E-commerce checkout → PRD with:
|
||||||
- 15 FRs (user account, cart management, payment flow)
|
- 15 FRs (user account, cart management, payment flow)
|
||||||
- 8 NFRs (performance, security, scalability)
|
- 8 NFRs (performance, security, scalability)
|
||||||
|
|
||||||
---
|
## Tips
|
||||||
|
|
||||||
## Best Practices
|
- **Do Product Brief first** — Run product-brief from Phase 1 for better results
|
||||||
|
- **Focus on "What" not "How"** — Planning defines what to build and why. Leave how (technical design) to Phase 3
|
||||||
### 1. Do Product Brief First
|
- **Document-Project first for Brownfield** — Always run `document-project` before planning brownfield projects. AI agents need existing codebase context
|
||||||
|
|
||||||
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
|
## Next Steps
|
||||||
|
|
||||||
After PRD:
|
After PRD:
|
||||||
|
|
||||||
1. **Create UX Design** (optional) - If UX is critical
|
1. **Create UX Design** (optional) — If UX is critical
|
||||||
2. **Create Architecture** - Technical design
|
2. **Create Architecture** — Technical design
|
||||||
3. **Create Epics and Stories** - After architecture
|
3. **Create Epics and Stories** — After architecture
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Related
|
|
||||||
|
|
||||||
- [Create Product Brief](/docs/how-to/workflows/create-product-brief.md) - Input for PRD
|
|
||||||
- [Create UX Design](/docs/how-to/workflows/create-ux-design.md) - Optional UX workflow
|
|
||||||
- [Create Architecture](/docs/how-to/workflows/create-architecture.md) - Next step after PRD
|
|
||||||
|
|
|
||||||
|
|
@ -3,11 +3,8 @@ title: "How to Create a Product Brief"
|
||||||
description: How to create a product brief using the BMad Method
|
description: How to create a product brief using the BMad Method
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
Use the `product-brief` workflow to define product vision and strategy through an interactive process.
|
Use the `product-brief` workflow to define product vision and strategy through an interactive process.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Use This
|
## When to Use This
|
||||||
|
|
||||||
- Starting new product or major feature initiative
|
- Starting new product or major feature initiative
|
||||||
|
|
@ -15,15 +12,11 @@ Use the `product-brief` workflow to define product vision and strategy through a
|
||||||
- Transitioning from exploration to strategy
|
- Transitioning from exploration to strategy
|
||||||
- Need executive-level product documentation
|
- Need executive-level product documentation
|
||||||
|
|
||||||
---
|
:::note[Prerequisites]
|
||||||
|
|
||||||
## Prerequisites
|
|
||||||
|
|
||||||
- BMad Method installed
|
- BMad Method installed
|
||||||
- Analyst agent available
|
- Analyst agent available
|
||||||
- Optional: Research documents from previous workflows
|
- Optional: Research documents from previous workflows
|
||||||
|
:::
|
||||||
---
|
|
||||||
|
|
||||||
## Steps
|
## Steps
|
||||||
|
|
||||||
|
|
@ -50,22 +43,18 @@ The workflow guides you through strategic product vision definition:
|
||||||
|
|
||||||
The agent will draft sections and let you refine them interactively.
|
The agent will draft sections and let you refine them interactively.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## What You Get
|
## What You Get
|
||||||
|
|
||||||
The `product-brief.md` document includes:
|
The `product-brief.md` document includes:
|
||||||
|
|
||||||
- **Executive summary** - High-level overview
|
- **Executive summary** — High-level overview
|
||||||
- **Problem statement** - With evidence
|
- **Problem statement** — With evidence
|
||||||
- **Proposed solution** - And differentiators
|
- **Proposed solution** — And differentiators
|
||||||
- **Target users** - Segmented
|
- **Target users** — Segmented
|
||||||
- **MVP scope** - Ruthlessly defined
|
- **MVP scope** — Ruthlessly defined
|
||||||
- **Financial impact** - And ROI
|
- **Financial impact** — And ROI
|
||||||
- **Strategic alignment** - With business goals
|
- **Strategic alignment** — With business goals
|
||||||
- **Risks and open questions** - Documented upfront
|
- **Risks and open questions** — Documented upfront
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Integration with Other Workflows
|
## Integration with Other Workflows
|
||||||
|
|
||||||
|
|
@ -79,11 +68,9 @@ The product brief feeds directly into the PRD workflow:
|
||||||
|
|
||||||
Planning workflows automatically load the product brief if it exists.
|
Planning workflows automatically load the product brief if it exists.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Common Patterns
|
## Common Patterns
|
||||||
|
|
||||||
### Greenfield Software (Full Analysis)
|
**Greenfield Software (Full Analysis):**
|
||||||
|
|
||||||
```
|
```
|
||||||
1. brainstorm-project - explore approaches
|
1. brainstorm-project - explore approaches
|
||||||
|
|
@ -92,26 +79,16 @@ Planning workflows automatically load the product brief if it exists.
|
||||||
4. → Phase 2: prd
|
4. → Phase 2: prd
|
||||||
```
|
```
|
||||||
|
|
||||||
### Skip Analysis (Clear Requirements)
|
**Skip Analysis (Clear Requirements):**
|
||||||
|
|
||||||
```
|
```
|
||||||
→ Phase 2: prd or tech-spec directly
|
→ Phase 2: prd or tech-spec directly
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Tips
|
## Tips
|
||||||
|
|
||||||
- Be specific about the problem you're solving
|
- **Be specific about the problem** — Vague problems lead to vague solutions
|
||||||
- Ruthlessly prioritize MVP scope
|
- **Ruthlessly prioritize MVP scope** — Less is more
|
||||||
- Document assumptions and risks
|
- **Document assumptions and risks** — Surface unknowns early
|
||||||
- Use research findings as evidence
|
- **Use research findings as evidence** — Back up claims with data
|
||||||
- This is recommended for greenfield projects
|
- **Recommended for greenfield projects** — Sets strategic foundation
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Related
|
|
||||||
|
|
||||||
- [Run Brainstorming Session](/docs/how-to/workflows/run-brainstorming-session.md) - Explore ideas first
|
|
||||||
- [Conduct Research](/docs/how-to/workflows/conduct-research.md) - Validate ideas
|
|
||||||
- [Create PRD](/docs/how-to/workflows/create-prd.md) - Next step after product brief
|
|
||||||
|
|
|
||||||
|
|
@ -3,27 +3,20 @@ title: "How to Create a Story"
|
||||||
description: How to create implementation-ready stories from epic backlog
|
description: 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.
|
Use the `create-story` workflow to prepare the next story from the epic backlog for implementation.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Use This
|
## When to Use This
|
||||||
|
|
||||||
- Before implementing each story
|
- Before implementing each story
|
||||||
- When moving to the next story in an epic
|
- When moving to the next story in an epic
|
||||||
- After sprint-planning has been run
|
- After sprint-planning has been run
|
||||||
|
|
||||||
---
|
:::note[Prerequisites]
|
||||||
|
|
||||||
## Prerequisites
|
|
||||||
|
|
||||||
- BMad Method installed
|
- BMad Method installed
|
||||||
- SM (Scrum Master) agent available
|
- SM (Scrum Master) agent available
|
||||||
- Sprint-status.yaml created by sprint-planning
|
- Sprint-status.yaml created by sprint-planning
|
||||||
- Architecture and PRD available for context
|
- Architecture and PRD available for context
|
||||||
|
:::
|
||||||
---
|
|
||||||
|
|
||||||
## Steps
|
## Steps
|
||||||
|
|
||||||
|
|
@ -48,8 +41,6 @@ The agent will:
|
||||||
|
|
||||||
The agent creates a comprehensive story file ready for development.
|
The agent creates a comprehensive story file ready for development.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## What You Get
|
## What You Get
|
||||||
|
|
||||||
A `story-[slug].md` file containing:
|
A `story-[slug].md` file containing:
|
||||||
|
|
@ -61,23 +52,18 @@ A `story-[slug].md` file containing:
|
||||||
- Dependencies on other stories
|
- Dependencies on other stories
|
||||||
- Definition of Done
|
- Definition of Done
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Story Content Sources
|
## Story Content Sources
|
||||||
|
|
||||||
The create-story workflow pulls from:
|
The create-story workflow pulls from:
|
||||||
|
|
||||||
- **PRD** - Requirements and acceptance criteria
|
- **PRD** — Requirements and acceptance criteria
|
||||||
- **Architecture** - Technical approach and ADRs
|
- **Architecture** — Technical approach and ADRs
|
||||||
- **Epic file** - Story context and dependencies
|
- **Epic file** — Story context and dependencies
|
||||||
- **Existing code** - Patterns to follow (brownfield)
|
- **Existing code** — Patterns to follow (brownfield)
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Example Output
|
## Example Output
|
||||||
|
|
||||||
```markdown
|
```markdown
|
||||||
|
|
||||||
## Objective
|
## Objective
|
||||||
Implement email verification flow for new user registrations.
|
Implement email verification flow for new user registrations.
|
||||||
|
|
||||||
|
|
@ -93,7 +79,7 @@ Implement email verification flow for new user registrations.
|
||||||
- Follow existing email template patterns in /templates
|
- Follow existing email template patterns in /templates
|
||||||
|
|
||||||
## Dependencies
|
## Dependencies
|
||||||
- Story 1.1 (User Registration) - DONE ✅
|
- Story 1.1 (User Registration) - DONE
|
||||||
|
|
||||||
## Definition of Done
|
## Definition of Done
|
||||||
- All acceptance criteria pass
|
- All acceptance criteria pass
|
||||||
|
|
@ -101,19 +87,16 @@ Implement email verification flow for new user registrations.
|
||||||
- Code review approved
|
- Code review approved
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Tips
|
## Tips
|
||||||
|
|
||||||
- Complete one story before creating the next
|
- **Complete one story before creating the next** — Focus on finishing
|
||||||
- Ensure dependencies are marked DONE before starting
|
- **Ensure dependencies are DONE** — Don't start blocked stories
|
||||||
- Review technical notes for architecture alignment
|
- **Review technical notes** — Align with architecture
|
||||||
- Use the story file as context for dev-story
|
- **Use the story file as context** — Pass to dev-story workflow
|
||||||
|
|
||||||
---
|
## Next Steps
|
||||||
|
|
||||||
## Related
|
After creating a story:
|
||||||
|
|
||||||
- [Run Sprint Planning](/docs/how-to/workflows/run-sprint-planning.md) - Initialize tracking
|
1. **Implement Story** — Run dev-story with the DEV agent
|
||||||
- [Implement Story](/docs/how-to/workflows/implement-story.md) - Next step
|
2. **Code Review** — Run code-review after implementation
|
||||||
- [Run Code Review](/docs/how-to/workflows/run-code-review.md) - After implementation
|
|
||||||
|
|
|
||||||
|
|
@ -3,11 +3,8 @@ title: "How to Create a UX Design"
|
||||||
description: How to create UX specifications using the BMad Method
|
description: How to create UX specifications using the BMad Method
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
Use the `create-ux-design` workflow to create UX specifications for projects where user experience is a primary differentiator.
|
Use the `create-ux-design` workflow to create UX specifications for projects where user experience is a primary differentiator.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Use This
|
## When to Use This
|
||||||
|
|
||||||
- UX is primary competitive advantage
|
- UX is primary competitive advantage
|
||||||
|
|
@ -16,8 +13,6 @@ Use the `create-ux-design` workflow to create UX specifications for projects whe
|
||||||
- Design system creation
|
- Design system creation
|
||||||
- Accessibility-critical experiences
|
- Accessibility-critical experiences
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Skip This
|
## When to Skip This
|
||||||
|
|
||||||
- Simple CRUD interfaces
|
- Simple CRUD interfaces
|
||||||
|
|
@ -25,15 +20,11 @@ Use the `create-ux-design` workflow to create UX specifications for projects whe
|
||||||
- Changes to existing screens you're happy with
|
- Changes to existing screens you're happy with
|
||||||
- Quick Flow projects
|
- Quick Flow projects
|
||||||
|
|
||||||
---
|
:::note[Prerequisites]
|
||||||
|
|
||||||
## Prerequisites
|
|
||||||
|
|
||||||
- BMad Method installed
|
- BMad Method installed
|
||||||
- UX Designer agent available
|
- UX Designer agent available
|
||||||
- PRD completed
|
- PRD completed
|
||||||
|
:::
|
||||||
---
|
|
||||||
|
|
||||||
## Steps
|
## Steps
|
||||||
|
|
||||||
|
|
@ -58,17 +49,15 @@ Point the agent to your PRD and describe:
|
||||||
|
|
||||||
The workflow uses a collaborative approach:
|
The workflow uses a collaborative approach:
|
||||||
|
|
||||||
1. **Visual exploration** - Generate multiple options
|
1. **Visual exploration** — Generate multiple options
|
||||||
2. **Informed decisions** - Evaluate with user needs
|
2. **Informed decisions** — Evaluate with user needs
|
||||||
3. **Collaborative design** - Refine iteratively
|
3. **Collaborative design** — Refine iteratively
|
||||||
4. **Living documentation** - Evolves with project
|
4. **Living documentation** — Evolves with project
|
||||||
|
|
||||||
### 5. Review the UX Spec
|
### 5. Review the UX Spec
|
||||||
|
|
||||||
The agent produces comprehensive UX documentation.
|
The agent produces comprehensive UX documentation.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## What You Get
|
## What You Get
|
||||||
|
|
||||||
The `ux-spec.md` document includes:
|
The `ux-spec.md` document includes:
|
||||||
|
|
@ -79,8 +68,6 @@ The `ux-spec.md` document includes:
|
||||||
- Design system (components, patterns, tokens)
|
- Design system (components, patterns, tokens)
|
||||||
- Epic breakdown (UX stories)
|
- Epic breakdown (UX stories)
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Example
|
## Example
|
||||||
|
|
||||||
Dashboard redesign produces:
|
Dashboard redesign produces:
|
||||||
|
|
@ -90,8 +77,6 @@ Dashboard redesign produces:
|
||||||
- Responsive grid
|
- Responsive grid
|
||||||
- 3 epics (Layout, Visualization, Accessibility)
|
- 3 epics (Layout, Visualization, Accessibility)
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Integration
|
## Integration
|
||||||
|
|
||||||
The UX spec feeds into:
|
The UX spec feeds into:
|
||||||
|
|
@ -99,19 +84,17 @@ The UX spec feeds into:
|
||||||
- Epic and story creation
|
- Epic and story creation
|
||||||
- Architecture decisions (Phase 3)
|
- Architecture decisions (Phase 3)
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Tips
|
## Tips
|
||||||
|
|
||||||
- Focus on user problems, not solutions first
|
- **Focus on user problems first** — Solutions come second
|
||||||
- Generate multiple options before deciding
|
- **Generate multiple options** — Don't settle on the first idea
|
||||||
- Consider accessibility from the start
|
- **Consider accessibility from the start** — Not an afterthought
|
||||||
- Document component reusability
|
- **Document component reusability** — Build a system, not just screens
|
||||||
|
|
||||||
---
|
## Next Steps
|
||||||
|
|
||||||
## Related
|
After UX design:
|
||||||
|
|
||||||
- [Create PRD](/docs/how-to/workflows/create-prd.md) - Create requirements first
|
1. **Update PRD** — Incorporate UX findings
|
||||||
- [Create Architecture](/docs/how-to/workflows/create-architecture.md) - Technical design
|
2. **Create Architecture** — Technical design informed by UX
|
||||||
- [Create Epics and Stories](/docs/how-to/workflows/create-epics-and-stories.md) - Work breakdown
|
3. **Create Epics and Stories** — Include UX-specific stories
|
||||||
|
|
|
||||||
|
|
@ -3,27 +3,20 @@ title: "How to Implement a Story"
|
||||||
description: How to implement a story using the dev-story workflow
|
description: How to implement a story using the dev-story workflow
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
Use the `dev-story` workflow to implement a story with tests following the architecture and conventions.
|
Use the `dev-story` workflow to implement a story with tests following the architecture and conventions.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Use This
|
## When to Use This
|
||||||
|
|
||||||
- After create-story has prepared the story file
|
- After create-story has prepared the story file
|
||||||
- When ready to write code for a story
|
- When ready to write code for a story
|
||||||
- Story dependencies are marked DONE
|
- Story dependencies are marked DONE
|
||||||
|
|
||||||
---
|
:::note[Prerequisites]
|
||||||
|
|
||||||
## Prerequisites
|
|
||||||
|
|
||||||
- BMad Method installed
|
- BMad Method installed
|
||||||
- DEV agent available
|
- DEV agent available
|
||||||
- Story file created by create-story
|
- Story file created by create-story
|
||||||
- Architecture and tech-spec available for context
|
- Architecture and tech-spec available for context
|
||||||
|
:::
|
||||||
---
|
|
||||||
|
|
||||||
## Steps
|
## Steps
|
||||||
|
|
||||||
|
|
@ -53,75 +46,52 @@ The DEV agent:
|
||||||
|
|
||||||
Work with the agent until all acceptance criteria are met.
|
Work with the agent until all acceptance criteria are met.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## What Happens
|
## What Happens
|
||||||
|
|
||||||
The dev-story workflow:
|
The dev-story workflow:
|
||||||
|
|
||||||
1. **Reads context** - Story file, architecture, existing patterns
|
1. **Reads context** — Story file, architecture, existing patterns
|
||||||
2. **Plans implementation** - Identifies files to create/modify
|
2. **Plans implementation** — Identifies files to create/modify
|
||||||
3. **Writes code** - Following conventions and patterns
|
3. **Writes code** — Following conventions and patterns
|
||||||
4. **Writes tests** - Unit, integration, or E2E as appropriate
|
4. **Writes tests** — Unit, integration, or E2E as appropriate
|
||||||
5. **Validates** - Runs tests and checks acceptance criteria
|
5. **Validates** — Runs tests and checks acceptance criteria
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Key Principles
|
## Key Principles
|
||||||
|
|
||||||
### One Story at a Time
|
**One Story at a Time** — Complete each story's full lifecycle before starting the next. This prevents context switching and ensures quality.
|
||||||
|
|
||||||
Complete each story's full lifecycle before starting the next. This prevents context switching and ensures quality.
|
**Follow Architecture** — The DEV agent references ADRs for technology decisions, standards for naming and structure, and existing patterns in the codebase.
|
||||||
|
|
||||||
### Follow Architecture
|
**Write Tests** — Every story includes appropriate tests: unit tests for business logic, integration tests for API endpoints, E2E tests for critical flows.
|
||||||
|
|
||||||
The DEV agent references:
|
|
||||||
- ADRs for technology decisions
|
|
||||||
- Standards for naming and structure
|
|
||||||
- Existing patterns in the codebase
|
|
||||||
|
|
||||||
### Write Tests
|
|
||||||
|
|
||||||
Every story includes appropriate tests:
|
|
||||||
- Unit tests for business logic
|
|
||||||
- Integration tests for API endpoints
|
|
||||||
- E2E tests for critical flows
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## After Implementation
|
## After Implementation
|
||||||
|
|
||||||
1. **Update sprint-status.yaml** - Mark story as READY FOR REVIEW
|
1. **Update sprint-status.yaml** — Mark story as READY FOR REVIEW
|
||||||
2. **Run code-review** - Quality assurance
|
2. **Run code-review** — Quality assurance
|
||||||
3. **Address feedback** - If code review finds issues
|
3. **Address feedback** — If code review finds issues
|
||||||
4. **Mark DONE** - After code review passes
|
4. **Mark DONE** — After code review passes
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Tips
|
## Tips
|
||||||
|
|
||||||
- Keep the story file open for reference
|
- **Keep the story file open** — Reference it during implementation
|
||||||
- Ask the agent to explain decisions
|
- **Ask the agent to explain decisions** — Understand the approach
|
||||||
- Run tests frequently during implementation
|
- **Run tests frequently** — Catch issues early
|
||||||
- Don't skip tests for "simple" changes
|
- **Don't skip tests** — Even for "simple" changes
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Troubleshooting
|
## Troubleshooting
|
||||||
|
|
||||||
**Q: Story needs significant changes mid-implementation?**
|
**Story needs significant changes mid-implementation?**
|
||||||
A: Run `correct-course` to analyze impact and route appropriately.
|
Run `correct-course` to analyze impact and route appropriately.
|
||||||
|
|
||||||
**Q: Can I work on multiple stories in parallel?**
|
**Can I work on multiple stories in parallel?**
|
||||||
A: Not recommended. Complete one story's full lifecycle first.
|
Not recommended. Complete one story's full lifecycle first.
|
||||||
|
|
||||||
**Q: What if implementation reveals the story is too large?**
|
**What if implementation reveals the story is too large?**
|
||||||
A: Split the story and document the change.
|
Split the story and document the change.
|
||||||
|
|
||||||
---
|
## Next Steps
|
||||||
|
|
||||||
## Related
|
After implementing a story:
|
||||||
|
|
||||||
- [Create Story](/docs/how-to/workflows/create-story.md) - Prepare the story first
|
1. **Code Review** — Run code-review with the DEV agent
|
||||||
- [Run Code Review](/docs/how-to/workflows/run-code-review.md) - After implementation
|
2. **Create Next Story** — Run create-story with the SM agent
|
||||||
- [Run Sprint Planning](/docs/how-to/workflows/run-sprint-planning.md) - Sprint organization
|
|
||||||
|
|
|
||||||
|
|
@ -3,10 +3,7 @@ title: "How to Use Quick Spec"
|
||||||
description: How to create a technical specification using Quick Spec workflow
|
description: 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.
|
||||||
Use the `tech-spec` workflow for Quick Flow projects to go directly from idea to implementation-ready specification.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Use This
|
## When to Use This
|
||||||
|
|
||||||
|
|
@ -16,15 +13,11 @@ Use the `tech-spec` workflow for Quick Flow projects to go directly from idea to
|
||||||
- Adding to existing brownfield codebase
|
- Adding to existing brownfield codebase
|
||||||
- Quick Flow track projects
|
- Quick Flow track projects
|
||||||
|
|
||||||
---
|
:::note[Prerequisites]
|
||||||
|
|
||||||
## Prerequisites
|
|
||||||
|
|
||||||
- BMad Method installed
|
- BMad Method installed
|
||||||
- PM agent or Quick Flow Solo Dev agent available
|
- PM agent or Quick Flow Solo Dev agent available
|
||||||
- Project directory (can be empty for greenfield)
|
- Project directory (can be empty for greenfield)
|
||||||
|
:::
|
||||||
---
|
|
||||||
|
|
||||||
## Steps
|
## Steps
|
||||||
|
|
||||||
|
|
@ -63,12 +56,9 @@ For brownfield projects, the agent will:
|
||||||
|
|
||||||
The agent generates a comprehensive tech-spec with ready-to-implement stories.
|
The agent generates a comprehensive tech-spec with ready-to-implement stories.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## What You Get
|
## What You Get
|
||||||
|
|
||||||
### tech-spec.md
|
**tech-spec.md:**
|
||||||
|
|
||||||
- Problem statement and solution
|
- Problem statement and solution
|
||||||
- Detected framework versions and dependencies
|
- Detected framework versions and dependencies
|
||||||
- Brownfield code patterns (if applicable)
|
- Brownfield code patterns (if applicable)
|
||||||
|
|
@ -76,18 +66,11 @@ The agent generates a comprehensive tech-spec with ready-to-implement stories.
|
||||||
- Specific file paths to modify
|
- Specific file paths to modify
|
||||||
- Complete implementation guidance
|
- Complete implementation guidance
|
||||||
|
|
||||||
### Story Files
|
**Story Files:**
|
||||||
|
- Single changes: `story-[slug].md`
|
||||||
|
- Small features: `epics.md` + `story-[epic-slug]-1.md`, etc.
|
||||||
|
|
||||||
For single changes:
|
## Example: Bug Fix
|
||||||
- `story-[slug].md` - Single user story ready for development
|
|
||||||
|
|
||||||
For small features:
|
|
||||||
- `epics.md` - Epic organization
|
|
||||||
- `story-[epic-slug]-1.md`, `story-[epic-slug]-2.md`, etc.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Example: Bug Fix (Single Change)
|
|
||||||
|
|
||||||
**You:** "I want to fix the login validation bug that allows empty passwords"
|
**You:** "I want to fix the login validation bug that allows empty passwords"
|
||||||
|
|
||||||
|
|
@ -99,11 +82,7 @@ For small features:
|
||||||
5. Generates tech-spec.md with specific file paths
|
5. Generates tech-spec.md with specific file paths
|
||||||
6. Creates story-login-fix.md
|
6. Creates story-login-fix.md
|
||||||
|
|
||||||
**Total time:** 15-30 minutes (mostly implementation)
|
## Example: Small Feature
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Example: Small Feature (Multi-Story)
|
|
||||||
|
|
||||||
**You:** "I want to add OAuth social login (Google, GitHub)"
|
**You:** "I want to add OAuth social login (Google, GitHub)"
|
||||||
|
|
||||||
|
|
@ -118,10 +97,6 @@ For small features:
|
||||||
- story-oauth-1.md (Backend OAuth setup)
|
- story-oauth-1.md (Backend OAuth setup)
|
||||||
- story-oauth-2.md (Frontend login buttons)
|
- story-oauth-2.md (Frontend login buttons)
|
||||||
|
|
||||||
**Total time:** 1-3 hours (mostly implementation)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Implementing After Tech Spec
|
## Implementing After Tech Spec
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
|
@ -133,27 +108,15 @@ For small features:
|
||||||
# Then: Load DEV agent and run dev-story for each story
|
# Then: Load DEV agent and run dev-story for each story
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Tips
|
## Tips
|
||||||
|
|
||||||
### Be Specific in Discovery
|
- **Be specific in discovery** — "Fix email validation in UserService to allow plus-addressing" beats "Fix validation bug"
|
||||||
|
- **Trust convention detection** — If it detects your patterns correctly, say yes! It's faster than establishing new conventions
|
||||||
|
- **Keep single changes atomic** — If your "single change" needs 3+ files, it might be a multi-story feature. Let the workflow guide you
|
||||||
|
|
||||||
- ✅ "Fix email validation in UserService to allow plus-addressing"
|
## Next Steps
|
||||||
- ❌ "Fix validation bug"
|
|
||||||
|
|
||||||
### Trust Convention Detection
|
After tech spec:
|
||||||
|
|
||||||
If it detects your patterns correctly, say yes! It's faster than establishing new conventions.
|
1. **Implement Story** — Run dev-story with the DEV agent
|
||||||
|
2. **Sprint Planning** — Optional for multi-story features
|
||||||
### Keep Single Changes Atomic
|
|
||||||
|
|
||||||
If your "single change" needs 3+ files, it might be a multi-story feature. Let the workflow guide you.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Related
|
|
||||||
|
|
||||||
- [Quick Flow](/docs/explanation/features/quick-flow.md) - Understanding Quick Spec Flow
|
|
||||||
- [Implement Story](/docs/how-to/workflows/implement-story.md) - After tech spec
|
|
||||||
- [Create PRD](/docs/how-to/workflows/create-prd.md) - For larger projects needing full BMad Method
|
|
||||||
|
|
|
||||||
|
|
@ -3,11 +3,8 @@ title: "How to Run a Brainstorming Session"
|
||||||
description: How to run a brainstorming session using the BMad Method
|
description: How to run a brainstorming session using the BMad Method
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
Use the `brainstorm-project` workflow to explore solution approaches through parallel ideation tracks.
|
Use the `brainstorm-project` workflow to explore solution approaches through parallel ideation tracks.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Use This
|
## When to Use This
|
||||||
|
|
||||||
- Very vague or seed kernel of an idea that needs exploration
|
- Very vague or seed kernel of an idea that needs exploration
|
||||||
|
|
@ -15,14 +12,10 @@ Use the `brainstorm-project` workflow to explore solution approaches through par
|
||||||
- See your idea from different angles and viewpoints
|
- See your idea from different angles and viewpoints
|
||||||
- No idea what you want to build, but want to find some inspiration
|
- No idea what you want to build, but want to find some inspiration
|
||||||
|
|
||||||
---
|
:::note[Prerequisites]
|
||||||
|
|
||||||
## Prerequisites
|
|
||||||
|
|
||||||
- BMad Method installed
|
- BMad Method installed
|
||||||
- Analyst agent available
|
- Analyst agent available
|
||||||
|
:::
|
||||||
---
|
|
||||||
|
|
||||||
## Steps
|
## Steps
|
||||||
|
|
||||||
|
|
@ -48,17 +41,15 @@ Tell the agent about your project idea, even if it's vague:
|
||||||
|
|
||||||
The workflow generates solution approaches through parallel ideation tracks:
|
The workflow generates solution approaches through parallel ideation tracks:
|
||||||
|
|
||||||
- **Architecture track** - Technical approaches and patterns
|
- **Architecture track** — Technical approaches and patterns
|
||||||
- **UX track** - User experience possibilities
|
- **UX track** — User experience possibilities
|
||||||
- **Integration track** - How it connects with other systems
|
- **Integration track** — How it connects with other systems
|
||||||
- **Value track** - Business value and differentiation
|
- **Value track** — Business value and differentiation
|
||||||
|
|
||||||
### 5. Evaluate Options
|
### 5. Evaluate Options
|
||||||
|
|
||||||
Review the generated options with rationale for each approach.
|
Review the generated options with rationale for each approach.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## What You Get
|
## What You Get
|
||||||
|
|
||||||
- Multiple solution approaches with trade-offs
|
- Multiple solution approaches with trade-offs
|
||||||
|
|
@ -66,29 +57,17 @@ Review the generated options with rationale for each approach.
|
||||||
- UX and integration considerations
|
- UX and integration considerations
|
||||||
- Clear rationale for each direction
|
- Clear rationale for each direction
|
||||||
|
|
||||||
---
|
## Tips
|
||||||
|
|
||||||
|
- **Don't worry about having a fully formed idea** — Vague is fine
|
||||||
|
- **Let the agent guide exploration** — Follow the prompts
|
||||||
|
- **Consider multiple tracks** — Don't settle on the first option
|
||||||
|
- **Use outputs as input for product-brief** — Build on brainstorming results
|
||||||
|
|
||||||
## Next Steps
|
## Next Steps
|
||||||
|
|
||||||
After brainstorming:
|
After brainstorming:
|
||||||
|
|
||||||
1. **Research** - Validate ideas with market/technical research
|
1. **Research** — Validate ideas with market/technical research
|
||||||
2. **Product Brief** - Capture strategic vision
|
2. **Product Brief** — Capture strategic vision
|
||||||
3. **PRD** - Move to formal planning
|
3. **PRD** — Move to formal planning
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Tips
|
|
||||||
|
|
||||||
- Don't worry about having a fully formed idea
|
|
||||||
- Let the agent guide the exploration
|
|
||||||
- Consider multiple tracks before deciding
|
|
||||||
- Use outputs as input for product-brief workflow
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Related
|
|
||||||
|
|
||||||
- [Conduct Research](/docs/how-to/workflows/conduct-research.md) - Validate your ideas
|
|
||||||
- [Create Product Brief](/docs/how-to/workflows/create-product-brief.md) - Capture strategic vision
|
|
||||||
- [Create PRD](/docs/how-to/workflows/create-prd.md) - Move to formal planning
|
|
||||||
|
|
|
||||||
|
|
@ -3,27 +3,20 @@ title: "How to Run Code Review"
|
||||||
description: How to run code review for quality assurance
|
description: How to run code review for quality assurance
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
Use the `code-review` workflow to perform a thorough quality review of implemented code.
|
Use the `code-review` workflow to perform a thorough quality review of implemented code.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Use This
|
## When to Use This
|
||||||
|
|
||||||
- After dev-story completes implementation
|
- After dev-story completes implementation
|
||||||
- Before marking a story as DONE
|
- Before marking a story as DONE
|
||||||
- Every story goes through code review - no exceptions
|
- Every story goes through code review — no exceptions
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Prerequisites
|
|
||||||
|
|
||||||
|
:::note[Prerequisites]
|
||||||
- BMad Method installed
|
- BMad Method installed
|
||||||
- DEV agent available
|
- DEV agent available
|
||||||
- Story implementation complete
|
- Story implementation complete
|
||||||
- Tests written and passing
|
- Tests written and passing
|
||||||
|
:::
|
||||||
---
|
|
||||||
|
|
||||||
## Steps
|
## Steps
|
||||||
|
|
||||||
|
|
@ -55,56 +48,21 @@ If issues are found:
|
||||||
2. Re-run tests
|
2. Re-run tests
|
||||||
3. Run code-review again
|
3. Run code-review again
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## What Gets Reviewed
|
## What Gets Reviewed
|
||||||
|
|
||||||
The code review checks:
|
| Category | Checks |
|
||||||
|
|----------|--------|
|
||||||
### Code Quality
|
| **Code Quality** | Clean code, appropriate abstractions, no code smells, proper error handling |
|
||||||
- Clean, readable code
|
| **Architecture Alignment** | Follows ADRs, consistent with patterns, proper separation of concerns |
|
||||||
- Appropriate abstractions
|
| **Testing** | Adequate coverage, meaningful tests, edge cases, follows project patterns |
|
||||||
- No code smells
|
| **Security** | No hardcoded secrets, input validation, proper auth, no common vulnerabilities |
|
||||||
- Proper error handling
|
| **Performance** | No obvious issues, appropriate data structures, efficient queries |
|
||||||
|
|
||||||
### Architecture Alignment
|
|
||||||
- Follows ADRs and architecture decisions
|
|
||||||
- Consistent with existing patterns
|
|
||||||
- Proper separation of concerns
|
|
||||||
|
|
||||||
### Testing
|
|
||||||
- Adequate test coverage
|
|
||||||
- Tests are meaningful (not just for coverage)
|
|
||||||
- Edge cases handled
|
|
||||||
- Tests follow project patterns
|
|
||||||
|
|
||||||
### Security
|
|
||||||
- No hardcoded secrets
|
|
||||||
- Input validation
|
|
||||||
- Authentication/authorization proper
|
|
||||||
- No common vulnerabilities
|
|
||||||
|
|
||||||
### Performance
|
|
||||||
- No obvious performance issues
|
|
||||||
- Appropriate data structures
|
|
||||||
- Efficient queries
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Review Outcomes
|
## Review Outcomes
|
||||||
|
|
||||||
### ✅ Approved
|
**Approved** — Code meets quality standards, tests pass. Mark story as DONE in sprint-status.yaml.
|
||||||
|
|
||||||
- Code meets quality standards
|
**Changes Requested** — Issues identified that need fixing. Fix issues in dev-story, then re-run code-review.
|
||||||
- Tests pass
|
|
||||||
- **Action:** Mark story as DONE in sprint-status.yaml
|
|
||||||
|
|
||||||
### 🔧 Changes Requested
|
|
||||||
|
|
||||||
- Issues identified that need fixing
|
|
||||||
- **Action:** Fix issues in dev-story, then re-run code-review
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Quality Gates
|
## Quality Gates
|
||||||
|
|
||||||
|
|
@ -115,27 +73,17 @@ Every story goes through code-review before being marked done. This ensures:
|
||||||
- Test coverage
|
- Test coverage
|
||||||
- Security review
|
- Security review
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Tips
|
## Tips
|
||||||
|
|
||||||
- Don't skip code review for "simple" changes
|
- **Don't skip for "simple" changes** — Simple changes can have subtle bugs
|
||||||
- Address all findings, not just critical ones
|
- **Address all findings** — Not just critical ones
|
||||||
- Use findings as learning opportunities
|
- **Use findings as learning opportunities** — Improve over time
|
||||||
- Re-run review after fixes
|
- **Re-run review after fixes** — Verify issues are resolved
|
||||||
|
|
||||||
---
|
## Next Steps
|
||||||
|
|
||||||
## After Code Review
|
After code review:
|
||||||
|
|
||||||
1. **If approved:** Update sprint-status.yaml to mark story DONE
|
1. **If approved** — Update sprint-status.yaml to mark story DONE
|
||||||
2. **If changes requested:** Fix issues and re-run review
|
2. **If changes requested** — Fix issues and re-run review
|
||||||
3. **Move to next story:** Run create-story for the next item
|
3. **Move to next story** — Run create-story for the next item
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Related
|
|
||||||
|
|
||||||
- [Implement Story](/docs/how-to/workflows/implement-story.md) - Before code review
|
|
||||||
- [Create Story](/docs/how-to/workflows/create-story.md) - Move to next story
|
|
||||||
- [Run Sprint Planning](/docs/how-to/workflows/run-sprint-planning.md) - Sprint organization
|
|
||||||
|
|
|
||||||
|
|
@ -3,11 +3,8 @@ title: "How to Run Implementation Readiness"
|
||||||
description: How to validate planning and solutioning before implementation
|
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.
|
Use the `implementation-readiness` workflow to validate that planning and solutioning are complete and aligned before Phase 4 implementation.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Use This
|
## When to Use This
|
||||||
|
|
||||||
- **Always** before Phase 4 for BMad Method and Enterprise projects
|
- **Always** before Phase 4 for BMad Method and Enterprise projects
|
||||||
|
|
@ -15,22 +12,16 @@ Use the `implementation-readiness` workflow to validate that planning and soluti
|
||||||
- Before sprint-planning workflow
|
- Before sprint-planning workflow
|
||||||
- When stakeholders request readiness check
|
- When stakeholders request readiness check
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Skip This
|
## When to Skip This
|
||||||
|
|
||||||
- Quick Flow (no solutioning phase)
|
- Quick Flow (no solutioning phase)
|
||||||
- BMad Method Simple (no gate check required)
|
- BMad Method Simple (no gate check required)
|
||||||
|
|
||||||
---
|
:::note[Prerequisites]
|
||||||
|
|
||||||
## Prerequisites
|
|
||||||
|
|
||||||
- BMad Method installed
|
- BMad Method installed
|
||||||
- Architect agent available
|
- Architect agent available
|
||||||
- PRD, Architecture, and Epics completed
|
- PRD, Architecture, and Epics completed
|
||||||
|
:::
|
||||||
---
|
|
||||||
|
|
||||||
## Steps
|
## Steps
|
||||||
|
|
||||||
|
|
@ -56,66 +47,42 @@ The workflow systematically checks:
|
||||||
|
|
||||||
The agent produces a gate decision with rationale.
|
The agent produces a gate decision with rationale.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Gate Decision Outcomes
|
## Gate Decision Outcomes
|
||||||
|
|
||||||
### ✅ PASS
|
| Decision | Meaning | Action |
|
||||||
|
|----------|---------|--------|
|
||||||
- All critical criteria met
|
| **PASS** | All critical criteria met, minor gaps acceptable | Proceed to Phase 4 |
|
||||||
- Minor gaps acceptable with documented plan
|
| **CONCERNS** | Some criteria not met but not blockers | Proceed with caution, address gaps in parallel |
|
||||||
- **Action:** Proceed to Phase 4
|
| **FAIL** | Critical gaps or contradictions | BLOCK Phase 4, resolve issues first |
|
||||||
|
|
||||||
### ⚠️ 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
|
## What Gets Checked
|
||||||
|
|
||||||
### PRD/GDD Completeness
|
**PRD/GDD Completeness:**
|
||||||
- Problem statement clear and evidence-based
|
- Problem statement clear and evidence-based
|
||||||
- Success metrics defined
|
- Success metrics defined
|
||||||
- User personas identified
|
- User personas identified
|
||||||
- Functional requirements (FRs) complete
|
- FRs and NFRs complete
|
||||||
- Non-functional requirements (NFRs) specified
|
|
||||||
- Risks and assumptions documented
|
- Risks and assumptions documented
|
||||||
|
|
||||||
### Architecture Completeness
|
**Architecture Completeness:**
|
||||||
- System architecture defined
|
- System, data, API architecture defined
|
||||||
- Data architecture specified
|
|
||||||
- API architecture decided
|
|
||||||
- Key ADRs documented
|
- Key ADRs documented
|
||||||
- Security architecture addressed
|
- Security architecture addressed
|
||||||
- FR/NFR-specific guidance provided
|
- FR/NFR-specific guidance provided
|
||||||
- Standards and conventions defined
|
- Standards and conventions defined
|
||||||
|
|
||||||
### Epic/Story Completeness
|
**Epic/Story Completeness:**
|
||||||
- All PRD features mapped to stories
|
- All PRD features mapped to stories
|
||||||
- Stories have acceptance criteria
|
- Stories have acceptance criteria
|
||||||
- Stories prioritized (P0/P1/P2/P3)
|
- Stories prioritized (P0/P1/P2/P3)
|
||||||
- Dependencies identified
|
- Dependencies identified
|
||||||
- Story sequencing logical
|
|
||||||
|
|
||||||
### Alignment Checks
|
**Alignment Checks:**
|
||||||
- Architecture addresses all PRD FRs/NFRs
|
- Architecture addresses all PRD FRs/NFRs
|
||||||
- Epics align with architecture decisions
|
- Epics align with architecture decisions
|
||||||
- No contradictions between epics
|
- No contradictions between epics
|
||||||
- NFRs have technical approach
|
|
||||||
- Integration points clear
|
- Integration points clear
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## What You Get
|
## What You Get
|
||||||
|
|
||||||
An `implementation-readiness.md` document containing:
|
An `implementation-readiness.md` document containing:
|
||||||
|
|
@ -128,11 +95,9 @@ An `implementation-readiness.md` document containing:
|
||||||
6. **Gate Decision** with rationale
|
6. **Gate Decision** with rationale
|
||||||
7. **Next Steps**
|
7. **Next Steps**
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Example
|
## Example
|
||||||
|
|
||||||
E-commerce platform → CONCERNS ⚠️
|
E-commerce platform → CONCERNS
|
||||||
|
|
||||||
**Gaps identified:**
|
**Gaps identified:**
|
||||||
- Missing security architecture section
|
- Missing security architecture section
|
||||||
|
|
@ -144,19 +109,17 @@ E-commerce platform → CONCERNS ⚠️
|
||||||
|
|
||||||
**Action:** Proceed with caution, address before payment epic.
|
**Action:** Proceed with caution, address before payment epic.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Tips
|
## Tips
|
||||||
|
|
||||||
- Run this before every Phase 4 start
|
- **Run before every Phase 4 start** — It's a valuable checkpoint
|
||||||
- Take FAIL decisions seriously - fix issues first
|
- **Take FAIL decisions seriously** — Fix issues first
|
||||||
- Use CONCERNS as a checklist for parallel work
|
- **Use CONCERNS as a checklist** — Track parallel work
|
||||||
- Document why you proceed despite concerns
|
- **Document why you proceed despite concerns** — Transparency matters
|
||||||
|
|
||||||
---
|
## Next Steps
|
||||||
|
|
||||||
## Related
|
After implementation readiness:
|
||||||
|
|
||||||
- [Create Architecture](/docs/how-to/workflows/create-architecture.md) - Architecture workflow
|
1. **If PASS** — Run sprint-planning to start Phase 4
|
||||||
- [Create Epics and Stories](/docs/how-to/workflows/create-epics-and-stories.md) - Work breakdown
|
2. **If CONCERNS** — Proceed with documented gaps to address
|
||||||
- [Run Sprint Planning](/docs/how-to/workflows/run-sprint-planning.md) - Start implementation
|
3. **If FAIL** — Return to relevant workflow to fix issues
|
||||||
|
|
|
||||||
|
|
@ -3,27 +3,20 @@ title: "How to Run Sprint Planning"
|
||||||
description: How to initialize sprint tracking for implementation
|
description: How to initialize sprint tracking for implementation
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
Use the `sprint-planning` workflow to initialize the sprint tracking file and organize work for implementation.
|
Use the `sprint-planning` workflow to initialize the sprint tracking file and organize work for implementation.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Use This
|
## When to Use This
|
||||||
|
|
||||||
- Once at the start of Phase 4 (Implementation)
|
- Once at the start of Phase 4 (Implementation)
|
||||||
- After implementation-readiness gate passes
|
- After implementation-readiness gate passes
|
||||||
- When starting a new sprint cycle
|
- When starting a new sprint cycle
|
||||||
|
|
||||||
---
|
:::note[Prerequisites]
|
||||||
|
|
||||||
## Prerequisites
|
|
||||||
|
|
||||||
- BMad Method installed
|
- BMad Method installed
|
||||||
- SM (Scrum Master) agent available
|
- SM (Scrum Master) agent available
|
||||||
- Epic files created from `create-epics-and-stories`
|
- Epic files created from `create-epics-and-stories`
|
||||||
- Implementation-readiness passed (for BMad Method/Enterprise)
|
- Implementation-readiness passed (for BMad Method/Enterprise)
|
||||||
|
:::
|
||||||
---
|
|
||||||
|
|
||||||
## Steps
|
## Steps
|
||||||
|
|
||||||
|
|
@ -45,8 +38,6 @@ Point the agent to your epic files created during Phase 3.
|
||||||
|
|
||||||
The agent organizes stories into the sprint tracking file.
|
The agent organizes stories into the sprint tracking file.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## What You Get
|
## What You Get
|
||||||
|
|
||||||
A `sprint-status.yaml` file containing:
|
A `sprint-status.yaml` file containing:
|
||||||
|
|
@ -56,12 +47,8 @@ A `sprint-status.yaml` file containing:
|
||||||
- Dependencies between stories
|
- Dependencies between stories
|
||||||
- Priority ordering
|
- Priority ordering
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Story Lifecycle States
|
## Story Lifecycle States
|
||||||
|
|
||||||
Stories move through these states in the sprint status file:
|
|
||||||
|
|
||||||
| State | Description |
|
| State | Description |
|
||||||
|-------|-------------|
|
|-------|-------------|
|
||||||
| **TODO** | Story identified but not started |
|
| **TODO** | Story identified but not started |
|
||||||
|
|
@ -69,43 +56,39 @@ Stories move through these states in the sprint status file:
|
||||||
| **READY FOR REVIEW** | Implementation complete, awaiting code review |
|
| **READY FOR REVIEW** | Implementation complete, awaiting code review |
|
||||||
| **DONE** | Accepted and complete |
|
| **DONE** | Accepted and complete |
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Typical Sprint Flow
|
## Typical Sprint Flow
|
||||||
|
|
||||||
### Sprint 0 (Planning Phase)
|
**Sprint 0 (Planning Phase):**
|
||||||
- Complete Phases 1-3
|
- Complete Phases 1-3
|
||||||
- PRD/GDD + Architecture complete
|
- PRD/GDD + Architecture complete
|
||||||
- Epics+Stories created via create-epics-and-stories
|
- Epics+Stories created via create-epics-and-stories
|
||||||
|
|
||||||
### Sprint 1+ (Implementation Phase)
|
**Sprint 1+ (Implementation Phase):**
|
||||||
|
|
||||||
**Start of Phase 4:**
|
Start of Phase 4:
|
||||||
1. SM runs `sprint-planning` (once)
|
1. SM runs `sprint-planning` (once)
|
||||||
|
|
||||||
**Per Story (repeat until epic complete):**
|
Per Story (repeat until epic complete):
|
||||||
1. SM runs `create-story`
|
1. SM runs `create-story`
|
||||||
2. DEV runs `dev-story`
|
2. DEV runs `dev-story`
|
||||||
3. DEV runs `code-review`
|
3. DEV runs `code-review`
|
||||||
4. Update sprint-status.yaml
|
4. Update sprint-status.yaml
|
||||||
|
|
||||||
**After Epic Complete:**
|
After Epic Complete:
|
||||||
- SM runs `retrospective`
|
- SM runs `retrospective`
|
||||||
- Move to next epic
|
- Move to next epic
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Tips
|
## Tips
|
||||||
|
|
||||||
- Run sprint-planning only once at Phase 4 start
|
- **Run sprint-planning only once** — At Phase 4 start
|
||||||
- Use `sprint-status` during Phase 4 to check current state
|
- **Use sprint-status during Phase 4** — Check current state anytime
|
||||||
- Keep the sprint-status.yaml file as single source of truth
|
- **Keep sprint-status.yaml as single source of truth** — All status updates go here
|
||||||
- Update story status after each stage
|
- **Update story status after each stage** — Keep it current
|
||||||
|
|
||||||
---
|
## Next Steps
|
||||||
|
|
||||||
## Related
|
After sprint planning:
|
||||||
|
|
||||||
- [Create Story](/docs/how-to/workflows/create-story.md) - Prepare stories for implementation
|
1. **Create Story** — Prepare the first story for implementation
|
||||||
- [Implement Story](/docs/how-to/workflows/implement-story.md) - Dev workflow
|
2. **Implement Story** — Run dev-story with the DEV agent
|
||||||
- [Run Code Review](/docs/how-to/workflows/run-code-review.md) - Quality assurance
|
3. **Code Review** — Quality assurance after implementation
|
||||||
|
|
|
||||||
|
|
@ -3,11 +3,8 @@ title: "How to Run Test Design"
|
||||||
description: How to create comprehensive test plans using TEA's test-design workflow
|
description: How to create comprehensive test plans using TEA's test-design workflow
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
Use TEA's `*test-design` workflow to create comprehensive test plans with risk assessment and coverage strategies.
|
Use TEA's `*test-design` workflow to create comprehensive test plans with risk assessment and coverage strategies.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Use This
|
## When to Use This
|
||||||
|
|
||||||
**System-level (Phase 3):**
|
**System-level (Phase 3):**
|
||||||
|
|
@ -20,16 +17,12 @@ Use TEA's `*test-design` workflow to create comprehensive test plans with risk a
|
||||||
- Before implementing stories in the epic
|
- Before implementing stories in the epic
|
||||||
- To identify epic-specific testing needs
|
- To identify epic-specific testing needs
|
||||||
|
|
||||||
---
|
:::note[Prerequisites]
|
||||||
|
|
||||||
## Prerequisites
|
|
||||||
|
|
||||||
- BMad Method installed
|
- BMad Method installed
|
||||||
- TEA agent available
|
- TEA agent available
|
||||||
- For system-level: Architecture document complete
|
- For system-level: Architecture document complete
|
||||||
- For epic-level: Epic defined with stories
|
- For epic-level: Epic defined with stories
|
||||||
|
:::
|
||||||
---
|
|
||||||
|
|
||||||
## Steps
|
## Steps
|
||||||
|
|
||||||
|
|
@ -47,8 +40,8 @@ Start a fresh chat and load the TEA (Test Architect) agent.
|
||||||
|
|
||||||
TEA will ask if you want:
|
TEA will ask if you want:
|
||||||
|
|
||||||
- **System-level** - For architecture testability review (Phase 3)
|
- **System-level** — For architecture testability review (Phase 3)
|
||||||
- **Epic-level** - For epic-specific test planning (Phase 4)
|
- **Epic-level** — For epic-specific test planning (Phase 4)
|
||||||
|
|
||||||
### 4. Provide Context
|
### 4. Provide Context
|
||||||
|
|
||||||
|
|
@ -64,20 +57,16 @@ For epic-level:
|
||||||
|
|
||||||
TEA generates a comprehensive test design document.
|
TEA generates a comprehensive test design document.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## What You Get
|
## What You Get
|
||||||
|
|
||||||
### System-Level Output (`test-design-system.md`)
|
**System-Level Output (`test-design-system.md`):**
|
||||||
|
|
||||||
- Testability review of architecture
|
- Testability review of architecture
|
||||||
- ADR → test mapping
|
- ADR → test mapping
|
||||||
- Architecturally Significant Requirements (ASRs)
|
- Architecturally Significant Requirements (ASRs)
|
||||||
- Environment needs
|
- Environment needs
|
||||||
- Test infrastructure recommendations
|
- Test infrastructure recommendations
|
||||||
|
|
||||||
### Epic-Level Output (`test-design-epic-N.md`)
|
**Epic-Level Output (`test-design-epic-N.md`):**
|
||||||
|
|
||||||
- Risk assessment for the epic
|
- Risk assessment for the epic
|
||||||
- Test priorities
|
- Test priorities
|
||||||
- Coverage plan
|
- Coverage plan
|
||||||
|
|
@ -85,44 +74,25 @@ TEA generates a comprehensive test design document.
|
||||||
- Integration risks
|
- Integration risks
|
||||||
- Mitigation strategies
|
- Mitigation strategies
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Test Design for Different Tracks
|
## Test Design for Different Tracks
|
||||||
|
|
||||||
### Greenfield - BMad Method
|
| Track | Phase 3 Focus | Phase 4 Focus |
|
||||||
|
|-------|---------------|---------------|
|
||||||
| Stage | Test Design Focus |
|
| **Greenfield** | System-level testability review | Per-epic risk assessment and test plan |
|
||||||
|-------|-------------------|
|
| **Brownfield** | System-level + existing test baseline | Regression hotspots, integration risks |
|
||||||
| Phase 3 | System-level testability review |
|
| **Enterprise** | Compliance-aware testability | Security/performance/compliance focus |
|
||||||
| Phase 4 | Per-epic risk assessment and test plan |
|
|
||||||
|
|
||||||
### Brownfield - BMad Method/Enterprise
|
|
||||||
|
|
||||||
| Stage | Test Design Focus |
|
|
||||||
|-------|-------------------|
|
|
||||||
| Phase 3 | System-level + existing test baseline |
|
|
||||||
| Phase 4 | Regression hotspots, integration risks |
|
|
||||||
|
|
||||||
### Enterprise
|
|
||||||
|
|
||||||
| Stage | Test Design Focus |
|
|
||||||
|-------|-------------------|
|
|
||||||
| Phase 3 | Compliance-aware testability |
|
|
||||||
| Phase 4 | Security/performance/compliance focus |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Tips
|
## Tips
|
||||||
|
|
||||||
- Run system-level test-design right after architecture
|
- **Run system-level right after architecture** — Early testability review
|
||||||
- Run epic-level test-design at the start of each epic
|
- **Run epic-level at the start of each epic** — Targeted test planning
|
||||||
- Update test design if ADRs change
|
- **Update if ADRs change** — Keep test design aligned
|
||||||
- Use the output to guide `*atdd` and `*automate` workflows
|
- **Use output to guide other workflows** — Feeds into `*atdd` and `*automate`
|
||||||
|
|
||||||
---
|
## Next Steps
|
||||||
|
|
||||||
## Related
|
After test design:
|
||||||
|
|
||||||
- [TEA Overview](/docs/explanation/features/tea-overview.md) - Understanding the Test Architect
|
1. **Setup Test Framework** — If not already configured
|
||||||
- [Setup Test Framework](/docs/how-to/workflows/setup-test-framework.md) - Setting up testing infrastructure
|
2. **Implementation Readiness** — System-level feeds into gate check
|
||||||
- [Create Architecture](/docs/how-to/workflows/create-architecture.md) - Architecture workflow
|
3. **Story Implementation** — Epic-level guides testing during dev
|
||||||
|
|
|
||||||
|
|
@ -3,11 +3,8 @@ title: "How to Set Up Party Mode"
|
||||||
description: How to set up and use Party Mode for multi-agent collaboration
|
description: How to set up and use Party Mode for multi-agent collaboration
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
Use Party Mode to orchestrate dynamic multi-agent conversations with your entire BMad team.
|
Use Party Mode to orchestrate dynamic multi-agent conversations with your entire BMad team.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Use This
|
## When to Use This
|
||||||
|
|
||||||
- Exploring complex topics that benefit from diverse expert perspectives
|
- Exploring complex topics that benefit from diverse expert perspectives
|
||||||
|
|
@ -15,14 +12,10 @@ Use Party Mode to orchestrate dynamic multi-agent conversations with your entire
|
||||||
- Getting comprehensive views across multiple domains
|
- Getting comprehensive views across multiple domains
|
||||||
- Strategic decisions with trade-offs
|
- Strategic decisions with trade-offs
|
||||||
|
|
||||||
---
|
:::note[Prerequisites]
|
||||||
|
|
||||||
## Prerequisites
|
|
||||||
|
|
||||||
- BMad Method installed with multiple agents
|
- BMad Method installed with multiple agents
|
||||||
- Any agent loaded that supports party mode
|
- Any agent loaded that supports party mode
|
||||||
|
:::
|
||||||
---
|
|
||||||
|
|
||||||
## Steps
|
## Steps
|
||||||
|
|
||||||
|
|
@ -62,56 +55,36 @@ The facilitator will:
|
||||||
|
|
||||||
Type "exit" or "done" to conclude the session. Participating agents will say personalized farewells.
|
Type "exit" or "done" to conclude the session. Participating agents will say personalized farewells.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## What Happens
|
## What Happens
|
||||||
|
|
||||||
1. **Agent Roster** - Party Mode loads your complete agent roster
|
1. **Agent Roster** — Party Mode loads your complete agent roster
|
||||||
2. **Introduction** - Available team members are introduced
|
2. **Introduction** — Available team members are introduced
|
||||||
3. **Topic Analysis** - The facilitator analyzes your topic
|
3. **Topic Analysis** — The facilitator analyzes your topic
|
||||||
4. **Agent Selection** - 2-3 most relevant agents are selected
|
4. **Agent Selection** — 2-3 most relevant agents are selected
|
||||||
5. **Discussion** - Agents respond, reference each other, engage in cross-talk
|
5. **Discussion** — Agents respond, reference each other, engage in cross-talk
|
||||||
6. **Exit** - Session concludes with farewells
|
6. **Exit** — Session concludes with farewells
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Example Party Compositions
|
## Example Party Compositions
|
||||||
|
|
||||||
### Product Strategy
|
| Topic | Typical Agents |
|
||||||
- PM + Innovation Strategist (CIS) + Analyst
|
|-------|---------------|
|
||||||
|
| **Product Strategy** | PM + Innovation Strategist (CIS) + Analyst |
|
||||||
### Technical Design
|
| **Technical Design** | Architect + Creative Problem Solver (CIS) + Game Architect |
|
||||||
- Architect + Creative Problem Solver (CIS) + Game Architect
|
| **User Experience** | UX Designer + Design Thinking Coach (CIS) + Storyteller (CIS) |
|
||||||
|
| **Quality Assessment** | TEA + DEV + Architect |
|
||||||
### User Experience
|
|
||||||
- UX Designer + Design Thinking Coach (CIS) + Storyteller (CIS)
|
|
||||||
|
|
||||||
### Quality Assessment
|
|
||||||
- TEA + DEV + Architect
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Key Features
|
## Key Features
|
||||||
|
|
||||||
- **Intelligent agent selection** - Selects based on expertise needed
|
- **Intelligent agent selection** — Selects based on expertise needed
|
||||||
- **Authentic personalities** - Each agent maintains their unique voice
|
- **Authentic personalities** — Each agent maintains their unique voice
|
||||||
- **Natural cross-talk** - Agents reference and build on each other
|
- **Natural cross-talk** — Agents reference and build on each other
|
||||||
- **Optional TTS** - Voice configurations for each agent
|
- **Optional TTS** — Voice configurations for each agent
|
||||||
- **Graceful exit** - Personalized farewells
|
- **Graceful exit** — Personalized farewells
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Tips
|
## Tips
|
||||||
|
|
||||||
- Be specific about your topic for better agent selection
|
- **Be specific about your topic** — Better agent selection
|
||||||
- Let the conversation flow naturally
|
- **Let the conversation flow** — Don't over-direct
|
||||||
- Ask follow-up questions to go deeper
|
- **Ask follow-up questions** — Go deeper on interesting points
|
||||||
- Take notes on key insights
|
- **Take notes on key insights** — Capture valuable perspectives
|
||||||
- Use for strategic decisions, not routine tasks
|
- **Use for strategic decisions** — Not routine tasks
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Related
|
|
||||||
|
|
||||||
- [Party Mode](/docs/explanation/features/party-mode.md) - Understanding Party Mode
|
|
||||||
- [Agent Roles](/docs/explanation/core-concepts/agent-roles.md) - Available agents
|
|
||||||
|
|
|
||||||
|
|
@ -3,11 +3,8 @@ title: "How to Set Up a Test Framework"
|
||||||
description: How to set up a production-ready test framework using TEA
|
description: How to set up a production-ready test framework using TEA
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
Use TEA's `*framework` workflow to scaffold a production-ready test framework for your project.
|
Use TEA's `*framework` workflow to scaffold a production-ready test framework for your project.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Use This
|
## When to Use This
|
||||||
|
|
||||||
- No existing test framework in your project
|
- No existing test framework in your project
|
||||||
|
|
@ -15,15 +12,11 @@ Use TEA's `*framework` workflow to scaffold a production-ready test framework fo
|
||||||
- Starting a new project that needs testing infrastructure
|
- Starting a new project that needs testing infrastructure
|
||||||
- Phase 3 (Solutioning) after architecture is complete
|
- Phase 3 (Solutioning) after architecture is complete
|
||||||
|
|
||||||
---
|
:::note[Prerequisites]
|
||||||
|
|
||||||
## Prerequisites
|
|
||||||
|
|
||||||
- BMad Method installed
|
- BMad Method installed
|
||||||
- Architecture completed (or at least tech stack decided)
|
- Architecture completed (or at least tech stack decided)
|
||||||
- TEA agent available
|
- TEA agent available
|
||||||
|
:::
|
||||||
---
|
|
||||||
|
|
||||||
## Steps
|
## Steps
|
||||||
|
|
||||||
|
|
@ -50,13 +43,11 @@ TEA will ask about:
|
||||||
|
|
||||||
TEA generates:
|
TEA generates:
|
||||||
|
|
||||||
- **Test scaffold** - Directory structure and config files
|
- **Test scaffold** — Directory structure and config files
|
||||||
- **Sample specs** - Example tests following best practices
|
- **Sample specs** — Example tests following best practices
|
||||||
- **`.env.example`** - Environment variable template
|
- **`.env.example`** — Environment variable template
|
||||||
- **`.nvmrc`** - Node version specification
|
- **`.nvmrc`** — Node version specification
|
||||||
- **README updates** - Testing documentation
|
- **README updates** — Testing documentation
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## What You Get
|
## What You Get
|
||||||
|
|
||||||
|
|
@ -71,8 +62,6 @@ tests/
|
||||||
└── README.md
|
└── README.md
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Optional: Playwright Utils Integration
|
## Optional: Playwright Utils Integration
|
||||||
|
|
||||||
TEA can integrate with `@seontechnologies/playwright-utils` for advanced fixtures:
|
TEA can integrate with `@seontechnologies/playwright-utils` for advanced fixtures:
|
||||||
|
|
@ -85,29 +74,25 @@ Enable during BMad installation or set `tea_use_playwright_utils: true` in confi
|
||||||
|
|
||||||
**Utilities available:** api-request, network-recorder, auth-session, intercept-network-call, recurse, log, file-utils, burn-in, network-error-monitor
|
**Utilities available:** api-request, network-recorder, auth-session, intercept-network-call, recurse, log, file-utils, burn-in, network-error-monitor
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Optional: MCP Enhancements
|
## Optional: MCP Enhancements
|
||||||
|
|
||||||
TEA can use Playwright MCP servers for enhanced capabilities:
|
TEA can use Playwright MCP servers for enhanced capabilities:
|
||||||
|
|
||||||
- `playwright` - Browser automation
|
- `playwright` — Browser automation
|
||||||
- `playwright-test` - Test runner with failure analysis
|
- `playwright-test` — Test runner with failure analysis
|
||||||
|
|
||||||
Configure in your IDE's MCP settings.
|
Configure in your IDE's MCP settings.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Tips
|
## Tips
|
||||||
|
|
||||||
- Run `*framework` only once per repository
|
- **Run only once per repository** — Framework setup is a one-time operation
|
||||||
- Run after architecture is complete so framework aligns with tech stack
|
- **Run after architecture is complete** — Framework aligns with tech stack
|
||||||
- Follow up with `*ci` to set up CI/CD pipeline
|
- **Follow up with CI setup** — Run `*ci` to configure CI/CD pipeline
|
||||||
|
|
||||||
---
|
## Next Steps
|
||||||
|
|
||||||
## Related
|
After test framework setup:
|
||||||
|
|
||||||
- [TEA Overview](/docs/explanation/features/tea-overview.md) - Understanding the Test Architect
|
1. **Test Design** — Create test plans for system or epics
|
||||||
- [Run Test Design](/docs/how-to/workflows/run-test-design.md) - Creating test plans
|
2. **CI Configuration** — Set up automated test runs
|
||||||
- [Create Architecture](/docs/how-to/workflows/create-architecture.md) - Architecture workflow
|
3. **Story Implementation** — Tests are ready for development
|
||||||
|
|
|
||||||
|
|
@ -3,139 +3,107 @@ title: "Agents Reference"
|
||||||
description: Complete reference for BMad Method agents and their commands
|
description: Complete reference for BMad Method agents and their commands
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
Quick reference of all BMad Method agents and their available commands.
|
Quick reference of all BMad Method agents and their available commands.
|
||||||
|
|
||||||
---
|
:::tip[Universal Commands]
|
||||||
|
All agents support: `*menu` (redisplay options), `*dismiss` (dismiss agent), and `*party-mode` (multi-agent collaboration).
|
||||||
|
:::
|
||||||
|
|
||||||
## Analyst (Mary)
|
## Analyst (Mary)
|
||||||
|
|
||||||
Business analysis and research.
|
Business analysis and research.
|
||||||
|
|
||||||
**Commands:**
|
**Commands:**
|
||||||
- `*workflow-status` - Get workflow status or initialize tracking
|
- `*workflow-status` — Get workflow status or initialize tracking
|
||||||
- `*brainstorm-project` - Guided brainstorming session
|
- `*brainstorm-project` — Guided brainstorming session
|
||||||
- `*research` - Market, domain, competitive, or technical research
|
- `*research` — Market, domain, competitive, or technical research
|
||||||
- `*product-brief` - Create a product brief (input for PRD)
|
- `*product-brief` — Create a product brief (input for PRD)
|
||||||
- `*document-project` - Document existing brownfield projects
|
- `*document-project` — Document existing brownfield projects
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## PM (John)
|
## PM (John)
|
||||||
|
|
||||||
Product requirements and planning.
|
Product requirements and planning.
|
||||||
|
|
||||||
**Commands:**
|
**Commands:**
|
||||||
- `*workflow-status` - Get workflow status or initialize tracking
|
- `*workflow-status` — Get workflow status or initialize tracking
|
||||||
- `*create-prd` - Create Product Requirements Document
|
- `*create-prd` — Create Product Requirements Document
|
||||||
- `*create-epics-and-stories` - Break PRD into epics and user stories (after Architecture)
|
- `*create-epics-and-stories` — Break PRD into epics and user stories (after Architecture)
|
||||||
- `*implementation-readiness` - Validate PRD, UX, Architecture, Epics alignment
|
- `*implementation-readiness` — Validate PRD, UX, Architecture, Epics alignment
|
||||||
- `*correct-course` - Course correction during implementation
|
- `*correct-course` — Course correction during implementation
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Architect (Winston)
|
## Architect (Winston)
|
||||||
|
|
||||||
System architecture and technical design.
|
System architecture and technical design.
|
||||||
|
|
||||||
**Commands:**
|
**Commands:**
|
||||||
- `*workflow-status` - Get workflow status or initialize tracking
|
- `*workflow-status` — Get workflow status or initialize tracking
|
||||||
- `*create-architecture` - Create architecture document to guide development
|
- `*create-architecture` — Create architecture document to guide development
|
||||||
- `*implementation-readiness` - Validate PRD, UX, Architecture, Epics alignment
|
- `*implementation-readiness` — Validate PRD, UX, Architecture, Epics alignment
|
||||||
- `*create-excalidraw-diagram` - System architecture or technical diagrams
|
- `*create-excalidraw-diagram` — System architecture or technical diagrams
|
||||||
- `*create-excalidraw-dataflow` - Data flow diagrams
|
- `*create-excalidraw-dataflow` — Data flow diagrams
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## SM (Bob)
|
## SM (Bob)
|
||||||
|
|
||||||
Sprint planning and story preparation.
|
Sprint planning and story preparation.
|
||||||
|
|
||||||
**Commands:**
|
**Commands:**
|
||||||
- `*sprint-planning` - Generate sprint-status.yaml from epic files
|
- `*sprint-planning` — Generate sprint-status.yaml from epic files
|
||||||
- `*create-story` - Create story from epic (prep for development)
|
- `*create-story` — Create story from epic (prep for development)
|
||||||
- `*validate-create-story` - Validate story quality
|
- `*validate-create-story` — Validate story quality
|
||||||
- `*epic-retrospective` - Team retrospective after epic completion
|
- `*epic-retrospective` — Team retrospective after epic completion
|
||||||
- `*correct-course` - Course correction during implementation
|
- `*correct-course` — Course correction during implementation
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## DEV (Amelia)
|
## DEV (Amelia)
|
||||||
|
|
||||||
Story implementation and code review.
|
Story implementation and code review.
|
||||||
|
|
||||||
**Commands:**
|
**Commands:**
|
||||||
- `*dev-story` - Execute story workflow (implementation with tests)
|
- `*dev-story` — Execute story workflow (implementation with tests)
|
||||||
- `*code-review` - Thorough code review
|
- `*code-review` — Thorough code review
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Quick Flow Solo Dev (Barry)
|
## Quick Flow Solo Dev (Barry)
|
||||||
|
|
||||||
Fast solo development without handoffs.
|
Fast solo development without handoffs.
|
||||||
|
|
||||||
**Commands:**
|
**Commands:**
|
||||||
- `*quick-spec` - Architect technical spec with implementation-ready stories
|
- `*quick-spec` — Architect technical spec with implementation-ready stories
|
||||||
- `*quick-dev` - Implement tech spec end-to-end solo
|
- `*quick-dev` — Implement tech spec end-to-end solo
|
||||||
- `*code-review` - Review and improve code
|
- `*code-review` — Review and improve code
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## TEA (Murat)
|
## TEA (Murat)
|
||||||
|
|
||||||
Test architecture and quality strategy.
|
Test architecture and quality strategy.
|
||||||
|
|
||||||
**Commands:**
|
**Commands:**
|
||||||
- `*framework` - Initialize production-ready test framework
|
- `*framework` — Initialize production-ready test framework
|
||||||
- `*atdd` - Generate E2E tests first (before implementation)
|
- `*atdd` — Generate E2E tests first (before implementation)
|
||||||
- `*automate` - Comprehensive test automation
|
- `*automate` — Comprehensive test automation
|
||||||
- `*test-design` - Create comprehensive test scenarios
|
- `*test-design` — Create comprehensive test scenarios
|
||||||
- `*trace` - Map requirements to tests, quality gate decision
|
- `*trace` — Map requirements to tests, quality gate decision
|
||||||
- `*nfr-assess` - Validate non-functional requirements
|
- `*nfr-assess` — Validate non-functional requirements
|
||||||
- `*ci` - Scaffold CI/CD quality pipeline
|
- `*ci` — Scaffold CI/CD quality pipeline
|
||||||
- `*test-review` - Review test quality
|
- `*test-review` — Review test quality
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## UX Designer (Sally)
|
## UX Designer (Sally)
|
||||||
|
|
||||||
User experience and UI design.
|
User experience and UI design.
|
||||||
|
|
||||||
**Commands:**
|
**Commands:**
|
||||||
- `*create-ux-design` - Generate UX design and UI plan from PRD
|
- `*create-ux-design` — Generate UX design and UI plan from PRD
|
||||||
- `*validate-design` - Validate UX specification and design artifacts
|
- `*validate-design` — Validate UX specification and design artifacts
|
||||||
- `*create-excalidraw-wireframe` - Create website or app wireframe
|
- `*create-excalidraw-wireframe` — Create website or app wireframe
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Technical Writer (Paige)
|
## Technical Writer (Paige)
|
||||||
|
|
||||||
Technical documentation and diagrams.
|
Technical documentation and diagrams.
|
||||||
|
|
||||||
**Commands:**
|
**Commands:**
|
||||||
- `*document-project` - Comprehensive project documentation
|
- `*document-project` — Comprehensive project documentation
|
||||||
- `*generate-mermaid` - Generate Mermaid diagrams
|
- `*generate-mermaid` — Generate Mermaid diagrams
|
||||||
- `*create-excalidraw-flowchart` - Process and logic flow visualizations
|
- `*create-excalidraw-flowchart` — Process and logic flow visualizations
|
||||||
- `*create-excalidraw-diagram` - System architecture or technical diagrams
|
- `*create-excalidraw-diagram` — System architecture or technical diagrams
|
||||||
- `*create-excalidraw-dataflow` - Data flow visualizations
|
- `*create-excalidraw-dataflow` — Data flow visualizations
|
||||||
- `*validate-doc` - Review documentation against standards
|
- `*validate-doc` — Review documentation against standards
|
||||||
- `*improve-readme` - Review and improve README files
|
- `*improve-readme` — Review and improve README files
|
||||||
- `*explain-concept` - Create clear technical explanations
|
- `*explain-concept` — Create clear technical explanations
|
||||||
- `*standards-guide` - Show BMad documentation standards
|
- `*standards-guide` — Show BMad documentation standards
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Universal Commands
|
|
||||||
|
|
||||||
Available to all agents:
|
|
||||||
|
|
||||||
- `*menu` - Redisplay menu options
|
|
||||||
- `*dismiss` - Dismiss agent
|
|
||||||
- `*party-mode` - Multi-agent collaboration (most agents)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Related
|
|
||||||
|
|
||||||
- [Agent Roles](/docs/explanation/core-concepts/agent-roles.md) - Understanding agent responsibilities
|
|
||||||
- [What Are Agents](/docs/explanation/core-concepts/what-are-agents.md) - Foundational concepts
|
|
||||||
|
|
|
||||||
|
|
@ -2,66 +2,66 @@
|
||||||
title: "Core Tasks"
|
title: "Core Tasks"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
Reusable task definitions that can be invoked by any BMad module, workflow, or agent.
|
||||||
|
|
||||||
Core Tasks are reusable task definitions that can be invoked by any BMad module, workflow, or agent. These tasks provide standardized functionality for common operations.
|
## Contents
|
||||||
|
|
||||||
## Table of Contents
|
|
||||||
|
|
||||||
- [Index Docs](#index-docs) — Generate directory index files
|
- [Index Docs](#index-docs) — Generate directory index files
|
||||||
- [Adversarial Review](#adversarial-review-general) — Critical content review
|
- [Adversarial Review](#adversarial-review) — Critical content review
|
||||||
- [Shard Document](#shard-document) — Split large documents into sections
|
- [Shard Document](#shard-document) — Split large documents into sections
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Index Docs
|
## Index Docs
|
||||||
|
|
||||||
**Generates or updates an index.md file documenting all documents in a specified directory.**
|
**Generates or updates an index.md file documenting all files in a specified directory.**
|
||||||
|
|
||||||
This task scans a target directory, reads file contents to understand their purpose, and creates a well-organized index with accurate descriptions. Files are grouped by type, purpose, or subdirectory, and descriptions are generated from actual content rather than guessing from filenames.
|
**Use it when:**
|
||||||
|
- You need navigable documentation for a folder of markdown files
|
||||||
**Use it when:** You need to create navigable documentation for a folder of markdown files, or you want to maintain an updated index as content evolves.
|
- You want to maintain an updated index as content evolves
|
||||||
|
|
||||||
**How it works:**
|
**How it works:**
|
||||||
1. Scan the target directory for files and subdirectories
|
1. Scan the target directory for files and subdirectories
|
||||||
2. Group content by type, purpose, or location
|
2. Group content by type, purpose, or location
|
||||||
3. Read each file to generate brief (3-10 word) descriptions based on actual content
|
3. Read each file to generate brief (3-10 word) descriptions
|
||||||
4. Create or update index.md with organized listings using relative paths
|
4. Create or update index.md with organized listings
|
||||||
|
|
||||||
**Output format:** A markdown index with sections for Files and Subdirectories, each entry containing a relative link and description.
|
**Output:** Markdown index with sections for Files and Subdirectories, each entry containing a relative link and description.
|
||||||
|
|
||||||
---
|
## Adversarial Review
|
||||||
|
|
||||||
## Adversarial Review (General)
|
|
||||||
|
|
||||||
**Performs a cynical, skeptical review of any content to identify issues and improvement opportunities.**
|
**Performs a cynical, skeptical review of any content to identify issues and improvement opportunities.**
|
||||||
|
|
||||||
This task applies adversarial thinking to content review—approaching the material with the assumption that problems exist. It's designed to find what's missing, not just what's wrong, and produces at least ten specific findings. The reviewer adopts a professional but skeptical tone, looking for gaps, inconsistencies, oversights, and areas that need clarification.
|
**Use it when:**
|
||||||
|
- Reviewing code diffs before merging
|
||||||
**Use it when:** You need a critical eye on code diffs, specifications, user stories, documentation, or any artifact before finalizing. It's particularly valuable before merging code, releasing documentation, or considering a specification complete.
|
- Finalizing specifications or user stories
|
||||||
|
- Releasing documentation
|
||||||
|
- Any artifact needs a critical eye before completion
|
||||||
|
|
||||||
**How it works:**
|
**How it works:**
|
||||||
1. Load the content to review (diff, branch, uncommitted changes, document, etc.)
|
1. Load the content to review (diff, branch, document, etc.)
|
||||||
2. Perform adversarial analysis with extreme skepticism—assume problems exist
|
2. Perform adversarial analysis — assume problems exist
|
||||||
3. Find at least ten issues to fix or improve
|
3. Find at least ten issues to fix or improve
|
||||||
4. Output findings as a markdown list
|
4. Output findings as a markdown list
|
||||||
|
|
||||||
**Note:** This task is designed to run in a separate subagent/process with read access to the project but no prior context, ensuring an unbiased review.
|
:::note[Unbiased Review]
|
||||||
|
This task runs in a separate subagent with read access but no prior context, ensuring an unbiased review.
|
||||||
---
|
:::
|
||||||
|
|
||||||
## Shard Document
|
## Shard Document
|
||||||
|
|
||||||
**Splits large markdown documents into smaller, organized files based on level 2 (##) sections.**
|
**Splits large markdown documents into smaller files based on level 2 (`##`) sections.**
|
||||||
|
|
||||||
Uses the `@kayvan/markdown-tree-parser` tool to automatically break down large documents into a folder structure. Each level 2 heading becomes a separate file, and an index.md is generated to tie everything together. This makes large documents more maintainable and allows for easier navigation and updates to individual sections.
|
**Use it when:**
|
||||||
|
- A markdown file has grown too large to work with effectively
|
||||||
**Use it when:** A markdown file has grown too large to effectively work with, or you want to break a monolithic document into manageable sections that can be edited independently.
|
- You want to break a monolithic document into manageable sections
|
||||||
|
- Individual sections need to be edited independently
|
||||||
|
|
||||||
**How it works:**
|
**How it works:**
|
||||||
1. Confirm source document path and verify it's a markdown file
|
1. Confirm source document path (must be markdown)
|
||||||
2. Determine destination folder (defaults to same location as source, folder named after document)
|
2. Determine destination folder (defaults to folder named after document)
|
||||||
3. Execute the sharding command using npx @kayvan/markdown-tree-parser
|
3. Execute sharding via `npx @kayvan/markdown-tree-parser`
|
||||||
4. Verify output files and index.md were created
|
4. Verify output files and index.md were created
|
||||||
5. Handle the original document—delete, move to archive, or keep with warning
|
5. Handle original document — delete, move to archive, or keep
|
||||||
|
|
||||||
**Handling the original:** After sharding, the task prompts you to delete, archive, or keep the original document. Deleting or archiving is recommended to avoid confusion and ensure updates happen in the sharded files only.
|
:::caution[Original File]
|
||||||
|
After sharding, delete or archive the original to avoid confusion. Updates should happen in the sharded files only.
|
||||||
|
:::
|
||||||
|
|
|
||||||
|
|
@ -1,14 +1,28 @@
|
||||||
---
|
---
|
||||||
title: "Core Module Global Inheritable Config"
|
title: "Global Inheritable Config"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
Configuration values defined in the Core Module that all other modules inherit by default.
|
||||||
|
|
||||||
The Core Modules module.yaml file defines configuration values that are useful and unique for all other modules to utilize, and by default all other modules installed will clone the values defined in the core module yaml.config into their own. It is possible for other modules to override these values, but the general intent it to accept the core module values and define their own values as needed, or extend the core values.
|
## Core Config Values
|
||||||
|
|
||||||
Currently, the core module.yaml config will define (asking the user upon installation, and recording to the core module config.yaml):
|
These values are set during installation and recorded to the core `module.yaml`:
|
||||||
- `user_name`: string (defaults to the system defined user name)
|
|
||||||
- `communication_language`: string (defaults to english)
|
|
||||||
- `document_output_language`: string (defaults to english)
|
|
||||||
- `output_folder`: string (default `_bmad-output`)
|
|
||||||
|
|
||||||
An example of extending one of these values, in the BMad Method module.yaml it defines a planning_artifacts config, which will default to `default: "{output_folder}/planning-artifacts"` thus whatever the output_folder will be, this extended versions default will use the value from this core module and append a new folder onto it. The user can choose to replace this without utilizing the output_folder from the core if they so chose.
|
| Config Key | Default | Description |
|
||||||
|
|------------|---------|-------------|
|
||||||
|
| `user_name` | System username | User's display name |
|
||||||
|
| `communication_language` | `english` | Language for agent communication |
|
||||||
|
| `document_output_language` | `english` | Language for generated documents |
|
||||||
|
| `output_folder` | `_bmad-output` | Directory for workflow outputs |
|
||||||
|
|
||||||
|
## Inheritance Behavior
|
||||||
|
|
||||||
|
All installed modules automatically clone these values into their own config. Modules can:
|
||||||
|
|
||||||
|
- **Accept defaults** — Use core values as-is (recommended)
|
||||||
|
- **Override values** — Replace with module-specific settings
|
||||||
|
- **Extend values** — Build on core values with additional paths
|
||||||
|
|
||||||
|
:::tip[Extending Config]
|
||||||
|
Use `{output_folder}` to reference the core value. Example: BMad Method defines `planning_artifacts` as `{output_folder}/planning-artifacts`, automatically inheriting whatever output folder the user configured.
|
||||||
|
:::
|
||||||
|
|
|
||||||
|
|
@ -2,371 +2,121 @@
|
||||||
title: "BMad Glossary"
|
title: "BMad Glossary"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
Terminology reference for the BMad Method.
|
||||||
Comprehensive terminology reference for the BMad Method.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Navigation
|
|
||||||
|
|
||||||
- [Core Concepts](#core-concepts)
|
|
||||||
- [Scale and Complexity](#scale-and-complexity)
|
|
||||||
- [Planning Documents](#planning-documents)
|
|
||||||
- [Workflow and Phases](#workflow-and-phases)
|
|
||||||
- [Agents and Roles](#agents-and-roles)
|
|
||||||
- [Status and Tracking](#status-and-tracking)
|
|
||||||
- [Project Types](#project-types)
|
|
||||||
- [Implementation Terms](#implementation-terms)
|
|
||||||
- [Game Development Terms](#game-development-terms)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Core Concepts
|
## Core Concepts
|
||||||
|
|
||||||
### BMad (Breakthrough Method of Agile AI Driven Development)
|
| Term | Definition |
|
||||||
|
|------|------------|
|
||||||
AI-driven agile development framework with specialized agents, guided workflows, and scale-adaptive intelligence.
|
| **Agent** | Specialized AI persona with specific expertise (PM, Architect, SM, DEV, TEA) that guides users through workflows and creates deliverables. |
|
||||||
|
| **BMad** | Breakthrough Method of Agile AI Driven Development — AI-driven agile framework with specialized agents, guided workflows, and scale-adaptive intelligence. |
|
||||||
### BMM (BMad Method Module)
|
| **BMad Method** | Complete methodology for AI-assisted software development, encompassing planning, architecture, implementation, and quality assurance workflows that adapt to project complexity. |
|
||||||
|
| **BMM** | BMad Method Module — core orchestration system providing comprehensive lifecycle management through specialized agents and workflows. |
|
||||||
Core orchestration system for AI-driven agile development, providing comprehensive lifecycle management through specialized agents and workflows.
|
| **Scale-Adaptive System** | Intelligent workflow orchestration that adjusts planning depth and documentation requirements based on project needs through three planning tracks. |
|
||||||
|
| **Workflow** | Multi-step guided process that orchestrates AI agent activities to produce specific deliverables. Workflows are interactive and adapt to user context. |
|
||||||
### BMad Method
|
|
||||||
|
|
||||||
The complete methodology for AI-assisted software development, encompassing planning, architecture, implementation, and quality assurance workflows that adapt to project complexity.
|
|
||||||
|
|
||||||
### Scale-Adaptive System
|
|
||||||
|
|
||||||
BMad Method's intelligent workflow orchestration that automatically adjusts planning depth, documentation requirements, and implementation processes based on project needs through three distinct planning tracks (Quick Flow, BMad Method, Enterprise Method).
|
|
||||||
|
|
||||||
### Agent
|
|
||||||
|
|
||||||
A specialized AI persona with specific expertise (PM, Architect, SM, DEV, TEA) that guides users through workflows and creates deliverables. Agents have defined capabilities, communication styles, and workflow access.
|
|
||||||
|
|
||||||
### Workflow
|
|
||||||
|
|
||||||
A multi-step guided process that orchestrates AI agent activities to produce specific deliverables. Workflows are interactive and adapt to user context.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Scale and Complexity
|
## Scale and Complexity
|
||||||
|
|
||||||
### Quick Flow Track
|
| Term | Definition |
|
||||||
|
|------|------------|
|
||||||
Fast implementation track using tech-spec planning only. Best for bug fixes, small features, and changes with clear scope. Typical range: 1-15 stories. No architecture phase needed. Examples: bug fixes, OAuth login, search features.
|
| **BMad Method Track** | Full product planning track using PRD + Architecture + UX. Best for products, platforms, and complex features. Typical range: 10-50+ stories. |
|
||||||
|
| **Enterprise Method Track** | Extended planning track adding Security Architecture, DevOps Strategy, and Test Strategy. Best for compliance needs and multi-tenant systems. Typical range: 30+ stories. |
|
||||||
### BMad Method Track
|
| **Planning Track** | Methodology path (Quick Flow, BMad Method, or Enterprise) chosen based on planning needs and complexity, not story count alone. |
|
||||||
|
| **Quick Flow Track** | Fast implementation track using tech-spec only. Best for bug fixes, small features, and clear-scope changes. Typical range: 1-15 stories. |
|
||||||
Full product planning track using PRD + Architecture + UX. Best for products, platforms, and complex features requiring system design. Typical range: 10-50+ stories. Examples: admin dashboards, e-commerce platforms, SaaS products.
|
|
||||||
|
|
||||||
### Enterprise Method Track
|
|
||||||
|
|
||||||
Extended enterprise planning track adding Security Architecture, DevOps Strategy, and Test Strategy to BMad Method. Best for enterprise requirements, compliance needs, and multi-tenant systems. Typical range: 30+ stories. Examples: multi-tenant platforms, compliance-driven systems, mission-critical applications.
|
|
||||||
|
|
||||||
### Planning Track
|
|
||||||
|
|
||||||
The methodology path (Quick Flow, BMad Method, or Enterprise Method) chosen for a project based on planning needs, complexity, and requirements rather than story count alone.
|
|
||||||
|
|
||||||
**Note:** Story counts are guidance, not definitions. Tracks are determined by what planning the project needs, not story math.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Planning Documents
|
## Planning Documents
|
||||||
|
|
||||||
### Tech-Spec (Technical Specification)
|
| Term | Definition |
|
||||||
|
|------|------------|
|
||||||
**Quick Flow track only.** Comprehensive technical plan created upfront that serves as the primary planning document for small changes or features. Contains problem statement, solution approach, file-level changes, stack detection (brownfield), testing strategy, and developer resources.
|
| **Architecture Document** | *BMad Method/Enterprise.* System-wide design document defining structure, components, data models, integration patterns, security, and deployment. |
|
||||||
|
| **Epics** | High-level feature groupings containing multiple related stories. Typically 5-15 stories each representing cohesive functionality. |
|
||||||
### PRD (Product Requirements Document)
|
| **Game Brief** | *BMGD.* Document capturing game's core vision, pillars, target audience, and scope. Foundation for the GDD. |
|
||||||
|
| **GDD** | *BMGD.* Game Design Document — comprehensive document detailing all aspects of game design: mechanics, systems, content, and more. |
|
||||||
**BMad Method/Enterprise tracks.** Product-level planning document containing vision, goals, Functional Requirements (FRs), Non-Functional Requirements (NFRs), success criteria, and UX considerations. Replaces tech-spec for larger projects that need product planning. **V6 Note:** PRD focuses on WHAT to build (requirements). Epic+Stories are created separately AFTER architecture via create-epics-and-stories workflow.
|
| **PRD** | *BMad Method/Enterprise.* Product Requirements Document containing vision, goals, FRs, NFRs, and success criteria. Focuses on WHAT to build. |
|
||||||
|
| **Product Brief** | *Phase 1.* Optional strategic document capturing product vision, market context, and high-level requirements before detailed planning. |
|
||||||
### Architecture Document
|
| **Tech-Spec** | *Quick Flow only.* Comprehensive technical plan with problem statement, solution approach, file-level changes, and testing strategy. |
|
||||||
|
|
||||||
**BMad Method/Enterprise tracks.** System-wide design document defining structure, components, interactions, data models, integration patterns, security, performance, and deployment.
|
|
||||||
|
|
||||||
**Scale-Adaptive:** Architecture complexity scales with track - BMad Method is lightweight to moderate, Enterprise Method is comprehensive with security/devops/test strategies.
|
|
||||||
|
|
||||||
### Epics
|
|
||||||
|
|
||||||
High-level feature groupings that contain multiple related stories. Typically span 5-15 stories each and represent cohesive functionality (e.g., "User Authentication Epic").
|
|
||||||
|
|
||||||
### Product Brief
|
|
||||||
|
|
||||||
Optional strategic planning document created in Phase 1 (Analysis) that captures product vision, market context, user needs, and high-level requirements before detailed planning.
|
|
||||||
|
|
||||||
### GDD (Game Design Document)
|
|
||||||
|
|
||||||
Game development equivalent of PRD, created by Game Designer agent for game projects. Comprehensive document detailing all aspects of game design: mechanics, systems, content, and more.
|
|
||||||
|
|
||||||
### Game Brief
|
|
||||||
|
|
||||||
Document capturing the game's core vision, pillars, target audience, and scope. Foundation for the GDD.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Workflow and Phases
|
## Workflow and Phases
|
||||||
|
|
||||||
### Phase 0: Documentation (Prerequisite)
|
| Term | Definition |
|
||||||
|
|------|------------|
|
||||||
**Conditional phase for brownfield projects.** Creates comprehensive codebase documentation before planning. Only required if existing documentation is insufficient for AI agents.
|
| **Phase 0: Documentation** | *Brownfield.* Conditional prerequisite phase creating codebase documentation before planning. Only required if existing docs are insufficient. |
|
||||||
|
| **Phase 1: Analysis** | Discovery phase including brainstorming, research, and product brief creation. Optional for Quick Flow, recommended for BMad Method. |
|
||||||
### Phase 1: Analysis (Optional)
|
| **Phase 2: Planning** | Required phase creating formal requirements. Routes to tech-spec (Quick Flow) or PRD (BMad Method/Enterprise). |
|
||||||
|
| **Phase 3: Solutioning** | *BMad Method/Enterprise.* Architecture design phase including creation, validation, and gate checks. |
|
||||||
Discovery and research phase including brainstorming, research workflows, and product brief creation. Optional for Quick Flow, recommended for BMad Method, required for Enterprise Method.
|
| **Phase 4: Implementation** | Required sprint-based development through story-by-story iteration using sprint-planning, create-story, dev-story, and code-review workflows. |
|
||||||
|
| **Quick Spec Flow** | Fast-track workflow for Quick Flow projects going straight from idea to tech-spec to implementation. |
|
||||||
### Phase 2: Planning (Required)
|
| **Workflow Init** | Initialization workflow creating bmm-workflow-status.yaml, detecting project type, and determining planning track. |
|
||||||
|
| **Workflow Status** | Universal entry point checking for existing status file, displaying progress, and recommending next action. |
|
||||||
**Always required.** Creates formal requirements and work breakdown. Routes to tech-spec (Quick Flow) or PRD (BMad Method/Enterprise) based on selected track.
|
|
||||||
|
|
||||||
### Phase 3: Solutioning (Track-Dependent)
|
|
||||||
|
|
||||||
Architecture design phase. Required for BMad Method and Enterprise Method tracks. Includes architecture creation, validation, and gate checks.
|
|
||||||
|
|
||||||
### Phase 4: Implementation (Required)
|
|
||||||
|
|
||||||
Sprint-based development through story-by-story iteration. Uses sprint-planning, create-story, dev-story, code-review, and retrospective workflows.
|
|
||||||
|
|
||||||
### Quick Spec Flow
|
|
||||||
|
|
||||||
Fast-track workflow system for Quick Flow track projects that goes straight from idea to tech-spec to implementation, bypassing heavy planning. Designed for bug fixes, small features, and rapid prototyping.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Agents and Roles
|
## Agents and Roles
|
||||||
|
|
||||||
### PM (Product Manager)
|
| Term | Definition |
|
||||||
|
|------|------------|
|
||||||
Agent responsible for creating PRDs, tech-specs, and managing product requirements. Primary agent for Phase 2 planning.
|
| **Analyst** | Agent that initializes workflows, conducts research, creates product briefs, and tracks progress. Often the entry point for new projects. |
|
||||||
|
| **Architect** | Agent designing system architecture, creating architecture documents, and validating designs. Primary agent for Phase 3. |
|
||||||
### Analyst (Business Analyst)
|
| **BMad Master** | Meta-level orchestrator from BMad Core facilitating party mode and providing high-level guidance across all modules. |
|
||||||
|
| **DEV** | Developer agent implementing stories, writing code, running tests, and performing code reviews. Primary implementer in Phase 4. |
|
||||||
Agent that initializes workflows, conducts research, creates product briefs, and tracks progress. Often the entry point for new projects.
|
| **Game Architect** | *BMGD.* Agent designing game system architecture and validating game-specific technical designs. |
|
||||||
|
| **Game Designer** | *BMGD.* Agent creating game design documents (GDD) and running game-specific workflows. |
|
||||||
### Architect
|
| **Party Mode** | Multi-agent collaboration feature where agents discuss challenges together. BMad Master orchestrates, selecting 2-3 relevant agents per message. |
|
||||||
|
| **PM** | Product Manager agent creating PRDs and tech-specs. Primary agent for Phase 2 planning. |
|
||||||
Agent that designs system architecture, creates architecture documents, performs technical reviews, and validates designs. Primary agent for Phase 3 solutioning.
|
| **SM** | Scrum Master agent managing sprints, creating stories, and coordinating implementation. Primary orchestrator for Phase 4. |
|
||||||
|
| **TEA** | Test Architect agent responsible for test strategy, quality gates, and NFR assessment. Integrates throughout all phases. |
|
||||||
### SM (Scrum Master)
|
| **Technical Writer** | Agent specialized in creating technical documentation, diagrams, and maintaining documentation standards. |
|
||||||
|
| **UX Designer** | Agent creating UX design documents, interaction patterns, and visual specifications for UI-heavy projects. |
|
||||||
Agent that manages sprints, creates stories, generates contexts, and coordinates implementation. Primary orchestrator for Phase 4 implementation.
|
|
||||||
|
|
||||||
### DEV (Developer)
|
|
||||||
|
|
||||||
Agent that implements stories, writes code, runs tests, and performs code reviews. Primary implementer in Phase 4.
|
|
||||||
|
|
||||||
### TEA (Test Architect)
|
|
||||||
|
|
||||||
Agent responsible for test strategy, quality gates, NFR assessment, and comprehensive quality assurance. Integrates throughout all phases.
|
|
||||||
|
|
||||||
### Technical Writer
|
|
||||||
|
|
||||||
Agent specialized in creating and maintaining high-quality technical documentation. Expert in documentation standards, information architecture, and professional technical writing.
|
|
||||||
|
|
||||||
### UX Designer
|
|
||||||
|
|
||||||
Agent that creates UX design documents, interaction patterns, and visual specifications for UI-heavy projects.
|
|
||||||
|
|
||||||
### Game Designer
|
|
||||||
|
|
||||||
Specialized agent for game development projects. Creates game design documents (GDD) and game-specific workflows.
|
|
||||||
|
|
||||||
### Game Architect
|
|
||||||
|
|
||||||
Agent that designs game system architecture, creates technical architecture for games, and validates game-specific designs.
|
|
||||||
|
|
||||||
### BMad Master
|
|
||||||
|
|
||||||
Meta-level orchestrator agent from BMad Core. Facilitates party mode, lists available tasks and workflows, and provides high-level guidance across all modules.
|
|
||||||
|
|
||||||
### Party Mode
|
|
||||||
|
|
||||||
Multi-agent collaboration feature where all installed agents discuss challenges together in real-time. BMad Master orchestrates, selecting 2-3 relevant agents per message for natural cross-talk and debate. Best for strategic decisions, creative brainstorming, cross-functional alignment, and complex problem-solving.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Status and Tracking
|
## Status and Tracking
|
||||||
|
|
||||||
### bmm-workflow-status.yaml
|
| Term | Definition |
|
||||||
|
|------|------------|
|
||||||
**Phases 1-3.** Tracking file that shows current phase, completed workflows, progress, and next recommended actions. Created by workflow-init, updated automatically.
|
| **bmm-workflow-status.yaml** | *Phases 1-3.* Tracking file showing current phase, completed workflows, and next recommended actions. |
|
||||||
|
| **DoD** | Definition of Done — criteria for marking a story complete: implementation done, tests passing, code reviewed, docs updated. |
|
||||||
### sprint-status.yaml
|
| **Epic Status Progression** | `backlog → in-progress → done` — lifecycle states for epics during implementation. |
|
||||||
|
| **Gate Check** | Validation workflow (implementation-readiness) ensuring PRD, Architecture, and Epics are aligned before Phase 4. |
|
||||||
**Phase 4 only.** Single source of truth for implementation tracking. Contains all epics, stories, and retrospectives with current status for each. Created by sprint-planning, updated by agents.
|
| **Retrospective** | Workflow after each epic capturing learnings and improvements for continuous improvement. |
|
||||||
|
| **sprint-status.yaml** | *Phase 4.* Single source of truth for implementation tracking containing all epics, stories, and their statuses. |
|
||||||
### Story Status Progression
|
| **Story Status Progression** | `backlog → ready-for-dev → in-progress → review → done` — lifecycle states for stories. |
|
||||||
|
|
||||||
```
|
|
||||||
backlog → ready-for-dev → in-progress → review → done
|
|
||||||
```
|
|
||||||
|
|
||||||
- **backlog** - Story exists in epic but not yet created
|
|
||||||
- **ready-for-dev** - Story file created via create-story; validation is optional
|
|
||||||
- **in-progress** - DEV is implementing via dev-story
|
|
||||||
- **review** - Implementation complete, awaiting code-review
|
|
||||||
- **done** - Completed with DoD met
|
|
||||||
|
|
||||||
### Epic Status Progression
|
|
||||||
|
|
||||||
```
|
|
||||||
backlog → in-progress → done
|
|
||||||
```
|
|
||||||
|
|
||||||
- **backlog** - Epic not yet started
|
|
||||||
- **in-progress** - Epic actively being worked on
|
|
||||||
- **done** - All stories in epic completed
|
|
||||||
|
|
||||||
### Retrospective
|
|
||||||
|
|
||||||
Workflow run after completing each epic to capture learnings, identify improvements, and feed insights into next epic planning. Critical for continuous improvement.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Project Types
|
## Project Types
|
||||||
|
|
||||||
### Greenfield
|
| Term | Definition |
|
||||||
|
|------|------------|
|
||||||
New project starting from scratch with no existing codebase. Freedom to establish patterns, choose stack, and design from clean slate.
|
| **Brownfield** | Existing project with established codebase and patterns. Requires understanding existing architecture and planning integration. |
|
||||||
|
| **Convention Detection** | *Quick Flow.* Feature auto-detecting existing code style, naming conventions, and frameworks from brownfield codebases. |
|
||||||
### Brownfield
|
| **document-project** | *Brownfield.* Workflow analyzing and documenting existing codebase with three scan levels: quick, deep, exhaustive. |
|
||||||
|
| **Feature Flags** | *Brownfield.* Implementation technique for gradual rollout, easy rollback, and A/B testing of new functionality. |
|
||||||
Existing project with established codebase, patterns, and constraints. Requires understanding existing architecture, respecting established conventions, and planning integration with current systems.
|
| **Greenfield** | New project starting from scratch with freedom to establish patterns, choose stack, and design from clean slate. |
|
||||||
|
| **Integration Points** | *Brownfield.* Specific locations where new code connects with existing systems. Must be documented in tech-specs. |
|
||||||
**Critical:** Brownfield projects should run document-project workflow BEFORE planning to ensure AI agents have adequate context about existing code.
|
|
||||||
|
|
||||||
### document-project Workflow
|
|
||||||
|
|
||||||
**Brownfield prerequisite.** Analyzes and documents existing codebase, creating comprehensive documentation including project overview, architecture analysis, source tree, API contracts, and data models. Three scan levels: quick, deep, exhaustive.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Implementation Terms
|
## Implementation Terms
|
||||||
|
|
||||||
### Story
|
| Term | Definition |
|
||||||
|
|------|------------|
|
||||||
Single unit of implementable work with clear acceptance criteria, typically 2-8 hours of development effort. Stories are grouped into epics and tracked in sprint-status.yaml.
|
| **Context Engineering** | Loading domain-specific standards into AI context automatically via manifests, ensuring consistent outputs regardless of prompt variation. |
|
||||||
|
| **Correct Course** | Workflow for navigating significant changes when implementation is off-track. Analyzes impact and recommends adjustments. |
|
||||||
### Story File
|
| **Shard / Sharding** | Splitting large planning documents into section-based files for LLM optimization. Phase 4 workflows load only needed sections. |
|
||||||
|
| **Sprint** | Time-boxed period of development work, typically 1-2 weeks. |
|
||||||
Markdown file containing story details: description, acceptance criteria, technical notes, dependencies, implementation guidance, and testing requirements.
|
| **Sprint Planning** | Workflow initializing Phase 4 by creating sprint-status.yaml and extracting epics/stories from planning docs. |
|
||||||
|
| **Story** | Single unit of implementable work with clear acceptance criteria, typically 2-8 hours of effort. Grouped into epics. |
|
||||||
### Story Context
|
| **Story Context** | Implementation guidance embedded in story files during create-story, referencing existing patterns and approaches. |
|
||||||
|
| **Story File** | Markdown file containing story description, acceptance criteria, technical notes, and testing requirements. |
|
||||||
Implementation guidance embedded within story files during the create-story workflow. Provides implementation-specific context, references existing patterns, suggests approaches, and helps maintain consistency with established codebase conventions.
|
| **Track Selection** | Automatic analysis by workflow-init suggesting appropriate track based on complexity indicators. User can override. |
|
||||||
|
|
||||||
### Sprint Planning
|
|
||||||
|
|
||||||
Workflow that initializes Phase 4 implementation by creating sprint-status.yaml, extracting all epics/stories from planning docs, and setting up tracking infrastructure.
|
|
||||||
|
|
||||||
### Sprint
|
|
||||||
|
|
||||||
Time-boxed period of development work, typically 1-2 weeks.
|
|
||||||
|
|
||||||
### Gate Check
|
|
||||||
|
|
||||||
Validation workflow (implementation-readiness) run before Phase 4 to ensure PRD + Architecture + Epics + UX (optional) are aligned with no gaps or contradictions. Required for BMad Method and Enterprise Method tracks.
|
|
||||||
|
|
||||||
### DoD (Definition of Done)
|
|
||||||
|
|
||||||
Criteria that must be met before marking a story as done. Typically includes: implementation complete, tests written and passing, code reviewed, documentation updated, and acceptance criteria validated.
|
|
||||||
|
|
||||||
### Shard / Sharding
|
|
||||||
|
|
||||||
**For runtime LLM optimization only (NOT human docs).** Splitting large planning documents (PRD, epics, architecture) into smaller section-based files to improve workflow efficiency. Phase 1-3 workflows load entire sharded documents transparently. Phase 4 workflows selectively load only needed sections for massive token savings.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Game Development Terms
|
## Game Development Terms
|
||||||
|
|
||||||
### Core Fantasy
|
| Term | Definition |
|
||||||
|
|------|------------|
|
||||||
The emotional experience players seek from your game. What they want to FEEL.
|
| **Core Fantasy** | *BMGD.* The emotional experience players seek from your game — what they want to FEEL. |
|
||||||
|
| **Core Loop** | *BMGD.* Fundamental cycle of actions players repeat throughout gameplay. The heart of your game. |
|
||||||
### Core Loop
|
| **Design Pillar** | *BMGD.* Core principle guiding all design decisions. Typically 3-5 pillars define a game's identity. |
|
||||||
|
| **Environmental Storytelling** | *BMGD.* Narrative communicated through the game world itself rather than explicit dialogue. |
|
||||||
The fundamental cycle of actions players repeat throughout gameplay. The heart of your game.
|
| **Game Type** | *BMGD.* Genre classification determining which specialized GDD sections are included. |
|
||||||
|
| **MDA Framework** | *BMGD.* Mechanics → Dynamics → Aesthetics — framework for analyzing and designing games. |
|
||||||
### Design Pillar
|
| **Meta-Progression** | *BMGD.* Persistent progression carrying between individual runs or sessions. |
|
||||||
|
| **Metroidvania** | *BMGD.* Genre featuring interconnected world exploration with ability-gated progression. |
|
||||||
Core principle that guides all design decisions. Typically 3-5 pillars define a game's identity.
|
| **Narrative Complexity** | *BMGD.* How central story is to the game: Critical, Heavy, Moderate, or Light. |
|
||||||
|
| **Permadeath** | *BMGD.* Game mechanic where character death is permanent, typically requiring a new run. |
|
||||||
### Game Type
|
| **Player Agency** | *BMGD.* Degree to which players can make meaningful choices affecting outcomes. |
|
||||||
|
| **Procedural Generation** | *BMGD.* Algorithmic creation of game content (levels, items, characters) rather than hand-crafted. |
|
||||||
Genre classification that determines which specialized GDD sections are included.
|
| **Roguelike** | *BMGD.* Genre featuring procedural generation, permadeath, and run-based progression. |
|
||||||
|
|
||||||
### Narrative Complexity
|
|
||||||
|
|
||||||
How central story is to the game experience:
|
|
||||||
- **Critical** - Story IS the game (visual novels)
|
|
||||||
- **Heavy** - Deep narrative with gameplay (RPGs)
|
|
||||||
- **Moderate** - Meaningful story supporting gameplay
|
|
||||||
- **Light** - Minimal story, gameplay-focused
|
|
||||||
|
|
||||||
### Environmental Storytelling
|
|
||||||
|
|
||||||
Narrative communicated through the game world itself—visual details, audio, found documents—rather than explicit dialogue.
|
|
||||||
|
|
||||||
### MDA Framework
|
|
||||||
|
|
||||||
Mechanics → Dynamics → Aesthetics. Framework for analyzing and designing games.
|
|
||||||
|
|
||||||
### Procedural Generation
|
|
||||||
|
|
||||||
Algorithmic creation of game content (levels, items, characters) rather than hand-crafted.
|
|
||||||
|
|
||||||
### Roguelike
|
|
||||||
|
|
||||||
Genre featuring procedural generation, permadeath, and run-based progression.
|
|
||||||
|
|
||||||
### Metroidvania
|
|
||||||
|
|
||||||
Genre featuring interconnected world exploration with ability-gated progression.
|
|
||||||
|
|
||||||
### Meta-Progression
|
|
||||||
|
|
||||||
Persistent progression that carries between individual runs or sessions.
|
|
||||||
|
|
||||||
### Permadeath
|
|
||||||
|
|
||||||
Game mechanic where character death is permanent, typically requiring a new run.
|
|
||||||
|
|
||||||
### Player Agency
|
|
||||||
|
|
||||||
The degree to which players can make meaningful choices that affect outcomes.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Additional Terms
|
|
||||||
|
|
||||||
### Workflow Status
|
|
||||||
|
|
||||||
Universal entry point workflow that checks for existing status file, displays current phase/progress, and recommends next action based on project state.
|
|
||||||
|
|
||||||
### Workflow Init
|
|
||||||
|
|
||||||
Initialization workflow that creates bmm-workflow-status.yaml, detects greenfield vs brownfield, determines planning track, and sets up appropriate workflow path.
|
|
||||||
|
|
||||||
### Track Selection
|
|
||||||
|
|
||||||
Automatic analysis by workflow-init that uses keyword analysis, complexity indicators, and project requirements to suggest appropriate track (Quick Flow, BMad Method, or Enterprise Method). User can override suggested track.
|
|
||||||
|
|
||||||
### Correct Course
|
|
||||||
|
|
||||||
Workflow run during Phase 4 when significant changes or issues arise. Analyzes impact, proposes solutions, and routes to appropriate remediation workflows.
|
|
||||||
|
|
||||||
### Feature Flags
|
|
||||||
|
|
||||||
Implementation technique for brownfield projects that allows gradual rollout of new functionality, easy rollback, and A/B testing. Recommended for BMad Method and Enterprise brownfield changes.
|
|
||||||
|
|
||||||
### Integration Points
|
|
||||||
|
|
||||||
Specific locations where new code connects with existing systems. Must be documented explicitly in brownfield tech-specs and architectures.
|
|
||||||
|
|
||||||
### Context Engineering
|
|
||||||
|
|
||||||
Loading domain-specific standards and patterns into AI context automatically, rather than relying on prompts alone. In TEA, this means the `tea-index.csv` manifest loads relevant knowledge fragments so the AI doesn't relearn testing patterns each session. This approach ensures consistent, production-ready outputs regardless of prompt variation.
|
|
||||||
|
|
||||||
### Convention Detection
|
|
||||||
|
|
||||||
Quick Spec Flow feature that automatically detects existing code style, naming conventions, patterns, and frameworks from brownfield codebases, then asks user to confirm before proceeding.
|
|
||||||
|
|
|
||||||
|
|
@ -2,19 +2,14 @@
|
||||||
title: "BMGD Workflows Guide"
|
title: "BMGD Workflows Guide"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
Complete reference for all BMGD workflows organized by development phase.
|
Complete reference for all BMGD workflows organized by development phase.
|
||||||
|
|
||||||
---
|
## Overview
|
||||||
|
|
||||||
## Workflow Overview
|
|
||||||
|
|
||||||
BMGD workflows are organized into four phases:
|
BMGD workflows are organized into four phases:
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 1: Preproduction
|
## Phase 1: Preproduction
|
||||||
|
|
||||||
### Brainstorm Game
|
### Brainstorm Game
|
||||||
|
|
@ -24,23 +19,19 @@ BMGD workflows are organized into four phases:
|
||||||
**Input:** None required
|
**Input:** None required
|
||||||
**Output:** Ideas and concepts (optionally saved)
|
**Output:** Ideas and concepts (optionally saved)
|
||||||
|
|
||||||
**Description:**
|
|
||||||
Guided ideation session using game-specific brainstorming techniques:
|
Guided ideation session using game-specific brainstorming techniques:
|
||||||
|
|
||||||
- **MDA Framework** - Mechanics → Dynamics → Aesthetics analysis
|
- **MDA Framework** — Mechanics → Dynamics → Aesthetics analysis
|
||||||
- **Core Loop Workshop** - Define the fundamental gameplay loop
|
- **Core Loop Workshop** — Define the fundamental gameplay loop
|
||||||
- **Player Fantasy Mining** - Explore what players want to feel
|
- **Player Fantasy Mining** — Explore what players want to feel
|
||||||
- **Genre Mashup** - Combine genres for unique concepts
|
- **Genre Mashup** — Combine genres for unique concepts
|
||||||
|
|
||||||
**Steps:**
|
**Steps:**
|
||||||
|
|
||||||
1. Initialize brainstorm session
|
1. Initialize brainstorm session
|
||||||
2. Load game-specific techniques
|
2. Load game-specific techniques
|
||||||
3. Execute ideation with selected techniques
|
3. Execute ideation with selected techniques
|
||||||
4. Summarize and (optionally) hand off to Game Brief
|
4. Summarize and (optionally) hand off to Game Brief
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Game Brief
|
### Game Brief
|
||||||
|
|
||||||
**Command:** `create-game-brief`
|
**Command:** `create-game-brief`
|
||||||
|
|
@ -48,11 +39,9 @@ Guided ideation session using game-specific brainstorming techniques:
|
||||||
**Input:** Ideas from brainstorming (optional)
|
**Input:** Ideas from brainstorming (optional)
|
||||||
**Output:** `{output_folder}/game-brief.md`
|
**Output:** `{output_folder}/game-brief.md`
|
||||||
|
|
||||||
**Description:**
|
Captures your game's core vision and fundamentals. Foundation for all subsequent design work.
|
||||||
Captures your game's core vision and fundamentals. This is the foundation for all subsequent design work.
|
|
||||||
|
|
||||||
**Sections covered:**
|
**Sections covered:**
|
||||||
|
|
||||||
- Game concept and vision
|
- Game concept and vision
|
||||||
- Design pillars (3-5 core principles)
|
- Design pillars (3-5 core principles)
|
||||||
- Target audience and market
|
- Target audience and market
|
||||||
|
|
@ -60,8 +49,6 @@ Captures your game's core vision and fundamentals. This is the foundation for al
|
||||||
- Core gameplay loop
|
- Core gameplay loop
|
||||||
- Initial scope definition
|
- Initial scope definition
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 2: Design
|
## Phase 2: Design
|
||||||
|
|
||||||
### GDD (Game Design Document)
|
### GDD (Game Design Document)
|
||||||
|
|
@ -71,11 +58,9 @@ Captures your game's core vision and fundamentals. This is the foundation for al
|
||||||
**Input:** Game Brief
|
**Input:** Game Brief
|
||||||
**Output:** `{output_folder}/gdd.md` (or sharded into `{output_folder}/gdd/`)
|
**Output:** `{output_folder}/gdd.md` (or sharded into `{output_folder}/gdd/`)
|
||||||
|
|
||||||
**Description:**
|
|
||||||
Comprehensive game design document with genre-specific sections based on 24 supported game types.
|
Comprehensive game design document with genre-specific sections based on 24 supported game types.
|
||||||
|
|
||||||
**Core sections:**
|
**Core sections:**
|
||||||
|
|
||||||
1. Executive Summary
|
1. Executive Summary
|
||||||
2. Gameplay Systems
|
2. Gameplay Systems
|
||||||
3. Core Mechanics
|
3. Core Mechanics
|
||||||
|
|
@ -88,14 +73,11 @@ Comprehensive game design document with genre-specific sections based on 24 supp
|
||||||
10. Epic Generation (for sprint planning)
|
10. Epic Generation (for sprint planning)
|
||||||
|
|
||||||
**Features:**
|
**Features:**
|
||||||
|
|
||||||
- Game type selection with specialized sections
|
- Game type selection with specialized sections
|
||||||
- Hybrid game type support
|
- Hybrid game type support
|
||||||
- Automatic epic generation
|
- Automatic epic generation
|
||||||
- Scale-adaptive complexity
|
- Scale-adaptive complexity
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Narrative Design
|
### Narrative Design
|
||||||
|
|
||||||
**Command:** `narrative`
|
**Command:** `narrative`
|
||||||
|
|
@ -103,11 +85,9 @@ Comprehensive game design document with genre-specific sections based on 24 supp
|
||||||
**Input:** GDD (required), Game Brief (optional)
|
**Input:** GDD (required), Game Brief (optional)
|
||||||
**Output:** `{output_folder}/narrative-design.md`
|
**Output:** `{output_folder}/narrative-design.md`
|
||||||
|
|
||||||
**Description:**
|
|
||||||
For story-driven games. Creates comprehensive narrative documentation.
|
For story-driven games. Creates comprehensive narrative documentation.
|
||||||
|
|
||||||
**Sections covered:**
|
**Sections covered:**
|
||||||
|
|
||||||
1. Story Foundation (premise, themes, tone)
|
1. Story Foundation (premise, themes, tone)
|
||||||
2. Story Structure (acts, beats, pacing)
|
2. Story Structure (acts, beats, pacing)
|
||||||
3. Characters (protagonists, antagonists, supporting, arcs)
|
3. Characters (protagonists, antagonists, supporting, arcs)
|
||||||
|
|
@ -120,13 +100,10 @@ For story-driven games. Creates comprehensive narrative documentation.
|
||||||
10. Appendices (relationship map, timeline)
|
10. Appendices (relationship map, timeline)
|
||||||
|
|
||||||
**Narrative Complexity Levels:**
|
**Narrative Complexity Levels:**
|
||||||
|
- **Critical** — Story IS the game (visual novels, adventure games)
|
||||||
- **Critical** - Story IS the game (visual novels, adventure games)
|
- **Heavy** — Deep narrative with gameplay (RPGs, story-driven action)
|
||||||
- **Heavy** - Deep narrative with gameplay (RPGs, story-driven action)
|
- **Moderate** — Meaningful story supporting gameplay
|
||||||
- **Moderate** - Meaningful story supporting gameplay
|
- **Light** — Minimal story, gameplay-focused
|
||||||
- **Light** - Minimal story, gameplay-focused
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 3: Technical
|
## Phase 3: Technical
|
||||||
|
|
||||||
|
|
@ -137,11 +114,9 @@ For story-driven games. Creates comprehensive narrative documentation.
|
||||||
**Input:** GDD, Narrative Design (optional)
|
**Input:** GDD, Narrative Design (optional)
|
||||||
**Output:** `{output_folder}/game-architecture.md`
|
**Output:** `{output_folder}/game-architecture.md`
|
||||||
|
|
||||||
**Description:**
|
|
||||||
Technical architecture document covering engine selection, system design, and implementation approach.
|
Technical architecture document covering engine selection, system design, and implementation approach.
|
||||||
|
|
||||||
**Sections covered:**
|
**Sections covered:**
|
||||||
|
|
||||||
1. Executive Summary
|
1. Executive Summary
|
||||||
2. Engine/Framework Selection
|
2. Engine/Framework Selection
|
||||||
3. Core Systems Architecture
|
3. Core Systems Architecture
|
||||||
|
|
@ -153,8 +128,6 @@ Technical architecture document covering engine selection, system design, and im
|
||||||
9. Build and Deployment
|
9. Build and Deployment
|
||||||
10. Technical Risks and Mitigations
|
10. Technical Risks and Mitigations
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 4: Production
|
## Phase 4: Production
|
||||||
|
|
||||||
Production workflows inherit from BMM and add game-specific overrides.
|
Production workflows inherit from BMM and add game-specific overrides.
|
||||||
|
|
@ -166,11 +139,8 @@ Production workflows inherit from BMM and add game-specific overrides.
|
||||||
**Input:** GDD with epics
|
**Input:** GDD with epics
|
||||||
**Output:** `{implementation_artifacts}/sprint-status.yaml`
|
**Output:** `{implementation_artifacts}/sprint-status.yaml`
|
||||||
|
|
||||||
**Description:**
|
|
||||||
Generates or updates sprint tracking from epic files. Sets up the sprint backlog and tracking.
|
Generates or updates sprint tracking from epic files. Sets up the sprint backlog and tracking.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Sprint Status
|
### Sprint Status
|
||||||
|
|
||||||
**Command:** `sprint-status`
|
**Command:** `sprint-status`
|
||||||
|
|
@ -178,14 +148,12 @@ Generates or updates sprint tracking from epic files. Sets up the sprint backlog
|
||||||
**Input:** `sprint-status.yaml`
|
**Input:** `sprint-status.yaml`
|
||||||
**Output:** Sprint summary, risks, next action recommendation
|
**Output:** Sprint summary, risks, next action recommendation
|
||||||
|
|
||||||
**Description:**
|
Summarizes sprint progress, surfaces risks (stale file, orphaned stories, stories in review), and recommends the next workflow to run.
|
||||||
Summarizes sprint progress, surfaces risks (stale file, orphaned stories, stories in review), and recommends the next workflow to run. Supports three modes:
|
|
||||||
|
|
||||||
- **interactive** (default): Displays summary with menu options
|
**Modes:**
|
||||||
- **validate**: Checks sprint-status.yaml structure
|
- **interactive** (default) — Displays summary with menu options
|
||||||
- **data**: Returns raw data for other workflows
|
- **validate** — Checks sprint-status.yaml structure
|
||||||
|
- **data** — Returns raw data for other workflows
|
||||||
---
|
|
||||||
|
|
||||||
### Create Story
|
### Create Story
|
||||||
|
|
||||||
|
|
@ -194,13 +162,10 @@ Summarizes sprint progress, surfaces risks (stale file, orphaned stories, storie
|
||||||
**Input:** GDD, Architecture, Epic context
|
**Input:** GDD, Architecture, Epic context
|
||||||
**Output:** `{output_folder}/epics/{epic-name}/stories/{story-name}.md`
|
**Output:** `{output_folder}/epics/{epic-name}/stories/{story-name}.md`
|
||||||
|
|
||||||
**Description:**
|
|
||||||
Creates implementable story drafts with acceptance criteria, tasks, and technical notes. Stories are marked ready-for-dev directly when created.
|
Creates implementable story drafts with acceptance criteria, tasks, and technical notes. Stories are marked ready-for-dev directly when created.
|
||||||
|
|
||||||
**Validation:** `validate-create-story`
|
**Validation:** `validate-create-story`
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Dev Story
|
### Dev Story
|
||||||
|
|
||||||
**Command:** `dev-story`
|
**Command:** `dev-story`
|
||||||
|
|
@ -208,11 +173,8 @@ Creates implementable story drafts with acceptance criteria, tasks, and technica
|
||||||
**Input:** Story (ready for dev)
|
**Input:** Story (ready for dev)
|
||||||
**Output:** Implemented code
|
**Output:** Implemented code
|
||||||
|
|
||||||
**Description:**
|
|
||||||
Implements story tasks following acceptance criteria. Uses TDD approach (red-green-refactor). Updates sprint-status.yaml automatically on completion.
|
Implements story tasks following acceptance criteria. Uses TDD approach (red-green-refactor). Updates sprint-status.yaml automatically on completion.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Code Review
|
### Code Review
|
||||||
|
|
||||||
**Command:** `code-review`
|
**Command:** `code-review`
|
||||||
|
|
@ -220,11 +182,8 @@ Implements story tasks following acceptance criteria. Uses TDD approach (red-gre
|
||||||
**Input:** Story (ready for review)
|
**Input:** Story (ready for review)
|
||||||
**Output:** Review feedback, approved/needs changes
|
**Output:** Review feedback, approved/needs changes
|
||||||
|
|
||||||
**Description:**
|
|
||||||
Thorough QA code review with game-specific considerations (performance, 60fps, etc.).
|
Thorough QA code review with game-specific considerations (performance, 60fps, etc.).
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Retrospective
|
### Retrospective
|
||||||
|
|
||||||
**Command:** `epic-retrospective`
|
**Command:** `epic-retrospective`
|
||||||
|
|
@ -232,11 +191,8 @@ Thorough QA code review with game-specific considerations (performance, 60fps, e
|
||||||
**Input:** Completed epic
|
**Input:** Completed epic
|
||||||
**Output:** Retrospective document
|
**Output:** Retrospective document
|
||||||
|
|
||||||
**Description:**
|
|
||||||
Facilitates team retrospective after epic completion. Captures learnings and improvements.
|
Facilitates team retrospective after epic completion. Captures learnings and improvements.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Correct Course
|
### Correct Course
|
||||||
|
|
||||||
**Command:** `correct-course`
|
**Command:** `correct-course`
|
||||||
|
|
@ -244,25 +200,18 @@ Facilitates team retrospective after epic completion. Captures learnings and imp
|
||||||
**Input:** Current project state
|
**Input:** Current project state
|
||||||
**Output:** Correction plan
|
**Output:** Correction plan
|
||||||
|
|
||||||
**Description:**
|
|
||||||
Navigates significant changes when implementation is off-track. Analyzes impact and recommends adjustments.
|
Navigates significant changes when implementation is off-track. Analyzes impact and recommends adjustments.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Workflow Status
|
## Workflow Status
|
||||||
|
|
||||||
**Command:** `workflow-status`
|
**Command:** `workflow-status`
|
||||||
**Agent:** All agents
|
**Agent:** All agents
|
||||||
**Output:** Project status summary
|
|
||||||
|
|
||||||
**Description:**
|
|
||||||
Checks current project status across all phases. Shows completed documents, current phase, and next steps.
|
Checks current project status across all phases. Shows completed documents, current phase, and next steps.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Quick-Flow Workflows
|
## Quick-Flow Workflows
|
||||||
|
|
||||||
Fast-track workflows that skip full planning phases. See **[Quick-Flow Guide](/docs/how-to/workflows/bmgd-quick-flow.md)** for detailed usage.
|
Fast-track workflows that skip full planning phases. See [Quick-Flow Guide](/docs/how-to/workflows/bmgd-quick-flow.md) for detailed usage.
|
||||||
|
|
||||||
### Quick-Prototype
|
### Quick-Prototype
|
||||||
|
|
||||||
|
|
@ -271,17 +220,13 @@ Fast-track workflows that skip full planning phases. See **[Quick-Flow Guide](/d
|
||||||
**Input:** Idea or concept to test
|
**Input:** Idea or concept to test
|
||||||
**Output:** Working prototype, playtest results
|
**Output:** Working prototype, playtest results
|
||||||
|
|
||||||
**Description:**
|
|
||||||
Rapid prototyping workflow for testing game mechanics and ideas quickly. Focuses on "feel" over polish.
|
Rapid prototyping workflow for testing game mechanics and ideas quickly. Focuses on "feel" over polish.
|
||||||
|
|
||||||
**Use when:**
|
**Use when:**
|
||||||
|
|
||||||
- Testing if a mechanic is fun
|
- Testing if a mechanic is fun
|
||||||
- Proving a concept before committing to design
|
- Proving a concept before committing to design
|
||||||
- Experimenting with gameplay ideas
|
- Experimenting with gameplay ideas
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Quick-Dev
|
### Quick-Dev
|
||||||
|
|
||||||
**Command:** `quick-dev`
|
**Command:** `quick-dev`
|
||||||
|
|
@ -289,17 +234,13 @@ Rapid prototyping workflow for testing game mechanics and ideas quickly. Focuses
|
||||||
**Input:** Tech-spec, prototype, or direct instructions
|
**Input:** Tech-spec, prototype, or direct instructions
|
||||||
**Output:** Implemented feature
|
**Output:** Implemented feature
|
||||||
|
|
||||||
**Description:**
|
|
||||||
Flexible development workflow with game-specific considerations (performance, feel, integration).
|
Flexible development workflow with game-specific considerations (performance, feel, integration).
|
||||||
|
|
||||||
**Use when:**
|
**Use when:**
|
||||||
|
|
||||||
- Implementing features from tech-specs
|
- Implementing features from tech-specs
|
||||||
- Building on successful prototypes
|
- Building on successful prototypes
|
||||||
- Making changes that don't need full story workflow
|
- Making changes that don't need full story workflow
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Quality Assurance Workflows
|
## Quality Assurance Workflows
|
||||||
|
|
||||||
Game testing workflows for automated testing, playtesting, and quality assurance across Unity, Unreal, and Godot.
|
Game testing workflows for automated testing, playtesting, and quality assurance across Unity, Unreal, and Godot.
|
||||||
|
|
@ -311,22 +252,18 @@ Game testing workflows for automated testing, playtesting, and quality assurance
|
||||||
**Input:** Game project
|
**Input:** Game project
|
||||||
**Output:** Configured test framework
|
**Output:** Configured test framework
|
||||||
|
|
||||||
**Description:**
|
|
||||||
Initialize a production-ready test framework for your game engine:
|
Initialize a production-ready test framework for your game engine:
|
||||||
|
|
||||||
- **Unity**: Unity Test Framework with Edit Mode and Play Mode tests
|
- **Unity** — Unity Test Framework with Edit Mode and Play Mode tests
|
||||||
- **Unreal**: Unreal Automation system with functional tests
|
- **Unreal** — Unreal Automation system with functional tests
|
||||||
- **Godot**: GUT (Godot Unit Test) framework
|
- **Godot** — GUT (Godot Unit Test) framework
|
||||||
|
|
||||||
**Creates:**
|
**Creates:**
|
||||||
|
|
||||||
- Test directory structure
|
- Test directory structure
|
||||||
- Framework configuration
|
- Framework configuration
|
||||||
- Sample unit and integration tests
|
- Sample unit and integration tests
|
||||||
- Test documentation
|
- Test documentation
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Test Design
|
### Test Design
|
||||||
|
|
||||||
**Command:** `test-design`
|
**Command:** `test-design`
|
||||||
|
|
@ -334,7 +271,6 @@ Initialize a production-ready test framework for your game engine:
|
||||||
**Input:** GDD, Architecture
|
**Input:** GDD, Architecture
|
||||||
**Output:** `{output_folder}/game-test-design.md`
|
**Output:** `{output_folder}/game-test-design.md`
|
||||||
|
|
||||||
**Description:**
|
|
||||||
Creates comprehensive test scenarios covering:
|
Creates comprehensive test scenarios covering:
|
||||||
|
|
||||||
- Core gameplay mechanics
|
- Core gameplay mechanics
|
||||||
|
|
@ -344,8 +280,6 @@ Creates comprehensive test scenarios covering:
|
||||||
|
|
||||||
Uses GIVEN/WHEN/THEN format with priority levels (P0-P3).
|
Uses GIVEN/WHEN/THEN format with priority levels (P0-P3).
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Automate
|
### Automate
|
||||||
|
|
||||||
**Command:** `automate`
|
**Command:** `automate`
|
||||||
|
|
@ -353,15 +287,12 @@ Uses GIVEN/WHEN/THEN format with priority levels (P0-P3).
|
||||||
**Input:** Test design, game code
|
**Input:** Test design, game code
|
||||||
**Output:** Automated test files
|
**Output:** Automated test files
|
||||||
|
|
||||||
**Description:**
|
|
||||||
Generates engine-appropriate automated tests:
|
Generates engine-appropriate automated tests:
|
||||||
|
|
||||||
- Unit tests for pure logic
|
- Unit tests for pure logic
|
||||||
- Integration tests for system interactions
|
- Integration tests for system interactions
|
||||||
- Smoke tests for critical path validation
|
- Smoke tests for critical path validation
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Playtest Plan
|
### Playtest Plan
|
||||||
|
|
||||||
**Command:** `playtest-plan`
|
**Command:** `playtest-plan`
|
||||||
|
|
@ -369,7 +300,6 @@ Generates engine-appropriate automated tests:
|
||||||
**Input:** Build, test objectives
|
**Input:** Build, test objectives
|
||||||
**Output:** `{output_folder}/playtest-plan.md`
|
**Output:** `{output_folder}/playtest-plan.md`
|
||||||
|
|
||||||
**Description:**
|
|
||||||
Creates structured playtesting sessions:
|
Creates structured playtesting sessions:
|
||||||
|
|
||||||
- Session structure (pre/during/post)
|
- Session structure (pre/during/post)
|
||||||
|
|
@ -378,12 +308,9 @@ Creates structured playtesting sessions:
|
||||||
- Analysis templates
|
- Analysis templates
|
||||||
|
|
||||||
**Playtest Types:**
|
**Playtest Types:**
|
||||||
|
- **Internal** — Team validation
|
||||||
- Internal (team validation)
|
- **External** — Unbiased feedback
|
||||||
- External (unbiased feedback)
|
- **Focused** — Specific feature testing
|
||||||
- Focused (specific feature testing)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Performance Test
|
### Performance Test
|
||||||
|
|
||||||
|
|
@ -392,7 +319,6 @@ Creates structured playtesting sessions:
|
||||||
**Input:** Platform targets
|
**Input:** Platform targets
|
||||||
**Output:** `{output_folder}/performance-test-plan.md`
|
**Output:** `{output_folder}/performance-test-plan.md`
|
||||||
|
|
||||||
**Description:**
|
|
||||||
Designs performance testing strategy:
|
Designs performance testing strategy:
|
||||||
|
|
||||||
- Frame rate targets per platform
|
- Frame rate targets per platform
|
||||||
|
|
@ -401,8 +327,6 @@ Designs performance testing strategy:
|
||||||
- Benchmark scenarios
|
- Benchmark scenarios
|
||||||
- Profiling methodology
|
- Profiling methodology
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Test Review
|
### Test Review
|
||||||
|
|
||||||
**Command:** `test-review`
|
**Command:** `test-review`
|
||||||
|
|
@ -410,7 +334,6 @@ Designs performance testing strategy:
|
||||||
**Input:** Existing test suite
|
**Input:** Existing test suite
|
||||||
**Output:** `{output_folder}/test-review-report.md`
|
**Output:** `{output_folder}/test-review-report.md`
|
||||||
|
|
||||||
**Description:**
|
|
||||||
Reviews test quality and coverage:
|
Reviews test quality and coverage:
|
||||||
|
|
||||||
- Test suite metrics
|
- Test suite metrics
|
||||||
|
|
@ -418,8 +341,6 @@ Reviews test quality and coverage:
|
||||||
- Coverage gaps
|
- Coverage gaps
|
||||||
- Recommendations
|
- Recommendations
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Utility Workflows
|
## Utility Workflows
|
||||||
|
|
||||||
### Party Mode
|
### Party Mode
|
||||||
|
|
@ -427,40 +348,21 @@ Reviews test quality and coverage:
|
||||||
**Command:** `party-mode`
|
**Command:** `party-mode`
|
||||||
**Agent:** All agents
|
**Agent:** All agents
|
||||||
|
|
||||||
**Description:**
|
|
||||||
Brings multiple agents together for collaborative discussion on complex decisions.
|
Brings multiple agents together for collaborative discussion on complex decisions.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Advanced Elicitation
|
### Advanced Elicitation
|
||||||
|
|
||||||
**Command:** `advanced-elicitation`
|
**Command:** `advanced-elicitation`
|
||||||
**Agent:** All agents (web only)
|
**Agent:** All agents (web only)
|
||||||
|
|
||||||
**Description:**
|
|
||||||
Deep exploration techniques to challenge assumptions and surface hidden requirements.
|
Deep exploration techniques to challenge assumptions and surface hidden requirements.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Standalone BMGD Workflows
|
## Standalone BMGD Workflows
|
||||||
|
|
||||||
BMGD Phase 4 workflows are standalone implementations tailored for game development:
|
:::note[Implementation Detail]
|
||||||
|
BMGD Phase 4 workflows are standalone implementations tailored for game development. They are self-contained with game-specific logic, templates, and checklists — no dependency on BMM workflow files.
|
||||||
|
:::
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
workflow: '{project-root}/_bmad/bmgd/workflows/4-production/dev-story/workflow.yaml'
|
workflow: '{project-root}/_bmad/bmgd/workflows/4-production/dev-story/workflow.yaml'
|
||||||
```
|
```
|
||||||
|
|
||||||
This means:
|
|
||||||
|
|
||||||
1. BMGD workflows are self-contained with game-specific logic
|
|
||||||
2. Game-focused templates, checklists, and instructions
|
|
||||||
3. No dependency on BMM workflow files
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Next Steps
|
|
||||||
|
|
||||||
- **[Quick Start Guide](/docs/tutorials/getting-started/quick-start-bmgd.md)** - Get started with BMGD
|
|
||||||
- **[Quick-Flow Guide](/docs/how-to/workflows/bmgd-quick-flow.md)** - Rapid prototyping and development
|
|
||||||
- **[Agents Guide](/docs/explanation/game-dev/agents.md)** - Agent reference
|
|
||||||
- **[Game Types Guide](/docs/explanation/game-dev/game-types.md)** - Game type templates
|
|
||||||
|
|
|
||||||
|
|
@ -2,32 +2,31 @@
|
||||||
title: "Core Workflows"
|
title: "Core Workflows"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
Domain-agnostic workflows that can be utilized by any BMad-compliant module, workflow, or agent.
|
||||||
|
|
||||||
Core Workflows are domain-agnostic workflows that can be utilized by any BMad-compliant module, workflow, or agent. These workflows are installed by default and available at any time.
|
## Party Mode
|
||||||
|
|
||||||
## Available Core Workflows
|
Orchestrate dynamic multi-agent conversations with your entire BMad team. Engage multiple specialized perspectives simultaneously — each agent maintains their unique personality, expertise, and communication style.
|
||||||
|
|
||||||
### [Party Mode](/docs/explanation/features/party-mode.md)
|
See [Party Mode](/docs/explanation/features/party-mode.md) for detailed usage.
|
||||||
|
|
||||||
Orchestrate dynamic multi-agent conversations with your entire BMad team. Engage with multiple specialized perspectives simultaneously—each agent maintaining their unique personality, expertise, and communication style.
|
## Brainstorming
|
||||||
|
|
||||||
### [Brainstorming](/docs/explanation/features/brainstorming-techniques.md)
|
Facilitate structured creative sessions using 60+ proven ideation techniques. The AI acts as coach and guide, using proven creativity methods to draw out ideas and insights.
|
||||||
|
|
||||||
Facilitate structured creative sessions using 60+ proven ideation techniques. The AI acts as coach and guide, using proven creativity methods to draw out ideas and insights that are already within you.
|
See [Brainstorming Techniques](/docs/explanation/features/brainstorming-techniques.md) for detailed usage.
|
||||||
|
|
||||||
### [Advanced Elicitation](/docs/explanation/features/advanced-elicitation.md)
|
## Advanced Elicitation
|
||||||
|
|
||||||
Push the LLM to rethink its work through 50+ reasoning methods—the inverse of brainstorming. The LLM applies sophisticated techniques to re-examine and enhance content it has just generated, essentially "LLM brainstorming" to find better approaches and uncover improvements.
|
Push the LLM to rethink its work through 50+ reasoning methods — the inverse of brainstorming. The LLM applies sophisticated techniques to re-examine and enhance content it has just generated.
|
||||||
|
|
||||||
---
|
See [Advanced Elicitation](/docs/explanation/features/advanced-elicitation.md) for detailed usage.
|
||||||
|
|
||||||
## Workflow Integration
|
## Workflow Integration
|
||||||
|
|
||||||
Core Workflows are designed to be invoked and configured by other modules. When called from another workflow, they accept contextual parameters to customize the session:
|
Core Workflows accept contextual parameters when called from other modules:
|
||||||
|
|
||||||
- **Topic focus** — Direct the session toward a specific domain or question
|
- **Topic focus** — Direct the session toward a specific domain or question
|
||||||
- **Additional personas** (Party Mode) — Inject expert agents into the roster at runtime
|
- **Additional personas** (Party Mode) — Inject expert agents into the roster at runtime
|
||||||
- **Guardrails** (Brainstorming) — Set constraints and boundaries for ideation
|
- **Guardrails** (Brainstorming) — Set constraints and boundaries for ideation
|
||||||
- **Output goals** — Define what the final output needs to accomplish
|
- **Output goals** — Define what the final output needs to accomplish
|
||||||
|
|
||||||
This allows modules to leverage these workflows' capabilities while maintaining focus on their specific domain and objectives.
|
|
||||||
|
|
|
||||||
|
|
@ -1,74 +1,73 @@
|
||||||
---
|
---
|
||||||
title: "Document Project Workflow - Technical Reference"
|
title: "Document Project Workflow"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
Analyzes and documents brownfield projects for AI-assisted development.
|
||||||
|
|
||||||
**Module:** BMM (BMad Method Module)
|
:::note[Quick Facts]
|
||||||
|
- **Module:** BMM (BMad Method Module)
|
||||||
|
- **Command:** `*document-project`
|
||||||
|
- **Agents:** Analyst, Technical Writer
|
||||||
|
- **Output:** Master index + documentation files in `{output_folder}`
|
||||||
|
:::
|
||||||
|
|
||||||
## Purpose
|
## Purpose
|
||||||
|
|
||||||
Analyzes and documents brownfield projects by scanning codebase, architecture, and patterns to create comprehensive reference documentation for AI-assisted development. Generates a master index and multiple documentation files tailored to project structure and type.
|
Scans your codebase, architecture, and patterns to create comprehensive reference documentation. Generates a master index and multiple documentation files tailored to your project structure and type.
|
||||||
|
|
||||||
## How to Invoke
|
## How to Invoke
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
/bmad:bmm:workflows:document-project
|
*document-project
|
||||||
```
|
```
|
||||||
---
|
|
||||||
|
|
||||||
## Scan Levels
|
## Scan Levels
|
||||||
|
|
||||||
Choose the right scan depth for your needs:
|
Choose the right depth for your needs:
|
||||||
|
|
||||||
### 1. Quick Scan (Default)
|
### Quick Scan (Default)
|
||||||
|
|
||||||
**What it does:** Pattern-based analysis without reading source files
|
**What it does:** Pattern-based analysis without reading source files
|
||||||
**Reads:** Config files, package manifests, directory structure, README
|
|
||||||
**Use when:**
|
|
||||||
|
|
||||||
|
**Reads:** Config files, package manifests, directory structure, README
|
||||||
|
|
||||||
|
**Use when:**
|
||||||
- You need a fast project overview
|
- You need a fast project overview
|
||||||
- Initial understanding of project structure
|
- Initial understanding of project structure
|
||||||
- Planning next steps before deeper analysis
|
- Planning next steps before deeper analysis
|
||||||
|
|
||||||
**Does NOT read:** Source code files (`_.js`, `_.ts`, `_.py`, `_.go`, etc.)
|
### Deep Scan
|
||||||
|
|
||||||
### 2. Deep Scan
|
|
||||||
|
|
||||||
**What it does:** Reads files in critical directories based on project type
|
**What it does:** Reads files in critical directories based on project type
|
||||||
**Reads:** Files in critical paths defined by documentation requirements
|
|
||||||
**Use when:**
|
|
||||||
|
|
||||||
|
**Reads:** Files in critical paths defined by documentation requirements
|
||||||
|
|
||||||
|
**Use when:**
|
||||||
- Creating comprehensive documentation for brownfield PRD
|
- Creating comprehensive documentation for brownfield PRD
|
||||||
- Need detailed analysis of key areas
|
- Need detailed analysis of key areas
|
||||||
- Want balance between depth and speed
|
- Want balance between depth and speed
|
||||||
|
|
||||||
**Example:** For a web app, reads controllers/, models/, components/, but not every utility file
|
### Exhaustive Scan
|
||||||
|
|
||||||
### 3. Exhaustive Scan
|
|
||||||
|
|
||||||
**What it does:** Reads ALL source files in project
|
**What it does:** Reads ALL source files in project
|
||||||
**Reads:** Every source file (excludes node_modules, dist, build, .git)
|
|
||||||
**Use when:**
|
|
||||||
|
|
||||||
|
**Reads:** Every source file (excludes node_modules, dist, build, .git)
|
||||||
|
|
||||||
|
**Use when:**
|
||||||
- Complete project analysis needed
|
- Complete project analysis needed
|
||||||
- Migration planning requires full understanding
|
- Migration planning requires full understanding
|
||||||
- Detailed audit of entire codebase
|
- Detailed audit of entire codebase
|
||||||
- Deep technical debt assessment
|
|
||||||
|
|
||||||
**Note:** Deep-dive mode ALWAYS uses exhaustive scan (no choice)
|
:::caution[Deep-Dive Mode]
|
||||||
|
Deep-dive mode always uses exhaustive scan — no choice of scan level.
|
||||||
---
|
:::
|
||||||
|
|
||||||
## Resumability
|
## Resumability
|
||||||
|
|
||||||
The workflow can be interrupted and resumed without losing progress:
|
The workflow can be interrupted and resumed without losing progress:
|
||||||
|
|
||||||
- **State Tracking:** Progress saved in `project-scan-report.json`
|
- **State Tracking** — Progress saved in `project-scan-report.json`
|
||||||
- **Auto-Detection:** Workflow detects incomplete runs (<24 hours old)
|
- **Auto-Detection** — Workflow detects incomplete runs (<24 hours old)
|
||||||
- **Resume Prompt:** Choose to resume or start fresh
|
- **Resume Prompt** — Choose to resume or start fresh
|
||||||
- **Step-by-Step:** Resume from exact step where interrupted
|
- **Step-by-Step** — Resume from exact step where interrupted
|
||||||
- **Archiving:** Old state files automatically archived
|
- **Archiving** — Old state files automatically archived
|
||||||
|
|
||||||
**Related Documentation:**
|
|
||||||
|
|
||||||
- [Brownfield Development Guide](/docs/how-to/brownfield/index.md)
|
|
||||||
- [Implementation Workflows](/docs/how-to/workflows/run-sprint-planning.md)
|
|
||||||
|
|
|
||||||
|
|
@ -3,14 +3,13 @@ title: "Workflows Reference"
|
||||||
description: Reference documentation for BMad Method workflows
|
description: Reference documentation for BMad Method workflows
|
||||||
---
|
---
|
||||||
|
|
||||||
|
Reference documentation for all BMad Method workflows.
|
||||||
Complete reference documentation for all BMad Method workflows.
|
|
||||||
|
|
||||||
## Core Workflows
|
## Core Workflows
|
||||||
|
|
||||||
- [Core Workflows](/docs/reference/workflows/core-workflows.md) - Domain-agnostic workflows available to all modules
|
- [Core Workflows](/docs/reference/workflows/core-workflows.md) — Domain-agnostic workflows available to all modules
|
||||||
- [Document Project](/docs/reference/workflows/document-project.md) - Brownfield project documentation workflow
|
- [Document Project](/docs/reference/workflows/document-project.md) — Brownfield project documentation
|
||||||
|
|
||||||
## Module-Specific Workflows
|
## Module-Specific Workflows
|
||||||
|
|
||||||
- [BMGD Workflows](/docs/reference/workflows/bmgd-workflows.md) - Game development workflows
|
- [BMGD Workflows](/docs/reference/workflows/bmgd-workflows.md) — Game development workflows
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,231 @@
|
||||||
|
---
|
||||||
|
description: Plan and implement UI
|
||||||
|
auto_execution_mode: 3
|
||||||
|
---
|
||||||
|
|
||||||
|
# UI/UX Pro Max - Design Intelligence
|
||||||
|
|
||||||
|
Searchable database of UI styles, color palettes, font pairings, chart types, product recommendations, UX guidelines, and stack-specific best practices.
|
||||||
|
|
||||||
|
## Prerequisites
|
||||||
|
|
||||||
|
Check if Python is installed:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python3 --version || python --version
|
||||||
|
```
|
||||||
|
|
||||||
|
If Python is not installed, install it based on user's OS:
|
||||||
|
|
||||||
|
**macOS:**
|
||||||
|
```bash
|
||||||
|
brew install python3
|
||||||
|
```
|
||||||
|
|
||||||
|
**Ubuntu/Debian:**
|
||||||
|
```bash
|
||||||
|
sudo apt update && sudo apt install python3
|
||||||
|
```
|
||||||
|
|
||||||
|
**Windows:**
|
||||||
|
```powershell
|
||||||
|
winget install Python.Python.3.12
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## How to Use This Workflow
|
||||||
|
|
||||||
|
When user requests UI/UX work (design, build, create, implement, review, fix, improve), follow this workflow:
|
||||||
|
|
||||||
|
### Step 1: Analyze User Requirements
|
||||||
|
|
||||||
|
Extract key information from user request:
|
||||||
|
- **Product type**: SaaS, e-commerce, portfolio, dashboard, landing page, etc.
|
||||||
|
- **Style keywords**: minimal, playful, professional, elegant, dark mode, etc.
|
||||||
|
- **Industry**: healthcare, fintech, gaming, education, etc.
|
||||||
|
- **Stack**: React, Vue, Next.js, or default to `html-tailwind`
|
||||||
|
|
||||||
|
### Step 2: Search Relevant Domains
|
||||||
|
|
||||||
|
Use `search.py` multiple times to gather comprehensive information. Search until you have enough context.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python3 .shared/ui-ux-pro-max/scripts/search.py "<keyword>" --domain <domain> [-n <max_results>]
|
||||||
|
```
|
||||||
|
|
||||||
|
**Recommended search order:**
|
||||||
|
|
||||||
|
1. **Product** - Get style recommendations for product type
|
||||||
|
2. **Style** - Get detailed style guide (colors, effects, frameworks)
|
||||||
|
3. **Typography** - Get font pairings with Google Fonts imports
|
||||||
|
4. **Color** - Get color palette (Primary, Secondary, CTA, Background, Text, Border)
|
||||||
|
5. **Landing** - Get page structure (if landing page)
|
||||||
|
6. **Chart** - Get chart recommendations (if dashboard/analytics)
|
||||||
|
7. **UX** - Get best practices and anti-patterns
|
||||||
|
8. **Stack** - Get stack-specific guidelines (default: html-tailwind)
|
||||||
|
|
||||||
|
### Step 3: Stack Guidelines (Default: html-tailwind)
|
||||||
|
|
||||||
|
If user doesn't specify a stack, **default to `html-tailwind`**.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python3 .shared/ui-ux-pro-max/scripts/search.py "<keyword>" --stack html-tailwind
|
||||||
|
```
|
||||||
|
|
||||||
|
Available stacks: `html-tailwind`, `react`, `nextjs`, `vue`, `svelte`, `swiftui`, `react-native`, `flutter`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Search Reference
|
||||||
|
|
||||||
|
### Available Domains
|
||||||
|
|
||||||
|
| Domain | Use For | Example Keywords |
|
||||||
|
|--------|---------|------------------|
|
||||||
|
| `product` | Product type recommendations | SaaS, e-commerce, portfolio, healthcare, beauty, service |
|
||||||
|
| `style` | UI styles, colors, effects | glassmorphism, minimalism, dark mode, brutalism |
|
||||||
|
| `typography` | Font pairings, Google Fonts | elegant, playful, professional, modern |
|
||||||
|
| `color` | Color palettes by product type | saas, ecommerce, healthcare, beauty, fintech, service |
|
||||||
|
| `landing` | Page structure, CTA strategies | hero, hero-centric, testimonial, pricing, social-proof |
|
||||||
|
| `chart` | Chart types, library recommendations | trend, comparison, timeline, funnel, pie |
|
||||||
|
| `ux` | Best practices, anti-patterns | animation, accessibility, z-index, loading |
|
||||||
|
| `prompt` | AI prompts, CSS keywords | (style name) |
|
||||||
|
|
||||||
|
### Available Stacks
|
||||||
|
|
||||||
|
| Stack | Focus |
|
||||||
|
|-------|-------|
|
||||||
|
| `html-tailwind` | Tailwind utilities, responsive, a11y (DEFAULT) |
|
||||||
|
| `react` | State, hooks, performance, patterns |
|
||||||
|
| `nextjs` | SSR, routing, images, API routes |
|
||||||
|
| `vue` | Composition API, Pinia, Vue Router |
|
||||||
|
| `svelte` | Runes, stores, SvelteKit |
|
||||||
|
| `swiftui` | Views, State, Navigation, Animation |
|
||||||
|
| `react-native` | Components, Navigation, Lists |
|
||||||
|
| `flutter` | Widgets, State, Layout, Theming |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Example Workflow
|
||||||
|
|
||||||
|
**User request:** "Làm landing page cho dịch vụ chăm sóc da chuyên nghiệp"
|
||||||
|
|
||||||
|
**AI should:**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 1. Search product type
|
||||||
|
python3 .shared/ui-ux-pro-max/scripts/search.py "beauty spa wellness service" --domain product
|
||||||
|
|
||||||
|
# 2. Search style (based on industry: beauty, elegant)
|
||||||
|
python3 .shared/ui-ux-pro-max/scripts/search.py "elegant minimal soft" --domain style
|
||||||
|
|
||||||
|
# 3. Search typography
|
||||||
|
python3 .shared/ui-ux-pro-max/scripts/search.py "elegant luxury" --domain typography
|
||||||
|
|
||||||
|
# 4. Search color palette
|
||||||
|
python3 .shared/ui-ux-pro-max/scripts/search.py "beauty spa wellness" --domain color
|
||||||
|
|
||||||
|
# 5. Search landing page structure
|
||||||
|
python3 .shared/ui-ux-pro-max/scripts/search.py "hero-centric social-proof" --domain landing
|
||||||
|
|
||||||
|
# 6. Search UX guidelines
|
||||||
|
python3 .shared/ui-ux-pro-max/scripts/search.py "animation" --domain ux
|
||||||
|
python3 .shared/ui-ux-pro-max/scripts/search.py "accessibility" --domain ux
|
||||||
|
|
||||||
|
# 7. Search stack guidelines (default: html-tailwind)
|
||||||
|
python3 .shared/ui-ux-pro-max/scripts/search.py "layout responsive" --stack html-tailwind
|
||||||
|
```
|
||||||
|
|
||||||
|
**Then:** Synthesize all search results and implement the design.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Tips for Better Results
|
||||||
|
|
||||||
|
1. **Be specific with keywords** - "healthcare SaaS dashboard" > "app"
|
||||||
|
2. **Search multiple times** - Different keywords reveal different insights
|
||||||
|
3. **Combine domains** - Style + Typography + Color = Complete design system
|
||||||
|
4. **Always check UX** - Search "animation", "z-index", "accessibility" for common issues
|
||||||
|
5. **Use stack flag** - Get implementation-specific best practices
|
||||||
|
6. **Iterate** - If first search doesn't match, try different keywords
|
||||||
|
7. **Split Into Multiple Files** - For better maintainability:
|
||||||
|
- Separate components into individual files (e.g., `Header.tsx`, `Footer.tsx`)
|
||||||
|
- Extract reusable styles into dedicated files
|
||||||
|
- Keep each file focused and under 200-300 lines
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Common Rules for Professional UI
|
||||||
|
|
||||||
|
These are frequently overlooked issues that make UI look unprofessional:
|
||||||
|
|
||||||
|
### Icons & Visual Elements
|
||||||
|
|
||||||
|
| Rule | Do | Don't |
|
||||||
|
|------|----|----- |
|
||||||
|
| **No emoji icons** | Use SVG icons (Heroicons, Lucide, Simple Icons) | Use emojis like 🎨 🚀 ⚙️ as UI icons |
|
||||||
|
| **Stable hover states** | Use color/opacity transitions on hover | Use scale transforms that shift layout |
|
||||||
|
| **Correct brand logos** | Research official SVG from Simple Icons | Guess or use incorrect logo paths |
|
||||||
|
| **Consistent icon sizing** | Use fixed viewBox (24x24) with w-6 h-6 | Mix different icon sizes randomly |
|
||||||
|
|
||||||
|
### Interaction & Cursor
|
||||||
|
|
||||||
|
| Rule | Do | Don't |
|
||||||
|
|------|----|----- |
|
||||||
|
| **Cursor pointer** | Add `cursor-pointer` to all clickable/hoverable cards | Leave default cursor on interactive elements |
|
||||||
|
| **Hover feedback** | Provide visual feedback (color, shadow, border) | No indication element is interactive |
|
||||||
|
| **Smooth transitions** | Use `transition-colors duration-200` | Instant state changes or too slow (>500ms) |
|
||||||
|
|
||||||
|
### Light/Dark Mode Contrast
|
||||||
|
|
||||||
|
| Rule | Do | Don't |
|
||||||
|
|------|----|----- |
|
||||||
|
| **Glass card light mode** | Use `bg-white/80` or higher opacity | Use `bg-white/10` (too transparent) |
|
||||||
|
| **Text contrast light** | Use `#0F172A` (slate-900) for text | Use `#94A3B8` (slate-400) for body text |
|
||||||
|
| **Muted text light** | Use `#475569` (slate-600) minimum | Use gray-400 or lighter |
|
||||||
|
| **Border visibility** | Use `border-gray-200` in light mode | Use `border-white/10` (invisible) |
|
||||||
|
|
||||||
|
### Layout & Spacing
|
||||||
|
|
||||||
|
| Rule | Do | Don't |
|
||||||
|
|------|----|----- |
|
||||||
|
| **Floating navbar** | Add `top-4 left-4 right-4` spacing | Stick navbar to `top-0 left-0 right-0` |
|
||||||
|
| **Content padding** | Account for fixed navbar height | Let content hide behind fixed elements |
|
||||||
|
| **Consistent max-width** | Use same `max-w-6xl` or `max-w-7xl` | Mix different container widths |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Pre-Delivery Checklist
|
||||||
|
|
||||||
|
Before delivering UI code, verify these items:
|
||||||
|
|
||||||
|
### Visual Quality
|
||||||
|
- [ ] No emojis used as icons (use SVG instead)
|
||||||
|
- [ ] All icons from consistent icon set (Heroicons/Lucide)
|
||||||
|
- [ ] Brand logos are correct (verified from Simple Icons)
|
||||||
|
- [ ] Hover states don't cause layout shift
|
||||||
|
|
||||||
|
### Interaction
|
||||||
|
- [ ] All clickable elements have `cursor-pointer`
|
||||||
|
- [ ] Hover states provide clear visual feedback
|
||||||
|
- [ ] Transitions are smooth (150-300ms)
|
||||||
|
- [ ] Focus states visible for keyboard navigation
|
||||||
|
|
||||||
|
### Light/Dark Mode
|
||||||
|
- [ ] Light mode text has sufficient contrast (4.5:1 minimum)
|
||||||
|
- [ ] Glass/transparent elements visible in light mode
|
||||||
|
- [ ] Borders visible in both modes
|
||||||
|
- [ ] Test both modes before delivery
|
||||||
|
|
||||||
|
### Layout
|
||||||
|
- [ ] Floating elements have proper spacing from edges
|
||||||
|
- [ ] No content hidden behind fixed navbars
|
||||||
|
- [ ] Responsive at 320px, 768px, 1024px, 1440px
|
||||||
|
- [ ] No horizontal scroll on mobile
|
||||||
|
|
||||||
|
### Accessibility
|
||||||
|
- [ ] All images have alt text
|
||||||
|
- [ ] Form inputs have labels
|
||||||
|
- [ ] Color is not the only indicator
|
||||||
|
- [ ] `prefers-reduced-motion` respected
|
||||||
|
|
@ -0,0 +1,34 @@
|
||||||
|
# UI/UX Pro Max Knowledge Base
|
||||||
|
|
||||||
|
此資料夾包含 Design System Generator 使用的 UI/UX 知識庫。
|
||||||
|
|
||||||
|
## 路徑設定
|
||||||
|
|
||||||
|
- **預設**: `{project-root}/resources/ui-ux-pro-max`
|
||||||
|
- **可覆蓋**: 在 `_bmad/bmm/config.yaml` 設定 `kb_path`
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
# config.yaml - 使用預設路徑
|
||||||
|
kb_path: "{project-root}/resources/ui-ux-pro-max"
|
||||||
|
|
||||||
|
# config.yaml - 使用外部路徑
|
||||||
|
kb_path: "D:/Shared/ui-ux-pro-max"
|
||||||
|
```
|
||||||
|
|
||||||
|
## 用途
|
||||||
|
|
||||||
|
- 補完 UX 設計規範中缺失的 Design Tokens
|
||||||
|
- 提供 UI 元件規格建議
|
||||||
|
- 支援 `generate-design-system` workflow
|
||||||
|
|
||||||
|
## 查詢範例
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python scripts/search.py "color palette" --domain color --json
|
||||||
|
python scripts/search.py "typography" --domain typography --json
|
||||||
|
```
|
||||||
|
|
||||||
|
## 版本
|
||||||
|
|
||||||
|
- 來源:UI/UX Pro Max Knowledge Base
|
||||||
|
- 整合日期:2025-12-21
|
||||||
|
|
@ -0,0 +1,26 @@
|
||||||
|
No,Data Type,Keywords,Best Chart Type,Secondary Options,Color Guidance,Performance Impact,Accessibility Notes,Library Recommendation,Interactive Level
|
||||||
|
1,Trend Over Time,"trend, time-series, line, growth, timeline, progress",Line Chart,"Area Chart, Smooth Area",Primary: #0080FF. Multiple series: use distinct colors. Fill: 20% opacity,⚡ Excellent (optimized),✓ Clear line patterns for colorblind users. Add pattern overlays.,"Chart.js, Recharts, ApexCharts",Hover + Zoom
|
||||||
|
2,Compare Categories,"compare, categories, bar, comparison, ranking",Bar Chart (Horizontal or Vertical),"Column Chart, Grouped Bar",Each bar: distinct color. Category: grouped same color. Sorted: descending order,⚡ Excellent,✓ Easy to compare. Add value labels on bars for clarity.,"Chart.js, Recharts, D3.js",Hover + Sort
|
||||||
|
3,Part-to-Whole,"part-to-whole, pie, donut, percentage, proportion, share",Pie Chart or Donut,"Stacked Bar, Treemap",Colors: 5-6 max. Contrasting palette. Large slices first. Use labels.,⚡ Good (limit 6 slices),⚠ Hard for accessibility. Better: Stacked bar with legend. Avoid pie if >5 items.,"Chart.js, Recharts, D3.js",Hover + Drill
|
||||||
|
4,Correlation/Distribution,"correlation, distribution, scatter, relationship, pattern",Scatter Plot or Bubble Chart,"Heat Map, Matrix",Color axis: gradient (blue-red). Size: relative. Opacity: 0.6-0.8 to show density,⚠ Moderate (many points),⚠ Provide data table alternative. Use pattern + color distinction.,"D3.js, Plotly, Recharts",Hover + Brush
|
||||||
|
5,Heatmap/Intensity,"heatmap, heat-map, intensity, density, matrix",Heat Map or Choropleth,"Grid Heat Map, Bubble Heat",Gradient: Cool (blue) to Hot (red). Scale: clear legend. Divergent for ±data,⚡ Excellent (color CSS),⚠ Colorblind: Use pattern overlay. Provide numerical legend.,"D3.js, Plotly, ApexCharts",Hover + Zoom
|
||||||
|
6,Geographic Data,"geographic, map, location, region, geo, spatial","Choropleth Map, Bubble Map",Geographic Heat Map,Regional: single color gradient or categorized colors. Legend: clear scale,⚠ Moderate (rendering),⚠ Include text labels for regions. Provide data table alternative.,"D3.js, Mapbox, Leaflet",Pan + Zoom + Drill
|
||||||
|
7,Funnel/Flow,funnel/flow,"Funnel Chart, Sankey",Waterfall (for flows),Stages: gradient (starting color → ending color). Show conversion %,⚡ Good,✓ Clear stage labels + percentages. Good for accessibility if labeled.,"D3.js, Recharts, Custom SVG",Hover + Drill
|
||||||
|
8,Performance vs Target,performance-vs-target,Gauge Chart or Bullet Chart,"Dial, Thermometer",Performance: Red→Yellow→Green gradient. Target: marker line. Threshold colors,⚡ Good,✓ Add numerical value + percentage label beside gauge.,"D3.js, ApexCharts, Custom SVG",Hover
|
||||||
|
9,Time-Series Forecast,time-series-forecast,Line with Confidence Band,Ribbon Chart,Actual: solid line #0080FF. Forecast: dashed #FF9500. Band: light shading,⚡ Good,✓ Clearly distinguish actual vs forecast. Add legend.,"Chart.js, ApexCharts, Plotly",Hover + Toggle
|
||||||
|
10,Anomaly Detection,anomaly-detection,Line Chart with Highlights,Scatter with Alert,Normal: blue #0080FF. Anomaly: red #FF0000 circle/square marker + alert,⚡ Good,✓ Circle/marker for anomalies. Add text alert annotation.,"D3.js, Plotly, ApexCharts",Hover + Alert
|
||||||
|
11,Hierarchical/Nested Data,hierarchical/nested-data,Treemap,"Sunburst, Nested Donut, Icicle",Parent: distinct hues. Children: lighter shades. White borders 2-3px.,⚠ Moderate,⚠ Poor - provide table alternative. Label large areas.,"D3.js, Recharts, ApexCharts",Hover + Drilldown
|
||||||
|
12,Flow/Process Data,flow/process-data,Sankey Diagram,"Alluvial, Chord Diagram",Gradient from source to target. Opacity 0.4-0.6 for flows.,⚠ Moderate,⚠ Poor - provide flow table alternative.,"D3.js (d3-sankey), Plotly",Hover + Drilldown
|
||||||
|
13,Cumulative Changes,cumulative-changes,Waterfall Chart,"Stacked Bar, Cascade",Increases: #4CAF50. Decreases: #F44336. Start: #2196F3. End: #0D47A1.,⚡ Good,✓ Good - clear directional colors with labels.,"ApexCharts, Highcharts, Plotly",Hover
|
||||||
|
14,Multi-Variable Comparison,multi-variable-comparison,Radar/Spider Chart,"Parallel Coordinates, Grouped Bar",Single: #0080FF 20% fill. Multiple: distinct colors per dataset.,⚡ Good,⚠ Moderate - limit 5-8 axes. Add data table.,"Chart.js, Recharts, ApexCharts",Hover + Toggle
|
||||||
|
15,Stock/Trading OHLC,stock/trading-ohlc,Candlestick Chart,"OHLC Bar, Heikin-Ashi",Bullish: #26A69A. Bearish: #EF5350. Volume: 40% opacity below.,⚡ Good,⚠ Moderate - provide OHLC data table.,"Lightweight Charts (TradingView), ApexCharts",Real-time + Hover + Zoom
|
||||||
|
16,Relationship/Connection Data,relationship/connection-data,Network Graph,"Hierarchical Tree, Adjacency Matrix",Node types: categorical colors. Edges: #90A4AE 60% opacity.,❌ Poor (500+ nodes struggles),❌ Very Poor - provide adjacency list alternative.,"D3.js (d3-force), Vis.js, Cytoscape.js",Drilldown + Hover + Drag
|
||||||
|
17,Distribution/Statistical,distribution/statistical,Box Plot,"Violin Plot, Beeswarm",Box: #BBDEFB. Border: #1976D2. Median: #D32F2F. Outliers: #F44336.,⚡ Excellent,"✓ Good - include stats table (min, Q1, median, Q3, max).","Plotly, D3.js, Chart.js (plugin)",Hover
|
||||||
|
18,Performance vs Target (Compact),performance-vs-target-(compact),Bullet Chart,"Gauge, Progress Bar","Ranges: #FFCDD2, #FFF9C4, #C8E6C9. Performance: #1976D2. Target: black 3px.",⚡ Excellent,✓ Excellent - compact with clear values.,"D3.js, Plotly, Custom SVG",Hover
|
||||||
|
19,Proportional/Percentage,proportional/percentage,Waffle Chart,"Pictogram, Stacked Bar 100%",10x10 grid. 3-5 categories max. 2-3px spacing between squares.,⚡ Good,✓ Good - better than pie for accessibility.,"D3.js, React-Waffle, Custom CSS Grid",Hover
|
||||||
|
20,Hierarchical Proportional,hierarchical-proportional,Sunburst Chart,"Treemap, Icicle, Circle Packing",Center to outer: darker to lighter. 15-20% lighter per level.,⚠ Moderate,⚠ Poor - provide hierarchy table alternative.,"D3.js (d3-hierarchy), Recharts, ApexCharts",Drilldown + Hover
|
||||||
|
21,Root Cause Analysis,"root cause, decomposition, tree, hierarchy, drill-down, ai-split",Decomposition Tree,"Decision Tree, Flow Chart",Nodes: #2563EB (Primary) vs #EF4444 (Negative impact). Connectors: Neutral grey.,⚠ Moderate (calculation heavy),✓ clear hierarchy. Allow keyboard navigation for nodes.,"Power BI (native), React-Flow, Custom D3.js",Drill + Expand
|
||||||
|
22,3D Spatial Data,"3d, spatial, immersive, terrain, molecular, volumetric",3D Scatter/Surface Plot,"Volumetric Rendering, Point Cloud",Depth cues: lighting/shading. Z-axis: color gradient (cool to warm).,❌ Heavy (WebGL required),❌ Poor - requires alternative 2D view or data table.,"Three.js, Deck.gl, Plotly 3D",Rotate + Zoom + VR
|
||||||
|
23,Real-Time Streaming,"streaming, real-time, ticker, live, velocity, pulse",Streaming Area Chart,"Ticker Tape, Moving Gauge",Current: Bright Pulse (#00FF00). History: Fading opacity. Grid: Dark.,⚡ Optimized (canvas/webgl),⚠ Flashing elements - provide pause button. High contrast.,"Smoothed D3.js, CanvasJS, SciChart",Real-time + Pause
|
||||||
|
24,Sentiment/Emotion,"sentiment, emotion, nlp, opinion, feeling",Word Cloud with Sentiment,"Sentiment Arc, Radar Chart",Positive: #22C55E. Negative: #EF4444. Neutral: #94A3B8. Size = Frequency.,⚡ Good,⚠ Word clouds poor for screen readers. Use list view.,"D3-cloud, Highcharts, Nivo",Hover + Filter
|
||||||
|
25,Process Mining,"process, mining, variants, path, bottleneck, log",Process Map / Graph,"Directed Acyclic Graph (DAG), Petri Net",Happy path: #10B981 (Thick). Deviations: #F59E0B (Thin). Bottlenecks: #EF4444.,⚠ Moderate to Heavy,⚠ Complex graphs hard to navigate. Provide path summary.,"React-Flow, Cytoscape.js, Recharts",Drag + Node-Click
|
||||||
|
|
|
@ -0,0 +1,97 @@
|
||||||
|
No,Product Type,Keywords,Primary (Hex),Secondary (Hex),CTA (Hex),Background (Hex),Text (Hex),Border (Hex),Notes
|
||||||
|
1,SaaS (General),"saas, general",#2563EB,#3B82F6,#F97316,#F8FAFC,#1E293B,#E2E8F0,Trust blue + accent contrast
|
||||||
|
2,Micro SaaS,"micro, saas",#2563EB,#3B82F6,#F97316,#F8FAFC,#1E293B,#E2E8F0,Vibrant primary + white space
|
||||||
|
3,E-commerce,commerce,#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Brand primary + success green
|
||||||
|
4,E-commerce Luxury,"commerce, luxury",#1C1917,#44403C,#CA8A04,#FAFAF9,#0C0A09,#D6D3D1,Premium colors + minimal accent
|
||||||
|
5,Service Landing Page,"service, landing, page",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Brand primary + trust colors
|
||||||
|
6,B2B Service,"b2b, service",#0F172A,#334155,#0369A1,#F8FAFC,#020617,#E2E8F0,Professional blue + neutral grey
|
||||||
|
7,Financial Dashboard,"financial, dashboard",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Dark bg + red/green alerts + trust blue
|
||||||
|
8,Analytics Dashboard,"analytics, dashboard",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Cool→Hot gradients + neutral grey
|
||||||
|
9,Healthcare App,"healthcare, app",#0891B2,#22D3EE,#059669,#ECFEFF,#164E63,#A5F3FC,Calm blue + health green + trust
|
||||||
|
10,Educational App,"educational, app",#4F46E5,#818CF8,#F97316,#EEF2FF,#1E1B4B,#C7D2FE,Playful colors + clear hierarchy
|
||||||
|
11,Creative Agency,"creative, agency",#EC4899,#F472B6,#06B6D4,#FDF2F8,#831843,#FBCFE8,Bold primaries + artistic freedom
|
||||||
|
12,Portfolio/Personal,"portfolio, personal",#18181B,#3F3F46,#2563EB,#FAFAFA,#09090B,#E4E4E7,Brand primary + artistic interpretation
|
||||||
|
13,Gaming,gaming,#7C3AED,#A78BFA,#F43F5E,#0F0F23,#E2E8F0,#4C1D95,Vibrant + neon + immersive colors
|
||||||
|
14,Government/Public Service,"government, public, service",#0F172A,#334155,#0369A1,#F8FAFC,#020617,#E2E8F0,Professional blue + high contrast
|
||||||
|
15,Fintech/Crypto,"fintech, crypto",#F59E0B,#FBBF24,#8B5CF6,#0F172A,#F8FAFC,#334155,Dark tech colors + trust + vibrant accents
|
||||||
|
16,Social Media App,"social, media, app",#2563EB,#60A5FA,#F43F5E,#F8FAFC,#1E293B,#DBEAFE,Vibrant + engagement colors
|
||||||
|
17,Productivity Tool,"productivity, tool",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Clear hierarchy + functional colors
|
||||||
|
18,Design System/Component Library,"design, system, component, library",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Clear hierarchy + code-like structure
|
||||||
|
19,AI/Chatbot Platform,"chatbot, platform",#7C3AED,#A78BFA,#06B6D4,#FAF5FF,#1E1B4B,#DDD6FE,Neutral + AI Purple (#6366F1)
|
||||||
|
20,NFT/Web3 Platform,"nft, web3, platform",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Dark + Neon + Gold (#FFD700)
|
||||||
|
21,Creator Economy Platform,"creator, economy, platform",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Vibrant + Brand colors
|
||||||
|
22,Sustainability/ESG Platform,"sustainability, esg, platform",#7C3AED,#A78BFA,#06B6D4,#FAF5FF,#1E1B4B,#DDD6FE,Green (#228B22) + Earth tones
|
||||||
|
23,Remote Work/Collaboration Tool,"remote, work, collaboration, tool",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Calm Blue + Neutral grey
|
||||||
|
24,Mental Health App,"mental, health, app",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Calm Pastels + Trust colors
|
||||||
|
25,Pet Tech App,"pet, tech, app",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Playful + Warm colors
|
||||||
|
26,Smart Home/IoT Dashboard,"smart, home, iot, dashboard",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Dark + Status indicator colors
|
||||||
|
27,EV/Charging Ecosystem,"charging, ecosystem",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Electric Blue (#009CD1) + Green
|
||||||
|
28,Subscription Box Service,"subscription, box, service",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Brand + Excitement colors
|
||||||
|
29,Podcast Platform,"podcast, platform",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Dark + Audio waveform accents
|
||||||
|
30,Dating App,"dating, app",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Warm + Romantic (Pink/Red gradients)
|
||||||
|
31,Micro-Credentials/Badges Platform,"micro, credentials, badges, platform",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Trust Blue + Gold (#FFD700)
|
||||||
|
32,Knowledge Base/Documentation,"knowledge, base, documentation",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Clean hierarchy + minimal color
|
||||||
|
33,Hyperlocal Services,"hyperlocal, services",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Location markers + Trust colors
|
||||||
|
34,Beauty/Spa/Wellness Service,"beauty, spa, wellness, service",#10B981,#34D399,#8B5CF6,#ECFDF5,#064E3B,#A7F3D0,Soft pastels (Pink #FFB6C1 Sage #90EE90) + Cream + Gold accents
|
||||||
|
35,Luxury/Premium Brand,"luxury, premium, brand",#1C1917,#44403C,#CA8A04,#FAFAF9,#0C0A09,#D6D3D1,Black + Gold (#FFD700) + White + Minimal accent
|
||||||
|
36,Restaurant/Food Service,"restaurant, food, service",#DC2626,#F87171,#CA8A04,#FEF2F2,#450A0A,#FECACA,Warm colors (Orange Red Brown) + appetizing imagery
|
||||||
|
37,Fitness/Gym App,"fitness, gym, app",#DC2626,#F87171,#16A34A,#FEF2F2,#1F2937,#FECACA,Energetic (Orange #FF6B35 Electric Blue) + Dark bg
|
||||||
|
38,Real Estate/Property,"real, estate, property",#0F766E,#14B8A6,#0369A1,#F0FDFA,#134E4A,#99F6E4,Trust Blue (#0077B6) + Gold accents + White
|
||||||
|
39,Travel/Tourism Agency,"travel, tourism, agency",#EC4899,#F472B6,#06B6D4,#FDF2F8,#831843,#FBCFE8,Vibrant destination colors + Sky Blue + Warm accents
|
||||||
|
40,Hotel/Hospitality,"hotel, hospitality",#1E3A8A,#3B82F6,#CA8A04,#F8FAFC,#1E40AF,#BFDBFE,Warm neutrals + Gold (#D4AF37) + Brand accent
|
||||||
|
41,Wedding/Event Planning,"wedding, event, planning",#7C3AED,#A78BFA,#F97316,#FAF5FF,#4C1D95,#DDD6FE,Soft Pink (#FFD6E0) + Gold + Cream + Sage
|
||||||
|
42,Legal Services,"legal, services",#1E3A8A,#1E40AF,#B45309,#F8FAFC,#0F172A,#CBD5E1,Navy Blue (#1E3A5F) + Gold + White
|
||||||
|
43,Insurance Platform,"insurance, platform",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Trust Blue (#0066CC) + Green (security) + Neutral
|
||||||
|
44,Banking/Traditional Finance,"banking, traditional, finance",#0F766E,#14B8A6,#0369A1,#F0FDFA,#134E4A,#99F6E4,Navy (#0A1628) + Trust Blue + Gold accents
|
||||||
|
45,Online Course/E-learning,"online, course, learning",#0D9488,#2DD4BF,#EA580C,#F0FDFA,#134E4A,#5EEAD4,Vibrant learning colors + Progress green
|
||||||
|
46,Non-profit/Charity,"non, profit, charity",#0891B2,#22D3EE,#F97316,#ECFEFF,#164E63,#A5F3FC,Cause-related colors + Trust + Warm
|
||||||
|
47,Music Streaming,"music, streaming",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Dark (#121212) + Vibrant accents + Album art colors
|
||||||
|
48,Video Streaming/OTT,"video, streaming, ott",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Dark bg + Content poster colors + Brand accent
|
||||||
|
49,Job Board/Recruitment,"job, board, recruitment",#0F172A,#334155,#0369A1,#F8FAFC,#020617,#E2E8F0,Professional Blue + Success Green + Neutral
|
||||||
|
50,Marketplace (P2P),"marketplace, p2p",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Trust colors + Category colors + Success green
|
||||||
|
51,Logistics/Delivery,"logistics, delivery",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Blue (#2563EB) + Orange (tracking) + Green (delivered)
|
||||||
|
52,Agriculture/Farm Tech,"agriculture, farm, tech",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Earth Green (#4A7C23) + Brown + Sky Blue
|
||||||
|
53,Construction/Architecture,"construction, architecture",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Grey (#4A4A4A) + Orange (safety) + Blueprint Blue
|
||||||
|
54,Automotive/Car Dealership,"automotive, car, dealership",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Brand colors + Metallic accents + Dark/Light
|
||||||
|
55,Photography Studio,"photography, studio",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Black + White + Minimal accent
|
||||||
|
56,Coworking Space,"coworking, space",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Energetic colors + Wood tones + Brand accent
|
||||||
|
57,Cleaning Service,"cleaning, service",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Fresh Blue (#00B4D8) + Clean White + Green
|
||||||
|
58,Home Services (Plumber/Electrician),"home, services, plumber, electrician",#0F172A,#334155,#0369A1,#F8FAFC,#020617,#E2E8F0,Trust Blue + Safety Orange + Professional grey
|
||||||
|
59,Childcare/Daycare,"childcare, daycare",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Playful pastels + Safe colors + Warm accents
|
||||||
|
60,Senior Care/Elderly,"senior, care, elderly",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Calm Blue + Warm neutrals + Large text
|
||||||
|
61,Medical Clinic,"medical, clinic",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Medical Blue (#0077B6) + Trust White + Calm Green
|
||||||
|
62,Pharmacy/Drug Store,"pharmacy, drug, store",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Pharmacy Green + Trust Blue + Clean White
|
||||||
|
63,Dental Practice,"dental, practice",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Fresh Blue + White + Smile Yellow accent
|
||||||
|
64,Veterinary Clinic,"veterinary, clinic",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Caring Blue + Pet-friendly colors + Warm accents
|
||||||
|
65,Florist/Plant Shop,"florist, plant, shop",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Natural Green + Floral pinks/purples + Earth tones
|
||||||
|
66,Bakery/Cafe,"bakery, cafe",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Warm Brown + Cream + Appetizing accents
|
||||||
|
67,Coffee Shop,"coffee, shop",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Coffee Brown (#6F4E37) + Cream + Warm accents
|
||||||
|
68,Brewery/Winery,"brewery, winery",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Deep amber/burgundy + Gold + Craft aesthetic
|
||||||
|
69,Airline,airline,#7C3AED,#A78BFA,#06B6D4,#FAF5FF,#1E1B4B,#DDD6FE,Sky Blue + Brand colors + Trust accents
|
||||||
|
70,News/Media Platform,"news, media, platform",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Brand colors + High contrast + Category colors
|
||||||
|
71,Magazine/Blog,"magazine, blog",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Editorial colors + Brand primary + Clean white
|
||||||
|
72,Freelancer Platform,"freelancer, platform",#0F172A,#334155,#0369A1,#F8FAFC,#020617,#E2E8F0,Professional Blue + Success Green + Neutral
|
||||||
|
73,Consulting Firm,"consulting, firm",#0F172A,#334155,#0369A1,#F8FAFC,#020617,#E2E8F0,Navy + Gold + Professional grey
|
||||||
|
74,Marketing Agency,"marketing, agency",#EC4899,#F472B6,#06B6D4,#FDF2F8,#831843,#FBCFE8,Bold brand colors + Creative freedom
|
||||||
|
75,Event Management,"event, management",#7C3AED,#A78BFA,#F97316,#FAF5FF,#4C1D95,#DDD6FE,Event theme colors + Excitement accents
|
||||||
|
76,Conference/Webinar Platform,"conference, webinar, platform",#0F172A,#334155,#0369A1,#F8FAFC,#020617,#E2E8F0,Professional Blue + Video accent + Brand
|
||||||
|
77,Membership/Community,"membership, community",#7C3AED,#A78BFA,#F97316,#FAF5FF,#4C1D95,#DDD6FE,Community brand colors + Engagement accents
|
||||||
|
78,Newsletter Platform,"newsletter, platform",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Brand primary + Clean white + CTA accent
|
||||||
|
79,Digital Products/Downloads,"digital, products, downloads",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Product category colors + Brand + Success green
|
||||||
|
80,Church/Religious Organization,"church, religious, organization",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Warm Gold + Deep Purple/Blue + White
|
||||||
|
81,Sports Team/Club,"sports, team, club",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Team colors + Energetic accents
|
||||||
|
82,Museum/Gallery,"museum, gallery",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Art-appropriate neutrals + Exhibition accents
|
||||||
|
83,Theater/Cinema,"theater, cinema",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Dark + Spotlight accents + Gold
|
||||||
|
84,Language Learning App,"language, learning, app",#0D9488,#2DD4BF,#EA580C,#F0FDFA,#134E4A,#5EEAD4,Playful colors + Progress indicators + Country flags
|
||||||
|
85,Coding Bootcamp,"coding, bootcamp",#3B82F6,#60A5FA,#F97316,#F8FAFC,#1E293B,#E2E8F0,Code editor colors + Brand + Success green
|
||||||
|
86,Cybersecurity Platform,"cybersecurity, security, cyber, hacker",#00FF41,#0D0D0D,#00FF41,#000000,#E0E0E0,#1F1F1F,Matrix Green + Deep Black + Terminal feel
|
||||||
|
87,Developer Tool / IDE,"developer, tool, ide, code, dev",#3B82F6,#1E293B,#2563EB,#0F172A,#F1F5F9,#334155,Dark syntax theme colors + Blue focus
|
||||||
|
88,Biotech / Life Sciences,"biotech, science, biology, medical",#0EA5E9,#0284C7,#10B981,#F8FAFC,#0F172A,#E2E8F0,Sterile White + DNA Blue + Life Green
|
||||||
|
89,Space Tech / Aerospace,"space, aerospace, tech, futuristic",#FFFFFF,#94A3B8,#3B82F6,#0B0B10,#F8FAFC,#1E293B,Deep Space Black + Star White + Metallic
|
||||||
|
90,Architecture / Interior,"architecture, interior, design, luxury",#171717,#404040,#D4AF37,#FFFFFF,#171717,#E5E5E5,Monochrome + Gold Accent + High Imagery
|
||||||
|
91,Quantum Computing,"quantum, qubit, tech",#00FFFF,#7B61FF,#FF00FF,#050510,#E0E0FF,#333344,Interference patterns + Neon + Deep Dark
|
||||||
|
92,Biohacking / Longevity,"bio, health, science",#FF4D4D,#4D94FF,#00E676,#F5F5F7,#1C1C1E,#E5E5EA,Biological red/blue + Clinical white
|
||||||
|
93,Autonomous Systems,"drone, robot, fleet",#00FF41,#008F11,#FF3333,#0D1117,#E6EDF3,#30363D,Terminal Green + Tactical Dark
|
||||||
|
94,Generative AI Art,"art, gen-ai, creative",#111111,#333333,#FFFFFF,#FAFAFA,#000000,#E5E5E5,Canvas Neutral + High Contrast
|
||||||
|
95,Spatial / Vision OS,"spatial, glass, vision",#FFFFFF,#E5E5E5,#007AFF,#888888,#000000,#FFFFFF,Glass opacity 20% + System Blue
|
||||||
|
96,Climate Tech,"climate, green, energy",#2E8B57,#87CEEB,#FFD700,#F0FFF4,#1A3320,#C6E6C6,Nature Green + Solar Yellow + Air Blue
|
||||||
|
|
|
@ -0,0 +1,31 @@
|
||||||
|
No,Pattern Name,Keywords,Section Order,Primary CTA Placement,Color Strategy,Recommended Effects,Conversion Optimization
|
||||||
|
1,Hero + Features + CTA,"hero, hero-centric, features, feature-rich, cta, call-to-action","1. Hero with headline/image, 2. Value prop, 3. Key features (3-5), 4. CTA section, 5. Footer",Hero (sticky) + Bottom,Hero: Brand primary or vibrant. Features: Card bg #FAFAFA. CTA: Contrasting accent color,"Hero parallax, feature card hover lift, CTA glow on hover",Deep CTA placement. Use contrasting color (at least 7:1 contrast ratio). Sticky navbar CTA.
|
||||||
|
2,Hero + Testimonials + CTA,"hero, testimonials, social-proof, trust, reviews, cta","1. Hero, 2. Problem statement, 3. Solution overview, 4. Testimonials carousel, 5. CTA",Hero (sticky) + Post-testimonials,"Hero: Brand color. Testimonials: Light bg #F5F5F5. Quotes: Italic, muted color #666. CTA: Vibrant","Testimonial carousel slide animations, quote marks animations, avatar fade-in",Social proof before CTA. Use 3-5 testimonials. Include photo + name + role. CTA after social proof.
|
||||||
|
3,Product Demo + Features,"demo, product-demo, features, showcase, interactive","1. Hero, 2. Product video/mockup (center), 3. Feature breakdown per section, 4. Comparison (optional), 5. CTA",Video center + CTA right/bottom,Video surround: Brand color overlay. Features: Icon color #0080FF. Text: Dark #222,"Video play button pulse, feature scroll reveals, demo interaction highlights",Embedded product demo increases engagement. Use interactive mockup if possible. Auto-play video muted.
|
||||||
|
4,Minimal Single Column,"minimal, simple, direct, single-column, clean","1. Hero headline, 2. Short description, 3. Benefit bullets (3 max), 4. CTA, 5. Footer","Center, large CTA button",Minimalist: Brand + white #FFFFFF + accent. Buttons: High contrast 7:1+. Text: Black/Dark grey,Minimal hover effects. Smooth scroll. CTA scale on hover (subtle),Single CTA focus. Large typography. Lots of whitespace. No nav clutter. Mobile-first.
|
||||||
|
5,Funnel (3-Step Conversion),"funnel, conversion, steps, wizard, onboarding","1. Hero, 2. Step 1 (problem), 3. Step 2 (solution), 4. Step 3 (action), 5. CTA progression",Each step: mini-CTA. Final: main CTA,"Step colors: 1 (Red/Problem), 2 (Orange/Process), 3 (Green/Solution). CTA: Brand color","Step number animations, progress bar fill, step transitions smooth scroll",Progressive disclosure. Show only essential info per step. Use progress indicators. Multiple CTAs.
|
||||||
|
6,Comparison Table + CTA,"comparison, table, compare, versus, cta","1. Hero, 2. Problem intro, 3. Comparison table (product vs competitors), 4. Pricing (optional), 5. CTA",Table: Right column. CTA: Below table,Table: Alternating rows (white/light grey). Your product: Highlight #FFFACD (light yellow) or green. Text: Dark,"Table row hover highlight, price toggle animations, feature checkmark animations",Use comparison to show unique value. Highlight your product row. Include 'free trial' in pricing row.
|
||||||
|
7,Lead Magnet + Form,"lead, form, signup, capture, email, magnet","1. Hero (benefit headline), 2. Lead magnet preview (ebook cover, checklist, etc), 3. Form (minimal fields), 4. CTA submit",Form CTA: Submit button,Lead magnet: Professional design. Form: Clean white bg. Inputs: Light border #CCCCCC. CTA: Brand color,"Form focus state animations, input validation animations, success confirmation animation",Form fields ≤ 3 for best conversion. Offer valuable lead magnet preview. Show form submission progress.
|
||||||
|
8,Pricing Page + CTA,"pricing, plans, tiers, comparison, cta","1. Hero (pricing headline), 2. Price comparison cards, 3. Feature comparison table, 4. FAQ section, 5. Final CTA",Each card: CTA button. Sticky CTA in nav,"Free: Grey, Starter: Blue, Pro: Green/Gold, Enterprise: Dark. Cards: 1px border, shadow","Price toggle animation (monthly/yearly), card comparison highlight, FAQ accordion open/close",Recommend starter plan (pre-select/highlight). Show annual discount (20-30%). Use FAQs to address concerns.
|
||||||
|
9,Video-First Hero,"video, hero, media, visual, engaging","1. Hero with video background, 2. Key features overlay, 3. Benefits section, 4. CTA",Overlay on video (center/bottom) + Bottom section,Dark overlay 60% on video. Brand accent for CTA. White text on dark.,"Video autoplay muted, parallax scroll, text fade-in on scroll",86% higher engagement with video. Add captions for accessibility. Compress video for performance.
|
||||||
|
10,Scroll-Triggered Storytelling,"storytelling, scroll, narrative, story, immersive","1. Intro hook, 2. Chapter 1 (problem), 3. Chapter 2 (journey), 4. Chapter 3 (solution), 5. Climax CTA",End of each chapter (mini) + Final climax CTA,Progressive reveal. Each chapter has distinct color. Building intensity.,"ScrollTrigger animations, parallax layers, progressive disclosure, chapter transitions",Narrative increases time-on-page 3x. Use progress indicator. Mobile: simplify animations.
|
||||||
|
11,AI Personalization Landing,"ai, personalization, smart, recommendation, dynamic","1. Dynamic hero (personalized), 2. Relevant features, 3. Tailored testimonials, 4. Smart CTA",Context-aware placement based on user segment,Adaptive based on user data. A/B test color variations per segment.,"Dynamic content swap, fade transitions, personalized product recommendations",20%+ conversion with personalization. Requires analytics integration. Fallback for new users.
|
||||||
|
12,Waitlist/Coming Soon,"waitlist, coming-soon, launch, early-access, notify","1. Hero with countdown, 2. Product teaser/preview, 3. Email capture form, 4. Social proof (waitlist count)",Email form prominent (above fold) + Sticky form on scroll,Anticipation: Dark + accent highlights. Countdown in brand color. Urgency indicators.,"Countdown timer animation, email validation feedback, success confetti, social share buttons",Scarcity + exclusivity. Show waitlist count. Early access benefits. Referral program.
|
||||||
|
13,Comparison Table Focus,"comparison, table, versus, compare, features","1. Hero (problem statement), 2. Comparison matrix (you vs competitors), 3. Feature deep-dive, 4. Winner CTA",After comparison table (highlighted row) + Bottom,Your product column highlighted (accent bg or green). Competitors neutral. Checkmarks green.,"Table row hover highlight, feature checkmark animations, sticky comparison header",Show value vs competitors. 35% higher conversion. Be factual. Include pricing if favorable.
|
||||||
|
14,Pricing-Focused Landing,"pricing, price, cost, plans, subscription","1. Hero (value proposition), 2. Pricing cards (3 tiers), 3. Feature comparison, 4. FAQ, 5. Final CTA",Each pricing card + Sticky CTA in nav + Bottom,Popular plan highlighted (brand color border/bg). Free: grey. Enterprise: dark/premium.,"Price toggle monthly/annual animation, card hover lift, FAQ accordion smooth open",Annual discount 20-30%. Recommend mid-tier (most popular badge). Address objections in FAQ.
|
||||||
|
15,App Store Style Landing,"app, mobile, download, store, install","1. Hero with device mockup, 2. Screenshots carousel, 3. Features with icons, 4. Reviews/ratings, 5. Download CTAs",Download buttons prominent (App Store + Play Store) throughout,Dark/light matching app store feel. Star ratings in gold. Screenshots with device frames.,"Device mockup rotations, screenshot slider, star rating animations, download button pulse",Show real screenshots. Include ratings (4.5+ stars). QR code for mobile. Platform-specific CTAs.
|
||||||
|
16,FAQ/Documentation Landing,"faq, documentation, help, support, questions","1. Hero with search bar, 2. Popular categories, 3. FAQ accordion, 4. Contact/support CTA",Search bar prominent + Contact CTA for unresolved questions,"Clean, high readability. Minimal color. Category icons in brand color. Success green for resolved.","Search autocomplete, smooth accordion open/close, category hover, helpful feedback buttons",Reduce support tickets. Track search analytics. Show related articles. Contact escalation path.
|
||||||
|
17,Immersive/Interactive Experience,"immersive, interactive, experience, 3d, animation","1. Full-screen interactive element, 2. Guided product tour, 3. Key benefits revealed, 4. CTA after completion",After interaction complete + Skip option for impatient users,Immersive experience colors. Dark background for focus. Highlight interactive elements.,"WebGL, 3D interactions, gamification elements, progress indicators, reward animations",40% higher engagement. Performance trade-off. Provide skip option. Mobile fallback essential.
|
||||||
|
18,Event/Conference Landing,"event, conference, meetup, registration, schedule","1. Hero (date/location/countdown), 2. Speakers grid, 3. Agenda/schedule, 4. Sponsors, 5. Register CTA",Register CTA sticky + After speakers + Bottom,Urgency colors (countdown). Event branding. Speaker cards professional. Sponsor logos neutral.,"Countdown timer, speaker hover cards with bio, agenda tabs, early bird countdown",Early bird pricing with deadline. Social proof (past attendees). Speaker credibility. Multi-ticket discounts.
|
||||||
|
19,Product Review/Ratings Focused,"reviews, ratings, testimonials, social-proof, stars","1. Hero (product + aggregate rating), 2. Rating breakdown, 3. Individual reviews, 4. Buy/CTA",After reviews summary + Buy button alongside reviews,Trust colors. Star ratings gold. Verified badge green. Review sentiment colors.,"Star fill animations, review filtering, helpful vote interactions, photo lightbox",User-generated content builds trust. Show verified purchases. Filter by rating. Respond to negative reviews.
|
||||||
|
20,Community/Forum Landing,"community, forum, social, members, discussion","1. Hero (community value prop), 2. Popular topics/categories, 3. Active members showcase, 4. Join CTA",Join button prominent + After member showcase,"Warm, welcoming. Member photos add humanity. Topic badges in brand colors. Activity indicators green.","Member avatars animation, activity feed live updates, topic hover previews, join success celebration","Show active community (member count, posts today). Highlight benefits. Preview content. Easy onboarding."
|
||||||
|
21,Before-After Transformation,"before-after, transformation, results, comparison","1. Hero (problem state), 2. Transformation slider/comparison, 3. How it works, 4. Results CTA",After transformation reveal + Bottom,Contrast: muted/grey (before) vs vibrant/colorful (after). Success green for results.,"Slider comparison interaction, before/after reveal animations, result counters, testimonial videos",Visual proof of value. 45% higher conversion. Real results. Specific metrics. Guarantee offer.
|
||||||
|
22,Marketplace / Directory,"marketplace, directory, search, listing","1. Hero (Search focused), 2. Categories, 3. Featured Listings, 4. Trust/Safety, 5. CTA (Become a host/seller)",Hero Search Bar + Navbar 'List your item',Search: High contrast. Categories: Visual icons. Trust: Blue/Green.,"Search autocomplete animation, map hover pins, card carousel","Search bar is the CTA. Reduce friction to search. Popular searches suggestions."
|
||||||
|
23,Newsletter / Content First,"newsletter, content, writer, blog, subscribe","1. Hero (Value Prop + Form), 2. Recent Issues/Archives, 3. Social Proof (Subscriber count), 4. About Author",Hero inline form + Sticky header form,Minimalist. Paper-like background. Text focus. Accent color for Subscribe.,"Text highlight animations, typewriter effect, subtle fade-in","Single field form (Email only). Show 'Join X,000 readers'. Read sample link."
|
||||||
|
24,Webinar Registration,"webinar, registration, event, training, live","1. Hero (Topic + Timer + Form), 2. What you'll learn, 3. Speaker Bio, 4. Urgency/Bonuses, 5. Form (again)",Hero (Right side form) + Bottom anchor,Urgency: Red/Orange. Professional: Blue/Navy. Form: High contrast white.,"Countdown timer, speaker avatar float, urgent ticker","Limited seats logic. 'Live' indicator. Auto-fill timezone."
|
||||||
|
25,Enterprise Gateway,"enterprise, corporate, gateway, solutions, portal","1. Hero (Video/Mission), 2. Solutions by Industry, 3. Solutions by Role, 4. Client Logos, 5. Contact Sales",Contact Sales (Primary) + Login (Secondary),Corporate: Navy/Grey. High integrity. Conservative accents.,"Slow video background, logo carousel, tab switching for industries","Path selection (I am a...). Mega menu navigation. Trust signals prominent."
|
||||||
|
26,Portfolio Grid,"portfolio, grid, showcase, gallery, masonry","1. Hero (Name/Role), 2. Project Grid (Masonry), 3. About/Philosophy, 4. Contact",Project Card Hover + Footer Contact,Neutral background (let work shine). Text: Black/White. Accent: Minimal.,"Image lazy load reveal, hover overlay info, lightbox view","Visuals first. Filter by category. Fast loading essential."
|
||||||
|
27,Horizontal Scroll Journey,"horizontal, scroll, journey, gallery, storytelling, panoramic","1. Intro (Vertical), 2. The Journey (Horizontal Track), 3. Detail Reveal, 4. Vertical Footer","Floating Sticky CTA or End of Horizontal Track","Continuous palette transition. Chapter colors. Progress bar #000000.","Scroll-jacking (careful), parallax layers, horizontal slide, progress indicator","Immersive product discovery. High engagement. Keep navigation visible."
|
||||||
|
28,Bento Grid Showcase,"bento, grid, features, modular, apple-style, showcase","1. Hero, 2. Bento Grid (Key Features), 3. Detail Cards, 4. Tech Specs, 5. CTA","Floating Action Button or Bottom of Grid","Card backgrounds: #F5F5F7 or Glass. Icons: Vibrant brand colors. Text: Dark.","Hover card scale (1.02), video inside cards, tilt effect, staggered reveal","Scannable value props. High information density without clutter. Mobile stack."
|
||||||
|
29,Interactive 3D Configurator,"3d, configurator, customizer, interactive, product","1. Hero (Configurator), 2. Feature Highlight (synced), 3. Price/Specs, 4. Purchase","Inside Configurator UI + Sticky Bottom Bar","Neutral studio background. Product: Realistic materials. UI: Minimal overlay.","Real-time rendering, material swap animation, camera rotate/zoom, light reflection","Increases ownership feeling. 360 view reduces return rates. Direct add-to-cart."
|
||||||
|
30,AI-Driven Dynamic Landing,"ai, dynamic, personalized, adaptive, generative","1. Prompt/Input Hero, 2. Generated Result Preview, 3. How it Works, 4. Value Prop","Input Field (Hero) + 'Try it' Buttons","Adaptive to user input. Dark mode for compute feel. Neon accents.","Typing text effects, shimmering generation loaders, morphing layouts","Immediate value demonstration. 'Show, don't tell'. Low friction start."
|
||||||
|
|
|
@ -0,0 +1,97 @@
|
||||||
|
No,Product Type,Keywords,Primary Style Recommendation,Secondary Styles,Landing Page Pattern,Dashboard Style (if applicable),Color Palette Focus,Key Considerations
|
||||||
|
1,SaaS (General),"app, b2b, cloud, general, saas, software, subscription",Glassmorphism + Flat Design,"Soft UI Evolution, Minimalism",Hero + Features + CTA,Data-Dense + Real-Time Monitoring,Trust blue + accent contrast,Balance modern feel with clarity. Focus on CTAs.
|
||||||
|
2,Micro SaaS,"app, b2b, cloud, indie, micro, micro-saas, niche, saas, small, software, solo, subscription",Flat Design + Vibrant & Block,"Motion-Driven, Micro-interactions",Minimal & Direct + Demo,Executive Dashboard,Vibrant primary + white space,"Keep simple, show product quickly. Speed is key."
|
||||||
|
3,E-commerce,"buy, commerce, e, ecommerce, products, retail, sell, shop, store",Vibrant & Block-based,"Aurora UI, Motion-Driven",Feature-Rich Showcase,Sales Intelligence Dashboard,Brand primary + success green,Engagement & conversions. High visual hierarchy.
|
||||||
|
4,E-commerce Luxury,"buy, commerce, e, ecommerce, elegant, exclusive, high-end, luxury, premium, products, retail, sell, shop, store",Liquid Glass + Glassmorphism,"3D & Hyperrealism, Aurora UI",Feature-Rich Showcase,Sales Intelligence Dashboard,Premium colors + minimal accent,Elegance & sophistication. Premium materials.
|
||||||
|
5,Service Landing Page,"appointment, booking, consultation, conversion, landing, marketing, page, service",Hero-Centric + Trust & Authority,"Social Proof-Focused, Storytelling",Hero-Centric Design,N/A - Analytics for conversions,Brand primary + trust colors,Social proof essential. Show expertise.
|
||||||
|
6,B2B Service,"appointment, b, b2b, booking, business, consultation, corporate, enterprise, service",Trust & Authority + Minimal,"Feature-Rich, Conversion-Optimized",Feature-Rich Showcase,Sales Intelligence Dashboard,Professional blue + neutral grey,Credibility essential. Clear ROI messaging.
|
||||||
|
7,Financial Dashboard,"admin, analytics, dashboard, data, financial, panel",Dark Mode (OLED) + Data-Dense,"Minimalism, Accessible & Ethical",N/A - Dashboard focused,Financial Dashboard,Dark bg + red/green alerts + trust blue,"High contrast, real-time updates, accuracy paramount."
|
||||||
|
8,Analytics Dashboard,"admin, analytics, dashboard, data, panel",Data-Dense + Heat Map & Heatmap,"Minimalism, Dark Mode (OLED)",N/A - Analytics focused,Drill-Down Analytics + Comparative,Cool→Hot gradients + neutral grey,Clarity > aesthetics. Color-coded data priority.
|
||||||
|
9,Healthcare App,"app, clinic, health, healthcare, medical, patient",Neumorphism + Accessible & Ethical,"Soft UI Evolution, Claymorphism (for patients)",Social Proof-Focused,User Behavior Analytics,Calm blue + health green + trust,Accessibility mandatory. Calming aesthetic.
|
||||||
|
10,Educational App,"app, course, education, educational, learning, school, training",Claymorphism + Micro-interactions,"Vibrant & Block-based, Flat Design",Storytelling-Driven,User Behavior Analytics,Playful colors + clear hierarchy,Engagement & ease of use. Age-appropriate design.
|
||||||
|
11,Creative Agency,"agency, creative, design, marketing, studio",Brutalism + Motion-Driven,"Retro-Futurism, Storytelling-Driven",Storytelling-Driven,N/A - Portfolio focused,Bold primaries + artistic freedom,Differentiation key. Wow-factor necessary.
|
||||||
|
12,Portfolio/Personal,"creative, personal, portfolio, projects, showcase, work",Motion-Driven + Minimalism,"Brutalism, Aurora UI",Storytelling-Driven,N/A - Personal branding,Brand primary + artistic interpretation,Showcase work. Personality shine through.
|
||||||
|
13,Gaming,"entertainment, esports, game, gaming, play",3D & Hyperrealism + Retro-Futurism,"Motion-Driven, Vibrant & Block",Feature-Rich Showcase,N/A - Game focused,Vibrant + neon + immersive colors,Immersion priority. Performance critical.
|
||||||
|
14,Government/Public Service,"appointment, booking, consultation, government, public, service",Accessible & Ethical + Minimalism,"Flat Design, Inclusive Design",Minimal & Direct,Executive Dashboard,Professional blue + high contrast,WCAG AAA mandatory. Trust paramount.
|
||||||
|
15,Fintech/Crypto,"banking, blockchain, crypto, defi, finance, fintech, money, nft, payment, web3",Glassmorphism + Dark Mode (OLED),"Retro-Futurism, Motion-Driven",Conversion-Optimized,Real-Time Monitoring + Predictive,Dark tech colors + trust + vibrant accents,Security perception. Real-time data critical.
|
||||||
|
16,Social Media App,"app, community, content, entertainment, media, network, sharing, social, streaming, users, video",Vibrant & Block-based + Motion-Driven,"Aurora UI, Micro-interactions",Feature-Rich Showcase,User Behavior Analytics,Vibrant + engagement colors,Engagement & retention. Addictive design ethics.
|
||||||
|
17,Productivity Tool,"collaboration, productivity, project, task, tool, workflow",Flat Design + Micro-interactions,"Minimalism, Soft UI Evolution",Interactive Product Demo,Drill-Down Analytics,Clear hierarchy + functional colors,Ease of use. Speed & efficiency focus.
|
||||||
|
18,Design System/Component Library,"component, design, library, system",Minimalism + Accessible & Ethical,"Flat Design, Zero Interface",Feature-Rich Showcase,N/A - Dev focused,Clear hierarchy + code-like structure,Consistency. Developer-first approach.
|
||||||
|
19,AI/Chatbot Platform,"ai, artificial-intelligence, automation, chatbot, machine-learning, ml, platform",AI-Native UI + Minimalism,"Zero Interface, Glassmorphism",Interactive Product Demo,AI/ML Analytics Dashboard,Neutral + AI Purple (#6366F1),Conversational UI. Streaming text. Context awareness. Minimal chrome.
|
||||||
|
20,NFT/Web3 Platform,"nft, platform, web",Cyberpunk UI + Glassmorphism,"Aurora UI, 3D & Hyperrealism",Feature-Rich Showcase,Crypto/Blockchain Dashboard,Dark + Neon + Gold (#FFD700),Wallet integration. Transaction feedback. Gas fees display. Dark mode essential.
|
||||||
|
21,Creator Economy Platform,"creator, economy, platform",Vibrant & Block-based + Bento Box Grid,"Motion-Driven, Aurora UI",Social Proof-Focused,User Behavior Analytics,Vibrant + Brand colors,Creator profiles. Monetization display. Engagement metrics. Social proof.
|
||||||
|
22,Sustainability/ESG Platform,"ai, artificial-intelligence, automation, esg, machine-learning, ml, platform, sustainability",Organic Biophilic + Minimalism,"Accessible & Ethical, Flat Design",Trust & Authority,Energy/Utilities Dashboard,Green (#228B22) + Earth tones,Carbon footprint visuals. Progress indicators. Certification badges. Eco-friendly imagery.
|
||||||
|
23,Remote Work/Collaboration Tool,"collaboration, remote, tool, work",Soft UI Evolution + Minimalism,"Glassmorphism, Micro-interactions",Feature-Rich Showcase,Drill-Down Analytics,Calm Blue + Neutral grey,Real-time collaboration. Status indicators. Video integration. Notification management.
|
||||||
|
24,Mental Health App,"app, health, mental",Neumorphism + Accessible & Ethical,"Claymorphism, Soft UI Evolution",Social Proof-Focused,Healthcare Analytics,Calm Pastels + Trust colors,Calming aesthetics. Privacy-first. Crisis resources. Progress tracking. Accessibility mandatory.
|
||||||
|
25,Pet Tech App,"app, pet, tech",Claymorphism + Vibrant & Block-based,"Micro-interactions, Flat Design",Storytelling-Driven,User Behavior Analytics,Playful + Warm colors,Pet profiles. Health tracking. Playful UI. Photo galleries. Vet integration.
|
||||||
|
26,Smart Home/IoT Dashboard,"admin, analytics, dashboard, data, home, iot, panel, smart",Glassmorphism + Dark Mode (OLED),"Minimalism, AI-Native UI",Interactive Product Demo,Real-Time Monitoring,Dark + Status indicator colors,Device status. Real-time controls. Energy monitoring. Automation rules. Quick actions.
|
||||||
|
27,EV/Charging Ecosystem,"charging, ecosystem, ev",Minimalism + Aurora UI,"Glassmorphism, Organic Biophilic",Hero-Centric Design,Energy/Utilities Dashboard,Electric Blue (#009CD1) + Green,Charging station maps. Range estimation. Cost calculation. Environmental impact.
|
||||||
|
28,Subscription Box Service,"appointment, booking, box, consultation, membership, plan, recurring, service, subscription",Vibrant & Block-based + Motion-Driven,"Claymorphism, Aurora UI",Feature-Rich Showcase,E-commerce Analytics,Brand + Excitement colors,Unboxing experience. Personalization quiz. Subscription management. Product reveals.
|
||||||
|
29,Podcast Platform,"platform, podcast",Dark Mode (OLED) + Minimalism,"Motion-Driven, Vibrant & Block-based",Storytelling-Driven,Media/Entertainment Dashboard,Dark + Audio waveform accents,Audio player UX. Episode discovery. Creator tools. Analytics for podcasters.
|
||||||
|
30,Dating App,"app, dating",Vibrant & Block-based + Motion-Driven,"Aurora UI, Glassmorphism",Social Proof-Focused,User Behavior Analytics,Warm + Romantic (Pink/Red gradients),Profile cards. Swipe interactions. Match animations. Safety features. Video chat.
|
||||||
|
31,Micro-Credentials/Badges Platform,"badges, credentials, micro, platform",Minimalism + Flat Design,"Accessible & Ethical, Swiss Modernism 2.0",Trust & Authority,Education Dashboard,Trust Blue + Gold (#FFD700),Credential verification. Badge display. Progress tracking. Issuer trust. LinkedIn integration.
|
||||||
|
32,Knowledge Base/Documentation,"base, documentation, knowledge",Minimalism + Accessible & Ethical,"Swiss Modernism 2.0, Flat Design",FAQ/Documentation,N/A - Documentation focused,Clean hierarchy + minimal color,Search-first. Clear navigation. Code highlighting. Version switching. Feedback system.
|
||||||
|
33,Hyperlocal Services,"appointment, booking, consultation, hyperlocal, service, services",Minimalism + Vibrant & Block-based,"Micro-interactions, Flat Design",Conversion-Optimized,Drill-Down Analytics + Map,Location markers + Trust colors,Map integration. Service categories. Provider profiles. Booking system. Reviews.
|
||||||
|
34,Beauty/Spa/Wellness Service,"appointment, beauty, booking, consultation, service, spa, wellness",Soft UI Evolution + Neumorphism,"Glassmorphism, Minimalism",Hero-Centric Design + Social Proof,User Behavior Analytics,Soft pastels (Pink #FFB6C1 Sage #90EE90) + Cream + Gold accents,Calming aesthetic. Booking system. Service menu. Before/after gallery. Testimonials. Relaxing imagery.
|
||||||
|
35,Luxury/Premium Brand,"brand, elegant, exclusive, high-end, luxury, premium",Liquid Glass + Glassmorphism,"Minimalism, 3D & Hyperrealism",Storytelling-Driven + Feature-Rich,Sales Intelligence Dashboard,Black + Gold (#FFD700) + White + Minimal accent,Elegance paramount. Premium imagery. Storytelling. High-quality visuals. Exclusive feel.
|
||||||
|
36,Restaurant/Food Service,"appointment, booking, consultation, delivery, food, menu, order, restaurant, service",Vibrant & Block-based + Motion-Driven,"Claymorphism, Flat Design",Hero-Centric Design + Conversion,N/A - Booking focused,Warm colors (Orange Red Brown) + appetizing imagery,Menu display. Online ordering. Reservation system. Food photography. Location/hours prominent.
|
||||||
|
37,Fitness/Gym App,"app, exercise, fitness, gym, health, workout",Vibrant & Block-based + Dark Mode (OLED),"Motion-Driven, Neumorphism",Feature-Rich Showcase,User Behavior Analytics,Energetic (Orange #FF6B35 Electric Blue) + Dark bg,Progress tracking. Workout plans. Community features. Achievements. Motivational design.
|
||||||
|
38,Real Estate/Property,"buy, estate, housing, property, real, real-estate, rent",Glassmorphism + Minimalism,"Motion-Driven, 3D & Hyperrealism",Hero-Centric Design + Feature-Rich,Sales Intelligence Dashboard,Trust Blue (#0077B6) + Gold accents + White,Property listings. Virtual tours. Map integration. Agent profiles. Mortgage calculator. High-quality imagery.
|
||||||
|
39,Travel/Tourism Agency,"agency, booking, creative, design, flight, hotel, marketing, studio, tourism, travel, vacation",Aurora UI + Motion-Driven,"Vibrant & Block-based, Glassmorphism",Storytelling-Driven + Hero-Centric,Booking Analytics,Vibrant destination colors + Sky Blue + Warm accents,Destination showcase. Booking system. Itinerary builder. Reviews. Inspiration galleries. Mobile-first.
|
||||||
|
40,Hotel/Hospitality,"hospitality, hotel",Liquid Glass + Minimalism,"Glassmorphism, Soft UI Evolution",Hero-Centric Design + Social Proof,Revenue Management Dashboard,Warm neutrals + Gold (#D4AF37) + Brand accent,Room booking. Amenities showcase. Location maps. Guest reviews. Seasonal pricing. Luxury imagery.
|
||||||
|
41,Wedding/Event Planning,"conference, event, meetup, planning, registration, ticket, wedding",Soft UI Evolution + Aurora UI,"Glassmorphism, Motion-Driven",Storytelling-Driven + Social Proof,N/A - Planning focused,Soft Pink (#FFD6E0) + Gold + Cream + Sage,Portfolio gallery. Vendor directory. Planning tools. Timeline. Budget tracker. Romantic aesthetic.
|
||||||
|
42,Legal Services,"appointment, attorney, booking, compliance, consultation, contract, law, legal, service, services",Trust & Authority + Minimalism,"Accessible & Ethical, Swiss Modernism 2.0",Trust & Authority + Minimal,Case Management Dashboard,Navy Blue (#1E3A5F) + Gold + White,Credibility paramount. Practice areas. Attorney profiles. Case results. Contact forms. Professional imagery.
|
||||||
|
43,Insurance Platform,"insurance, platform",Trust & Authority + Flat Design,"Accessible & Ethical, Minimalism",Conversion-Optimized + Trust,Claims Analytics Dashboard,Trust Blue (#0066CC) + Green (security) + Neutral,Quote calculator. Policy comparison. Claims process. Trust signals. Clear pricing. Security badges.
|
||||||
|
44,Banking/Traditional Finance,"banking, finance, traditional",Minimalism + Accessible & Ethical,"Trust & Authority, Dark Mode (OLED)",Trust & Authority + Feature-Rich,Financial Dashboard,Navy (#0A1628) + Trust Blue + Gold accents,Security-first. Account overview. Transaction history. Mobile banking. Accessibility critical. Trust paramount.
|
||||||
|
45,Online Course/E-learning,"course, e, learning, online",Claymorphism + Vibrant & Block-based,"Motion-Driven, Flat Design",Feature-Rich Showcase + Social Proof,Education Dashboard,Vibrant learning colors + Progress green,Course catalog. Progress tracking. Video player. Quizzes. Certificates. Community forums. Gamification.
|
||||||
|
46,Non-profit/Charity,"charity, non, profit",Accessible & Ethical + Organic Biophilic,"Minimalism, Storytelling-Driven",Storytelling-Driven + Trust,Donation Analytics Dashboard,Cause-related colors + Trust + Warm,Impact stories. Donation flow. Transparency reports. Volunteer signup. Event calendar. Emotional connection.
|
||||||
|
47,Music Streaming,"music, streaming",Dark Mode (OLED) + Vibrant & Block-based,"Motion-Driven, Aurora UI",Feature-Rich Showcase,Media/Entertainment Dashboard,Dark (#121212) + Vibrant accents + Album art colors,Audio player. Playlist management. Artist pages. Personalization. Social features. Waveform visualizations.
|
||||||
|
48,Video Streaming/OTT,"ott, streaming, video",Dark Mode (OLED) + Motion-Driven,"Glassmorphism, Vibrant & Block-based",Hero-Centric Design + Feature-Rich,Media/Entertainment Dashboard,Dark bg + Content poster colors + Brand accent,Video player. Content discovery. Watchlist. Continue watching. Personalized recommendations. Thumbnail-heavy.
|
||||||
|
49,Job Board/Recruitment,"board, job, recruitment",Flat Design + Minimalism,"Vibrant & Block-based, Accessible & Ethical",Conversion-Optimized + Feature-Rich,HR Analytics Dashboard,Professional Blue + Success Green + Neutral,Job listings. Search/filter. Company profiles. Application tracking. Resume upload. Salary insights.
|
||||||
|
50,Marketplace (P2P),"buyers, listings, marketplace, p, platform, sellers",Vibrant & Block-based + Flat Design,"Micro-interactions, Trust & Authority",Feature-Rich Showcase + Social Proof,E-commerce Analytics,Trust colors + Category colors + Success green,Seller/buyer profiles. Listings. Reviews/ratings. Secure payment. Messaging. Search/filter. Trust badges.
|
||||||
|
51,Logistics/Delivery,"delivery, logistics",Minimalism + Flat Design,"Dark Mode (OLED), Micro-interactions",Feature-Rich Showcase + Conversion,Real-Time Monitoring + Route Analytics,Blue (#2563EB) + Orange (tracking) + Green (delivered),Real-time tracking. Delivery scheduling. Route optimization. Driver management. Status updates. Map integration.
|
||||||
|
52,Agriculture/Farm Tech,"agriculture, farm, tech",Organic Biophilic + Flat Design,"Minimalism, Accessible & Ethical",Feature-Rich Showcase + Trust,IoT Sensor Dashboard,Earth Green (#4A7C23) + Brown + Sky Blue,Crop monitoring. Weather data. IoT sensors. Yield tracking. Market prices. Sustainable imagery.
|
||||||
|
53,Construction/Architecture,"architecture, construction",Minimalism + 3D & Hyperrealism,"Brutalism, Swiss Modernism 2.0",Hero-Centric Design + Feature-Rich,Project Management Dashboard,Grey (#4A4A4A) + Orange (safety) + Blueprint Blue,Project portfolio. 3D renders. Timeline. Material specs. Team collaboration. Blueprint aesthetic.
|
||||||
|
54,Automotive/Car Dealership,"automotive, car, dealership",Motion-Driven + 3D & Hyperrealism,"Dark Mode (OLED), Glassmorphism",Hero-Centric Design + Feature-Rich,Sales Intelligence Dashboard,Brand colors + Metallic accents + Dark/Light,Vehicle showcase. 360° views. Comparison tools. Financing calculator. Test drive booking. High-quality imagery.
|
||||||
|
55,Photography Studio,"photography, studio",Motion-Driven + Minimalism,"Aurora UI, Glassmorphism",Storytelling-Driven + Hero-Centric,N/A - Portfolio focused,Black + White + Minimal accent,Portfolio gallery. Before/after. Service packages. Booking system. Client galleries. Full-bleed imagery.
|
||||||
|
56,Coworking Space,"coworking, space",Vibrant & Block-based + Glassmorphism,"Minimalism, Motion-Driven",Hero-Centric Design + Feature-Rich,Occupancy Dashboard,Energetic colors + Wood tones + Brand accent,Space tour. Membership plans. Booking system. Amenities. Community events. Virtual tour.
|
||||||
|
57,Cleaning Service,"appointment, booking, cleaning, consultation, service",Soft UI Evolution + Flat Design,"Minimalism, Micro-interactions",Conversion-Optimized + Trust,Service Analytics,Fresh Blue (#00B4D8) + Clean White + Green,Service packages. Booking system. Price calculator. Before/after gallery. Reviews. Trust badges.
|
||||||
|
58,Home Services (Plumber/Electrician),"appointment, booking, consultation, electrician, home, plumber, service, services",Flat Design + Trust & Authority,"Minimalism, Accessible & Ethical",Conversion-Optimized + Trust,Service Analytics,Trust Blue + Safety Orange + Professional grey,Service list. Emergency contact. Booking. Price transparency. Certifications. Local trust signals.
|
||||||
|
59,Childcare/Daycare,"childcare, daycare",Claymorphism + Vibrant & Block-based,"Soft UI Evolution, Accessible & Ethical",Social Proof-Focused + Trust,Parent Dashboard,Playful pastels + Safe colors + Warm accents,Programs. Staff profiles. Safety certifications. Parent portal. Activity updates. Cheerful imagery.
|
||||||
|
60,Senior Care/Elderly,"care, elderly, senior",Accessible & Ethical + Soft UI Evolution,"Minimalism, Neumorphism",Trust & Authority + Social Proof,Healthcare Analytics,Calm Blue + Warm neutrals + Large text,Care services. Staff qualifications. Facility tour. Family portal. Large touch targets. High contrast. Accessibility-first.
|
||||||
|
61,Medical Clinic,"clinic, medical",Accessible & Ethical + Minimalism,"Neumorphism, Trust & Authority",Trust & Authority + Conversion,Healthcare Analytics,Medical Blue (#0077B6) + Trust White + Calm Green,Services. Doctor profiles. Online booking. Patient portal. Insurance info. HIPAA compliant. Trust signals.
|
||||||
|
62,Pharmacy/Drug Store,"drug, pharmacy, store",Flat Design + Accessible & Ethical,"Minimalism, Trust & Authority",Conversion-Optimized + Trust,Inventory Dashboard,Pharmacy Green + Trust Blue + Clean White,Product catalog. Prescription upload. Refill reminders. Health info. Store locator. Safety certifications.
|
||||||
|
63,Dental Practice,"dental, practice",Soft UI Evolution + Minimalism,"Accessible & Ethical, Trust & Authority",Social Proof-Focused + Conversion,Patient Analytics,Fresh Blue + White + Smile Yellow accent,Services. Dentist profiles. Before/after. Online booking. Insurance. Patient testimonials. Friendly imagery.
|
||||||
|
64,Veterinary Clinic,"clinic, veterinary",Claymorphism + Accessible & Ethical,"Soft UI Evolution, Flat Design",Social Proof-Focused + Trust,Pet Health Dashboard,Caring Blue + Pet-friendly colors + Warm accents,Pet services. Vet profiles. Online booking. Pet portal. Emergency info. Friendly animal imagery.
|
||||||
|
65,Florist/Plant Shop,"florist, plant, shop",Organic Biophilic + Vibrant & Block-based,"Aurora UI, Motion-Driven",Hero-Centric Design + Conversion,E-commerce Analytics,Natural Green + Floral pinks/purples + Earth tones,Product catalog. Occasion categories. Delivery scheduling. Care guides. Seasonal collections. Beautiful imagery.
|
||||||
|
66,Bakery/Cafe,"bakery, cafe",Vibrant & Block-based + Soft UI Evolution,"Claymorphism, Motion-Driven",Hero-Centric Design + Conversion,N/A - Order focused,Warm Brown + Cream + Appetizing accents,Menu display. Online ordering. Location/hours. Catering. Seasonal specials. Appetizing photography.
|
||||||
|
67,Coffee Shop,"coffee, shop",Minimalism + Organic Biophilic,"Soft UI Evolution, Flat Design",Hero-Centric Design + Conversion,N/A - Order focused,Coffee Brown (#6F4E37) + Cream + Warm accents,Menu. Online ordering. Loyalty program. Location. Story/origin. Cozy aesthetic.
|
||||||
|
68,Brewery/Winery,"brewery, winery",Motion-Driven + Storytelling-Driven,"Dark Mode (OLED), Organic Biophilic",Storytelling-Driven + Hero-Centric,N/A - E-commerce focused,Deep amber/burgundy + Gold + Craft aesthetic,Product showcase. Story/heritage. Tasting notes. Events. Club membership. Artisanal imagery.
|
||||||
|
69,Airline,"ai, airline, artificial-intelligence, automation, machine-learning, ml",Minimalism + Glassmorphism,"Motion-Driven, Accessible & Ethical",Conversion-Optimized + Feature-Rich,Operations Dashboard,Sky Blue + Brand colors + Trust accents,Flight search. Booking. Check-in. Boarding pass. Loyalty program. Route maps. Mobile-first.
|
||||||
|
70,News/Media Platform,"content, entertainment, media, news, platform, streaming, video",Minimalism + Flat Design,"Dark Mode (OLED), Accessible & Ethical",Hero-Centric Design + Feature-Rich,Media Analytics Dashboard,Brand colors + High contrast + Category colors,Article layout. Breaking news. Categories. Search. Subscription. Mobile reading. Fast loading.
|
||||||
|
71,Magazine/Blog,"articles, blog, content, magazine, posts, writing",Swiss Modernism 2.0 + Motion-Driven,"Minimalism, Aurora UI",Storytelling-Driven + Hero-Centric,Content Analytics,Editorial colors + Brand primary + Clean white,Article showcase. Category navigation. Author profiles. Newsletter signup. Related content. Typography-focused.
|
||||||
|
72,Freelancer Platform,"freelancer, platform",Flat Design + Minimalism,"Vibrant & Block-based, Micro-interactions",Feature-Rich Showcase + Conversion,Marketplace Analytics,Professional Blue + Success Green + Neutral,Profile creation. Portfolio. Skill matching. Messaging. Payment. Reviews. Project management.
|
||||||
|
73,Consulting Firm,"consulting, firm",Trust & Authority + Minimalism,"Swiss Modernism 2.0, Accessible & Ethical",Trust & Authority + Feature-Rich,N/A - Lead generation,Navy + Gold + Professional grey,Service areas. Case studies. Team profiles. Thought leadership. Contact. Professional credibility.
|
||||||
|
74,Marketing Agency,"agency, creative, design, marketing, studio",Brutalism + Motion-Driven,"Vibrant & Block-based, Aurora UI",Storytelling-Driven + Feature-Rich,Campaign Analytics,Bold brand colors + Creative freedom,Portfolio. Case studies. Services. Team. Creative showcase. Results-focused. Bold aesthetic.
|
||||||
|
75,Event Management,"conference, event, management, meetup, registration, ticket",Vibrant & Block-based + Motion-Driven,"Glassmorphism, Aurora UI",Hero-Centric Design + Feature-Rich,Event Analytics,Event theme colors + Excitement accents,Event showcase. Registration. Agenda. Speakers. Sponsors. Ticket sales. Countdown timer.
|
||||||
|
76,Conference/Webinar Platform,"conference, platform, webinar",Glassmorphism + Minimalism,"Motion-Driven, Flat Design",Feature-Rich Showcase + Conversion,Attendee Analytics,Professional Blue + Video accent + Brand,Registration. Agenda. Speaker profiles. Live stream. Networking. Recording access. Virtual event features.
|
||||||
|
77,Membership/Community,"community, membership",Vibrant & Block-based + Soft UI Evolution,"Bento Box Grid, Micro-interactions",Social Proof-Focused + Conversion,Community Analytics,Community brand colors + Engagement accents,Member benefits. Pricing tiers. Community showcase. Events. Member directory. Exclusive content.
|
||||||
|
78,Newsletter Platform,"newsletter, platform",Minimalism + Flat Design,"Swiss Modernism 2.0, Accessible & Ethical",Minimal & Direct + Conversion,Email Analytics,Brand primary + Clean white + CTA accent,Subscribe form. Archive. About. Social proof. Sample content. Simple conversion.
|
||||||
|
79,Digital Products/Downloads,"digital, downloads, products",Vibrant & Block-based + Motion-Driven,"Glassmorphism, Bento Box Grid",Feature-Rich Showcase + Conversion,E-commerce Analytics,Product category colors + Brand + Success green,Product showcase. Preview. Pricing. Instant delivery. License management. Customer reviews.
|
||||||
|
80,Church/Religious Organization,"church, organization, religious",Accessible & Ethical + Soft UI Evolution,"Minimalism, Trust & Authority",Hero-Centric Design + Social Proof,N/A - Community focused,Warm Gold + Deep Purple/Blue + White,Service times. Events. Sermons. Community. Giving. Location. Welcoming imagery.
|
||||||
|
81,Sports Team/Club,"club, sports, team",Vibrant & Block-based + Motion-Driven,"Dark Mode (OLED), 3D & Hyperrealism",Hero-Centric Design + Feature-Rich,Performance Analytics,Team colors + Energetic accents,Schedule. Roster. News. Tickets. Merchandise. Fan engagement. Action imagery.
|
||||||
|
82,Museum/Gallery,"gallery, museum",Minimalism + Motion-Driven,"Swiss Modernism 2.0, 3D & Hyperrealism",Storytelling-Driven + Feature-Rich,Visitor Analytics,Art-appropriate neutrals + Exhibition accents,Exhibitions. Collections. Tickets. Events. Virtual tours. Educational content. Art-focused design.
|
||||||
|
83,Theater/Cinema,"cinema, theater",Dark Mode (OLED) + Motion-Driven,"Vibrant & Block-based, Glassmorphism",Hero-Centric Design + Conversion,Booking Analytics,Dark + Spotlight accents + Gold,Showtimes. Seat selection. Trailers. Coming soon. Membership. Dramatic imagery.
|
||||||
|
84,Language Learning App,"app, language, learning",Claymorphism + Vibrant & Block-based,"Micro-interactions, Flat Design",Feature-Rich Showcase + Social Proof,Learning Analytics,Playful colors + Progress indicators + Country flags,Lesson structure. Progress tracking. Gamification. Speaking practice. Community. Achievement badges.
|
||||||
|
85,Coding Bootcamp,"bootcamp, coding",Dark Mode (OLED) + Minimalism,"Cyberpunk UI, Flat Design",Feature-Rich Showcase + Social Proof,Student Analytics,Code editor colors + Brand + Success green,Curriculum. Projects. Career outcomes. Alumni. Pricing. Application. Terminal aesthetic.
|
||||||
|
86,Cybersecurity Platform,"cyber, security, platform",Cyberpunk UI + Dark Mode (OLED),"Neubrutalism, Minimal & Direct",Trust & Authority + Real-Time,Real-Time Monitoring + Heat Map,Matrix Green + Deep Black + Terminal feel,Data density. Threat visualization. Dark mode default.
|
||||||
|
87,Developer Tool / IDE,"dev, developer, tool, ide",Dark Mode (OLED) + Minimalism,"Flat Design, Bento Box Grid",Minimal & Direct + Documentation,Real-Time Monitor + Terminal,Dark syntax theme colors + Blue focus,Keyboard shortcuts. Syntax highlighting. Fast performance.
|
||||||
|
88,Biotech / Life Sciences,"biotech, biology, science",Glassmorphism + Clean Science,"Minimalism, Organic Biophilic",Storytelling-Driven + Research,Data-Dense + Predictive,Sterile White + DNA Blue + Life Green,Data accuracy. Cleanliness. Complex data viz.
|
||||||
|
89,Space Tech / Aerospace,"aerospace, space, tech",Holographic / HUD + Dark Mode,"Glassmorphism, 3D & Hyperrealism",Immersive Experience + Hero,Real-Time Monitoring + 3D,Deep Space Black + Star White + Metallic,High-tech feel. Precision. Telemetry data.
|
||||||
|
90,Architecture / Interior,"architecture, design, interior",Exaggerated Minimalism + High Imagery,"Swiss Modernism 2.0, Parallax",Portfolio Grid + Visuals,Project Management + Gallery,Monochrome + Gold Accent + High Imagery,High-res images. Typography. Space.
|
||||||
|
91,Quantum Computing Interface,"quantum, computing, physics, qubit, future, science",Holographic / HUD + Dark Mode,"Glassmorphism, Spatial UI",Immersive/Interactive Experience,3D Spatial Data + Real-Time Monitor,Quantum Blue #00FFFF + Deep Black + Interference patterns,Visualize complexity. Qubit states. Probability clouds. High-tech trust.
|
||||||
|
92,Biohacking / Longevity App,"biohacking, health, longevity, tracking, wellness, science",Biomimetic / Organic 2.0,"Minimalism, Dark Mode (OLED)",Data-Dense + Storytelling,Real-Time Monitor + Biological Data,Cellular Pink/Red + DNA Blue + Clean White,Personal data privacy. Scientific credibility. Biological visualizations.
|
||||||
|
93,Autonomous Drone Fleet Manager,"drone, autonomous, fleet, aerial, logistics, robotics",HUD / Sci-Fi FUI,"Real-Time Monitor, Spatial UI",Real-Time Monitor,Geographic + Real-Time,Tactical Green #00FF00 + Alert Red + Map Dark,Real-time telemetry. 3D spatial awareness. Latency indicators. Safety alerts.
|
||||||
|
94,Generative Art Platform,"art, generative, ai, creative, platform, gallery",Minimalism (Frame) + Gen Z Chaos,"Masonry Grid, Dark Mode",Bento Grid Showcase,Gallery / Portfolio,Neutral #F5F5F5 (Canvas) + User Content,Content is king. Fast loading. Creator attribution. Minting flow.
|
||||||
|
95,Spatial Computing OS / App,"spatial, vr, ar, vision, os, immersive, mixed-reality",Spatial UI (VisionOS),"Glassmorphism, 3D & Hyperrealism",Immersive/Interactive Experience,Spatial Dashboard,Frosted Glass + System Colors + Depth,Gaze/Pinch interaction. Depth hierarchy. Environment awareness.
|
||||||
|
96,Sustainable Energy / Climate Tech,"climate, energy, sustainable, green, tech, carbon",Organic Biophilic + E-Ink / Paper,"Data-Dense, Swiss Modernism",Interactive Demo + Data,Energy/Utilities Dashboard,Earth Green + Sky Blue + Solar Yellow,Data transparency. Impact visualization. Low-carbon web design.
|
||||||
|
|
|
@ -0,0 +1,24 @@
|
||||||
|
STT,Style Category,AI Prompt Keywords (Copy-Paste Ready),CSS/Technical Keywords,Implementation Checklist,Design System Variables
|
||||||
|
1,Minimalism & Swiss Style,"Design a minimalist landing page. Use: white space, geometric layouts, sans-serif fonts, high contrast, grid-based structure, essential elements only. Avoid shadows and gradients. Focus on clarity and functionality.","display: grid, gap: 2rem, font-family: sans-serif, color: #000 or #FFF, max-width: 1200px, clean borders, no box-shadow unless necessary","☐ Grid-based layout 12-16 columns, ☐ Typography hierarchy clear, ☐ No unnecessary decorations, ☐ WCAG AAA contrast verified, ☐ Mobile responsive grid","--spacing: 2rem, --border-radius: 0px, --font-weight: 400-700, --shadow: none, --accent-color: single primary only"
|
||||||
|
2,Neumorphism,"Create a neumorphic UI with soft 3D effects. Use light pastels, rounded corners (12-16px), subtle soft shadows (multiple layers), no hard lines, monochromatic color scheme with light/dark variations. Embossed/debossed effect on interactive elements.","border-radius: 12-16px, box-shadow: -5px -5px 15px rgba(0,0,0,0.1), 5px 5px 15px rgba(255,255,255,0.8), background: linear-gradient(145deg, color1, color2), transform: scale on press","☐ Rounded corners 12-16px consistent, ☐ Multiple shadow layers (2-3), ☐ Pastel color verified, ☐ Monochromatic palette checked, ☐ Press animation smooth 150ms","--border-radius: 14px, --shadow-soft-1: -5px -5px 15px, --shadow-soft-2: 5px 5px 15px, --color-light: #F5F5F5, --color-primary: single pastel"
|
||||||
|
3,Glassmorphism,"Design a glassmorphic interface with frosted glass effect. Use backdrop blur (10-20px), translucent overlays (rgba 10-30% opacity), vibrant background colors, subtle borders, light source reflection, layered depth. Perfect for modern overlays and cards.","backdrop-filter: blur(15px), background: rgba(255, 255, 255, 0.15), border: 1px solid rgba(255,255,255,0.2), -webkit-backdrop-filter: blur(15px), z-index layering for depth","☐ Backdrop-filter blur 10-20px, ☐ Translucent white 15-30% opacity, ☐ Subtle border 1px light, ☐ Vibrant background verified, ☐ Text contrast 4.5:1 checked","--blur-amount: 15px, --glass-opacity: 0.15, --border-color: rgba(255,255,255,0.2), --background: vibrant color, --text-color: light/dark based on BG"
|
||||||
|
4,Brutalism,"Create a brutalist design with raw, unpolished, stark aesthetic. Use pure primary colors (red, blue, yellow), black & white, no smooth transitions (instant), sharp corners, bold large typography, visible grid lines, default system fonts, intentional 'broken' design elements.","border-radius: 0px, transition: none or 0s, font-family: system-ui or monospace, font-weight: 700+, border: visible 2-4px, colors: #FF0000, #0000FF, #FFFF00, #000000, #FFFFFF","☐ No border-radius (0px), ☐ No transitions (instant), ☐ Bold typography (700+), ☐ Pure primary colors used, ☐ Visible grid/borders, ☐ Asymmetric layout intentional","--border-radius: 0px, --transition-duration: 0s, --font-weight: 700-900, --colors: primary only, --border-style: visible, --grid-visible: true"
|
||||||
|
5,3D & Hyperrealism,"Build an immersive 3D interface using realistic textures, 3D models (Three.js/Babylon.js), complex shadows, realistic lighting, parallax scrolling (3-5 layers), physics-based motion. Include skeuomorphic elements with tactile detail.","transform: translate3d, perspective: 1000px, WebGL canvas, Three.js/Babylon.js library, box-shadow: complex multi-layer, background: complex gradients, filter: drop-shadow()","☐ WebGL/Three.js integrated, ☐ 3D models loaded, ☐ Parallax 3-5 layers, ☐ Realistic lighting verified, ☐ Complex shadows rendered, ☐ Physics animation smooth 300-400ms","--perspective: 1000px, --parallax-layers: 5, --lighting-intensity: realistic, --shadow-depth: 20-40%, --animation-duration: 300-400ms"
|
||||||
|
6,Vibrant & Block-based,"Design an energetic, vibrant interface with bold block layouts, geometric shapes, high color contrast, large typography (32px+), animated background patterns, duotone effects. Perfect for startups and youth-focused apps. Use 4-6 contrasting colors from complementary/triadic schemes.","display: flex/grid with large gaps (48px+), font-size: 32px+, background: animated patterns (CSS), color: neon/vibrant colors, animation: continuous pattern movement","☐ Block layout with 48px+ gaps, ☐ Large typography 32px+, ☐ 4-6 vibrant colors max, ☐ Animated patterns active, ☐ Scroll-snap enabled, ☐ High contrast verified (7:1+)","--block-gap: 48px, --typography-size: 32px+, --color-palette: 4-6 vibrant colors, --animation: continuous pattern, --contrast-ratio: 7:1+"
|
||||||
|
7,Dark Mode (OLED),"Create an OLED-optimized dark interface with deep black (#000000), dark grey (#121212), midnight blue accents. Use minimal glow effects, vibrant neon accents (green, blue, gold, purple), high contrast text. Optimize for eye comfort and OLED power saving.","background: #000000 or #121212, color: #FFFFFF or #E0E0E0, text-shadow: 0 0 10px neon-color (sparingly), filter: brightness(0.8) if needed, color-scheme: dark","☐ Deep black #000000 or #121212, ☐ Vibrant neon accents used, ☐ Text contrast 7:1+, ☐ Minimal glow effects, ☐ OLED power optimization, ☐ No white (#FFFFFF) background","--bg-black: #000000, --bg-dark-grey: #121212, --text-primary: #FFFFFF, --accent-neon: neon colors, --glow-effect: minimal, --oled-optimized: true"
|
||||||
|
8,Accessible & Ethical,"Design with WCAG AAA compliance. Include: high contrast (7:1+), large text (16px+), keyboard navigation, screen reader compatibility, focus states visible (3-4px ring), semantic HTML, ARIA labels, skip links, reduced motion support (prefers-reduced-motion), 44x44px touch targets.","color-contrast: 7:1+, font-size: 16px+, outline: 3-4px on :focus-visible, aria-label, role attributes, @media (prefers-reduced-motion), touch-target: 44x44px, cursor: pointer","☐ WCAG AAA verified, ☐ 7:1+ contrast checked, ☐ Keyboard navigation tested, ☐ Screen reader tested, ☐ Focus visible 3-4px, ☐ Semantic HTML used, ☐ Touch targets 44x44px","--contrast-ratio: 7:1, --font-size-min: 16px, --focus-ring: 3-4px, --touch-target: 44x44px, --wcag-level: AAA, --keyboard-accessible: true, --sr-tested: true"
|
||||||
|
9,Claymorphism,"Design a playful, toy-like interface with soft 3D, chunky elements, bubbly aesthetic, rounded edges (16-24px), thick borders (3-4px), double shadows (inner + outer), pastel colors, smooth animations. Perfect for children's apps and creative tools.","border-radius: 16-24px, border: 3-4px solid, box-shadow: inset -2px -2px 8px, 4px 4px 8px, background: pastel-gradient, animation: soft bounce (cubic-bezier 0.34, 1.56)","☐ Border-radius 16-24px, ☐ Thick borders 3-4px, ☐ Double shadows (inner+outer), ☐ Pastel colors used, ☐ Soft bounce animations, ☐ Playful interactions","--border-radius: 20px, --border-width: 3-4px, --shadow-inner: inset -2px -2px 8px, --shadow-outer: 4px 4px 8px, --color-palette: pastels, --animation: bounce"
|
||||||
|
10,Aurora UI,"Create a vibrant gradient interface inspired by Northern Lights with mesh gradients, smooth color blends, flowing animations. Use complementary color pairs (blue-orange, purple-yellow), flowing background gradients, subtle continuous animations (8-12s loops), iridescent effects.","background: conic-gradient or radial-gradient with multiple stops, animation: @keyframes gradient (8-12s), background-size: 200% 200%, filter: saturate(1.2), blend-mode: screen or multiply","☐ Mesh/flowing gradients applied, ☐ 8-12s animation loop, ☐ Complementary colors used, ☐ Smooth color transitions, ☐ Iridescent effect subtle, ☐ Text contrast verified","--gradient-colors: complementary pairs, --animation-duration: 8-12s, --blend-mode: screen, --color-saturation: 1.2, --effect: iridescent, --loop-smooth: true"
|
||||||
|
11,Retro-Futurism,"Build a retro-futuristic (cyberpunk/vaporwave) interface with neon colors (blue, pink, cyan), deep black background, 80s aesthetic, CRT scanlines, glitch effects, neon glow text/borders, monospace fonts, geometric patterns. Use neon text-shadow and animated glitch effects.","color: neon colors (#0080FF, #FF006E, #00FFFF), text-shadow: 0 0 10px neon, background: #000 or #1A1A2E, font-family: monospace, animation: glitch (skew+offset), filter: hue-rotate","☐ Neon colors used, ☐ CRT scanlines effect, ☐ Glitch animations active, ☐ Monospace font, ☐ Deep black background, ☐ Glow effects applied, ☐ 80s patterns present","--neon-colors: #0080FF #FF006E #00FFFF, --background: #000000, --font-family: monospace, --effect: glitch+glow, --scanline-opacity: 0.3, --crt-effect: true"
|
||||||
|
12,Flat Design,"Create a flat, 2D interface with bold colors, no shadows/gradients, clean lines, simple geometric shapes, icon-heavy, typography-focused, minimal ornamentation. Use 4-6 solid, bright colors in a limited palette with high saturation.","box-shadow: none, background: solid color, border-radius: 0-4px, color: solid (no gradients), fill: solid, stroke: 1-2px, font: bold sans-serif, icons: simplified SVG","☐ No shadows/gradients, ☐ 4-6 solid colors max, ☐ Clean lines consistent, ☐ Simple shapes used, ☐ Icon-heavy layout, ☐ High saturation colors, ☐ Fast loading verified","--shadow: none, --color-palette: 4-6 solid, --border-radius: 2px, --gradient: none, --icons: simplified SVG, --animation: minimal 150-200ms"
|
||||||
|
13,Skeuomorphism,"Design a realistic, textured interface with 3D depth, real-world metaphors (leather, wood, metal), complex gradients (8-12 stops), realistic shadows, grain/texture overlays, tactile press animations. Perfect for premium/luxury products.","background: complex gradient (8-12 stops), box-shadow: realistic multi-layer, background-image: texture overlay (noise, grain), filter: drop-shadow, transform: scale on press (300-500ms)","☐ Realistic textures applied, ☐ Complex gradients 8-12 stops, ☐ Multi-layer shadows, ☐ Texture overlays present, ☐ Tactile animations smooth, ☐ Depth effect pronounced","--gradient-stops: 8-12, --texture-overlay: noise+grain, --shadow-layers: 3+, --animation-duration: 300-500ms, --depth-effect: pronounced, --tactile: true"
|
||||||
|
14,Liquid Glass,"Create a premium liquid glass effect with morphing shapes, flowing animations, chromatic aberration, iridescent gradients, smooth 400-600ms transitions. Use SVG morphing for shape changes, dynamic blur, smooth color transitions creating a fluid, premium feel.","animation: morphing SVG paths (400-600ms), backdrop-filter: blur + saturate, filter: hue-rotate + brightness, blend-mode: screen, background: iridescent gradient","☐ Morphing animations 400-600ms, ☐ Chromatic aberration applied, ☐ Dynamic blur active, ☐ Iridescent gradients, ☐ Smooth color transitions, ☐ Premium feel achieved","--morph-duration: 400-600ms, --blur-amount: 15px, --chromatic-aberration: true, --iridescent: true, --blend-mode: screen, --smooth-transitions: true"
|
||||||
|
15,Motion-Driven,"Build an animation-heavy interface with scroll-triggered animations, microinteractions, parallax scrolling (3-5 layers), smooth transitions (300-400ms), entrance animations, page transitions. Use Intersection Observer for scroll effects, transform for performance, GPU acceleration.","animation: @keyframes scroll-reveal, transform: translateY/X, Intersection Observer API, will-change: transform, scroll-behavior: smooth, animation-duration: 300-400ms","☐ Scroll animations active, ☐ Parallax 3-5 layers, ☐ Entrance animations smooth, ☐ Page transitions fluid, ☐ GPU accelerated, ☐ Prefers-reduced-motion respected","--animation-duration: 300-400ms, --parallax-layers: 5, --scroll-behavior: smooth, --gpu-accelerated: true, --entrance-animation: true, --page-transition: smooth"
|
||||||
|
16,Micro-interactions,"Design with delightful micro-interactions: small 50-100ms animations, gesture-based responses, tactile feedback, loading spinners, success/error states, subtle hover effects, haptic feedback triggers for mobile. Focus on responsive, contextual interactions.","animation: short 50-100ms, transition: hover states, @media (hover: hover) for desktop, :active for press, haptic-feedback CSS/API, loading animation smooth loop","☐ Micro-animations 50-100ms, ☐ Gesture-responsive, ☐ Tactile feedback visual/haptic, ☐ Loading spinners smooth, ☐ Success/error states clear, ☐ Hover effects subtle","--micro-animation-duration: 50-100ms, --gesture-responsive: true, --haptic-feedback: true, --loading-animation: smooth, --state-feedback: success+error"
|
||||||
|
17,Inclusive Design,"Design for universal accessibility: high contrast (7:1+), large text (16px+), keyboard-only navigation, screen reader optimization, WCAG AAA compliance, symbol-based color indicators (not color-only), haptic feedback, voice interaction support, reduced motion options.","aria-* attributes complete, role attributes semantic, focus-visible: 3-4px ring, color-contrast: 7:1+, @media (prefers-reduced-motion), alt text on all images, form labels properly associated","☐ WCAG AAA verified, ☐ 7:1+ contrast all text, ☐ Keyboard accessible (Tab/Enter), ☐ Screen reader tested, ☐ Focus visible 3-4px, ☐ No color-only indicators, ☐ Haptic fallback","--contrast-ratio: 7:1, --font-size: 16px+, --keyboard-accessible: true, --sr-compatible: true, --wcag-level: AAA, --color-symbols: true, --haptic: enabled"
|
||||||
|
18,Zero Interface,"Create a voice-first, gesture-based, AI-driven interface with minimal visible UI, progressive disclosure, voice recognition UI, gesture detection, AI predictions, smart suggestions, context-aware actions. Hide controls until needed.","voice-commands: Web Speech API, gesture-detection: touch events, AI-predictions: hidden by default (reveal on hover), progressive-disclosure: show on demand, minimal UI visible","☐ Voice commands responsive, ☐ Gesture detection active, ☐ AI predictions hidden/revealed, ☐ Progressive disclosure working, ☐ Minimal visible UI, ☐ Smart suggestions contextual","--voice-ui: enabled, --gesture-detection: active, --ai-predictions: smart, --progressive-disclosure: true, --visible-ui: minimal, --context-aware: true"
|
||||||
|
19,Soft UI Evolution,"Design evolved neumorphism with improved contrast (WCAG AA+), modern aesthetics, subtle depth, accessibility focus. Use soft shadows (softer than flat but clearer than pure neumorphism), better color hierarchy, improved focus states, modern 200-300ms animations.","box-shadow: softer multi-layer (0 2px 4px), background: improved contrast pastels, border-radius: 8-12px, animation: 200-300ms smooth, outline: 2-3px on focus, contrast: 4.5:1+","☐ Improved contrast AA/AAA, ☐ Soft shadows modern, ☐ Border-radius 8-12px, ☐ Animations 200-300ms, ☐ Focus states visible, ☐ Color hierarchy clear","--shadow-soft: modern blend, --border-radius: 10px, --animation-duration: 200-300ms, --contrast-ratio: 4.5:1+, --color-hierarchy: improved, --wcag-level: AA+"
|
||||||
|
20,Bento Grids,"Design a Bento Grid layout. Use: modular grid system, rounded corners (16-24px), different card sizes (1x1, 2x1, 2x2), card-based hierarchy, soft backgrounds (#F5F5F7), subtle borders, content-first, Apple-style aesthetic.","display: grid, grid-template-columns: repeat(auto-fit, minmax(...)), gap: 1rem, border-radius: 20px, background: #FFF, box-shadow: subtle","☐ Grid layout (CSS Grid), ☐ Rounded corners 16-24px, ☐ Varied card spans, ☐ Content fits card size, ☐ Responsive re-flow, ☐ Apple-like aesthetic","--grid-gap: 20px, --card-radius: 24px, --card-bg: #FFFFFF, --page-bg: #F5F5F7, --shadow: soft"
|
||||||
|
21,Neubrutalism,"Design a neubrutalist interface. Use: high contrast, hard black borders (3px+), bright pop colors, no blur, sharp or slightly rounded corners, bold typography, hard shadows (offset 4px 4px), raw aesthetic but functional.","border: 3px solid black, box-shadow: 5px 5px 0px black, colors: #FFDB58 #FF6B6B #4ECDC4, font-weight: 700, no gradients","☐ Hard borders (2-4px), ☐ Hard offset shadows, ☐ High saturation colors, ☐ Bold typography, ☐ No blurs/gradients, ☐ Distinctive 'ugly-cute' look","--border-width: 3px, --shadow-offset: 4px, --shadow-color: #000, --colors: high saturation, --font: bold sans"
|
||||||
|
22,HUD / Sci-Fi FUI,"Design a futuristic HUD (Heads Up Display) or FUI. Use: thin lines (1px), neon cyan/blue on black, technical markers, decorative brackets, data visualization, monospaced tech fonts, glowing elements, transparency.","border: 1px solid rgba(0,255,255,0.5), color: #00FFFF, background: transparent or rgba(0,0,0,0.8), font-family: monospace, text-shadow: 0 0 5px cyan","☐ Fine lines 1px, ☐ Neon glow text/borders, ☐ Monospaced font, ☐ Dark/Transparent BG, ☐ Decorative tech markers, ☐ Holographic feel","--hud-color: #00FFFF, --bg-color: rgba(0,10,20,0.9), --line-width: 1px, --glow: 0 0 5px, --font: monospace"
|
||||||
|
23,Pixel Art,"Design a pixel art inspired interface. Use: pixelated fonts, 8-bit or 16-bit aesthetic, sharp edges (image-rendering: pixelated), limited color palette, blocky UI elements, retro gaming feel.","font-family: 'Press Start 2P', image-rendering: pixelated, box-shadow: 4px 0 0 #000 (pixel border), no anti-aliasing","☐ Pixelated fonts loaded, ☐ Images sharp (no blur), ☐ CSS box-shadow for pixel borders, ☐ Retro palette, ☐ Blocky layout","--pixel-size: 4px, --font: pixel font, --border-style: pixel-shadow, --anti-alias: none"
|
||||||
|
|
|
@ -0,0 +1,53 @@
|
||||||
|
No,Category,Guideline,Description,Do,Don't,Code Good,Code Bad,Severity,Docs URL
|
||||||
|
1,Widgets,Use StatelessWidget when possible,Immutable widgets are simpler,StatelessWidget for static UI,StatefulWidget for everything,class MyWidget extends StatelessWidget,class MyWidget extends StatefulWidget (static),Medium,https://api.flutter.dev/flutter/widgets/StatelessWidget-class.html
|
||||||
|
2,Widgets,Keep widgets small,Single responsibility principle,Extract widgets into smaller pieces,Large build methods,Column(children: [Header() Content()]),500+ line build method,Medium,
|
||||||
|
3,Widgets,Use const constructors,Compile-time constants for performance,const MyWidget() when possible,Non-const for static widgets,const Text('Hello'),Text('Hello') for literals,High,https://dart.dev/guides/language/language-tour#constant-constructors
|
||||||
|
4,Widgets,Prefer composition over inheritance,Combine widgets using children,Compose widgets,Extend widget classes,Container(child: MyContent()),class MyContainer extends Container,Medium,
|
||||||
|
5,State,Use setState correctly,Minimal state in StatefulWidget,setState for UI state changes,setState for business logic,setState(() { _counter++; }),Complex logic in setState,Medium,https://api.flutter.dev/flutter/widgets/State/setState.html
|
||||||
|
6,State,Avoid setState in build,Never call setState during build,setState in callbacks only,setState in build method,onPressed: () => setState(() {}),build() { setState(); },High,
|
||||||
|
7,State,Use state management for complex apps,Provider Riverpod BLoC,State management for shared state,setState for global state,Provider.of<MyState>(context),Global setState calls,Medium,
|
||||||
|
8,State,Prefer Riverpod or Provider,Recommended state solutions,Riverpod for new projects,InheritedWidget manually,ref.watch(myProvider),Custom InheritedWidget,Medium,https://riverpod.dev/
|
||||||
|
9,State,Dispose resources,Clean up controllers and subscriptions,dispose() for cleanup,Memory leaks from subscriptions,@override void dispose() { controller.dispose(); },No dispose implementation,High,
|
||||||
|
10,Layout,Use Column and Row,Basic layout widgets,Column Row for linear layouts,Stack for simple layouts,"Column(children: [Text(), Button()])",Stack for vertical list,Medium,https://api.flutter.dev/flutter/widgets/Column-class.html
|
||||||
|
11,Layout,Use Expanded and Flexible,Control flex behavior,Expanded to fill space,Fixed sizes in flex containers,Expanded(child: Container()),Container(width: 200) in Row,Medium,
|
||||||
|
12,Layout,Use SizedBox for spacing,Consistent spacing,SizedBox for gaps,Container for spacing only,SizedBox(height: 16),Container(height: 16),Low,
|
||||||
|
13,Layout,Use LayoutBuilder for responsive,Respond to constraints,LayoutBuilder for adaptive layouts,Fixed sizes for responsive,LayoutBuilder(builder: (context constraints) {}),Container(width: 375),Medium,https://api.flutter.dev/flutter/widgets/LayoutBuilder-class.html
|
||||||
|
14,Layout,Avoid deep nesting,Keep widget tree shallow,Extract deeply nested widgets,10+ levels of nesting,Extract widget to method or class,Column(Row(Column(Row(...)))),Medium,
|
||||||
|
15,Lists,Use ListView.builder,Lazy list building,ListView.builder for long lists,ListView with children for large lists,"ListView.builder(itemCount: 100, itemBuilder: ...)",ListView(children: items.map(...).toList()),High,https://api.flutter.dev/flutter/widgets/ListView-class.html
|
||||||
|
16,Lists,Provide itemExtent when known,Skip measurement,itemExtent for fixed height items,No itemExtent for uniform lists,ListView.builder(itemExtent: 50),ListView.builder without itemExtent,Medium,
|
||||||
|
17,Lists,Use keys for stateful items,Preserve widget state,Key for stateful list items,No key for dynamic lists,ListTile(key: ValueKey(item.id)),ListTile without key,High,
|
||||||
|
18,Lists,Use SliverList for custom scroll,Custom scroll effects,CustomScrollView with Slivers,Nested ListViews,CustomScrollView(slivers: [SliverList()]),ListView inside ListView,Medium,https://api.flutter.dev/flutter/widgets/SliverList-class.html
|
||||||
|
19,Navigation,Use Navigator 2.0 or GoRouter,Declarative routing,go_router for navigation,Navigator.push for complex apps,GoRouter(routes: [...]),Navigator.push everywhere,Medium,https://pub.dev/packages/go_router
|
||||||
|
20,Navigation,Use named routes,Organized navigation,Named routes for clarity,Anonymous routes,Navigator.pushNamed(context '/home'),Navigator.push(context MaterialPageRoute()),Low,
|
||||||
|
21,Navigation,Handle back button (PopScope),Android back behavior and predictive back (Android 14+),Use PopScope widget (WillPopScope is deprecated),Use WillPopScope,"PopScope(canPop: false, onPopInvoked: (didPop) => ...)",WillPopScope(onWillPop: ...),High,https://api.flutter.dev/flutter/widgets/PopScope-class.html
|
||||||
|
22,Navigation,Pass typed arguments,Type-safe route arguments,Typed route arguments,Dynamic arguments,MyRoute(id: '123'),arguments: {'id': '123'},Medium,
|
||||||
|
23,Async,Use FutureBuilder,Async UI building,FutureBuilder for async data,setState for async,FutureBuilder(future: fetchData()),fetchData().then((d) => setState()),Medium,https://api.flutter.dev/flutter/widgets/FutureBuilder-class.html
|
||||||
|
24,Async,Use StreamBuilder,Stream UI building,StreamBuilder for streams,Manual stream subscription,StreamBuilder(stream: myStream),stream.listen in initState,Medium,https://api.flutter.dev/flutter/widgets/StreamBuilder-class.html
|
||||||
|
25,Async,Handle loading and error states,Complete async UI states,ConnectionState checks,Only success state,if (snapshot.connectionState == ConnectionState.waiting),No loading indicator,High,
|
||||||
|
26,Async,Cancel subscriptions,Clean up stream subscriptions,Cancel in dispose,Memory leaks,subscription.cancel() in dispose,No subscription cleanup,High,
|
||||||
|
27,Theming,Use ThemeData,Consistent theming,ThemeData for app theme,Hardcoded colors,Theme.of(context).primaryColor,Color(0xFF123456) everywhere,Medium,https://api.flutter.dev/flutter/material/ThemeData-class.html
|
||||||
|
28,Theming,Use ColorScheme,Material 3 color system,ColorScheme for colors,Individual color properties,colorScheme: ColorScheme.fromSeed(),primaryColor: Colors.blue,Medium,
|
||||||
|
29,Theming,Access theme via context,Dynamic theme access,Theme.of(context),Static theme reference,Theme.of(context).textTheme.bodyLarge,TextStyle(fontSize: 16),Medium,
|
||||||
|
30,Theming,Support dark mode,Respect system theme,darkTheme in MaterialApp,Light theme only,"MaterialApp(theme: light, darkTheme: dark)",MaterialApp(theme: light),Medium,
|
||||||
|
31,Animation,Use implicit animations,Simple animations,AnimatedContainer AnimatedOpacity,Explicit for simple transitions,AnimatedContainer(duration: Duration()),AnimationController for fade,Low,https://api.flutter.dev/flutter/widgets/AnimatedContainer-class.html
|
||||||
|
32,Animation,Use AnimationController for complex,Fine-grained control,AnimationController with Ticker,Implicit for complex sequences,AnimationController(vsync: this),AnimatedContainer for staggered,Medium,
|
||||||
|
33,Animation,Dispose AnimationControllers,Clean up animation resources,dispose() for controllers,Memory leaks,controller.dispose() in dispose,No controller disposal,High,
|
||||||
|
34,Animation,Use Hero for transitions,Shared element transitions,Hero for navigation animations,Manual shared element,Hero(tag: 'image' child: Image()),Custom shared element animation,Low,https://api.flutter.dev/flutter/widgets/Hero-class.html
|
||||||
|
35,Forms,Use Form widget,Form validation,Form with GlobalKey,Individual validation,Form(key: _formKey child: ...),TextField without Form,Medium,https://api.flutter.dev/flutter/widgets/Form-class.html
|
||||||
|
36,Forms,Use TextEditingController,Control text input,Controller for text fields,onChanged for all text,final controller = TextEditingController(),onChanged: (v) => setState(),Medium,
|
||||||
|
37,Forms,Validate on submit,Form validation flow,_formKey.currentState!.validate(),Skip validation,if (_formKey.currentState!.validate()),Submit without validation,High,
|
||||||
|
38,Forms,Dispose controllers,Clean up text controllers,dispose() for controllers,Memory leaks,controller.dispose() in dispose,No controller disposal,High,
|
||||||
|
39,Performance,Use const widgets,Reduce rebuilds,const for static widgets,No const for literals,const Icon(Icons.add),Icon(Icons.add),High,
|
||||||
|
40,Performance,Avoid rebuilding entire tree,Minimal rebuild scope,Isolate changing widgets,setState on parent,Consumer only around changing widget,setState on root widget,High,
|
||||||
|
41,Performance,Use RepaintBoundary,Isolate repaints,RepaintBoundary for animations,Full screen repaints,RepaintBoundary(child: AnimatedWidget()),Animation without boundary,Medium,https://api.flutter.dev/flutter/widgets/RepaintBoundary-class.html
|
||||||
|
42,Performance,Profile with DevTools,Measure before optimizing,Flutter DevTools profiling,Guess at performance,DevTools performance tab,Optimize without measuring,Medium,https://docs.flutter.dev/tools/devtools
|
||||||
|
43,Accessibility,Use Semantics widget,Screen reader support,Semantics for accessibility,Missing accessibility info,Semantics(label: 'Submit button'),GestureDetector without semantics,High,https://api.flutter.dev/flutter/widgets/Semantics-class.html
|
||||||
|
44,Accessibility,Support large fonts,MediaQuery text scaling,MediaQuery.textScaleFactor,Fixed font sizes,style: Theme.of(context).textTheme,TextStyle(fontSize: 14),High,
|
||||||
|
45,Accessibility,Test with screen readers,TalkBack and VoiceOver,Test accessibility regularly,Skip accessibility testing,Regular TalkBack testing,No screen reader testing,High,
|
||||||
|
46,Testing,Use widget tests,Test widget behavior,WidgetTester for UI tests,Unit tests only,testWidgets('...' (tester) async {}),Only test() for UI,Medium,https://docs.flutter.dev/testing
|
||||||
|
47,Testing,Use integration tests,Full app testing,integration_test package,Manual testing only,IntegrationTestWidgetsFlutterBinding,Manual E2E testing,Medium,
|
||||||
|
48,Testing,Mock dependencies,Isolate tests,Mockito or mocktail,Real dependencies in tests,when(mock.method()).thenReturn(),Real API calls in tests,Medium,
|
||||||
|
49,Platform,Use Platform checks,Platform-specific code,Platform.isIOS Platform.isAndroid,Same code for all platforms,if (Platform.isIOS) {},Hardcoded iOS behavior,Medium,
|
||||||
|
50,Platform,Use kIsWeb for web,Web platform detection,kIsWeb for web checks,Platform for web,if (kIsWeb) {},Platform.isWeb (doesn't exist),Medium,
|
||||||
|
51,Packages,Use pub.dev packages,Community packages,Popular maintained packages,Custom implementations,cached_network_image,Custom image cache,Medium,https://pub.dev/
|
||||||
|
52,Packages,Check package quality,Quality before adding,Pub points and popularity,Any package without review,100+ pub points,Unmaintained packages,Medium,
|
||||||
|
|
|
@ -0,0 +1,56 @@
|
||||||
|
No,Category,Guideline,Description,Do,Don't,Code Good,Code Bad,Severity,Docs URL
|
||||||
|
1,Animation,Use Tailwind animate utilities,Built-in animations are optimized and respect reduced-motion,Use animate-pulse animate-spin animate-ping,Custom @keyframes for simple effects,animate-pulse,@keyframes pulse {...},Medium,https://tailwindcss.com/docs/animation
|
||||||
|
2,Animation,Limit bounce animations,Continuous bounce is distracting and causes motion sickness,Use animate-bounce sparingly on CTAs only,Multiple bounce animations on page,Single CTA with animate-bounce,5+ elements with animate-bounce,High,
|
||||||
|
3,Animation,Transition duration,Use appropriate transition speeds for UI feedback,duration-150 to duration-300 for UI,duration-1000 or longer for UI elements,transition-all duration-200,transition-all duration-1000,Medium,https://tailwindcss.com/docs/transition-duration
|
||||||
|
4,Animation,Hover transitions,Add smooth transitions on hover state changes,Add transition class with hover states,Instant hover changes without transition,hover:bg-gray-100 transition-colors,hover:bg-gray-100 (no transition),Low,
|
||||||
|
5,Z-Index,Use Tailwind z-* scale,Consistent stacking context with predefined scale,z-0 z-10 z-20 z-30 z-40 z-50,Arbitrary z-index values,z-50 for modals,z-[9999],Medium,https://tailwindcss.com/docs/z-index
|
||||||
|
6,Z-Index,Fixed elements z-index,Fixed navigation and modals need explicit z-index,z-50 for nav z-40 for dropdowns,Relying on DOM order for stacking,fixed top-0 z-50,fixed top-0 (no z-index),High,
|
||||||
|
7,Z-Index,Negative z-index for backgrounds,Use negative z-index for decorative backgrounds,z-[-1] for background elements,Positive z-index for backgrounds,-z-10 for decorative,z-10 for background,Low,
|
||||||
|
8,Layout,Container max-width,Limit content width for readability,max-w-7xl mx-auto for main content,Full-width content on large screens,max-w-7xl mx-auto px-4,w-full (no max-width),Medium,https://tailwindcss.com/docs/container
|
||||||
|
9,Layout,Responsive padding,Adjust padding for different screen sizes,px-4 md:px-6 lg:px-8,Same padding all sizes,px-4 sm:px-6 lg:px-8,px-8 (same all sizes),Medium,
|
||||||
|
10,Layout,Grid gaps,Use consistent gap utilities for spacing,gap-4 gap-6 gap-8,Margins on individual items,grid gap-6,grid with mb-4 on each item,Medium,https://tailwindcss.com/docs/gap
|
||||||
|
11,Layout,Flexbox alignment,Use flex utilities for alignment,items-center justify-between,Multiple nested wrappers,flex items-center justify-between,Nested divs for alignment,Low,
|
||||||
|
12,Images,Aspect ratio,Maintain consistent image aspect ratios,aspect-video aspect-square,No aspect ratio on containers,aspect-video rounded-lg,No aspect control,Medium,https://tailwindcss.com/docs/aspect-ratio
|
||||||
|
13,Images,Object fit,Control image scaling within containers,object-cover object-contain,Stretched distorted images,object-cover w-full h-full,No object-fit,Medium,https://tailwindcss.com/docs/object-fit
|
||||||
|
14,Images,Lazy loading,Defer loading of off-screen images,loading='lazy' on images,All images eager load,<img loading='lazy'>,<img> without lazy,High,
|
||||||
|
15,Images,Responsive images,Serve appropriate image sizes,srcset and sizes attributes,Same large image all devices,srcset with multiple sizes,4000px image everywhere,High,
|
||||||
|
16,Typography,Prose plugin,Use @tailwindcss/typography for rich text,prose prose-lg for article content,Custom styles for markdown,prose prose-lg max-w-none,Custom text styling,Medium,https://tailwindcss.com/docs/typography-plugin
|
||||||
|
17,Typography,Line height,Use appropriate line height for readability,leading-relaxed for body text,Default tight line height,leading-relaxed (1.625),leading-none or leading-tight,Medium,https://tailwindcss.com/docs/line-height
|
||||||
|
18,Typography,Font size scale,Use consistent text size scale,text-sm text-base text-lg text-xl,Arbitrary font sizes,text-lg,text-[17px],Low,https://tailwindcss.com/docs/font-size
|
||||||
|
19,Typography,Text truncation,Handle long text gracefully,truncate or line-clamp-*,Overflow breaking layout,line-clamp-2,No overflow handling,Medium,https://tailwindcss.com/docs/text-overflow
|
||||||
|
20,Colors,Opacity utilities,Use color opacity utilities,bg-black/50 text-white/80,Separate opacity class,bg-black/50,bg-black opacity-50,Low,https://tailwindcss.com/docs/background-color
|
||||||
|
21,Colors,Dark mode,Support dark mode with dark: prefix,dark:bg-gray-900 dark:text-white,No dark mode support,dark:bg-gray-900,Only light theme,Medium,https://tailwindcss.com/docs/dark-mode
|
||||||
|
22,Colors,Semantic colors,Use semantic color naming in config,primary secondary danger success,Generic color names in components,bg-primary,bg-blue-500 everywhere,Medium,
|
||||||
|
23,Spacing,Consistent spacing scale,Use Tailwind spacing scale consistently,p-4 m-6 gap-8,Arbitrary pixel values,p-4 (1rem),p-[15px],Low,https://tailwindcss.com/docs/customizing-spacing
|
||||||
|
24,Spacing,Negative margins,Use sparingly for overlapping effects,-mt-4 for overlapping elements,Negative margins for layout fixing,-mt-8 for card overlap,-m-2 to fix spacing issues,Medium,
|
||||||
|
25,Spacing,Space between,Use space-y-* for vertical lists,space-y-4 on flex/grid column,Margin on each child,space-y-4,Each child has mb-4,Low,https://tailwindcss.com/docs/space
|
||||||
|
26,Forms,Focus states,Always show focus indicators,focus:ring-2 focus:ring-blue-500,Remove focus outline,focus:ring-2 focus:ring-offset-2,focus:outline-none (no replacement),High,
|
||||||
|
27,Forms,Input sizing,Consistent input dimensions,h-10 px-3 for inputs,Inconsistent input heights,h-10 w-full px-3,Various heights per input,Medium,
|
||||||
|
28,Forms,Disabled states,Clear disabled styling,disabled:opacity-50 disabled:cursor-not-allowed,No disabled indication,disabled:opacity-50,Same style as enabled,Medium,
|
||||||
|
29,Forms,Placeholder styling,Style placeholder text appropriately,placeholder:text-gray-400,Dark placeholder text,placeholder:text-gray-400,Default dark placeholder,Low,
|
||||||
|
30,Responsive,Mobile-first approach,Start with mobile styles and add breakpoints,Default mobile + md: lg: xl:,Desktop-first approach,text-sm md:text-base,text-base max-md:text-sm,Medium,https://tailwindcss.com/docs/responsive-design
|
||||||
|
31,Responsive,Breakpoint testing,Test at standard breakpoints,320 375 768 1024 1280 1536,Only test on development device,Test all breakpoints,Single device testing,High,
|
||||||
|
32,Responsive,Hidden/shown utilities,Control visibility per breakpoint,hidden md:block,Different content per breakpoint,hidden md:flex,Separate mobile/desktop components,Low,https://tailwindcss.com/docs/display
|
||||||
|
33,Buttons,Button sizing,Consistent button dimensions,px-4 py-2 or px-6 py-3,Inconsistent button sizes,px-4 py-2 text-sm,Various padding per button,Medium,
|
||||||
|
34,Buttons,Touch targets,Minimum 44px touch target on mobile,min-h-[44px] on mobile,Small buttons on mobile,min-h-[44px] min-w-[44px],h-8 w-8 on mobile,High,
|
||||||
|
35,Buttons,Loading states,Show loading feedback,disabled + spinner icon,Clickable during loading,<Button disabled><Spinner/></Button>,Button without loading state,High,
|
||||||
|
36,Buttons,Icon buttons,Accessible icon-only buttons,aria-label on icon buttons,Icon button without label,<button aria-label='Close'><XIcon/></button>,<button><XIcon/></button>,High,
|
||||||
|
37,Cards,Card structure,Consistent card styling,rounded-lg shadow-md p-6,Inconsistent card styles,rounded-2xl shadow-lg p-6,Mixed card styling,Low,
|
||||||
|
38,Cards,Card hover states,Interactive cards should have hover feedback,hover:shadow-lg transition-shadow,No hover on clickable cards,hover:shadow-xl transition-shadow,Static cards that are clickable,Medium,
|
||||||
|
39,Cards,Card spacing,Consistent internal card spacing,space-y-4 for card content,Inconsistent internal spacing,space-y-4 or p-6,Mixed mb-2 mb-4 mb-6,Low,
|
||||||
|
40,Accessibility,Screen reader text,Provide context for screen readers,sr-only for hidden labels,Missing context for icons,<span class='sr-only'>Close menu</span>,No label for icon button,High,https://tailwindcss.com/docs/screen-readers
|
||||||
|
41,Accessibility,Focus visible,Show focus only for keyboard users,focus-visible:ring-2,Focus on all interactions,focus-visible:ring-2,focus:ring-2 (shows on click too),Medium,
|
||||||
|
42,Accessibility,Reduced motion,Respect user motion preferences,motion-reduce:animate-none,Ignore motion preferences,motion-reduce:transition-none,No reduced motion support,High,https://tailwindcss.com/docs/hover-focus-and-other-states#prefers-reduced-motion
|
||||||
|
43,Performance,Configure content paths,Tailwind needs to know where classes are used,Use 'content' array in config,Use deprecated 'purge' option (v2),"content: ['./src/**/*.{js,ts,jsx,tsx}']",purge: [...],High,https://tailwindcss.com/docs/content-configuration
|
||||||
|
44,Performance,JIT mode,Use JIT for faster builds and smaller bundles,JIT enabled (default in v3),Full CSS in development,Tailwind v3 defaults,Tailwind v2 without JIT,Medium,
|
||||||
|
45,Performance,Avoid @apply bloat,Use @apply sparingly,Direct utilities in HTML,Heavy @apply usage,class='px-4 py-2 rounded',@apply px-4 py-2 rounded;,Low,https://tailwindcss.com/docs/reusing-styles
|
||||||
|
46,Plugins,Official plugins,Use official Tailwind plugins,@tailwindcss/forms typography aspect-ratio,Custom implementations,@tailwindcss/forms,Custom form reset CSS,Medium,https://tailwindcss.com/docs/plugins
|
||||||
|
47,Plugins,Custom utilities,Create utilities for repeated patterns,Custom utility in config,Repeated arbitrary values,Custom shadow utility,"shadow-[0_4px_20px_rgba(0,0,0,0.1)] everywhere",Medium,
|
||||||
|
48,Layout,Container Queries,Use @container for component-based responsiveness,Use @container and @lg: etc.,Media queries for component internals,@container @lg:grid-cols-2,@media (min-width: ...) inside component,Medium,https://github.com/tailwindlabs/tailwindcss-container-queries
|
||||||
|
49,Interactivity,Group and Peer,Style based on parent/sibling state,group-hover peer-checked,JS for simple state interactions,group-hover:text-blue-500,onMouseEnter={() => setHover(true)},Low,https://tailwindcss.com/docs/hover-focus-and-other-states#styling-based-on-parent-state
|
||||||
|
50,Customization,Arbitrary Values,Use [] for one-off values,w-[350px] for specific needs,Creating config for single use,top-[117px] (if strictly needed),style={{ top: '117px' }},Low,https://tailwindcss.com/docs/adding-custom-styles#using-arbitrary-values
|
||||||
|
51,Colors,Theme color variables,Define colors in Tailwind theme and use directly,bg-primary text-success border-cta,bg-[var(--color-primary)] text-[var(--color-success)],bg-primary,bg-[var(--color-primary)],Medium,https://tailwindcss.com/docs/customizing-colors
|
||||||
|
52,Colors,Use bg-linear-to-* for gradients,Tailwind v4 uses bg-linear-to-* syntax for gradients,bg-linear-to-r bg-linear-to-b,bg-gradient-to-* (deprecated in v4),bg-linear-to-r from-blue-500 to-purple-500,bg-gradient-to-r from-blue-500 to-purple-500,Medium,https://tailwindcss.com/docs/background-image
|
||||||
|
53,Layout,Use shrink-0 shorthand,Shorter class name for flex-shrink-0,shrink-0 shrink,flex-shrink-0 flex-shrink,shrink-0,flex-shrink-0,Low,https://tailwindcss.com/docs/flex-shrink
|
||||||
|
54,Layout,Use size-* for square dimensions,Single utility for equal width and height,size-4 size-8 size-12,Separate h-* w-* for squares,size-6,h-6 w-6,Low,https://tailwindcss.com/docs/size
|
||||||
|
55,Images,SVG explicit dimensions,Add width/height attributes to SVGs to prevent layout shift before CSS loads,<svg class='size-6' width='24' height='24'>,SVG without explicit dimensions,<svg class='size-6' width='24' height='24'>,<svg class='size-6'>,High,
|
||||||
|
|
|
@ -0,0 +1,53 @@
|
||||||
|
No,Category,Guideline,Description,Do,Don't,Code Good,Code Bad,Severity,Docs URL
|
||||||
|
1,Routing,Use App Router for new projects,App Router is the recommended approach in Next.js 14+,app/ directory with page.tsx,pages/ for new projects,app/dashboard/page.tsx,pages/dashboard.tsx,Medium,https://nextjs.org/docs/app
|
||||||
|
2,Routing,Use file-based routing,Create routes by adding files in app directory,page.tsx for routes layout.tsx for layouts,Manual route configuration,app/blog/[slug]/page.tsx,Custom router setup,Medium,https://nextjs.org/docs/app/building-your-application/routing
|
||||||
|
3,Routing,Colocate related files,Keep components styles tests with their routes,Component files alongside page.tsx,Separate components folder,app/dashboard/_components/,components/dashboard/,Low,
|
||||||
|
4,Routing,Use route groups for organization,Group routes without affecting URL,Parentheses for route groups,Nested folders affecting URL,(marketing)/about/page.tsx,marketing/about/page.tsx,Low,https://nextjs.org/docs/app/building-your-application/routing/route-groups
|
||||||
|
5,Routing,Handle loading states,Use loading.tsx for route loading UI,loading.tsx alongside page.tsx,Manual loading state management,app/dashboard/loading.tsx,useState for loading in page,Medium,https://nextjs.org/docs/app/building-your-application/routing/loading-ui-and-streaming
|
||||||
|
6,Routing,Handle errors with error.tsx,Catch errors at route level,error.tsx with reset function,try/catch in every component,app/dashboard/error.tsx,try/catch in page component,High,https://nextjs.org/docs/app/building-your-application/routing/error-handling
|
||||||
|
7,Rendering,Use Server Components by default,Server Components reduce client JS bundle,Keep components server by default,Add 'use client' unnecessarily,export default function Page(),('use client') for static content,High,https://nextjs.org/docs/app/building-your-application/rendering/server-components
|
||||||
|
8,Rendering,Mark Client Components explicitly,'use client' for interactive components,Add 'use client' only when needed,Server Component with hooks/events,('use client') for onClick useState,No directive with useState,High,https://nextjs.org/docs/app/building-your-application/rendering/client-components
|
||||||
|
9,Rendering,Push Client Components down,Keep Client Components as leaf nodes,Client wrapper for interactive parts only,Mark page as Client Component,<InteractiveButton/> in Server Page,('use client') on page.tsx,High,
|
||||||
|
10,Rendering,Use streaming for better UX,Stream content with Suspense boundaries,Suspense for slow data fetches,Wait for all data before render,<Suspense><SlowComponent/></Suspense>,await allData then render,Medium,https://nextjs.org/docs/app/building-your-application/routing/loading-ui-and-streaming
|
||||||
|
11,Rendering,Choose correct rendering strategy,SSG for static SSR for dynamic ISR for semi-static,generateStaticParams for known paths,SSR for static content,export const revalidate = 3600,fetch without cache config,Medium,
|
||||||
|
12,DataFetching,Fetch data in Server Components,Fetch directly in async Server Components,async function Page() { const data = await fetch() },useEffect for initial data,const data = await fetch(url),useEffect(() => fetch(url)),High,https://nextjs.org/docs/app/building-your-application/data-fetching
|
||||||
|
13,DataFetching,Configure caching explicitly (Next.js 15+),Next.js 15 changed defaults to uncached for fetch,Explicitly set cache: 'force-cache' for static data,Assume default is cached (it's not in Next.js 15),fetch(url { cache: 'force-cache' }),fetch(url) // Uncached in v15,High,https://nextjs.org/docs/app/building-your-application/upgrading/version-15
|
||||||
|
14,DataFetching,Deduplicate fetch requests,React and Next.js dedupe same requests,Same fetch call in multiple components,Manual request deduplication,Multiple components fetch same URL,Custom cache layer,Low,
|
||||||
|
15,DataFetching,Use Server Actions for mutations,Server Actions for form submissions,action={serverAction} in forms,API route for every mutation,<form action={createPost}>,<form onSubmit={callApiRoute}>,Medium,https://nextjs.org/docs/app/building-your-application/data-fetching/server-actions-and-mutations
|
||||||
|
16,DataFetching,Revalidate data appropriately,Use revalidatePath/revalidateTag after mutations,Revalidate after Server Action,'use client' with manual refetch,revalidatePath('/posts'),router.refresh() everywhere,Medium,https://nextjs.org/docs/app/building-your-application/caching#revalidating
|
||||||
|
17,Images,Use next/image for optimization,Automatic image optimization and lazy loading,<Image> component for all images,<img> tags directly,<Image src={} alt={} width={} height={}>,<img src={}/>,High,https://nextjs.org/docs/app/building-your-application/optimizing/images
|
||||||
|
18,Images,Provide width and height,Prevent layout shift with dimensions,width and height props or fill,Missing dimensions,<Image width={400} height={300}/>,<Image src={url}/>,High,
|
||||||
|
19,Images,Use fill for responsive images,Fill container with object-fit,fill prop with relative parent,Fixed dimensions for responsive,"<Image fill className=""object-cover""/>",<Image width={window.width}/>,Medium,
|
||||||
|
20,Images,Configure remote image domains,Whitelist external image sources,remotePatterns in next.config.js,Allow all domains,remotePatterns: [{ hostname: 'cdn.example.com' }],domains: ['*'],High,https://nextjs.org/docs/app/api-reference/components/image#remotepatterns
|
||||||
|
21,Images,Use priority for LCP images,Mark above-fold images as priority,priority prop on hero images,All images with priority,<Image priority src={hero}/>,<Image priority/> on every image,Medium,
|
||||||
|
22,Fonts,Use next/font for fonts,Self-hosted fonts with zero layout shift,next/font/google or next/font/local,External font links,import { Inter } from 'next/font/google',"<link href=""fonts.googleapis.com""/>",Medium,https://nextjs.org/docs/app/building-your-application/optimizing/fonts
|
||||||
|
23,Fonts,Apply font to layout,Set font in root layout for consistency,className on body in layout.tsx,Font in individual pages,<body className={inter.className}>,Each page imports font,Low,
|
||||||
|
24,Fonts,Use variable fonts,Variable fonts reduce bundle size,Single variable font file,Multiple font weights as files,Inter({ subsets: ['latin'] }),Inter_400 Inter_500 Inter_700,Low,
|
||||||
|
25,Metadata,Use generateMetadata for dynamic,Generate metadata based on params,export async function generateMetadata(),Hardcoded metadata everywhere,generateMetadata({ params }),export const metadata = {},Medium,https://nextjs.org/docs/app/building-your-application/optimizing/metadata
|
||||||
|
26,Metadata,Include OpenGraph images,Add OG images for social sharing,opengraph-image.tsx or og property,Missing social preview images,opengraph: { images: ['/og.png'] },No OG configuration,Medium,
|
||||||
|
27,Metadata,Use metadata API,Export metadata object for static metadata,export const metadata = {},Manual head tags,export const metadata = { title: 'Page' },<head><title>Page</title></head>,Medium,
|
||||||
|
28,API,Use Route Handlers for APIs,app/api routes for API endpoints,app/api/users/route.ts,pages/api for new projects,export async function GET(request),export default function handler,Medium,https://nextjs.org/docs/app/building-your-application/routing/route-handlers
|
||||||
|
29,API,Return proper Response objects,Use NextResponse for API responses,NextResponse.json() for JSON,Plain objects or res.json(),return NextResponse.json({ data }),return { data },Medium,
|
||||||
|
30,API,Handle HTTP methods explicitly,Export named functions for methods,Export GET POST PUT DELETE,Single handler for all methods,export async function POST(),switch(req.method),Low,
|
||||||
|
31,API,Validate request body,Validate input before processing,Zod or similar for validation,Trust client input,const body = schema.parse(await req.json()),const body = await req.json(),High,
|
||||||
|
32,Middleware,Use middleware for auth,Protect routes with middleware.ts,middleware.ts at root,Auth check in every page,export function middleware(request),if (!session) redirect in page,Medium,https://nextjs.org/docs/app/building-your-application/routing/middleware
|
||||||
|
33,Middleware,Match specific paths,Configure middleware matcher,config.matcher for specific routes,Run middleware on all routes,matcher: ['/dashboard/:path*'],No matcher config,Medium,
|
||||||
|
34,Middleware,Keep middleware edge-compatible,Middleware runs on Edge runtime,Edge-compatible code only,Node.js APIs in middleware,Edge-compatible auth check,fs.readFile in middleware,High,
|
||||||
|
35,Environment,Use NEXT_PUBLIC prefix,Client-accessible env vars need prefix,NEXT_PUBLIC_ for client vars,Server vars exposed to client,NEXT_PUBLIC_API_URL,API_SECRET in client code,High,https://nextjs.org/docs/app/building-your-application/configuring/environment-variables
|
||||||
|
36,Environment,Validate env vars,Check required env vars exist,Validate on startup,Undefined env at runtime,if (!process.env.DATABASE_URL) throw,process.env.DATABASE_URL (might be undefined),High,
|
||||||
|
37,Environment,Use .env.local for secrets,Local env file for development secrets,.env.local gitignored,Secrets in .env committed,.env.local with secrets,.env with DATABASE_PASSWORD,High,
|
||||||
|
38,Performance,Analyze bundle size,Use @next/bundle-analyzer,Bundle analyzer in dev,Ship large bundles blindly,ANALYZE=true npm run build,No bundle analysis,Medium,https://nextjs.org/docs/app/building-your-application/optimizing/bundle-analyzer
|
||||||
|
39,Performance,Use dynamic imports,Code split with next/dynamic,dynamic() for heavy components,Import everything statically,const Chart = dynamic(() => import('./Chart')),import Chart from './Chart',Medium,https://nextjs.org/docs/app/building-your-application/optimizing/lazy-loading
|
||||||
|
40,Performance,Avoid layout shifts,Reserve space for dynamic content,Skeleton loaders aspect ratios,Content popping in,"<Skeleton className=""h-48""/>",No placeholder for async content,High,
|
||||||
|
41,Performance,Use Partial Prerendering,Combine static and dynamic in one route,Static shell with Suspense holes,Full dynamic or static pages,Static header + dynamic content,Entire page SSR,Low,https://nextjs.org/docs/app/building-your-application/rendering/partial-prerendering
|
||||||
|
42,Link,Use next/link for navigation,Client-side navigation with prefetching,"<Link href=""""> for internal links",<a> for internal navigation,"<Link href=""/about"">About</Link>","<a href=""/about"">About</a>",High,https://nextjs.org/docs/app/api-reference/components/link
|
||||||
|
43,Link,Prefetch strategically,Control prefetching behavior,prefetch={false} for low-priority,Prefetch all links,<Link prefetch={false}>,Default prefetch on every link,Low,
|
||||||
|
44,Link,Use scroll option appropriately,Control scroll behavior on navigation,scroll={false} for tabs pagination,Always scroll to top,<Link scroll={false}>,Manual scroll management,Low,
|
||||||
|
45,Config,Use next.config.js correctly,Configure Next.js behavior,Proper config options,Deprecated or wrong options,images: { remotePatterns: [] },images: { domains: [] },Medium,https://nextjs.org/docs/app/api-reference/next-config-js
|
||||||
|
46,Config,Enable strict mode,Catch potential issues early,reactStrictMode: true,Strict mode disabled,reactStrictMode: true,reactStrictMode: false,Medium,
|
||||||
|
47,Config,Configure redirects and rewrites,Use config for URL management,redirects() rewrites() in config,Manual redirect handling,redirects: async () => [...],res.redirect in pages,Medium,https://nextjs.org/docs/app/api-reference/next-config-js/redirects
|
||||||
|
48,Deployment,Use Vercel for easiest deploy,Vercel optimized for Next.js,Deploy to Vercel,Self-host without knowledge,vercel deploy,Complex Docker setup for simple app,Low,https://nextjs.org/docs/app/building-your-application/deploying
|
||||||
|
49,Deployment,Configure output for self-hosting,Set output option for deployment target,output: 'standalone' for Docker,Default output for containers,output: 'standalone',No output config for Docker,Medium,https://nextjs.org/docs/app/building-your-application/deploying#self-hosting
|
||||||
|
50,Security,Sanitize user input,Never trust user input,Escape sanitize validate all input,Direct interpolation of user data,DOMPurify.sanitize(userInput),dangerouslySetInnerHTML={{ __html: userInput }},High,
|
||||||
|
51,Security,Use CSP headers,Content Security Policy for XSS protection,Configure CSP in next.config.js,No security headers,headers() with CSP,No CSP configuration,High,https://nextjs.org/docs/app/building-your-application/configuring/content-security-policy
|
||||||
|
52,Security,Validate Server Action input,Server Actions are public endpoints,Validate and authorize in Server Action,Trust Server Action input,Auth check + validation in action,Direct database call without check,High,
|
||||||
|
|
|
@ -0,0 +1,52 @@
|
||||||
|
No,Category,Guideline,Description,Do,Don't,Code Good,Code Bad,Severity,Docs URL
|
||||||
|
1,Components,Use functional components,Hooks-based components are standard,Functional components with hooks,Class components,const App = () => { },class App extends Component,Medium,https://reactnative.dev/docs/intro-react
|
||||||
|
2,Components,Keep components small,Single responsibility principle,Split into smaller components,Large monolithic components,<Header /><Content /><Footer />,500+ line component,Medium,
|
||||||
|
3,Components,Use TypeScript,Type safety for props and state,TypeScript for new projects,JavaScript without types,const Button: FC<Props> = () => { },const Button = (props) => { },Medium,
|
||||||
|
4,Components,Colocate component files,Keep related files together,Component folder with styles,Flat structure,components/Button/index.tsx styles.ts,components/Button.tsx styles/button.ts,Low,
|
||||||
|
5,Styling,Use StyleSheet.create,Optimized style objects,StyleSheet for all styles,Inline style objects,StyleSheet.create({ container: {} }),style={{ margin: 10 }},High,https://reactnative.dev/docs/stylesheet
|
||||||
|
6,Styling,Avoid inline styles,Prevent object recreation,Styles in StyleSheet,Inline style objects in render,style={styles.container},"style={{ margin: 10, padding: 5 }}",Medium,
|
||||||
|
7,Styling,Use flexbox for layout,React Native uses flexbox,flexDirection alignItems justifyContent,Absolute positioning everywhere,flexDirection: 'row',position: 'absolute' everywhere,Medium,https://reactnative.dev/docs/flexbox
|
||||||
|
8,Styling,Handle platform differences,Platform-specific styles,Platform.select or .ios/.android files,Same styles for both platforms,"Platform.select({ ios: {}, android: {} })",Hardcoded iOS values,Medium,https://reactnative.dev/docs/platform-specific-code
|
||||||
|
9,Styling,Use responsive dimensions,Scale for different screens,Dimensions or useWindowDimensions,Fixed pixel values,useWindowDimensions(),width: 375,Medium,
|
||||||
|
10,Navigation,Use React Navigation,Standard navigation library,React Navigation for routing,Manual navigation management,createStackNavigator(),Custom navigation state,Medium,https://reactnavigation.org/
|
||||||
|
11,Navigation,Type navigation params,Type-safe navigation,Typed navigation props,Untyped navigation,"navigation.navigate<RootStackParamList>('Home', { id })","navigation.navigate('Home', { id })",Medium,
|
||||||
|
12,Navigation,Use deep linking,Support URL-based navigation,Configure linking prop,No deep link support,linking: { prefixes: [] },No linking configuration,Medium,https://reactnavigation.org/docs/deep-linking/
|
||||||
|
13,Navigation,Handle back button,Android back button handling,useFocusEffect with BackHandler,Ignore back button,BackHandler.addEventListener,No back handler,High,
|
||||||
|
14,State,Use useState for local state,Simple component state,useState for UI state,Class component state,"const [count, setCount] = useState(0)",this.state = { count: 0 },Medium,
|
||||||
|
15,State,Use useReducer for complex state,Complex state logic,useReducer for related state,Multiple useState for related values,useReducer(reducer initialState),5+ useState calls,Medium,
|
||||||
|
16,State,Use context sparingly,Context for global state,Context for theme auth locale,Context for frequently changing data,ThemeContext for app theme,Context for list item data,Medium,
|
||||||
|
17,State,Consider Zustand or Redux,External state management,Zustand for simple Redux for complex,useState for global state,create((set) => ({ })),Prop drilling global state,Medium,
|
||||||
|
18,Lists,Use FlatList for long lists,Virtualized list rendering,FlatList for 50+ items,ScrollView with map,<FlatList data={items} />,<ScrollView>{items.map()}</ScrollView>,High,https://reactnative.dev/docs/flatlist
|
||||||
|
19,Lists,Provide keyExtractor,Unique keys for list items,keyExtractor with stable ID,Index as key,keyExtractor={(item) => item.id},"keyExtractor={(_, index) => index}",High,
|
||||||
|
20,Lists,Optimize renderItem,Memoize list item components,React.memo for list items,Inline render function,renderItem={({ item }) => <MemoizedItem item={item} />},renderItem={({ item }) => <View>...</View>},High,
|
||||||
|
21,Lists,Use getItemLayout for fixed height,Skip measurement for performance,getItemLayout when height known,Dynamic measurement for fixed items,"getItemLayout={(_, index) => ({ length: 50, offset: 50 * index, index })}",No getItemLayout for fixed height,Medium,
|
||||||
|
22,Lists,Implement windowSize,Control render window,Smaller windowSize for memory,Default windowSize for large lists,windowSize={5},windowSize={21} for huge lists,Medium,
|
||||||
|
23,Performance,Use React.memo,Prevent unnecessary re-renders,memo for pure components,No memoization,export default memo(MyComponent),export default MyComponent,Medium,
|
||||||
|
24,Performance,Use useCallback for handlers,Stable function references,useCallback for props,New function on every render,"useCallback(() => {}, [deps])",() => handlePress(),Medium,
|
||||||
|
25,Performance,Use useMemo for expensive ops,Cache expensive calculations,useMemo for heavy computations,Recalculate every render,"useMemo(() => expensive(), [deps])",const result = expensive(),Medium,
|
||||||
|
26,Performance,Avoid anonymous functions in JSX,Prevent re-renders,Named handlers or useCallback,Inline arrow functions,onPress={handlePress},onPress={() => doSomething()},Medium,
|
||||||
|
27,Performance,Use Hermes engine,Improved startup and memory,Enable Hermes in build,JavaScriptCore for new projects,hermes_enabled: true,hermes_enabled: false,Medium,https://reactnative.dev/docs/hermes
|
||||||
|
28,Images,Use expo-image,Modern performant image component for React Native,"Use expo-image for caching, blurring, and performance",Use default Image for heavy lists or unmaintained libraries,<Image source={url} cachePolicy='memory-disk' /> (expo-image),<FastImage source={url} />,Medium,https://docs.expo.dev/versions/latest/sdk/image/
|
||||||
|
29,Images,Specify image dimensions,Prevent layout shifts,width and height for remote images,No dimensions for network images,<Image style={{ width: 100 height: 100 }} />,<Image source={{ uri }} /> no size,High,
|
||||||
|
30,Images,Use resizeMode,Control image scaling,resizeMode cover contain,Stretch images,"resizeMode=""cover""",No resizeMode,Low,
|
||||||
|
31,Forms,Use controlled inputs,State-controlled form fields,value + onChangeText,Uncontrolled inputs,<TextInput value={text} onChangeText={setText} />,<TextInput defaultValue={text} />,Medium,
|
||||||
|
32,Forms,Handle keyboard,Manage keyboard visibility,KeyboardAvoidingView,Content hidden by keyboard,"<KeyboardAvoidingView behavior=""padding"">",No keyboard handling,High,https://reactnative.dev/docs/keyboardavoidingview
|
||||||
|
33,Forms,Use proper keyboard types,Appropriate keyboard for input,keyboardType for input type,Default keyboard for all,"keyboardType=""email-address""","keyboardType=""default"" for email",Low,
|
||||||
|
34,Touch,Use Pressable,Modern touch handling,Pressable for touch interactions,TouchableOpacity for new code,<Pressable onPress={} />,<TouchableOpacity onPress={} />,Low,https://reactnative.dev/docs/pressable
|
||||||
|
35,Touch,Provide touch feedback,Visual feedback on press,Ripple or opacity change,No feedback on press,android_ripple={{ color: 'gray' }},No press feedback,Medium,
|
||||||
|
36,Touch,Set hitSlop for small targets,Increase touch area,hitSlop for icons and small buttons,Tiny touch targets,hitSlop={{ top: 10 bottom: 10 }},44x44 with no hitSlop,Medium,
|
||||||
|
37,Animation,Use Reanimated,High-performance animations,react-native-reanimated,Animated API for complex,useSharedValue useAnimatedStyle,Animated.timing for gesture,Medium,https://docs.swmansion.com/react-native-reanimated/
|
||||||
|
38,Animation,Run on UI thread,worklets for smooth animation,Run animations on UI thread,JS thread animations,runOnUI(() => {}),Animated on JS thread,High,
|
||||||
|
39,Animation,Use gesture handler,Native gesture recognition,react-native-gesture-handler,JS-based gesture handling,<GestureDetector>,<View onTouchMove={} />,Medium,https://docs.swmansion.com/react-native-gesture-handler/
|
||||||
|
40,Async,Handle loading states,Show loading indicators,ActivityIndicator during load,Empty screen during load,{isLoading ? <ActivityIndicator /> : <Content />},No loading state,Medium,
|
||||||
|
41,Async,Handle errors gracefully,Error boundaries and fallbacks,Error UI for failed requests,Crash on error,{error ? <ErrorView /> : <Content />},No error handling,High,
|
||||||
|
42,Async,Cancel async operations,Cleanup on unmount,AbortController or cleanup,Memory leaks from async,useEffect cleanup,No cleanup for subscriptions,High,
|
||||||
|
43,Accessibility,Add accessibility labels,Describe UI elements,accessibilityLabel for all interactive,Missing labels,"accessibilityLabel=""Submit form""",<Pressable> without label,High,https://reactnative.dev/docs/accessibility
|
||||||
|
44,Accessibility,Use accessibility roles,Semantic meaning,accessibilityRole for elements,Wrong roles,"accessibilityRole=""button""",No role for button,Medium,
|
||||||
|
45,Accessibility,Support screen readers,Test with TalkBack/VoiceOver,Test with screen readers,Skip accessibility testing,Regular TalkBack testing,No screen reader testing,High,
|
||||||
|
46,Testing,Use React Native Testing Library,Component testing,render and fireEvent,Enzyme or manual testing,render(<Component />),shallow(<Component />),Medium,https://callstack.github.io/react-native-testing-library/
|
||||||
|
47,Testing,Test on real devices,Real device behavior,Test on iOS and Android devices,Simulator only,Device testing in CI,Simulator only testing,High,
|
||||||
|
48,Testing,Use Detox for E2E,End-to-end testing,Detox for critical flows,Manual E2E testing,detox test,Manual testing only,Medium,https://wix.github.io/Detox/
|
||||||
|
49,Native,Use native modules carefully,Bridge has overhead,Batch native calls,Frequent bridge crossing,Batch updates,Call native on every keystroke,High,
|
||||||
|
50,Native,Use Expo when possible,Simplified development,Expo for standard features,Bare RN for simple apps,expo install package,react-native link package,Low,https://docs.expo.dev/
|
||||||
|
51,Native,Handle permissions,Request permissions properly,Check and request permissions,Assume permissions granted,PermissionsAndroid.request(),Access without permission check,High,https://reactnative.dev/docs/permissionsandroid
|
||||||
|
|
|
@ -0,0 +1,54 @@
|
||||||
|
No,Category,Guideline,Description,Do,Don't,Code Good,Code Bad,Severity,Docs URL
|
||||||
|
1,State,Use useState for local state,Simple component state should use useState hook,useState for form inputs toggles counters,Class components this.state,"const [count, setCount] = useState(0)",this.state = { count: 0 },Medium,https://react.dev/reference/react/useState
|
||||||
|
2,State,Lift state up when needed,Share state between siblings by lifting to parent,Lift shared state to common ancestor,Prop drilling through many levels,Parent holds state passes down,Deep prop chains,Medium,https://react.dev/learn/sharing-state-between-components
|
||||||
|
3,State,Use useReducer for complex state,Complex state logic benefits from reducer pattern,useReducer for state with multiple sub-values,Multiple useState for related values,useReducer with action types,5+ useState calls that update together,Medium,https://react.dev/reference/react/useReducer
|
||||||
|
4,State,Avoid unnecessary state,Derive values from existing state when possible,Compute derived values in render,Store derivable values in state,const total = items.reduce(...),"const [total, setTotal] = useState(0)",High,https://react.dev/learn/choosing-the-state-structure
|
||||||
|
5,State,Initialize state lazily,Use function form for expensive initial state,useState(() => computeExpensive()),useState(computeExpensive()),useState(() => JSON.parse(data)),useState(JSON.parse(data)),Medium,https://react.dev/reference/react/useState#avoiding-recreating-the-initial-state
|
||||||
|
6,Effects,Clean up effects,Return cleanup function for subscriptions timers,Return cleanup function in useEffect,No cleanup for subscriptions,useEffect(() => { sub(); return unsub; }),useEffect(() => { subscribe(); }),High,https://react.dev/reference/react/useEffect#connecting-to-an-external-system
|
||||||
|
7,Effects,Specify dependencies correctly,Include all values used inside effect in deps array,All referenced values in dependency array,Empty deps with external references,[value] when using value in effect,[] when using props/state in effect,High,https://react.dev/reference/react/useEffect#specifying-reactive-dependencies
|
||||||
|
8,Effects,Avoid unnecessary effects,Don't use effects for transforming data or events,Transform data during render handle events directly,useEffect for derived state or event handling,const filtered = items.filter(...),useEffect(() => setFiltered(items.filter(...))),High,https://react.dev/learn/you-might-not-need-an-effect
|
||||||
|
9,Effects,Use refs for non-reactive values,Store values that don't trigger re-renders in refs,useRef for interval IDs DOM elements,useState for values that don't need render,const intervalRef = useRef(null),"const [intervalId, setIntervalId] = useState()",Medium,https://react.dev/reference/react/useRef
|
||||||
|
10,Rendering,Use keys properly,Stable unique keys for list items,Use stable IDs as keys,Array index as key for dynamic lists,key={item.id},key={index},High,https://react.dev/learn/rendering-lists#keeping-list-items-in-order-with-key
|
||||||
|
11,Rendering,Memoize expensive calculations,Use useMemo for costly computations,useMemo for expensive filtering/sorting,Recalculate every render,"useMemo(() => expensive(), [deps])",const result = expensiveCalc(),Medium,https://react.dev/reference/react/useMemo
|
||||||
|
12,Rendering,Memoize callbacks passed to children,Use useCallback for functions passed as props,useCallback for handlers passed to memoized children,New function reference every render,"useCallback(() => {}, [deps])",const handler = () => {},Medium,https://react.dev/reference/react/useCallback
|
||||||
|
13,Rendering,Use React.memo wisely,Wrap components that render often with same props,memo for pure components with stable props,memo everything or nothing,memo(ExpensiveList),memo(SimpleButton),Low,https://react.dev/reference/react/memo
|
||||||
|
14,Rendering,Avoid inline object/array creation in JSX,Create objects outside render or memoize,Define style objects outside component,Inline objects in props,<div style={styles.container}>,<div style={{ margin: 10 }}>,Medium,
|
||||||
|
15,Components,Keep components small and focused,Single responsibility for each component,One concern per component,Large multi-purpose components,<UserAvatar /><UserName />,<UserCard /> with 500 lines,Medium,
|
||||||
|
16,Components,Use composition over inheritance,Compose components using children and props,Use children prop for flexibility,Inheritance hierarchies,<Card>{content}</Card>,class SpecialCard extends Card,Medium,https://react.dev/learn/thinking-in-react
|
||||||
|
17,Components,Colocate related code,Keep related components and hooks together,Related files in same directory,Flat structure with many files,components/User/UserCard.tsx,components/UserCard.tsx + hooks/useUser.ts,Low,
|
||||||
|
18,Components,Use fragments to avoid extra DOM,Fragment or <> for multiple elements without wrapper,<> for grouping without DOM node,Extra div wrappers,<>{items.map(...)}</>,<div>{items.map(...)}</div>,Low,https://react.dev/reference/react/Fragment
|
||||||
|
19,Props,Destructure props,Destructure props for cleaner component code,Destructure in function signature,props.name props.value throughout,"function User({ name, age })",function User(props),Low,
|
||||||
|
20,Props,Provide default props values,Use default parameters or defaultProps,Default values in destructuring,Undefined checks throughout,function Button({ size = 'md' }),if (size === undefined) size = 'md',Low,
|
||||||
|
21,Props,Avoid prop drilling,Use context or composition for deeply nested data,Context for global data composition for UI,Passing props through 5+ levels,<UserContext.Provider>,<A user={u}><B user={u}><C user={u}>,Medium,https://react.dev/learn/passing-data-deeply-with-context
|
||||||
|
22,Props,Validate props with TypeScript,Use TypeScript interfaces for prop types,interface Props { name: string },PropTypes or no validation,interface ButtonProps { onClick: () => void },Button.propTypes = {},Medium,
|
||||||
|
23,Events,Use synthetic events correctly,React normalizes events across browsers,e.preventDefault() e.stopPropagation(),Access native event unnecessarily,onClick={(e) => e.preventDefault()},onClick={(e) => e.nativeEvent.preventDefault()},Low,https://react.dev/reference/react-dom/components/common#react-event-object
|
||||||
|
24,Events,Avoid binding in render,Use arrow functions in class or hooks,Arrow functions in functional components,bind in render or constructor,const handleClick = () => {},this.handleClick.bind(this),Medium,
|
||||||
|
25,Events,Pass event handlers not call results,Pass function reference not invocation,onClick={handleClick},onClick={handleClick()} causing immediate call,onClick={handleClick},onClick={handleClick()},High,
|
||||||
|
26,Forms,Controlled components for forms,Use state to control form inputs,value + onChange for inputs,Uncontrolled inputs with refs,<input value={val} onChange={setVal}>,<input ref={inputRef}>,Medium,https://react.dev/reference/react-dom/components/input#controlling-an-input-with-a-state-variable
|
||||||
|
27,Forms,Handle form submission properly,Prevent default and handle in submit handler,onSubmit with preventDefault,onClick on submit button only,<form onSubmit={handleSubmit}>,<button onClick={handleSubmit}>,Medium,
|
||||||
|
28,Forms,Debounce rapid input changes,Debounce search/filter inputs,useDeferredValue or debounce for search,Filter on every keystroke,useDeferredValue(searchTerm),useEffect filtering on every change,Medium,https://react.dev/reference/react/useDeferredValue
|
||||||
|
29,Hooks,Follow rules of hooks,Only call hooks at top level and in React functions,Hooks at component top level,Hooks in conditions loops or callbacks,"const [x, setX] = useState()","if (cond) { const [x, setX] = useState() }",High,https://react.dev/reference/rules/rules-of-hooks
|
||||||
|
30,Hooks,Custom hooks for reusable logic,Extract shared stateful logic to custom hooks,useCustomHook for reusable patterns,Duplicate hook logic across components,const { data } = useFetch(url),Duplicate useEffect/useState in components,Medium,https://react.dev/learn/reusing-logic-with-custom-hooks
|
||||||
|
31,Hooks,Name custom hooks with use prefix,Custom hooks must start with use,useFetch useForm useAuth,fetchData or getData for hook,function useFetch(url),function fetchData(url),High,
|
||||||
|
32,Context,Use context for global data,Context for theme auth locale,Context for app-wide state,Context for frequently changing data,<ThemeContext.Provider>,Context for form field values,Medium,https://react.dev/learn/passing-data-deeply-with-context
|
||||||
|
33,Context,Split contexts by concern,Separate contexts for different domains,ThemeContext + AuthContext,One giant AppContext,<ThemeProvider><AuthProvider>,<AppProvider value={{theme user...}}>,Medium,
|
||||||
|
34,Context,Memoize context values,Prevent unnecessary re-renders with useMemo,useMemo for context value object,New object reference every render,"value={useMemo(() => ({...}), [])}","value={{ user, theme }}",High,
|
||||||
|
35,Performance,Use React DevTools Profiler,Profile to identify performance bottlenecks,Profile before optimizing,Optimize without measuring,React DevTools Profiler,Guessing at bottlenecks,Medium,https://react.dev/learn/react-developer-tools
|
||||||
|
36,Performance,Lazy load components,Use React.lazy for code splitting,lazy() for routes and heavy components,Import everything upfront,const Page = lazy(() => import('./Page')),import Page from './Page',Medium,https://react.dev/reference/react/lazy
|
||||||
|
37,Performance,Virtualize long lists,Use windowing for lists over 100 items,react-window or react-virtual,Render thousands of DOM nodes,<VirtualizedList items={items}/>,{items.map(i => <Item />)},High,
|
||||||
|
38,Performance,Batch state updates,React 18 auto-batches but be aware,Let React batch related updates,Manual batching with flushSync,setA(1); setB(2); // batched,flushSync(() => setA(1)),Low,https://react.dev/learn/queueing-a-series-of-state-updates
|
||||||
|
39,ErrorHandling,Use error boundaries,Catch JavaScript errors in component tree,ErrorBoundary wrapping sections,Let errors crash entire app,<ErrorBoundary><App/></ErrorBoundary>,No error handling,High,https://react.dev/reference/react/Component#catching-rendering-errors-with-an-error-boundary
|
||||||
|
40,ErrorHandling,Handle async errors,Catch errors in async operations,try/catch in async handlers,Unhandled promise rejections,try { await fetch() } catch(e) {},await fetch() // no catch,High,
|
||||||
|
41,Testing,Test behavior not implementation,Test what user sees and does,Test renders and interactions,Test internal state or methods,expect(screen.getByText('Hello')),expect(component.state.name),Medium,https://testing-library.com/docs/react-testing-library/intro/
|
||||||
|
42,Testing,Use testing-library queries,Use accessible queries,getByRole getByLabelText,getByTestId for everything,getByRole('button'),getByTestId('submit-btn'),Medium,https://testing-library.com/docs/queries/about#priority
|
||||||
|
43,Accessibility,Use semantic HTML,Proper HTML elements for their purpose,button for clicks nav for navigation,div with onClick for buttons,<button onClick={...}>,<div onClick={...}>,High,https://react.dev/reference/react-dom/components#all-html-components
|
||||||
|
44,Accessibility,Manage focus properly,Handle focus for modals dialogs,Focus trap in modals return focus on close,No focus management,useEffect to focus input,Modal without focus trap,High,
|
||||||
|
45,Accessibility,Announce dynamic content,Use ARIA live regions for updates,aria-live for dynamic updates,Silent updates to screen readers,"<div aria-live=""polite"">{msg}</div>",<div>{msg}</div>,Medium,
|
||||||
|
46,Accessibility,Label form controls,Associate labels with inputs,htmlFor matching input id,Placeholder as only label,"<label htmlFor=""email"">Email</label>","<input placeholder=""Email""/>",High,
|
||||||
|
47,TypeScript,Type component props,Define interfaces for all props,interface Props with all prop types,any or missing types,interface Props { name: string },function Component(props: any),High,
|
||||||
|
48,TypeScript,Type state properly,Provide types for useState,useState<Type>() for complex state,Inferred any types,useState<User | null>(null),useState(null),Medium,
|
||||||
|
49,TypeScript,Type event handlers,Use React event types,React.ChangeEvent<HTMLInputElement>,Generic Event type,onChange: React.ChangeEvent<HTMLInputElement>,onChange: Event,Medium,
|
||||||
|
50,TypeScript,Use generics for reusable components,Generic components for flexible typing,Generic props for list components,Union types for flexibility,<List<T> items={T[]}>,<List items={any[]}>,Medium,
|
||||||
|
51,Patterns,Container/Presentational split,Separate data logic from UI,Container fetches presentational renders,Mixed data and UI in one,<UserContainer><UserView/></UserContainer>,<User /> with fetch and render,Low,
|
||||||
|
52,Patterns,Render props for flexibility,Share code via render prop pattern,Render prop for customizable rendering,Duplicate logic across components,<DataFetcher render={data => ...}/>,Copy paste fetch logic,Low,https://react.dev/reference/react/cloneElement#passing-data-with-a-render-prop
|
||||||
|
53,Patterns,Compound components,Related components sharing state,Tab + TabPanel sharing context,Prop drilling between related,<Tabs><Tab/><TabPanel/></Tabs>,<Tabs tabs={[]} panels={[...]}/>,Low,
|
||||||
|
|
|
@ -0,0 +1,54 @@
|
||||||
|
No,Category,Guideline,Description,Do,Don't,Code Good,Code Bad,Severity,Docs URL
|
||||||
|
1,Reactivity,Use $: for reactive statements,Automatic dependency tracking,$: for derived values,Manual recalculation,$: doubled = count * 2,let doubled; count && (doubled = count * 2),Medium,https://svelte.dev/docs/svelte-components#script-3-$-marks-a-statement-as-reactive
|
||||||
|
2,Reactivity,Trigger reactivity with assignment,Svelte tracks assignments not mutations,Reassign arrays/objects to trigger update,Mutate without reassignment,"items = [...items, newItem]",items.push(newItem),High,https://svelte.dev/docs/svelte-components#script-2-assignments-are-reactive
|
||||||
|
3,Reactivity,Use $state in Svelte 5,Runes for explicit reactivity,let count = $state(0),Implicit reactivity in Svelte 5,let count = $state(0),let count = 0 (Svelte 5),Medium,https://svelte.dev/blog/runes
|
||||||
|
4,Reactivity,Use $derived for computed values,$derived replaces $: in Svelte 5,let doubled = $derived(count * 2),$: in Svelte 5,let doubled = $derived(count * 2),$: doubled = count * 2 (Svelte 5),Medium,
|
||||||
|
5,Reactivity,Use $effect for side effects,$effect replaces $: side effects,Use $effect for subscriptions,$: for side effects in Svelte 5,$effect(() => console.log(count)),$: console.log(count) (Svelte 5),Medium,
|
||||||
|
6,Props,Export let for props,Declare props with export let,export let propName,Props without export,export let count = 0,let count = 0,High,https://svelte.dev/docs/svelte-components#script-1-export-creates-a-component-prop
|
||||||
|
7,Props,Use $props in Svelte 5,$props rune for prop access,let { name } = $props(),export let in Svelte 5,"let { name, age = 0 } = $props()",export let name; export let age = 0,Medium,
|
||||||
|
8,Props,Provide default values,Default props with assignment,export let count = 0,Required props without defaults,export let count = 0,export let count,Low,
|
||||||
|
9,Props,Use spread props,Pass through unknown props,{...$$restProps} on elements,Manual prop forwarding,<button {...$$restProps}>,<button class={$$props.class}>,Low,https://svelte.dev/docs/basic-markup#attributes-and-props
|
||||||
|
10,Bindings,Use bind: for two-way binding,Simplified input handling,bind:value for inputs,on:input with manual update,<input bind:value={name}>,<input value={name} on:input={e => name = e.target.value}>,Low,https://svelte.dev/docs/element-directives#bind-property
|
||||||
|
11,Bindings,Bind to DOM elements,Reference DOM nodes,bind:this for element reference,querySelector in onMount,<div bind:this={el}>,onMount(() => el = document.querySelector()),Medium,
|
||||||
|
12,Bindings,Use bind:group for radios/checkboxes,Simplified group handling,bind:group for radio/checkbox groups,Manual checked handling,"<input type=""radio"" bind:group={selected}>","<input type=""radio"" checked={selected === value}>",Low,
|
||||||
|
13,Events,Use on: for event handlers,Event directive syntax,on:click={handler},addEventListener in onMount,<button on:click={handleClick}>,onMount(() => btn.addEventListener()),Medium,https://svelte.dev/docs/element-directives#on-eventname
|
||||||
|
14,Events,Forward events with on:event,Pass events to parent,on:click without handler,createEventDispatcher for DOM events,<button on:click>,"dispatch('click', event)",Low,
|
||||||
|
15,Events,Use createEventDispatcher,Custom component events,dispatch for custom events,on:event for custom events,"dispatch('save', { data })",on:save without dispatch,Medium,https://svelte.dev/docs/svelte#createeventdispatcher
|
||||||
|
16,Lifecycle,Use onMount for initialization,Run code after component mounts,onMount for setup and data fetching,Code in script body for side effects,onMount(() => fetchData()),fetchData() in script body,High,https://svelte.dev/docs/svelte#onmount
|
||||||
|
17,Lifecycle,Return cleanup from onMount,Automatic cleanup on destroy,Return function from onMount,Separate onDestroy for paired cleanup,onMount(() => { sub(); return unsub }),onMount(sub); onDestroy(unsub),Medium,
|
||||||
|
18,Lifecycle,Use onDestroy sparingly,Only when onMount cleanup not possible,onDestroy for non-mount cleanup,onDestroy for mount-related cleanup,onDestroy for store unsubscribe,onDestroy(() => clearInterval(id)),Low,
|
||||||
|
19,Lifecycle,Avoid beforeUpdate/afterUpdate,Usually not needed,Reactive statements instead,beforeUpdate for derived state,$: if (x) doSomething(),beforeUpdate(() => doSomething()),Low,
|
||||||
|
20,Stores,Use writable for mutable state,Basic reactive store,writable for shared mutable state,Local variables for shared state,const count = writable(0),let count = 0 in module,Medium,https://svelte.dev/docs/svelte-store#writable
|
||||||
|
21,Stores,Use readable for read-only state,External data sources,readable for derived/external data,writable for read-only data,"readable(0, set => interval(set))",writable(0) for timer,Low,https://svelte.dev/docs/svelte-store#readable
|
||||||
|
22,Stores,Use derived for computed stores,Combine or transform stores,derived for computed values,Manual subscription for derived,"derived(count, $c => $c * 2)",count.subscribe(c => doubled = c * 2),Medium,https://svelte.dev/docs/svelte-store#derived
|
||||||
|
23,Stores,Use $ prefix for auto-subscription,Automatic subscribe/unsubscribe,$storeName in components,Manual subscription,{$count},count.subscribe(c => value = c),High,
|
||||||
|
24,Stores,Clean up custom subscriptions,Unsubscribe when component destroys,Return unsubscribe from onMount,Leave subscriptions open,onMount(() => store.subscribe(fn)),store.subscribe(fn) in script,High,
|
||||||
|
25,Slots,Use slots for composition,Content projection,<slot> for flexible content,Props for all content,<slot>Default</slot>,"<Component content=""text""/>",Medium,https://svelte.dev/docs/special-elements#slot
|
||||||
|
26,Slots,Name slots for multiple areas,Multiple content areas,"<slot name=""header"">",Single slot for complex layouts,"<slot name=""header""><slot name=""footer"">",<slot> with complex conditionals,Low,
|
||||||
|
27,Slots,Check slot content with $$slots,Conditional slot rendering,$$slots.name for conditional rendering,Always render slot wrapper,"{#if $$slots.footer}<slot name=""footer""/>{/if}","<div><slot name=""footer""/></div>",Low,
|
||||||
|
28,Styling,Use scoped styles by default,Styles scoped to component,<style> for component styles,Global styles for component,:global() only when needed,<style> all global,Medium,https://svelte.dev/docs/svelte-components#style
|
||||||
|
29,Styling,Use :global() sparingly,Escape scoping when needed,:global for third-party styling,Global for all styles,:global(.external-lib),<style> without scoping,Medium,
|
||||||
|
30,Styling,Use CSS variables for theming,Dynamic styling,CSS custom properties,Inline styles for themes,"style=""--color: {color}""","style=""color: {color}""",Low,
|
||||||
|
31,Transitions,Use built-in transitions,Svelte transition directives,transition:fade for simple effects,Manual CSS transitions,<div transition:fade>,<div class:fade={visible}>,Low,https://svelte.dev/docs/element-directives#transition-fn
|
||||||
|
32,Transitions,Use in: and out: separately,Different enter/exit animations,in:fly out:fade for asymmetric,Same transition for both,<div in:fly out:fade>,<div transition:fly>,Low,
|
||||||
|
33,Transitions,Add local modifier,Prevent ancestor trigger,transition:fade|local,Global transitions for lists,<div transition:slide|local>,<div transition:slide>,Medium,
|
||||||
|
34,Actions,Use actions for DOM behavior,Reusable DOM logic,use:action for DOM enhancements,onMount for each usage,<div use:clickOutside>,onMount(() => setupClickOutside(el)),Medium,https://svelte.dev/docs/element-directives#use-action
|
||||||
|
35,Actions,Return update and destroy,Lifecycle methods for actions,"Return { update, destroy }",Only initial setup,"return { update(params) {}, destroy() {} }",return destroy only,Medium,
|
||||||
|
36,Actions,Pass parameters to actions,Configure action behavior,use:action={params},Hardcoded action behavior,<div use:tooltip={options}>,<div use:tooltip>,Low,
|
||||||
|
37,Logic,Use {#if} for conditionals,Template conditionals,{#if} {:else if} {:else},Ternary in expressions,{#if cond}...{:else}...{/if},{cond ? a : b} for complex,Low,https://svelte.dev/docs/logic-blocks#if
|
||||||
|
38,Logic,Use {#each} for lists,List rendering,{#each} with key,Map in expression,{#each items as item (item.id)},{items.map(i => `<div>${i}</div>`)},Medium,
|
||||||
|
39,Logic,Always use keys in {#each},Proper list reconciliation,(item.id) for unique key,Index as key or no key,{#each items as item (item.id)},"{#each items as item, i (i)}",High,
|
||||||
|
40,Logic,Use {#await} for promises,Handle async states,{#await} for loading/error states,Manual promise handling,{#await promise}...{:then}...{:catch},{#if loading}...{#if error},Medium,https://svelte.dev/docs/logic-blocks#await
|
||||||
|
41,SvelteKit,Use +page.svelte for routes,File-based routing,+page.svelte for route components,Custom routing setup,routes/about/+page.svelte,routes/About.svelte,Medium,https://kit.svelte.dev/docs/routing
|
||||||
|
42,SvelteKit,Use +page.js for data loading,Load data before render,load function in +page.js,onMount for data fetching,export function load() {},onMount(() => fetchData()),High,https://kit.svelte.dev/docs/load
|
||||||
|
43,SvelteKit,Use +page.server.js for server-only,Server-side data loading,+page.server.js for sensitive data,+page.js for API keys,+page.server.js with DB access,+page.js with DB access,High,
|
||||||
|
44,SvelteKit,Use form actions,Server-side form handling,+page.server.js actions,API routes for forms,export const actions = { default },fetch('/api/submit'),Medium,https://kit.svelte.dev/docs/form-actions
|
||||||
|
45,SvelteKit,Use $app/stores for app state,$page $navigating $updated,$page for current page data,Manual URL parsing,import { page } from '$app/stores',window.location.pathname,Medium,https://kit.svelte.dev/docs/modules#$app-stores
|
||||||
|
46,Performance,Use {#key} for forced re-render,Reset component state,{#key id} for fresh instance,Manual destroy/create,{#key item.id}<Component/>{/key},on:change={() => component = null},Low,https://svelte.dev/docs/logic-blocks#key
|
||||||
|
47,Performance,Avoid unnecessary reactivity,Not everything needs $:,$: only for side effects,$: for simple assignments,$: if (x) console.log(x),$: y = x (when y = x works),Low,
|
||||||
|
48,Performance,Use immutable compiler option,Skip equality checks,immutable: true for large lists,Default for all components,<svelte:options immutable/>,Default without immutable,Low,
|
||||||
|
49,TypeScript,"Use lang=""ts"" in script",TypeScript support,"<script lang=""ts"">",JavaScript for typed projects,"<script lang=""ts"">",<script> with JSDoc,Medium,https://svelte.dev/docs/typescript
|
||||||
|
50,TypeScript,Type props with interface,Explicit prop types,interface $$Props for types,Untyped props,interface $$Props { name: string },export let name,Medium,
|
||||||
|
51,TypeScript,Type events with createEventDispatcher,Type-safe events,createEventDispatcher<Events>(),Untyped dispatch,createEventDispatcher<{ save: Data }>(),createEventDispatcher(),Medium,
|
||||||
|
52,Accessibility,Use semantic elements,Proper HTML in templates,button nav main appropriately,div for everything,<button on:click>,<div on:click>,High,
|
||||||
|
53,Accessibility,Add aria to dynamic content,Accessible state changes,aria-live for updates,Silent dynamic updates,"<div aria-live=""polite"">{message}</div>",<div>{message}</div>,Medium,
|
||||||
|
|
|
@ -0,0 +1,51 @@
|
||||||
|
No,Category,Guideline,Description,Do,Don't,Code Good,Code Bad,Severity,Docs URL
|
||||||
|
1,Views,Use struct for views,SwiftUI views are value types,struct MyView: View,class MyView: View,struct ContentView: View { var body: some View },class ContentView: View,High,https://developer.apple.com/documentation/swiftui/view
|
||||||
|
2,Views,Keep views small and focused,Single responsibility for each view,Extract subviews for complex layouts,Large monolithic views,Extract HeaderView FooterView,500+ line View struct,Medium,
|
||||||
|
3,Views,Use body computed property,body returns the view hierarchy,var body: some View { },func body() -> some View,"var body: some View { Text(""Hello"") }",func body() -> Text,High,
|
||||||
|
4,Views,Prefer composition over inheritance,Compose views using ViewBuilder,Combine smaller views,Inheritance hierarchies,VStack { Header() Content() },class SpecialView extends BaseView,Medium,
|
||||||
|
5,State,Use @State for local state,Simple value types owned by view,@State for view-local primitives,@State for shared data,@State private var count = 0,@State var sharedData: Model,High,https://developer.apple.com/documentation/swiftui/state
|
||||||
|
6,State,Use @Binding for two-way data,Pass mutable state to child views,@Binding for child input,@State in child for parent data,@Binding var isOn: Bool,$isOn to pass binding,Medium,https://developer.apple.com/documentation/swiftui/binding
|
||||||
|
7,State,Use @StateObject for reference types,ObservableObject owned by view,@StateObject for view-created objects,@ObservedObject for owned objects,@StateObject private var vm = ViewModel(),@ObservedObject var vm = ViewModel(),High,https://developer.apple.com/documentation/swiftui/stateobject
|
||||||
|
8,State,Use @ObservedObject for injected objects,Reference types passed from parent,@ObservedObject for injected dependencies,@StateObject for injected objects,@ObservedObject var vm: ViewModel,@StateObject var vm: ViewModel (injected),High,https://developer.apple.com/documentation/swiftui/observedobject
|
||||||
|
9,State,Use @EnvironmentObject for shared state,App-wide state injection,@EnvironmentObject for global state,Prop drilling through views,@EnvironmentObject var settings: Settings,Pass settings through 5 views,Medium,https://developer.apple.com/documentation/swiftui/environmentobject
|
||||||
|
10,State,Use @Published in ObservableObject,Automatically publish property changes,@Published for observed properties,Manual objectWillChange calls,@Published var items: [Item] = [],var items: [Item] { didSet { objectWillChange.send() } },Medium,
|
||||||
|
11,Observable,Use @Observable macro (iOS 17+),Modern observation without Combine,@Observable class for view models,ObservableObject for new projects,@Observable class ViewModel { },class ViewModel: ObservableObject,Medium,https://developer.apple.com/documentation/observation
|
||||||
|
12,Observable,Use @Bindable for @Observable,Create bindings from @Observable,@Bindable var vm for bindings,@Binding with @Observable,@Bindable var viewModel,$viewModel.name with @Observable,Medium,
|
||||||
|
13,Layout,Use VStack HStack ZStack,Standard stack-based layouts,Stacks for linear arrangements,GeometryReader for simple layouts,VStack { Text() Image() },GeometryReader for vertical list,Medium,https://developer.apple.com/documentation/swiftui/vstack
|
||||||
|
14,Layout,Use LazyVStack LazyHStack for lists,Lazy loading for performance,Lazy stacks for long lists,Regular stacks for 100+ items,LazyVStack { ForEach(items) },VStack { ForEach(largeArray) },High,https://developer.apple.com/documentation/swiftui/lazyvstack
|
||||||
|
15,Layout,Use GeometryReader sparingly,Only when needed for sizing,GeometryReader for responsive layouts,GeometryReader everywhere,GeometryReader for aspect ratio,GeometryReader wrapping everything,Medium,
|
||||||
|
16,Layout,Use spacing and padding consistently,Consistent spacing throughout app,Design system spacing values,Magic numbers for spacing,.padding(16) or .padding(),".padding(13), .padding(17)",Low,
|
||||||
|
17,Layout,Use frame modifiers correctly,Set explicit sizes when needed,.frame(maxWidth: .infinity),Fixed sizes for responsive content,.frame(maxWidth: .infinity),.frame(width: 375),Medium,
|
||||||
|
18,Modifiers,Order modifiers correctly,Modifier order affects rendering,Background before padding for full coverage,Wrong modifier order,.padding().background(Color.red),.background(Color.red).padding(),High,
|
||||||
|
19,Modifiers,Create custom ViewModifiers,Reusable modifier combinations,ViewModifier for repeated styling,Duplicate modifier chains,struct CardStyle: ViewModifier,.shadow().cornerRadius() everywhere,Medium,https://developer.apple.com/documentation/swiftui/viewmodifier
|
||||||
|
20,Modifiers,Use conditional modifiers carefully,Avoid changing view identity,if-else with same view type,Conditional that changes view identity,Text(title).foregroundColor(isActive ? .blue : .gray),if isActive { Text().bold() } else { Text() },Medium,
|
||||||
|
21,Navigation,Use NavigationStack (iOS 16+),Modern navigation with type-safe paths,NavigationStack with navigationDestination,NavigationView for new projects,NavigationStack { },NavigationView { } (deprecated),Medium,https://developer.apple.com/documentation/swiftui/navigationstack
|
||||||
|
22,Navigation,Use navigationDestination,Type-safe navigation destinations,.navigationDestination(for:),NavigationLink(destination:),.navigationDestination(for: Item.self),NavigationLink(destination: DetailView()),Medium,
|
||||||
|
23,Navigation,Use @Environment for dismiss,Programmatic navigation dismissal,@Environment(\.dismiss) var dismiss,presentationMode (deprecated),@Environment(\.dismiss) var dismiss,@Environment(\.presentationMode),Low,
|
||||||
|
24,Lists,Use List for scrollable content,Built-in scrolling and styling,List for standard scrollable content,ScrollView + VStack for simple lists,List { ForEach(items) { } },ScrollView { VStack { ForEach } },Low,https://developer.apple.com/documentation/swiftui/list
|
||||||
|
25,Lists,Provide stable identifiers,Use Identifiable or explicit id,Identifiable protocol or id parameter,Index as identifier,ForEach(items) where Item: Identifiable,"ForEach(items.indices, id: \.self)",High,
|
||||||
|
26,Lists,Use onDelete and onMove,Standard list editing,onDelete for swipe to delete,Custom delete implementation,.onDelete(perform: delete),.onTapGesture for delete,Low,
|
||||||
|
27,Forms,Use Form for settings,Grouped input controls,Form for settings screens,Manual grouping for forms,Form { Section { Toggle() } },VStack { Toggle() },Low,https://developer.apple.com/documentation/swiftui/form
|
||||||
|
28,Forms,Use @FocusState for keyboard,Manage keyboard focus,@FocusState for text field focus,Manual first responder handling,@FocusState private var isFocused: Bool,UIKit first responder,Medium,https://developer.apple.com/documentation/swiftui/focusstate
|
||||||
|
29,Forms,Validate input properly,Show validation feedback,Real-time validation feedback,Submit without validation,TextField with validation state,TextField without error handling,Medium,
|
||||||
|
30,Async,Use .task for async work,Automatic cancellation on view disappear,.task for view lifecycle async,onAppear with Task,.task { await loadData() },onAppear { Task { await loadData() } },Medium,https://developer.apple.com/documentation/swiftui/view/task(priority:_:)
|
||||||
|
31,Async,Handle loading states,Show progress during async operations,ProgressView during loading,Empty view during load,if isLoading { ProgressView() },No loading indicator,Medium,
|
||||||
|
32,Async,Use @MainActor for UI updates,Ensure UI updates on main thread,@MainActor on view models,Manual DispatchQueue.main,@MainActor class ViewModel,DispatchQueue.main.async,Medium,
|
||||||
|
33,Animation,Use withAnimation,Animate state changes,withAnimation for state transitions,No animation for state changes,withAnimation { isExpanded.toggle() },isExpanded.toggle(),Low,https://developer.apple.com/documentation/swiftui/withanimation(_:_:)
|
||||||
|
34,Animation,Use .animation modifier,Apply animations to views,.animation(.spring()) on view,Manual animation timing,.animation(.easeInOut),CABasicAnimation equivalent,Low,
|
||||||
|
35,Animation,Respect reduced motion,Check accessibility settings,Check accessibilityReduceMotion,Ignore motion preferences,@Environment(\.accessibilityReduceMotion),Always animate regardless,High,
|
||||||
|
36,Preview,Use #Preview macro (Xcode 15+),Modern preview syntax,#Preview for view previews,PreviewProvider protocol,#Preview { ContentView() },struct ContentView_Previews: PreviewProvider,Low,
|
||||||
|
37,Preview,Create multiple previews,Test different states and devices,Multiple previews for states,Single preview only,"#Preview(""Light"") { } #Preview(""Dark"") { }",Single preview configuration,Low,
|
||||||
|
38,Preview,Use preview data,Dedicated preview mock data,Static preview data,Production data in previews,Item.preview for preview,Fetch real data in preview,Low,
|
||||||
|
39,Performance,Avoid expensive body computations,Body should be fast to compute,Precompute in view model,Heavy computation in body,vm.computedValue in body,Complex calculation in body,High,
|
||||||
|
40,Performance,Use Equatable views,Skip unnecessary view updates,Equatable for complex views,Default equality for all views,struct MyView: View Equatable,No Equatable conformance,Medium,
|
||||||
|
41,Performance,Profile with Instruments,Measure before optimizing,Use SwiftUI Instruments,Guess at performance issues,Profile with Instruments,Optimize without measuring,Medium,
|
||||||
|
42,Accessibility,Add accessibility labels,Describe UI elements,.accessibilityLabel for context,Missing labels,".accessibilityLabel(""Close button"")",Button without label,High,https://developer.apple.com/documentation/swiftui/view/accessibilitylabel(_:)-1d7jv
|
||||||
|
43,Accessibility,Support Dynamic Type,Respect text size preferences,Scalable fonts and layouts,Fixed font sizes,.font(.body) with Dynamic Type,.font(.system(size: 16)),High,
|
||||||
|
44,Accessibility,Use semantic views,Proper accessibility traits,Correct accessibilityTraits,Wrong semantic meaning,Button for actions Image for display,Image that acts like button,Medium,
|
||||||
|
45,Testing,Use ViewInspector for testing,Third-party view testing,ViewInspector for unit tests,UI tests only,ViewInspector assertions,Only XCUITest,Medium,
|
||||||
|
46,Testing,Test view models,Unit test business logic,XCTest for view model,Skip view model testing,Test ViewModel methods,No unit tests,Medium,
|
||||||
|
47,Testing,Use preview as visual test,Previews catch visual regressions,Multiple preview configurations,No visual verification,Preview different states,Single preview only,Low,
|
||||||
|
48,Architecture,Use MVVM pattern,Separate view and logic,ViewModel for business logic,Logic in View,ObservableObject ViewModel,@State for complex logic,Medium,
|
||||||
|
49,Architecture,Keep views dumb,Views display view model state,View reads from ViewModel,Business logic in View,view.items from vm.items,Complex filtering in View,Medium,
|
||||||
|
50,Architecture,Use dependency injection,Inject dependencies for testing,Initialize with dependencies,Hard-coded dependencies,init(service: ServiceProtocol),let service = RealService(),Medium,
|
||||||
|
|
|
@ -0,0 +1,50 @@
|
||||||
|
No,Category,Guideline,Description,Do,Don't,Code Good,Code Bad,Severity,Docs URL
|
||||||
|
1,Composition,Use Composition API for new projects,Composition API offers better TypeScript support and logic reuse,<script setup> for components,Options API for new projects,<script setup>,export default { data() },Medium,https://vuejs.org/guide/extras/composition-api-faq.html
|
||||||
|
2,Composition,Use script setup syntax,Cleaner syntax with automatic exports,<script setup> with defineProps,setup() function manually,<script setup>,<script> setup() { return {} },Low,https://vuejs.org/api/sfc-script-setup.html
|
||||||
|
3,Reactivity,Use ref for primitives,ref() for primitive values that need reactivity,ref() for strings numbers booleans,reactive() for primitives,const count = ref(0),const count = reactive(0),Medium,https://vuejs.org/guide/essentials/reactivity-fundamentals.html
|
||||||
|
4,Reactivity,Use reactive for objects,reactive() for complex objects and arrays,reactive() for objects with multiple properties,ref() for complex objects,const state = reactive({ user: null }),const state = ref({ user: null }),Medium,
|
||||||
|
5,Reactivity,Access ref values with .value,Remember .value in script unwrap in template,Use .value in script,Forget .value in script,count.value++,count++ (in script),High,
|
||||||
|
6,Reactivity,Use computed for derived state,Computed properties cache and update automatically,computed() for derived values,Methods for derived values,const doubled = computed(() => count.value * 2),const doubled = () => count.value * 2,Medium,https://vuejs.org/guide/essentials/computed.html
|
||||||
|
7,Reactivity,Use shallowRef for large objects,Avoid deep reactivity for performance,shallowRef for large data structures,ref for large nested objects,const bigData = shallowRef(largeObject),const bigData = ref(largeObject),Medium,https://vuejs.org/api/reactivity-advanced.html#shallowref
|
||||||
|
8,Watchers,Use watchEffect for simple cases,Auto-tracks dependencies,watchEffect for simple reactive effects,watch with explicit deps when not needed,watchEffect(() => console.log(count.value)),"watch(count, (val) => console.log(val))",Low,https://vuejs.org/guide/essentials/watchers.html
|
||||||
|
9,Watchers,Use watch for specific sources,Explicit control over what to watch,watch with specific refs,watchEffect for complex conditional logic,"watch(userId, fetchUser)",watchEffect with conditionals,Medium,
|
||||||
|
10,Watchers,Clean up side effects,Return cleanup function in watchers,Return cleanup in watchEffect,Leave subscriptions open,watchEffect((onCleanup) => { onCleanup(unsub) }),watchEffect without cleanup,High,
|
||||||
|
11,Props,Define props with defineProps,Type-safe prop definitions,defineProps with TypeScript,Props without types,defineProps<{ msg: string }>(),defineProps(['msg']),Medium,https://vuejs.org/guide/typescript/composition-api.html#typing-component-props
|
||||||
|
12,Props,Use withDefaults for default values,Provide defaults for optional props,withDefaults with defineProps,Defaults in destructuring,"withDefaults(defineProps<Props>(), { count: 0 })",const { count = 0 } = defineProps(),Medium,
|
||||||
|
13,Props,Avoid mutating props,Props should be read-only,Emit events to parent for changes,Direct prop mutation,"emit('update:modelValue', newVal)",props.modelValue = newVal,High,
|
||||||
|
14,Emits,Define emits with defineEmits,Type-safe event emissions,defineEmits with types,Emit without definition,defineEmits<{ change: [id: number] }>(),"emit('change', id) without define",Medium,https://vuejs.org/guide/typescript/composition-api.html#typing-component-emits
|
||||||
|
15,Emits,Use v-model for two-way binding,Simplified parent-child data flow,v-model with modelValue prop,:value + @input manually,"<Child v-model=""value""/>","<Child :value=""value"" @input=""value = $event""/>",Low,https://vuejs.org/guide/components/v-model.html
|
||||||
|
16,Lifecycle,Use onMounted for DOM access,DOM is ready in onMounted,onMounted for DOM operations,Access DOM in setup directly,onMounted(() => el.value.focus()),el.value.focus() in setup,High,https://vuejs.org/api/composition-api-lifecycle.html
|
||||||
|
17,Lifecycle,Clean up in onUnmounted,Remove listeners and subscriptions,onUnmounted for cleanup,Leave listeners attached,onUnmounted(() => window.removeEventListener()),No cleanup on unmount,High,
|
||||||
|
18,Lifecycle,Avoid onBeforeMount for data,Use onMounted or setup for data fetching,Fetch in onMounted or setup,Fetch in onBeforeMount,onMounted(async () => await fetchData()),onBeforeMount(async () => await fetchData()),Low,
|
||||||
|
19,Components,Use single-file components,Keep template script style together,.vue files for components,Separate template/script files,Component.vue with all parts,Component.js + Component.html,Low,
|
||||||
|
20,Components,Use PascalCase for components,Consistent component naming,PascalCase in imports and templates,kebab-case in script,<MyComponent/>,<my-component/>,Low,https://vuejs.org/style-guide/rules-strongly-recommended.html
|
||||||
|
21,Components,Prefer composition over mixins,Composables replace mixins,Composables for shared logic,Mixins for code reuse,const { data } = useApi(),mixins: [apiMixin],Medium,
|
||||||
|
22,Composables,Name composables with use prefix,Convention for composable functions,useFetch useAuth useForm,getData or fetchApi,export function useFetch(),export function fetchData(),Medium,https://vuejs.org/guide/reusability/composables.html
|
||||||
|
23,Composables,Return refs from composables,Maintain reactivity when destructuring,Return ref values,Return reactive objects that lose reactivity,return { data: ref(null) },return reactive({ data: null }),Medium,
|
||||||
|
24,Composables,Accept ref or value params,Use toValue for flexible inputs,toValue() or unref() for params,Only accept ref or only value,const val = toValue(maybeRef),const val = maybeRef.value,Low,https://vuejs.org/api/reactivity-utilities.html#tovalue
|
||||||
|
25,Templates,Use v-bind shorthand,Cleaner template syntax,:prop instead of v-bind:prop,Full v-bind syntax,"<div :class=""cls"">","<div v-bind:class=""cls"">",Low,
|
||||||
|
26,Templates,Use v-on shorthand,Cleaner event binding,@event instead of v-on:event,Full v-on syntax,"<button @click=""handler"">","<button v-on:click=""handler"">",Low,
|
||||||
|
27,Templates,Avoid v-if with v-for,v-if has higher priority causes issues,Wrap in template or computed filter,v-if on same element as v-for,<template v-for><div v-if>,<div v-for v-if>,High,https://vuejs.org/style-guide/rules-essential.html#avoid-v-if-with-v-for
|
||||||
|
28,Templates,Use key with v-for,Proper list rendering and updates,Unique key for each item,Index as key for dynamic lists,"v-for=""item in items"" :key=""item.id""","v-for=""(item, i) in items"" :key=""i""",High,
|
||||||
|
29,State,Use Pinia for global state,Official state management for Vue 3,Pinia stores for shared state,Vuex for new projects,const store = useCounterStore(),Vuex with mutations,Medium,https://pinia.vuejs.org/
|
||||||
|
30,State,Define stores with defineStore,Composition API style stores,Setup stores with defineStore,Options stores for complex state,"defineStore('counter', () => {})","defineStore('counter', { state })",Low,
|
||||||
|
31,State,Use storeToRefs for destructuring,Maintain reactivity when destructuring,storeToRefs(store),Direct destructuring,const { count } = storeToRefs(store),const { count } = store,High,https://pinia.vuejs.org/core-concepts/#destructuring-from-a-store
|
||||||
|
32,Routing,Use useRouter and useRoute,Composition API router access,useRouter() useRoute() in setup,this.$router this.$route,const router = useRouter(),this.$router.push(),Medium,https://router.vuejs.org/guide/advanced/composition-api.html
|
||||||
|
33,Routing,Lazy load route components,Code splitting for routes,() => import() for components,Static imports for all routes,component: () => import('./Page.vue'),component: Page,Medium,https://router.vuejs.org/guide/advanced/lazy-loading.html
|
||||||
|
34,Routing,Use navigation guards,Protect routes and handle redirects,beforeEach for auth checks,Check auth in each component,router.beforeEach((to) => {}),Check auth in onMounted,Medium,
|
||||||
|
35,Performance,Use v-once for static content,Skip re-renders for static elements,v-once on never-changing content,v-once on dynamic content,<div v-once>{{ staticText }}</div>,<div v-once>{{ dynamicText }}</div>,Low,https://vuejs.org/api/built-in-directives.html#v-once
|
||||||
|
36,Performance,Use v-memo for expensive lists,Memoize list items,v-memo with dependency array,Re-render entire list always,"<div v-for v-memo=""[item.id]"">",<div v-for> without memo,Medium,https://vuejs.org/api/built-in-directives.html#v-memo
|
||||||
|
37,Performance,Use shallowReactive for flat objects,Avoid deep reactivity overhead,shallowReactive for flat state,reactive for simple objects,shallowReactive({ count: 0 }),reactive({ count: 0 }),Low,
|
||||||
|
38,Performance,Use defineAsyncComponent,Lazy load heavy components,defineAsyncComponent for modals dialogs,Import all components eagerly,defineAsyncComponent(() => import()),import HeavyComponent from,Medium,https://vuejs.org/guide/components/async.html
|
||||||
|
39,TypeScript,Use generic components,Type-safe reusable components,Generic with defineComponent,Any types in components,"<script setup lang=""ts"" generic=""T"">",<script setup> without types,Medium,https://vuejs.org/guide/typescript/composition-api.html
|
||||||
|
40,TypeScript,Type template refs,Proper typing for DOM refs,ref<HTMLInputElement>(null),ref(null) without type,const input = ref<HTMLInputElement>(null),const input = ref(null),Medium,
|
||||||
|
41,TypeScript,Use PropType for complex props,Type complex prop types,PropType<User> for object props,Object without type,type: Object as PropType<User>,type: Object,Medium,
|
||||||
|
42,Testing,Use Vue Test Utils,Official testing library,mount shallowMount for components,Manual DOM testing,import { mount } from '@vue/test-utils',document.createElement,Medium,https://test-utils.vuejs.org/
|
||||||
|
43,Testing,Test component behavior,Focus on inputs and outputs,Test props emit and rendered output,Test internal implementation,expect(wrapper.text()).toContain(),expect(wrapper.vm.internalState),Medium,
|
||||||
|
44,Forms,Use v-model modifiers,Built-in input handling,.lazy .number .trim modifiers,Manual input parsing,"<input v-model.number=""age"">","<input v-model=""age""> then parse",Low,https://vuejs.org/guide/essentials/forms.html#modifiers
|
||||||
|
45,Forms,Use VeeValidate or FormKit,Form validation libraries,VeeValidate for complex forms,Manual validation logic,useField useForm from vee-validate,Custom validation in each input,Medium,
|
||||||
|
46,Accessibility,Use semantic elements,Proper HTML elements in templates,button nav main for purpose,div for everything,<button @click>,<div @click>,High,
|
||||||
|
47,Accessibility,Bind aria attributes dynamically,Keep ARIA in sync with state,":aria-expanded=""isOpen""",Static ARIA values,":aria-expanded=""menuOpen""","aria-expanded=""true""",Medium,
|
||||||
|
48,SSR,Use Nuxt for SSR,Full-featured SSR framework,Nuxt 3 for SSR apps,Manual SSR setup,npx nuxi init my-app,Custom SSR configuration,Medium,https://nuxt.com/
|
||||||
|
49,SSR,Handle hydration mismatches,Client/server content must match,ClientOnly for browser-only content,Different content server/client,<ClientOnly><BrowserWidget/></ClientOnly>,<div>{{ Date.now() }}</div>,High,
|
||||||
|
|
|
@ -0,0 +1,59 @@
|
||||||
|
STT,Style Category,Type,Keywords,Primary Colors,Secondary Colors,Effects & Animation,Best For,Do Not Use For,Light Mode ✓,Dark Mode ✓,Performance,Accessibility,Mobile-Friendly,Conversion-Focused,Framework Compatibility,Era/Origin,Complexity
|
||||||
|
1,Minimalism & Swiss Style,General,"Clean, simple, spacious, functional, white space, high contrast, geometric, sans-serif, grid-based, essential","Monochromatic, Black #000000, White #FFFFFF","Neutral (Beige #F5F1E8, Grey #808080, Taupe #B38B6D), Primary accent","Subtle hover (200-250ms), smooth transitions, sharp shadows if any, clear type hierarchy, fast loading","Enterprise apps, dashboards, documentation sites, SaaS platforms, professional tools","Creative portfolios, entertainment, playful brands, artistic experiments",✓ Full,✓ Full,⚡ Excellent,✓ WCAG AAA,✓ High,◐ Medium,"Tailwind 10/10, Bootstrap 9/10, MUI 9/10",1950s Swiss,Low
|
||||||
|
2,Neumorphism,General,"Soft UI, embossed, debossed, convex, concave, light source, subtle depth, rounded (12-16px), monochromatic","Light pastels: Soft Blue #C8E0F4, Soft Pink #F5E0E8, Soft Grey #E8E8E8","Tints/shades (±30%), gradient subtlety, color harmony","Soft box-shadow (multiple: -5px -5px 15px, 5px 5px 15px), smooth press (150ms), inner subtle shadow","Health/wellness apps, meditation platforms, fitness trackers, minimal interaction UIs","Complex apps, critical accessibility, data-heavy dashboards, high-contrast required",✓ Full,◐ Partial,⚡ Good,⚠ Low contrast,✓ Good,◐ Medium,"Tailwind 8/10, CSS-in-JS 9/10",2020s Modern,Medium
|
||||||
|
3,Glassmorphism,General,"Frosted glass, transparent, blurred background, layered, vibrant background, light source, depth, multi-layer","Translucent white: rgba(255,255,255,0.1-0.3)","Vibrant: Electric Blue #0080FF, Neon Purple #8B00FF, Vivid Pink #FF1493, Teal #20B2AA","Backdrop blur (10-20px), subtle border (1px solid rgba white 0.2), light reflection, Z-depth","Modern SaaS, financial dashboards, high-end corporate, lifestyle apps, modal overlays, navigation","Low-contrast backgrounds, critical accessibility, performance-limited, dark text on dark",✓ Full,✓ Full,⚠ Good,⚠ Ensure 4.5:1,✓ Good,✓ High,"Tailwind 9/10, MUI 8/10, Chakra 8/10",2020s Modern,Medium
|
||||||
|
4,Brutalism,General,"Raw, unpolished, stark, high contrast, plain text, default fonts, visible borders, asymmetric, anti-design","Primary: Red #FF0000, Blue #0000FF, Yellow #FFFF00, Black #000000, White #FFFFFF","Limited: Neon Green #00FF00, Hot Pink #FF00FF, minimal secondary","No smooth transitions (instant), sharp corners (0px), bold typography (700+), visible grid, large blocks","Design portfolios, artistic projects, counter-culture brands, editorial/media sites, tech blogs","Corporate environments, conservative industries, critical accessibility, customer-facing professional",✓ Full,✓ Full,⚡ Excellent,✓ WCAG AAA,◐ Medium,✗ Low,"Tailwind 10/10, Bootstrap 7/10",1950s Brutalist,Low
|
||||||
|
5,3D & Hyperrealism,General,"Depth, realistic textures, 3D models, spatial navigation, tactile, skeuomorphic elements, rich detail, immersive","Deep Navy #001F3F, Forest Green #228B22, Burgundy #800020, Gold #FFD700, Silver #C0C0C0","Complex gradients (5-10 stops), realistic lighting, shadow variations (20-40% darker)","WebGL/Three.js 3D, realistic shadows (layers), physics lighting, parallax (3-5 layers), smooth 3D (300-400ms)","Gaming, product showcase, immersive experiences, high-end e-commerce, architectural viz, VR/AR","Low-end mobile, performance-limited, critical accessibility, data tables/forms",◐ Partial,◐ Partial,❌ Poor,⚠ Not accessible,✗ Low,◐ Medium,"Three.js 10/10, R3F 10/10, Babylon.js 10/10",2020s Modern,High
|
||||||
|
6,Vibrant & Block-based,General,"Bold, energetic, playful, block layout, geometric shapes, high color contrast, duotone, modern, energetic","Neon Green #39FF14, Electric Purple #BF00FF, Vivid Pink #FF1493, Bright Cyan #00FFFF, Sunburst #FFAA00","Complementary: Orange #FF7F00, Shocking Pink #FF006E, Lime #CCFF00, triadic schemes","Large sections (48px+ gaps), animated patterns, bold hover (color shift), scroll-snap, large type (32px+), 200-300ms","Startups, creative agencies, gaming, social media, youth-focused, entertainment, consumer","Financial institutions, healthcare, formal business, government, conservative, elderly",✓ Full,✓ Full,⚡ Good,◐ Ensure WCAG,✓ High,✓ High,"Tailwind 10/10, Chakra 9/10, Styled 9/10",2020s Modern,Medium
|
||||||
|
7,Dark Mode (OLED),General,"Dark theme, low light, high contrast, deep black, midnight blue, eye-friendly, OLED, night mode, power efficient","Deep Black #000000, Dark Grey #121212, Midnight Blue #0A0E27","Vibrant accents: Neon Green #39FF14, Electric Blue #0080FF, Gold #FFD700, Plasma Purple #BF00FF","Minimal glow (text-shadow: 0 0 10px), dark-to-light transitions, low white emission, high readability, visible focus","Night-mode apps, coding platforms, entertainment, eye-strain prevention, OLED devices, low-light","Print-first content, high-brightness outdoor, color-accuracy-critical",✗ No,✓ Only,⚡ Excellent,✓ WCAG AAA,✓ High,◐ Low,"Tailwind 10/10, MUI 10/10, Chakra 10/10",2020s Modern,Low
|
||||||
|
8,Accessible & Ethical,General,"High contrast, large text (16px+), keyboard navigation, screen reader friendly, WCAG compliant, focus state, semantic","WCAG AA/AAA (4.5:1 min), simple primary, clear secondary, high luminosity (7:1+)","Symbol-based colors (not color-only), supporting patterns, inclusive combinations","Clear focus rings (3-4px), ARIA labels, skip links, responsive design, reduced motion, 44x44px touch targets","Government, healthcare, education, inclusive products, large audience, legal compliance, public",None - accessibility universal,✓ Full,✓ Full,⚡ Excellent,✓ WCAG AAA,✓ High,✓ High,"All frameworks 10/10",Universal,Low
|
||||||
|
9,Claymorphism,General,"Soft 3D, chunky, playful, toy-like, bubbly, thick borders (3-4px), double shadows, rounded (16-24px)","Pastel: Soft Peach #FDBCB4, Baby Blue #ADD8E6, Mint #98FF98, Lilac #E6E6FA, light BG","Soft gradients (pastel-to-pastel), light/dark variations (20-30%), gradient subtle","Inner+outer shadows (subtle, no hard lines), soft press (200ms ease-out), fluffy elements, smooth transitions","Educational apps, children's apps, SaaS platforms, creative tools, fun-focused, onboarding, casual games","Formal corporate, professional services, data-critical, serious/medical, legal apps, finance",✓ Full,◐ Partial,⚡ Good,⚠ Ensure 4.5:1,✓ High,✓ High,"Tailwind 9/10, CSS-in-JS 9/10",2020s Modern,Medium
|
||||||
|
10,Aurora UI,General,"Vibrant gradients, smooth blend, Northern Lights effect, mesh gradient, luminous, atmospheric, abstract","Complementary: Blue-Orange, Purple-Yellow, Electric Blue #0080FF, Magenta #FF1493, Cyan #00FFFF","Smooth transitions (Blue→Purple→Pink→Teal), iridescent effects, blend modes (screen, multiply)","Large flowing CSS/SVG gradients, subtle 8-12s animations, depth via color layering, smooth morph","Modern SaaS, creative agencies, branding, music platforms, lifestyle, premium products, hero sections","Data-heavy dashboards, critical accessibility, content-heavy where distraction issues",✓ Full,✓ Full,⚠ Good,⚠ Text contrast,✓ Good,✓ High,"Tailwind 9/10, CSS-in-JS 10/10",2020s Modern,Medium
|
||||||
|
11,Retro-Futurism,General,"Vintage sci-fi, 80s aesthetic, neon glow, geometric patterns, CRT scanlines, pixel art, cyberpunk, synthwave","Neon Blue #0080FF, Hot Pink #FF006E, Cyan #00FFFF, Deep Black #1A1A2E, Purple #5D34D0","Metallic Silver #C0C0C0, Gold #FFD700, duotone, 80s Pink #FF10F0, neon accents","CRT scanlines (::before overlay), neon glow (text-shadow+box-shadow), glitch effects (skew/offset keyframes)","Gaming, entertainment, music platforms, tech brands, artistic projects, nostalgic, cyberpunk","Conservative industries, critical accessibility, professional/corporate, elderly, legal/finance",✓ Full,✓ Dark focused,⚠ Moderate,⚠ High contrast/strain,◐ Medium,◐ Medium,"Tailwind 8/10, CSS-in-JS 9/10",1980s Retro,Medium
|
||||||
|
12,Flat Design,General,"2D, minimalist, bold colors, no shadows, clean lines, simple shapes, typography-focused, modern, icon-heavy","Solid bright: Red, Orange, Blue, Green, limited palette (4-6 max)","Complementary colors, muted secondaries, high saturation, clean accents","No gradients/shadows, simple hover (color/opacity shift), fast loading, clean transitions (150-200ms ease), minimal icons","Web apps, mobile apps, cross-platform, startup MVPs, user-friendly, SaaS, dashboards, corporate","Complex 3D, premium/luxury, artistic portfolios, immersive experiences, high-detail",✓ Full,✓ Full,⚡ Excellent,✓ WCAG AAA,✓ High,✓ High,"Tailwind 10/10, Bootstrap 10/10, MUI 9/10",2010s Modern,Low
|
||||||
|
13,Skeuomorphism,General,"Realistic, texture, depth, 3D appearance, real-world metaphors, shadows, gradients, tactile, detailed, material","Rich realistic: wood, leather, metal colors, detailed gradients (8-12 stops), metallic effects","Realistic lighting gradients, shadow variations (30-50% darker), texture overlays, material colors","Realistic shadows (layers), depth (perspective), texture details (noise, grain), realistic animations (300-500ms)","Legacy apps, gaming, immersive storytelling, premium products, luxury, realistic simulations, education","Modern enterprise, critical accessibility, low-performance, web (use Flat/Modern)",◐ Partial,◐ Partial,❌ Poor,⚠ Textures reduce readability,✗ Low,◐ Medium,"CSS-in-JS 7/10, Custom 8/10",2007-2012 iOS,High
|
||||||
|
14,Liquid Glass,General,"Flowing glass, morphing, smooth transitions, fluid effects, translucent, animated blur, iridescent, chromatic aberration","Vibrant iridescent (rainbow spectrum), translucent base with opacity shifts, gradient fluidity","Chromatic aberration (Red-Cyan), iridescent oil-spill, fluid gradient blends, holographic effects","Morphing elements (SVG/CSS), fluid animations (400-600ms curves), dynamic blur (backdrop-filter), color transitions","Premium SaaS, high-end e-commerce, creative platforms, branding experiences, luxury portfolios","Performance-limited, critical accessibility, complex data, budget projects",✓ Full,✓ Full,⚠ Moderate-Poor,⚠ Text contrast,◐ Medium,✓ High,"Framer Motion 10/10, GSAP 10/10",2020s Modern,High
|
||||||
|
15,Motion-Driven,General,"Animation-heavy, microinteractions, smooth transitions, scroll effects, parallax, entrance anim, page transitions","Bold colors emphasize movement, high contrast animated, dynamic gradients, accent action colors","Transitional states, success (Green #22C55E), error (Red #EF4444), neutral feedback","Scroll anim (Intersection Observer), hover (300-400ms), entrance, parallax (3-5 layers), page transitions","Portfolio sites, storytelling platforms, interactive experiences, entertainment apps, creative, SaaS","Data dashboards, critical accessibility, low-power devices, content-heavy, motion-sensitive",✓ Full,✓ Full,⚠ Good,⚠ Prefers-reduced-motion,✓ Good,✓ High,"GSAP 10/10, Framer Motion 10/10",2020s Modern,High
|
||||||
|
16,Micro-interactions,General,"Small animations, gesture-based, tactile feedback, subtle animations, contextual interactions, responsive","Subtle color shifts (10-20%), feedback: Green #22C55E, Red #EF4444, Amber #F59E0B","Accent feedback, neutral supporting, clear action indicators","Small hover (50-100ms), loading spinners, success/error state anim, gesture-triggered (swipe/pinch), haptic","Mobile apps, touchscreen UIs, productivity tools, user-friendly, consumer apps, interactive components","Desktop-only, critical performance, accessibility-first (alternatives needed)",✓ Full,✓ Full,⚡ Excellent,✓ Good,✓ High,✓ High,"Framer Motion 10/10, React Spring 9/10",2020s Modern,Medium
|
||||||
|
17,Inclusive Design,General,"Accessible, color-blind friendly, high contrast, haptic feedback, voice interaction, screen reader, WCAG AAA, universal","WCAG AAA (7:1+ contrast), avoid red-green only, symbol-based indicators, high contrast primary","Supporting patterns (stripes, dots, hatch), symbols, combinations, clear non-color indicators","Haptic feedback (vibration), voice guidance, focus indicators (4px+ ring), motion options, alt content, semantic","Public services, education, healthcare, finance, government, accessible consumer, inclusive",None - accessibility universal,✓ Full,✓ Full,⚡ Excellent,✓ WCAG AAA,✓ High,✓ High,"All frameworks 10/10",Universal,Low
|
||||||
|
18,Zero Interface,General,"Minimal visible UI, voice-first, gesture-based, AI-driven, invisible controls, predictive, context-aware, ambient","Neutral backgrounds: Soft white #FAFAFA, light grey #F0F0F0, warm off-white #F5F1E8","Subtle feedback: light green, light red, minimal UI elements, soft accents","Voice recognition UI, gesture detection, AI predictions (smooth reveal), progressive disclosure, smart suggestions","Voice assistants, AI platforms, future-forward UX, smart home, contextual computing, ambient experiences","Complex workflows, data-entry heavy, traditional systems, legacy support, explicit control",✓ Full,✓ Full,⚡ Excellent,✓ Excellent,✓ High,✓ High,"Tailwind 10/10, Custom 10/10",2020s AI-Era,Low
|
||||||
|
19,Soft UI Evolution,General,"Evolved soft UI, better contrast, modern aesthetics, subtle depth, accessibility-focused, improved shadows, hybrid","Improved contrast pastels: Soft Blue #87CEEB, Soft Pink #FFB6C1, Soft Green #90EE90, better hierarchy","Better combinations, accessible secondary, supporting with improved contrast, modern accents","Improved shadows (softer than flat, clearer than neumorphism), modern (200-300ms), focus visible, WCAG AA/AAA","Modern enterprise apps, SaaS platforms, health/wellness, modern business tools, professional, hybrid","Extreme minimalism, critical performance, systems without modern OS",✓ Full,✓ Full,⚡ Excellent,✓ WCAG AA+,✓ High,✓ High,"Tailwind 9/10, MUI 9/10, Chakra 9/10",2020s Modern,Medium
|
||||||
|
20,Hero-Centric Design,Landing Page,"Large hero section, compelling headline, high-contrast CTA, product showcase, value proposition, hero image/video, dramatic visual","Brand primary color, white/light backgrounds for contrast, accent color for CTA","Supporting colors for secondary CTAs, accent highlights, trust elements (testimonials, logos)","Smooth scroll reveal, fade-in animations on hero, subtle background parallax, CTA glow/pulse effect","SaaS landing pages, product launches, service landing pages, B2B platforms, tech companies","Complex navigation, multi-page experiences, data-heavy applications",✓ Full,✓ Full,⚡ Good,✓ WCAG AA,✓ Full,✓ Very High,"Tailwind 10/10, Bootstrap 9/10",2020s Modern,Medium
|
||||||
|
21,Conversion-Optimized,Landing Page,"Form-focused, minimalist design, single CTA focus, high contrast, urgency elements, trust signals, social proof, clear value","Primary brand color, high-contrast white/light backgrounds, warning/urgency colors for time-limited offers","Secondary CTA color (muted), trust element colors (testimonial highlights), accent for key benefits","Hover states on CTA (color shift, slight scale), form field focus animations, loading spinner, success feedback","E-commerce product pages, free trial signups, lead generation, SaaS pricing pages, limited-time offers","Complex feature explanations, multi-product showcases, technical documentation",✓ Full,✓ Full,⚡ Excellent,✓ WCAG AA,✓ Full (mobile-optimized),✓ Very High,"Tailwind 10/10, Bootstrap 9/10",2020s Modern,Medium
|
||||||
|
22,Feature-Rich Showcase,Landing Page,"Multiple feature sections, grid layout, benefit cards, visual feature demonstrations, interactive elements, problem-solution pairs","Primary brand, bright secondary colors for feature cards, contrasting accent for CTAs","Supporting colors for: benefits (green), problems (red/orange), features (blue/purple), social proof (neutral)","Card hover effects (lift/scale), icon animations on scroll, feature toggle animations, smooth section transitions","Enterprise SaaS, software tools landing pages, platform services, complex product explanations, B2B products","Simple product pages, early-stage startups with few features, entertainment landing pages",✓ Full,✓ Full,⚡ Good,✓ WCAG AA,✓ Good,✓ High,"Tailwind 10/10, Bootstrap 9/10",2020s Modern,Medium
|
||||||
|
23,Minimal & Direct,Landing Page,"Minimal text, white space heavy, single column layout, direct messaging, clean typography, visual-centric, fast-loading","Monochromatic primary, white background, single accent color for CTA, black/dark grey text","Minimal secondary colors, reserved for critical CTAs only, neutral supporting elements","Very subtle hover effects, minimal animations, fast page load (no heavy animations), smooth scroll","Simple service landing pages, indie products, consulting services, micro SaaS, freelancer portfolios","Feature-heavy products, complex explanations, multi-product showcases",✓ Full,✓ Full,⚡ Excellent,✓ WCAG AAA,✓ Full,✓ High,"Tailwind 10/10, Bootstrap 10/10",2020s Modern,Low
|
||||||
|
24,Social Proof-Focused,Landing Page,"Testimonials prominent, client logos displayed, case studies sections, reviews/ratings, user avatars, success metrics, credibility markers","Primary brand, trust colors (blue), success/growth colors (green), neutral backgrounds","Testimonial highlight colors, logo grid backgrounds (light grey), badge/achievement colors","Testimonial carousel animations, logo grid fade-in, stat counter animations (number count-up), review star ratings","B2B SaaS, professional services, premium products, e-commerce conversion pages, established brands","Startup MVPs, products without users, niche/experimental products",✓ Full,✓ Full,⚡ Good,✓ WCAG AA,✓ Full,✓ High,"Tailwind 10/10, Bootstrap 9/10",2020s Modern,Medium
|
||||||
|
25,Interactive Product Demo,Landing Page,"Embedded product mockup/video, interactive elements, product walkthrough, step-by-step guides, hover-to-reveal features, embedded demos","Primary brand, interface colors matching product, demo highlight colors for interactive elements","Product UI colors, tutorial step colors (numbered progression), hover state indicators","Product animation playback, step progression animations, hover reveal effects, smooth zoom on interaction","SaaS platforms, tool/software products, productivity apps landing pages, developer tools, productivity software","Simple services, consulting, non-digital products, complexity-averse audiences",✓ Full,✓ Full,⚠ Good (video/interactive),✓ WCAG AA,✓ Good,✓ Very High,"Tailwind 9/10, React 10/10, Framer Motion 9/10",2020s Modern,High
|
||||||
|
26,Trust & Authority,Landing Page,"Certificates/badges displayed, expert credentials, case studies with metrics, before/after comparisons, industry recognition, security badges","Professional colors (blue/grey), trust colors, certification badge colors (gold/silver accents)","Certificate highlight colors, metric showcase colors, comparison highlight (success green)","Badge hover effects, metric pulse animations, certificate carousel, smooth stat reveal","Healthcare/medical landing pages, financial services, enterprise software, premium/luxury products, legal services","Casual products, entertainment, viral/social-first products",✓ Full,✓ Full,⚡ Excellent,✓ WCAG AAA,✓ Full,✓ High,"Tailwind 10/10, Bootstrap 9/10",2020s Modern,Low
|
||||||
|
27,Storytelling-Driven,Landing Page,"Narrative flow, visual story progression, section transitions, consistent character/brand voice, emotional messaging, journey visualization","Brand primary, warm/emotional colors, varied accent colors per story section, high visual variety","Story section color coding, emotional state colors (calm, excitement, success), transitional gradients","Section-to-section animations, scroll-triggered reveals, character/icon animations, morphing transitions, parallax narrative","Brand/startup stories, mission-driven products, premium/lifestyle brands, documentary-style products, educational","Technical/complex products (unless narrative-driven), traditional enterprise software",✓ Full,✓ Full,⚠ Moderate (animations),✓ WCAG AA,✓ Good,✓ High,"GSAP 10/10, Framer Motion 9/10, Tailwind 8/10",2020s Modern,High
|
||||||
|
28,Data-Dense Dashboard,BI/Analytics,"Multiple charts/widgets, data tables, KPI cards, minimal padding, grid layout, space-efficient, maximum data visibility","Neutral primary (light grey/white #F5F5F5), data colors (blue/green/red), dark text #333333","Chart colors: success (green #22C55E), warning (amber #F59E0B), alert (red #EF4444), neutral (grey)","Hover tooltips, chart zoom on click, row highlighting on hover, smooth filter animations, data loading spinners","Business intelligence dashboards, financial analytics, enterprise reporting, operational dashboards, data warehousing","Marketing dashboards, consumer-facing analytics, simple reporting",✓ Full,✓ Full,⚡ Excellent,✓ WCAG AA,◐ Medium,✗ Not applicable,"Recharts 9/10, Chart.js 9/10, D3.js 10/10",2020s Modern,Medium
|
||||||
|
29,Heat Map & Heatmap Style,BI/Analytics,"Color-coded grid/matrix, data intensity visualization, geographical heat maps, correlation matrices, cell-based representation, gradient coloring","Gradient scale: Cool (blue #0080FF) to hot (red #FF0000), neutral middle (white/yellow)","Support gradients: Light (cool blue) to dark (warm red), divergent for positive/negative data, monochromatic options","Color gradient transitions on data change, cell highlighting on hover, tooltip reveal on click, smooth color animation","Geographical analysis, performance matrices, correlation analysis, user behavior heatmaps, temperature/intensity data","Linear data representation, categorical comparisons (use bar charts), small datasets",✓ Full,✓ Full (with adjustments),⚡ Excellent,⚠ Colorblind considerations,◐ Medium,✗ Not applicable,"D3.js 10/10, Recharts 8/10, Chart.js 8/10",2020s Modern,Medium
|
||||||
|
30,Executive Dashboard,BI/Analytics,"High-level KPIs, large key metrics, minimal detail, summary view, trend indicators, at-a-glance insights, executive summary","Brand colors, professional palette (blue/grey/white), accent for KPIs, red for alerts/concerns","KPI highlight colors: positive (green), negative (red), neutral (grey), trend arrow colors","KPI value animations (count-up), trend arrow direction animations, metric card hover lift, alert pulse effect","C-suite dashboards, business summary reports, decision-maker dashboards, strategic planning views","Detailed analyst dashboards, technical deep-dives, operational monitoring",✓ Full,✓ Full,⚡ Excellent,✓ WCAG AA,✗ Low (not mobile-optimized),✗ Not applicable,"Recharts 9/10, Chart.js 9/10, MUI 9/10",2020s Modern,Low
|
||||||
|
31,Real-Time Monitoring,BI/Analytics,"Live data updates, status indicators, alert notifications, streaming data visualization, active monitoring, streaming charts","Alert colors: critical (red #FF0000), warning (orange #FFA500), normal (green #22C55E), updating (blue animation)","Status indicator colors, chart line colors varying by metric, streaming data highlight colors","Real-time chart animations, alert pulse/glow, status indicator blink animation, smooth data stream updates, loading effect","System monitoring dashboards, DevOps dashboards, real-time analytics, stock market dashboards, live event tracking","Historical analysis, long-term trend reports, archived data dashboards",✓ Full,✓ Full,⚡ Good (real-time load),✓ WCAG AA,◐ Medium,✗ Not applicable,"Recharts 9/10, D3.js 10/10, Socket.io 10/10",2020s Modern,High
|
||||||
|
32,Drill-Down Analytics,BI/Analytics,"Hierarchical data exploration, expandable sections, interactive drill-down paths, summary-to-detail flow, context preservation","Primary brand, breadcrumb colors, drill-level indicator colors, hierarchy depth colors","Drill-down path indicator colors, level-specific colors, highlight colors for selected level, transition colors","Drill-down expand animations, breadcrumb click transitions, smooth detail reveal, level change smooth, data reload animation","Sales analytics, product analytics, funnel analysis, multi-dimensional data exploration, business intelligence","Simple linear data, single-metric dashboards, streaming real-time dashboards",✓ Full,✓ Full,⚡ Good,✓ WCAG AA,◐ Medium,✗ Not applicable,"D3.js 10/10, Recharts 8/10, AG Grid 9/10",2020s Modern,High
|
||||||
|
33,Comparative Analysis Dashboard,BI/Analytics,"Side-by-side comparisons, period-over-period metrics, A/B test results, regional comparisons, performance benchmarks","Comparison colors: primary (blue), comparison (orange/purple), delta indicator (green/red)","Winning metric color (green), losing metric color (red), neutral comparison (grey), benchmark colors","Comparison bar animations (grow to value), delta indicator animations (direction arrows), highlight on compare","Period-over-period reporting, A/B test dashboards, market comparison, competitive analysis, regional performance","Single metric dashboards, future projections (use forecasting), real-time only (no historical)",✓ Full,✓ Full,⚡ Excellent,✓ WCAG AA,◐ Medium,✗ Not applicable,"Recharts 9/10, Chart.js 9/10, D3.js 9/10",2020s Modern,Medium
|
||||||
|
34,Predictive Analytics,BI/Analytics,"Forecast lines, confidence intervals, trend projections, scenario modeling, AI-driven insights, anomaly detection visualization","Forecast line color (distinct from actual), confidence interval shading, anomaly highlight (red alert), trend colors","High confidence (dark color), low confidence (light color), anomaly colors (red/orange), normal trend (green/blue)","Forecast line animation on draw, confidence band fade-in, anomaly pulse alert, smoothing function animations","Forecasting dashboards, anomaly detection systems, trend prediction dashboards, AI-powered analytics, budget planning","Historical-only dashboards, simple reporting, real-time operational dashboards",✓ Full,✓ Full,⚠ Good (computation),✓ WCAG AA,◐ Medium,✗ Not applicable,"D3.js 10/10, Recharts 8/10, TensorFlow.js 8/10",2020s Modern,High
|
||||||
|
35,User Behavior Analytics,BI/Analytics,"Funnel visualization, user flow diagrams, conversion tracking, engagement metrics, user journey mapping, cohort analysis","Funnel stage colors: high engagement (green), drop-off (red), conversion (blue), user flow arrows (grey)","Stage completion colors (success), abandonment colors (warning), engagement levels (gradient), cohort colors","Funnel animation (fill-down), flow diagram animations (connection draw), conversion pulse, engagement bar fill","Conversion funnel analysis, user journey tracking, engagement analytics, cohort analysis, retention tracking","Real-time operational metrics, technical system monitoring, financial transactions",✓ Full,✓ Full,⚡ Good,✓ WCAG AA,✓ Good,✗ Not applicable,"Recharts 9/10, Chart.js 9/10, D3.js 9/10",2020s Modern,Medium
|
||||||
|
36,Financial Dashboard,BI/Analytics,"Revenue metrics, profit/loss visualization, budget tracking, financial ratios, portfolio performance, cash flow, audit trail","Financial colors: profit (green #22C55E), loss (red #EF4444), neutral (grey), trust (dark blue #003366)","Revenue highlight (green), expenses (red), budget variance (orange/red), balance (grey), accuracy (blue)","Number animations (count-up), trend direction indicators, percentage change animations, profit/loss color transitions","Financial reporting, accounting dashboards, portfolio tracking, budget monitoring, banking analytics","Simple business dashboards, entertainment/social metrics, non-financial data",✓ Full,✓ Full,⚡ Excellent,✓ WCAG AAA,✗ Low,✗ Not applicable,"Recharts 9/10, Chart.js 9/10, AG Grid 10/10",2020s Modern,Medium
|
||||||
|
37,Sales Intelligence Dashboard,BI/Analytics,"Deal pipeline, sales metrics, territory performance, sales rep leaderboard, win-loss analysis, quota tracking, forecast accuracy","Sales colors: won (green), lost (red), in-progress (blue), blocked (orange), quota met (gold), quota missed (grey)","Pipeline stage colors, rep performance colors, quota achievement colors, forecast accuracy colors","Deal movement animations, metric updates, leaderboard ranking changes, gauge needle movements, status change highlights","CRM dashboards, sales management, opportunity tracking, performance management, quota planning","Marketing analytics, customer support metrics, HR dashboards",✓ Full,✓ Full,⚡ Good,✓ WCAG AA,◐ Medium,✗ Not applicable,"Recharts 9/10, Chart.js 9/10",2020s Modern,Medium
|
||||||
|
38,Neubrutalism,General,"Bold borders, black outlines, primary colors, thick shadows, no gradients, flat colors, 45° shadows, playful, Gen Z","#FFEB3B (Yellow), #FF5252 (Red), #2196F3 (Blue), #000000 (Black borders)","Limited accent colors, high contrast combinations, no gradients allowed","box-shadow: 4px 4px 0 #000, border: 3px solid #000, no gradients, sharp corners (0px), bold typography","Gen Z brands, startups, creative agencies, Figma-style apps, Notion-style interfaces, tech blogs","Luxury brands, finance, healthcare, conservative industries (too playful)",✓ Full,✓ Full,⚡ Excellent,✓ WCAG AAA,✓ High,✓ High,"Tailwind 10/10, Bootstrap 8/10",2020s Modern,Low
|
||||||
|
39,Bento Box Grid,General,"Modular cards, asymmetric grid, varied sizes, Apple-style, dashboard tiles, negative space, clean hierarchy, cards","Neutral base + brand accent, #FFFFFF, #F5F5F5, brand primary","Subtle gradients, shadow variations, accent highlights for interactive cards","grid-template with varied spans, rounded-xl (16px), subtle shadows, hover scale (1.02), smooth transitions","Dashboards, product pages, portfolios, Apple-style marketing, feature showcases, SaaS","Dense data tables, text-heavy content, real-time monitoring",✓ Full,✓ Full,⚡ Excellent,✓ WCAG AA,✓ High,✓ High,"Tailwind 10/10, CSS Grid 10/10",2020s Apple,Low
|
||||||
|
40,Y2K Aesthetic,General,"Neon pink, chrome, metallic, bubblegum, iridescent, glossy, retro-futurism, 2000s, futuristic nostalgia","#FF69B4 (Hot Pink), #00FFFF (Cyan), #C0C0C0 (Silver), #9400D3 (Purple)","Metallic gradients, glossy overlays, iridescent effects, chrome textures","linear-gradient metallic, glossy buttons, 3D chrome effects, glow animations, bubble shapes","Fashion brands, music platforms, Gen Z brands, nostalgia marketing, entertainment, youth-focused","B2B enterprise, healthcare, finance, conservative industries, elderly users",✓ Full,◐ Partial,⚠ Good,⚠ Check contrast,✓ Good,✓ High,"Tailwind 8/10, CSS-in-JS 9/10",Y2K 2000s,Medium
|
||||||
|
41,Cyberpunk UI,General,"Neon, dark mode, terminal, HUD, sci-fi, glitch, dystopian, futuristic, matrix, tech noir","#00FF00 (Matrix Green), #FF00FF (Magenta), #00FFFF (Cyan), #0D0D0D (Dark)","Neon gradients, scanline overlays, glitch colors, terminal green accents","Neon glow (text-shadow), glitch animations (skew/offset), scanlines (::before overlay), terminal fonts","Gaming platforms, tech products, crypto apps, sci-fi applications, developer tools, entertainment","Corporate enterprise, healthcare, family apps, conservative brands, elderly users",✗ No,✓ Only,⚠ Moderate,⚠ Limited (dark+neon),◐ Medium,◐ Medium,"Tailwind 8/10, Custom CSS 10/10",2020s Cyberpunk,Medium
|
||||||
|
42,Organic Biophilic,General,"Nature, organic shapes, green, sustainable, rounded, flowing, wellness, earthy, natural textures","#228B22 (Forest Green), #8B4513 (Earth Brown), #87CEEB (Sky Blue), #F5F5DC (Beige)","Natural gradients, earth tones, sky blues, organic textures, wood/stone colors","Rounded corners (16-24px), organic curves (border-radius variations), natural shadows, flowing SVG shapes","Wellness apps, sustainability brands, eco products, health apps, meditation, organic food brands","Tech-focused products, gaming, industrial, urban brands",✓ Full,✓ Full,⚡ Excellent,✓ WCAG AA,✓ High,✓ High,"Tailwind 10/10, CSS 10/10",2020s Sustainable,Low
|
||||||
|
43,AI-Native UI,General,"Chatbot, conversational, voice, assistant, agentic, ambient, minimal chrome, streaming text, AI interactions","Neutral + single accent, #6366F1 (AI Purple), #10B981 (Success), #F5F5F5 (Background)","Status indicators, streaming highlights, context card colors, subtle accent variations","Typing indicators (3-dot pulse), streaming text animations, pulse animations, context cards, smooth reveals","AI products, chatbots, voice assistants, copilots, AI-powered tools, conversational interfaces","Traditional forms, data-heavy dashboards, print-first content",✓ Full,✓ Full,⚡ Excellent,✓ WCAG AA,✓ High,✓ High,"Tailwind 10/10, React 10/10",2020s AI-Era,Low
|
||||||
|
44,Memphis Design,General,"80s, geometric, playful, postmodern, shapes, patterns, squiggles, triangles, neon, abstract, bold","#FF71CE (Hot Pink), #FFCE5C (Yellow), #86CCCA (Teal), #6A7BB4 (Blue Purple)","Complementary geometric colors, pattern fills, contrasting accent shapes","transform: rotate(), clip-path: polygon(), mix-blend-mode, repeating patterns, bold shapes","Creative agencies, music sites, youth brands, event promotion, artistic portfolios, entertainment","Corporate finance, healthcare, legal, elderly users, conservative brands",✓ Full,✓ Full,⚡ Excellent,⚠ Check contrast,✓ Good,◐ Medium,"Tailwind 9/10, CSS 10/10",1980s Postmodern,Medium
|
||||||
|
45,Vaporwave,General,"Synthwave, retro-futuristic, 80s-90s, neon, glitch, nostalgic, sunset gradient, dreamy, aesthetic","#FF71CE (Pink), #01CDFE (Cyan), #05FFA1 (Mint), #B967FF (Purple)","Sunset gradients, glitch overlays, VHS effects, neon accents, pastel variations","text-shadow glow, linear-gradient, filter: hue-rotate(), glitch animations, retro scan lines","Music platforms, gaming, creative portfolios, tech startups, entertainment, artistic projects","Business apps, e-commerce, education, healthcare, enterprise software",✓ Full,✓ Dark focused,⚠ Moderate,⚠ Poor (motion),◐ Medium,◐ Medium,"Tailwind 8/10, CSS-in-JS 9/10",1980s-90s Retro,Medium
|
||||||
|
46,Dimensional Layering,General,"Depth, overlapping, z-index, layers, 3D, shadows, elevation, floating, cards, spatial hierarchy","Neutral base (#FFFFFF, #F5F5F5, #E0E0E0) + brand accent for elevated elements","Shadow variations (sm/md/lg/xl), elevation colors, highlight colors for top layers","z-index stacking, box-shadow elevation (4 levels), transform: translateZ(), backdrop-filter, parallax","Dashboards, card layouts, modals, navigation, product showcases, SaaS interfaces","Print-style layouts, simple blogs, low-end devices, flat design requirements",✓ Full,✓ Full,⚠ Good,⚠ Moderate (SR issues),✓ Good,✓ High,"Tailwind 10/10, MUI 10/10, Chakra 10/10",2020s Modern,Medium
|
||||||
|
47,Exaggerated Minimalism,General,"Bold minimalism, oversized typography, high contrast, negative space, loud minimal, statement design","#000000 (Black), #FFFFFF (White), single vibrant accent only","Minimal - single accent color, no secondary colors, extreme restraint","font-size: clamp(3rem 10vw 12rem), font-weight: 900, letter-spacing: -0.05em, massive whitespace","Fashion, architecture, portfolios, agency landing pages, luxury brands, editorial","E-commerce catalogs, dashboards, forms, data-heavy, elderly users, complex apps",✓ Full,✓ Full,⚡ Excellent,✓ WCAG AA,✓ High,✓ High,"Tailwind 10/10, Typography.js 10/10",2020s Modern,Low
|
||||||
|
48,Kinetic Typography,General,"Motion text, animated type, moving letters, dynamic, typing effect, morphing, scroll-triggered text","Flexible - high contrast recommended, bold colors for emphasis, animation-friendly palette","Accent colors for emphasis, transition colors, gradient text fills","@keyframes text animation, typing effect, background-clip: text, GSAP ScrollTrigger, split text","Hero sections, marketing sites, video platforms, storytelling, creative portfolios, landing pages","Long-form content, accessibility-critical, data interfaces, forms, elderly users",✓ Full,✓ Full,⚠ Moderate,❌ Poor (motion),✓ Good,✓ Very High,"GSAP 10/10, Framer Motion 10/10",2020s Modern,High
|
||||||
|
49,Parallax Storytelling,General,"Scroll-driven, narrative, layered scrolling, immersive, progressive disclosure, cinematic, scroll-triggered","Story-dependent, often gradients and natural colors, section-specific palettes","Section transition colors, depth layer colors, narrative mood colors","transform: translateY(scroll), position: fixed/sticky, perspective: 1px, scroll-triggered animations","Brand storytelling, product launches, case studies, portfolios, annual reports, marketing campaigns","E-commerce, dashboards, mobile-first, SEO-critical, accessibility-required",✓ Full,✓ Full,❌ Poor,❌ Poor (motion),✗ Low,✓ High,"GSAP ScrollTrigger 10/10, Locomotive Scroll 10/10",2020s Modern,High
|
||||||
|
50,Swiss Modernism 2.0,General,"Grid system, Helvetica, modular, asymmetric, international style, rational, clean, mathematical spacing","#000000, #FFFFFF, #F5F5F5, single vibrant accent only","Minimal secondary, accent for emphasis only, no gradients","display: grid, grid-template-columns: repeat(12 1fr), gap: 1rem, mathematical ratios, clear hierarchy","Corporate sites, architecture, editorial, SaaS, museums, professional services, documentation","Playful brands, children's sites, entertainment, gaming, emotional storytelling",✓ Full,✓ Full,⚡ Excellent,✓ WCAG AAA,✓ High,✓ High,"Tailwind 10/10, Bootstrap 9/10, Foundation 10/10",1950s Swiss + 2020s,Low
|
||||||
|
51,HUD / Sci-Fi FUI,General,"Futuristic, technical, wireframe, neon, data, transparency, iron man, sci-fi, interface","Neon Cyan #00FFFF, Holographic Blue #0080FF, Alert Red #FF0000","Transparent Black, Grid Lines #333333","Glow effects, scanning animations, ticker text, blinking markers, fine line drawing","Sci-fi games, space tech, cybersecurity, movie props, immersive dashboards","Standard corporate, reading heavy content, accessible public services",✓ Low,✓ Full,⚠ Moderate (renders),⚠ Poor (thin lines),◐ Medium,✗ Low,"React 9/10, Canvas 10/10",2010s Sci-Fi,High
|
||||||
|
52,Pixel Art,General,"Retro, 8-bit, 16-bit, gaming, blocky, nostalgic, pixelated, arcade","Primary colors (NES Palette), brights, limited palette","Black outlines, shading via dithering or block colors","Frame-by-frame sprite animation, blinking cursor, instant transitions, marquee text","Indie games, retro tools, creative portfolios, nostalgia marketing, Web3/NFT","Professional corporate, modern SaaS, high-res photography sites",✓ Full,✓ Full,⚡ Excellent,✓ Good (if contrast ok),✓ High,◐ Medium,"CSS (box-shadow) 8/10, Canvas 10/10",1980s Arcade,Medium
|
||||||
|
53,Bento Grids,General,"Apple-style, modular, cards, organized, clean, hierarchy, grid, rounded, soft","Off-white #F5F5F7, Clean White #FFFFFF, Text #1D1D1F","Subtle accents, soft shadows, blurred backdrops","Hover scale (1.02), soft shadow expansion, smooth layout shifts, content reveal","Product features, dashboards, personal sites, marketing summaries, galleries","Long-form reading, data tables, complex forms",✓ Full,✓ Full,⚡ Excellent,✓ WCAG AA,✓ High,✓ High,"CSS Grid 10/10, Tailwind 10/10",2020s Apple/Linear,Low
|
||||||
|
54,Neubrutalism,General,"Bold, ugly-cute, raw, high contrast, flat, hard shadows, distinct, playful, loud","Pop Yellow #FFDE59, Bright Red #FF5757, Black #000000","Lavender #CBA6F7, Mint #76E0C2","Hard hover shifts (4px), marquee scrolling, jitter animations, bold borders","Design tools, creative agencies, Gen Z brands, personal blogs, gumroad-style","Banking, legal, healthcare, serious enterprise, elderly users",✓ Full,✓ Full,⚡ Excellent,✓ WCAG AAA,✓ High,✓ High,"Tailwind 10/10, Plain CSS 10/10",2020s Modern Retro,Low
|
||||||
|
55,Spatial UI (VisionOS),General,"Glass, depth, immersion, spatial, translucent, gaze, gesture, apple, vision-pro","Frosted Glass #FFFFFF (15-30% opacity), System White","Vibrant system colors for active states, deep shadows for depth","Parallax depth, dynamic lighting response, gaze-hover effects, smooth scale on focus","Spatial computing apps, VR/AR interfaces, immersive media, futuristic dashboards","Text-heavy documents, high-contrast requirements, non-3D capable devices",✓ Full,✓ Full,⚠ Moderate (blur cost),⚠ Contrast risks,✓ High (if adapted),✓ High,"SwiftUI, React (Three.js/Fiber)",2024 Spatial Era,High
|
||||||
|
56,E-Ink / Paper,General,"Paper-like, matte, high contrast, texture, reading, calm, slow tech, monochrome","Off-White #FDFBF7, Paper White #F5F5F5, Ink Black #1A1A1A","Pencil Grey #4A4A4A, Highlighter Yellow #FFFF00 (accent)","No motion blur, distinct page turns, grain/noise texture, sharp transitions (no fade)","Reading apps, digital newspapers, minimal journals, distraction-free writing, slow-living brands","Gaming, video platforms, high-energy marketing, dark mode dependent apps",✓ Full,✗ Low (inverted only),⚡ Excellent,✓ WCAG AAA,✓ High,✓ Medium,"Tailwind 10/10, CSS 10/10",2020s Digital Well-being,Low
|
||||||
|
57,Gen Z Chaos / Maximalism,General,"Chaos, clutter, stickers, raw, collage, mixed media, loud, internet culture, ironic","Clashing Brights: #FF00FF, #00FF00, #FFFF00, #0000FF","Gradients, rainbow, glitch, noise, heavily saturated mix","Marquee scrolls, jitter, sticker layering, GIF overload, random placement, drag-and-drop","Gen Z lifestyle brands, music artists, creative portfolios, viral marketing, fashion","Corporate, government, healthcare, banking, serious tools",✓ Full,✓ Full,⚠ Poor (heavy assets),❌ Poor,◐ Medium,✓ High (Viral),CSS-in-JS 8/10,2023+ Internet Core,High
|
||||||
|
58,Biomimetic / Organic 2.0,General,"Nature-inspired, cellular, fluid, breathing, generative, algorithms, life-like","Cellular Pink #FF9999, Chlorophyll Green #00FF41, Bioluminescent Blue","Deep Ocean #001E3C, Coral #FF7F50, Organic gradients","Breathing animations, fluid morphing, generative growth, physics-based movement","Sustainability tech, biotech, advanced health, meditation, generative art platforms","Standard SaaS, data grids, strict corporate, accounting",✓ Full,✓ Full,⚠ Moderate,✓ Good,✓ Good,✓ High,"Canvas 10/10, WebGL 10/10",2024+ Generative,High
|
||||||
|
|
|
@ -0,0 +1,58 @@
|
||||||
|
STT,Font Pairing Name,Category,Heading Font,Body Font,Mood/Style Keywords,Best For,Google Fonts URL,CSS Import,Tailwind Config,Notes
|
||||||
|
1,Classic Elegant,"Serif + Sans",Playfair Display,Inter,"elegant, luxury, sophisticated, timeless, premium, editorial","Luxury brands, fashion, spa, beauty, editorial, magazines, high-end e-commerce","https://fonts.google.com/share?selection.family=Inter:wght@300;400;500;600;700|Playfair+Display:wght@400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=Inter:wght@300;400;500;600;700&family=Playfair+Display:wght@400;500;600;700&display=swap');","fontFamily: { serif: ['Playfair Display', 'serif'], sans: ['Inter', 'sans-serif'] }","High contrast between elegant heading and clean body. Perfect for luxury/premium."
|
||||||
|
2,Modern Professional,"Sans + Sans",Poppins,Open Sans,"modern, professional, clean, corporate, friendly, approachable","SaaS, corporate sites, business apps, startups, professional services","https://fonts.google.com/share?selection.family=Open+Sans:wght@300;400;500;600;700|Poppins:wght@400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=Open+Sans:wght@300;400;500;600;700&family=Poppins:wght@400;500;600;700&display=swap');","fontFamily: { heading: ['Poppins', 'sans-serif'], body: ['Open Sans', 'sans-serif'] }","Geometric Poppins for headings, humanist Open Sans for readability."
|
||||||
|
3,Tech Startup,"Sans + Sans",Space Grotesk,DM Sans,"tech, startup, modern, innovative, bold, futuristic","Tech companies, startups, SaaS, developer tools, AI products","https://fonts.google.com/share?selection.family=DM+Sans:wght@400;500;700|Space+Grotesk:wght@400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=DM+Sans:wght@400;500;700&family=Space+Grotesk:wght@400;500;600;700&display=swap');","fontFamily: { heading: ['Space Grotesk', 'sans-serif'], body: ['DM Sans', 'sans-serif'] }","Space Grotesk has unique character, DM Sans is highly readable."
|
||||||
|
4,Editorial Classic,"Serif + Serif",Cormorant Garamond,Libre Baskerville,"editorial, classic, literary, traditional, refined, bookish","Publishing, blogs, news sites, literary magazines, book covers","https://fonts.google.com/share?selection.family=Cormorant+Garamond:wght@400;500;600;700|Libre+Baskerville:wght@400;700","@import url('https://fonts.googleapis.com/css2?family=Cormorant+Garamond:wght@400;500;600;700&family=Libre+Baskerville:wght@400;700&display=swap');","fontFamily: { heading: ['Cormorant Garamond', 'serif'], body: ['Libre Baskerville', 'serif'] }","All-serif pairing for traditional editorial feel."
|
||||||
|
5,Minimal Swiss,"Sans + Sans",Inter,Inter,"minimal, clean, swiss, functional, neutral, professional","Dashboards, admin panels, documentation, enterprise apps, design systems","https://fonts.google.com/share?selection.family=Inter:wght@300;400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=Inter:wght@300;400;500;600;700&display=swap');","fontFamily: { sans: ['Inter', 'sans-serif'] }","Single font family with weight variations. Ultimate simplicity."
|
||||||
|
6,Playful Creative,"Display + Sans",Fredoka,Nunito,"playful, friendly, fun, creative, warm, approachable","Children's apps, educational, gaming, creative tools, entertainment","https://fonts.google.com/share?selection.family=Fredoka:wght@400;500;600;700|Nunito:wght@300;400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=Fredoka:wght@400;500;600;700&family=Nunito:wght@300;400;500;600;700&display=swap');","fontFamily: { heading: ['Fredoka', 'sans-serif'], body: ['Nunito', 'sans-serif'] }","Rounded, friendly fonts perfect for playful UIs."
|
||||||
|
7,Bold Statement,"Display + Sans",Bebas Neue,Source Sans 3,"bold, impactful, strong, dramatic, modern, headlines","Marketing sites, portfolios, agencies, event pages, sports","https://fonts.google.com/share?selection.family=Bebas+Neue|Source+Sans+3:wght@300;400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=Bebas+Neue&family=Source+Sans+3:wght@300;400;500;600;700&display=swap');","fontFamily: { display: ['Bebas Neue', 'sans-serif'], body: ['Source Sans 3', 'sans-serif'] }","Bebas Neue for large headlines only. All-caps display font."
|
||||||
|
8,Wellness Calm,"Serif + Sans",Lora,Raleway,"calm, wellness, health, relaxing, natural, organic","Health apps, wellness, spa, meditation, yoga, organic brands","https://fonts.google.com/share?selection.family=Lora:wght@400;500;600;700|Raleway:wght@300;400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=Lora:wght@400;500;600;700&family=Raleway:wght@300;400;500;600;700&display=swap');","fontFamily: { serif: ['Lora', 'serif'], sans: ['Raleway', 'sans-serif'] }","Lora's organic curves with Raleway's elegant simplicity."
|
||||||
|
9,Developer Mono,"Mono + Sans",JetBrains Mono,IBM Plex Sans,"code, developer, technical, precise, functional, hacker","Developer tools, documentation, code editors, tech blogs, CLI apps","https://fonts.google.com/share?selection.family=IBM+Plex+Sans:wght@300;400;500;600;700|JetBrains+Mono:wght@400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=IBM+Plex+Sans:wght@300;400;500;600;700&family=JetBrains+Mono:wght@400;500;600;700&display=swap');","fontFamily: { mono: ['JetBrains Mono', 'monospace'], sans: ['IBM Plex Sans', 'sans-serif'] }","JetBrains for code, IBM Plex for UI. Developer-focused."
|
||||||
|
10,Retro Vintage,"Display + Serif",Abril Fatface,Merriweather,"retro, vintage, nostalgic, dramatic, decorative, bold","Vintage brands, breweries, restaurants, creative portfolios, posters","https://fonts.google.com/share?selection.family=Abril+Fatface|Merriweather:wght@300;400;700","@import url('https://fonts.googleapis.com/css2?family=Abril+Fatface&family=Merriweather:wght@300;400;700&display=swap');","fontFamily: { display: ['Abril Fatface', 'serif'], body: ['Merriweather', 'serif'] }","Abril Fatface for hero headlines only. High-impact vintage feel."
|
||||||
|
11,Geometric Modern,"Sans + Sans",Outfit,Work Sans,"geometric, modern, clean, balanced, contemporary, versatile","General purpose, portfolios, agencies, modern brands, landing pages","https://fonts.google.com/share?selection.family=Outfit:wght@300;400;500;600;700|Work+Sans:wght@300;400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=Outfit:wght@300;400;500;600;700&family=Work+Sans:wght@300;400;500;600;700&display=swap');","fontFamily: { heading: ['Outfit', 'sans-serif'], body: ['Work Sans', 'sans-serif'] }","Both geometric but Outfit more distinctive for headings."
|
||||||
|
12,Luxury Serif,"Serif + Sans",Cormorant,Montserrat,"luxury, high-end, fashion, elegant, refined, premium","Fashion brands, luxury e-commerce, jewelry, high-end services","https://fonts.google.com/share?selection.family=Cormorant:wght@400;500;600;700|Montserrat:wght@300;400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=Cormorant:wght@400;500;600;700&family=Montserrat:wght@300;400;500;600;700&display=swap');","fontFamily: { serif: ['Cormorant', 'serif'], sans: ['Montserrat', 'sans-serif'] }","Cormorant's elegance with Montserrat's geometric precision."
|
||||||
|
13,Friendly SaaS,"Sans + Sans",Plus Jakarta Sans,Plus Jakarta Sans,"friendly, modern, saas, clean, approachable, professional","SaaS products, web apps, dashboards, B2B, productivity tools","https://fonts.google.com/share?selection.family=Plus+Jakarta+Sans:wght@300;400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=Plus+Jakarta+Sans:wght@300;400;500;600;700&display=swap');","fontFamily: { sans: ['Plus Jakarta Sans', 'sans-serif'] }","Single versatile font. Modern alternative to Inter."
|
||||||
|
14,News Editorial,"Serif + Sans",Newsreader,Roboto,"news, editorial, journalism, trustworthy, readable, informative","News sites, blogs, magazines, journalism, content-heavy sites","https://fonts.google.com/share?selection.family=Newsreader:wght@400;500;600;700|Roboto:wght@300;400;500;700","@import url('https://fonts.googleapis.com/css2?family=Newsreader:wght@400;500;600;700&family=Roboto:wght@300;400;500;700&display=swap');","fontFamily: { serif: ['Newsreader', 'serif'], sans: ['Roboto', 'sans-serif'] }","Newsreader designed for long-form reading. Roboto for UI."
|
||||||
|
15,Handwritten Charm,"Script + Sans",Caveat,Quicksand,"handwritten, personal, friendly, casual, warm, charming","Personal blogs, invitations, creative portfolios, lifestyle brands","https://fonts.google.com/share?selection.family=Caveat:wght@400;500;600;700|Quicksand:wght@300;400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=Caveat:wght@400;500;600;700&family=Quicksand:wght@300;400;500;600;700&display=swap');","fontFamily: { script: ['Caveat', 'cursive'], sans: ['Quicksand', 'sans-serif'] }","Use Caveat sparingly for accents. Quicksand for body."
|
||||||
|
16,Corporate Trust,"Sans + Sans",Lexend,Source Sans 3,"corporate, trustworthy, accessible, readable, professional, clean","Enterprise, government, healthcare, finance, accessibility-focused","https://fonts.google.com/share?selection.family=Lexend:wght@300;400;500;600;700|Source+Sans+3:wght@300;400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=Lexend:wght@300;400;500;600;700&family=Source+Sans+3:wght@300;400;500;600;700&display=swap');","fontFamily: { heading: ['Lexend', 'sans-serif'], body: ['Source Sans 3', 'sans-serif'] }","Lexend designed for readability. Excellent accessibility."
|
||||||
|
17,Brutalist Raw,"Mono + Mono",Space Mono,Space Mono,"brutalist, raw, technical, monospace, minimal, stark","Brutalist designs, developer portfolios, experimental, tech art","https://fonts.google.com/share?selection.family=Space+Mono:wght@400;700","@import url('https://fonts.googleapis.com/css2?family=Space+Mono:wght@400;700&display=swap');","fontFamily: { mono: ['Space Mono', 'monospace'] }","All-mono for raw brutalist aesthetic. Limited weights."
|
||||||
|
18,Fashion Forward,"Sans + Sans",Syne,Manrope,"fashion, avant-garde, creative, bold, artistic, edgy","Fashion brands, creative agencies, art galleries, design studios","https://fonts.google.com/share?selection.family=Manrope:wght@300;400;500;600;700|Syne:wght@400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=Manrope:wght@300;400;500;600;700&family=Syne:wght@400;500;600;700&display=swap');","fontFamily: { heading: ['Syne', 'sans-serif'], body: ['Manrope', 'sans-serif'] }","Syne's unique character for headlines. Manrope for readability."
|
||||||
|
19,Soft Rounded,"Sans + Sans",Varela Round,Nunito Sans,"soft, rounded, friendly, approachable, warm, gentle","Children's products, pet apps, friendly brands, wellness, soft UI","https://fonts.google.com/share?selection.family=Nunito+Sans:wght@300;400;500;600;700|Varela+Round","@import url('https://fonts.googleapis.com/css2?family=Nunito+Sans:wght@300;400;500;600;700&family=Varela+Round&display=swap');","fontFamily: { heading: ['Varela Round', 'sans-serif'], body: ['Nunito Sans', 'sans-serif'] }","Both rounded and friendly. Perfect for soft UI designs."
|
||||||
|
20,Premium Sans,"Sans + Sans",Satoshi,General Sans,"premium, modern, clean, sophisticated, versatile, balanced","Premium brands, modern agencies, SaaS, portfolios, startups","https://fonts.google.com/share?selection.family=DM+Sans:wght@400;500;700","@import url('https://fonts.googleapis.com/css2?family=DM+Sans:wght@400;500;700&display=swap');","fontFamily: { sans: ['DM Sans', 'sans-serif'] }","Note: Satoshi/General Sans on Fontshare. DM Sans as Google alternative."
|
||||||
|
21,Vietnamese Friendly,"Sans + Sans",Be Vietnam Pro,Noto Sans,"vietnamese, international, readable, clean, multilingual, accessible","Vietnamese sites, multilingual apps, international products","https://fonts.google.com/share?selection.family=Be+Vietnam+Pro:wght@300;400;500;600;700|Noto+Sans:wght@300;400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=Be+Vietnam+Pro:wght@300;400;500;600;700&family=Noto+Sans:wght@300;400;500;600;700&display=swap');","fontFamily: { sans: ['Be Vietnam Pro', 'Noto Sans', 'sans-serif'] }","Be Vietnam Pro excellent Vietnamese support. Noto as fallback."
|
||||||
|
22,Japanese Elegant,"Serif + Sans",Noto Serif JP,Noto Sans JP,"japanese, elegant, traditional, modern, multilingual, readable","Japanese sites, Japanese restaurants, cultural sites, anime/manga","https://fonts.google.com/share?selection.family=Noto+Sans+JP:wght@300;400;500;700|Noto+Serif+JP:wght@400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=Noto+Sans+JP:wght@300;400;500;700&family=Noto+Serif+JP:wght@400;500;600;700&display=swap');","fontFamily: { serif: ['Noto Serif JP', 'serif'], sans: ['Noto Sans JP', 'sans-serif'] }","Noto fonts excellent Japanese support. Traditional + modern feel."
|
||||||
|
23,Korean Modern,"Sans + Sans",Noto Sans KR,Noto Sans KR,"korean, modern, clean, professional, multilingual, readable","Korean sites, K-beauty, K-pop, Korean businesses, multilingual","https://fonts.google.com/share?selection.family=Noto+Sans+KR:wght@300;400;500;700","@import url('https://fonts.googleapis.com/css2?family=Noto+Sans+KR:wght@300;400;500;700&display=swap');","fontFamily: { sans: ['Noto Sans KR', 'sans-serif'] }","Clean Korean typography. Single font with weight variations."
|
||||||
|
24,Chinese Traditional,"Serif + Sans",Noto Serif TC,Noto Sans TC,"chinese, traditional, elegant, cultural, multilingual, readable","Traditional Chinese sites, cultural content, Taiwan/Hong Kong markets","https://fonts.google.com/share?selection.family=Noto+Sans+TC:wght@300;400;500;700|Noto+Serif+TC:wght@400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=Noto+Sans+TC:wght@300;400;500;700&family=Noto+Serif+TC:wght@400;500;600;700&display=swap');","fontFamily: { serif: ['Noto Serif TC', 'serif'], sans: ['Noto Sans TC', 'sans-serif'] }","Traditional Chinese character support. Elegant pairing."
|
||||||
|
25,Chinese Simplified,"Sans + Sans",Noto Sans SC,Noto Sans SC,"chinese, simplified, modern, professional, multilingual, readable","Simplified Chinese sites, mainland China market, business apps","https://fonts.google.com/share?selection.family=Noto+Sans+SC:wght@300;400;500;700","@import url('https://fonts.googleapis.com/css2?family=Noto+Sans+SC:wght@300;400;500;700&display=swap');","fontFamily: { sans: ['Noto Sans SC', 'sans-serif'] }","Simplified Chinese support. Clean modern look."
|
||||||
|
26,Arabic Elegant,"Serif + Sans",Noto Naskh Arabic,Noto Sans Arabic,"arabic, elegant, traditional, cultural, RTL, readable","Arabic sites, Middle East market, Islamic content, bilingual sites","https://fonts.google.com/share?selection.family=Noto+Naskh+Arabic:wght@400;500;600;700|Noto+Sans+Arabic:wght@300;400;500;700","@import url('https://fonts.googleapis.com/css2?family=Noto+Naskh+Arabic:wght@400;500;600;700&family=Noto+Sans+Arabic:wght@300;400;500;700&display=swap');","fontFamily: { serif: ['Noto Naskh Arabic', 'serif'], sans: ['Noto Sans Arabic', 'sans-serif'] }","RTL support. Naskh for traditional, Sans for modern Arabic."
|
||||||
|
27,Thai Modern,"Sans + Sans",Noto Sans Thai,Noto Sans Thai,"thai, modern, readable, clean, multilingual, accessible","Thai sites, Southeast Asia, tourism, Thai restaurants","https://fonts.google.com/share?selection.family=Noto+Sans+Thai:wght@300;400;500;700","@import url('https://fonts.googleapis.com/css2?family=Noto+Sans+Thai:wght@300;400;500;700&display=swap');","fontFamily: { sans: ['Noto Sans Thai', 'sans-serif'] }","Clean Thai typography. Excellent readability."
|
||||||
|
28,Hebrew Modern,"Sans + Sans",Noto Sans Hebrew,Noto Sans Hebrew,"hebrew, modern, RTL, clean, professional, readable","Hebrew sites, Israeli market, Jewish content, bilingual sites","https://fonts.google.com/share?selection.family=Noto+Sans+Hebrew:wght@300;400;500;700","@import url('https://fonts.googleapis.com/css2?family=Noto+Sans+Hebrew:wght@300;400;500;700&display=swap');","fontFamily: { sans: ['Noto Sans Hebrew', 'sans-serif'] }","RTL support. Clean modern Hebrew typography."
|
||||||
|
29,Legal Professional,"Serif + Sans",EB Garamond,Lato,"legal, professional, traditional, trustworthy, formal, authoritative","Law firms, legal services, contracts, formal documents, government","https://fonts.google.com/share?selection.family=EB+Garamond:wght@400;500;600;700|Lato:wght@300;400;700","@import url('https://fonts.googleapis.com/css2?family=EB+Garamond:wght@400;500;600;700&family=Lato:wght@300;400;700&display=swap');","fontFamily: { serif: ['EB Garamond', 'serif'], sans: ['Lato', 'sans-serif'] }","EB Garamond for authority. Lato for clean body text."
|
||||||
|
30,Medical Clean,"Sans + Sans",Figtree,Noto Sans,"medical, clean, accessible, professional, healthcare, trustworthy","Healthcare, medical clinics, pharma, health apps, accessibility","https://fonts.google.com/share?selection.family=Figtree:wght@300;400;500;600;700|Noto+Sans:wght@300;400;500;700","@import url('https://fonts.googleapis.com/css2?family=Figtree:wght@300;400;500;600;700&family=Noto+Sans:wght@300;400;500;700&display=swap');","fontFamily: { heading: ['Figtree', 'sans-serif'], body: ['Noto Sans', 'sans-serif'] }","Clean, accessible fonts for medical contexts."
|
||||||
|
31,Financial Trust,"Sans + Sans",IBM Plex Sans,IBM Plex Sans,"financial, trustworthy, professional, corporate, banking, serious","Banks, finance, insurance, investment, fintech, enterprise","https://fonts.google.com/share?selection.family=IBM+Plex+Sans:wght@300;400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=IBM+Plex+Sans:wght@300;400;500;600;700&display=swap');","fontFamily: { sans: ['IBM Plex Sans', 'sans-serif'] }","IBM Plex conveys trust and professionalism. Excellent for data."
|
||||||
|
32,Real Estate Luxury,"Serif + Sans",Cinzel,Josefin Sans,"real estate, luxury, elegant, sophisticated, property, premium","Real estate, luxury properties, architecture, interior design","https://fonts.google.com/share?selection.family=Cinzel:wght@400;500;600;700|Josefin+Sans:wght@300;400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=Cinzel:wght@400;500;600;700&family=Josefin+Sans:wght@300;400;500;600;700&display=swap');","fontFamily: { serif: ['Cinzel', 'serif'], sans: ['Josefin Sans', 'sans-serif'] }","Cinzel's elegance for headlines. Josefin for modern body."
|
||||||
|
33,Restaurant Menu,"Serif + Sans",Playfair Display SC,Karla,"restaurant, menu, culinary, elegant, foodie, hospitality","Restaurants, cafes, food blogs, culinary, hospitality","https://fonts.google.com/share?selection.family=Karla:wght@300;400;500;600;700|Playfair+Display+SC:wght@400;700","@import url('https://fonts.googleapis.com/css2?family=Karla:wght@300;400;500;600;700&family=Playfair+Display+SC:wght@400;700&display=swap');","fontFamily: { display: ['Playfair Display SC', 'serif'], sans: ['Karla', 'sans-serif'] }","Small caps Playfair for menu headers. Karla for descriptions."
|
||||||
|
34,Art Deco,"Display + Sans",Poiret One,Didact Gothic,"art deco, vintage, 1920s, elegant, decorative, gatsby","Vintage events, art deco themes, luxury hotels, classic cocktails","https://fonts.google.com/share?selection.family=Didact+Gothic|Poiret+One","@import url('https://fonts.googleapis.com/css2?family=Didact+Gothic&family=Poiret+One&display=swap');","fontFamily: { display: ['Poiret One', 'sans-serif'], sans: ['Didact Gothic', 'sans-serif'] }","Poiret One for art deco headlines only. Didact for body."
|
||||||
|
35,Magazine Style,"Serif + Sans",Libre Bodoni,Public Sans,"magazine, editorial, publishing, refined, journalism, print","Magazines, online publications, editorial content, journalism","https://fonts.google.com/share?selection.family=Libre+Bodoni:wght@400;500;600;700|Public+Sans:wght@300;400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=Libre+Bodoni:wght@400;500;600;700&family=Public+Sans:wght@300;400;500;600;700&display=swap');","fontFamily: { serif: ['Libre Bodoni', 'serif'], sans: ['Public Sans', 'sans-serif'] }","Bodoni's editorial elegance. Public Sans for clean UI."
|
||||||
|
36,Crypto/Web3,"Sans + Sans",Orbitron,Exo 2,"crypto, web3, futuristic, tech, blockchain, digital","Crypto platforms, NFT, blockchain, web3, futuristic tech","https://fonts.google.com/share?selection.family=Exo+2:wght@300;400;500;600;700|Orbitron:wght@400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=Exo+2:wght@300;400;500;600;700&family=Orbitron:wght@400;500;600;700&display=swap');","fontFamily: { display: ['Orbitron', 'sans-serif'], body: ['Exo 2', 'sans-serif'] }","Orbitron for futuristic headers. Exo 2 for readable body."
|
||||||
|
37,Gaming Bold,"Display + Sans",Russo One,Chakra Petch,"gaming, bold, action, esports, competitive, energetic","Gaming, esports, action games, competitive sports, entertainment","https://fonts.google.com/share?selection.family=Chakra+Petch:wght@300;400;500;600;700|Russo+One","@import url('https://fonts.googleapis.com/css2?family=Chakra+Petch:wght@300;400;500;600;700&family=Russo+One&display=swap');","fontFamily: { display: ['Russo One', 'sans-serif'], body: ['Chakra Petch', 'sans-serif'] }","Russo One for impact. Chakra Petch for techy body text."
|
||||||
|
38,Indie/Craft,"Display + Sans",Amatic SC,Cabin,"indie, craft, handmade, artisan, organic, creative","Craft brands, indie products, artisan, handmade, organic products","https://fonts.google.com/share?selection.family=Amatic+SC:wght@400;700|Cabin:wght@400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=Amatic+SC:wght@400;700&family=Cabin:wght@400;500;600;700&display=swap');","fontFamily: { display: ['Amatic SC', 'sans-serif'], sans: ['Cabin', 'sans-serif'] }","Amatic for handwritten feel. Cabin for readable body."
|
||||||
|
39,Startup Bold,"Sans + Sans",Clash Display,Satoshi,"startup, bold, modern, innovative, confident, dynamic","Startups, pitch decks, product launches, bold brands","https://fonts.google.com/share?selection.family=Outfit:wght@400;500;600;700|Rubik:wght@300;400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=Outfit:wght@400;500;600;700&family=Rubik:wght@300;400;500;600;700&display=swap');","fontFamily: { heading: ['Outfit', 'sans-serif'], body: ['Rubik', 'sans-serif'] }","Note: Clash Display on Fontshare. Outfit as Google alternative."
|
||||||
|
40,E-commerce Clean,"Sans + Sans",Rubik,Nunito Sans,"ecommerce, clean, shopping, product, retail, conversion","E-commerce, online stores, product pages, retail, shopping","https://fonts.google.com/share?selection.family=Nunito+Sans:wght@300;400;500;600;700|Rubik:wght@300;400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=Nunito+Sans:wght@300;400;500;600;700&family=Rubik:wght@300;400;500;600;700&display=swap');","fontFamily: { heading: ['Rubik', 'sans-serif'], body: ['Nunito Sans', 'sans-serif'] }","Clean readable fonts perfect for product descriptions."
|
||||||
|
41,Academic/Research,"Serif + Sans",Crimson Pro,Atkinson Hyperlegible,"academic, research, scholarly, accessible, readable, educational","Universities, research papers, academic journals, educational","https://fonts.google.com/share?selection.family=Atkinson+Hyperlegible:wght@400;700|Crimson+Pro:wght@400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=Atkinson+Hyperlegible:wght@400;700&family=Crimson+Pro:wght@400;500;600;700&display=swap');","fontFamily: { serif: ['Crimson Pro', 'serif'], sans: ['Atkinson Hyperlegible', 'sans-serif'] }","Crimson for scholarly headlines. Atkinson for accessibility."
|
||||||
|
42,Dashboard Data,"Mono + Sans",Fira Code,Fira Sans,"dashboard, data, analytics, code, technical, precise","Dashboards, analytics, data visualization, admin panels","https://fonts.google.com/share?selection.family=Fira+Code:wght@400;500;600;700|Fira+Sans:wght@300;400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=Fira+Code:wght@400;500;600;700&family=Fira+Sans:wght@300;400;500;600;700&display=swap');","fontFamily: { mono: ['Fira Code', 'monospace'], sans: ['Fira Sans', 'sans-serif'] }","Fira family cohesion. Code for data, Sans for labels."
|
||||||
|
43,Music/Entertainment,"Display + Sans",Righteous,Poppins,"music, entertainment, fun, energetic, bold, performance","Music platforms, entertainment, events, festivals, performers","https://fonts.google.com/share?selection.family=Poppins:wght@300;400;500;600;700|Righteous","@import url('https://fonts.googleapis.com/css2?family=Poppins:wght@300;400;500;600;700&family=Righteous&display=swap');","fontFamily: { display: ['Righteous', 'sans-serif'], sans: ['Poppins', 'sans-serif'] }","Righteous for bold entertainment headers. Poppins for body."
|
||||||
|
44,Minimalist Portfolio,"Sans + Sans",Archivo,Space Grotesk,"minimal, portfolio, designer, creative, clean, artistic","Design portfolios, creative professionals, minimalist brands","https://fonts.google.com/share?selection.family=Archivo:wght@300;400;500;600;700|Space+Grotesk:wght@300;400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=Archivo:wght@300;400;500;600;700&family=Space+Grotesk:wght@300;400;500;600;700&display=swap');","fontFamily: { heading: ['Space Grotesk', 'sans-serif'], body: ['Archivo', 'sans-serif'] }","Space Grotesk for distinctive headers. Archivo for clean body."
|
||||||
|
45,Kids/Education,"Display + Sans",Baloo 2,Comic Neue,"kids, education, playful, friendly, colorful, learning","Children's apps, educational games, kid-friendly content","https://fonts.google.com/share?selection.family=Baloo+2:wght@400;500;600;700|Comic+Neue:wght@300;400;700","@import url('https://fonts.googleapis.com/css2?family=Baloo+2:wght@400;500;600;700&family=Comic+Neue:wght@300;400;700&display=swap');","fontFamily: { display: ['Baloo 2', 'sans-serif'], sans: ['Comic Neue', 'sans-serif'] }","Fun, playful fonts for children. Comic Neue is readable comic style."
|
||||||
|
46,Wedding/Romance,"Script + Serif",Great Vibes,Cormorant Infant,"wedding, romance, elegant, script, invitation, feminine","Wedding sites, invitations, romantic brands, bridal","https://fonts.google.com/share?selection.family=Cormorant+Infant:wght@300;400;500;600;700|Great+Vibes","@import url('https://fonts.googleapis.com/css2?family=Cormorant+Infant:wght@300;400;500;600;700&family=Great+Vibes&display=swap');","fontFamily: { script: ['Great Vibes', 'cursive'], serif: ['Cormorant Infant', 'serif'] }","Great Vibes for elegant accents. Cormorant for readable text."
|
||||||
|
47,Science/Tech,"Sans + Sans",Exo,Roboto Mono,"science, technology, research, data, futuristic, precise","Science, research, tech documentation, data-heavy sites","https://fonts.google.com/share?selection.family=Exo:wght@300;400;500;600;700|Roboto+Mono:wght@300;400;500;700","@import url('https://fonts.googleapis.com/css2?family=Exo:wght@300;400;500;600;700&family=Roboto+Mono:wght@300;400;500;700&display=swap');","fontFamily: { sans: ['Exo', 'sans-serif'], mono: ['Roboto Mono', 'monospace'] }","Exo for modern tech feel. Roboto Mono for code/data."
|
||||||
|
48,Accessibility First,"Sans + Sans",Atkinson Hyperlegible,Atkinson Hyperlegible,"accessible, readable, inclusive, WCAG, dyslexia-friendly, clear","Accessibility-critical sites, government, healthcare, inclusive design","https://fonts.google.com/share?selection.family=Atkinson+Hyperlegible:wght@400;700","@import url('https://fonts.googleapis.com/css2?family=Atkinson+Hyperlegible:wght@400;700&display=swap');","fontFamily: { sans: ['Atkinson Hyperlegible', 'sans-serif'] }","Designed for maximum legibility. Excellent for accessibility."
|
||||||
|
49,Sports/Fitness,"Sans + Sans",Barlow Condensed,Barlow,"sports, fitness, athletic, energetic, condensed, action","Sports, fitness, gyms, athletic brands, competition","https://fonts.google.com/share?selection.family=Barlow+Condensed:wght@400;500;600;700|Barlow:wght@300;400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=Barlow+Condensed:wght@400;500;600;700&family=Barlow:wght@300;400;500;600;700&display=swap');","fontFamily: { display: ['Barlow Condensed', 'sans-serif'], body: ['Barlow', 'sans-serif'] }","Condensed for impact headlines. Regular Barlow for body."
|
||||||
|
50,Luxury Minimalist,"Serif + Sans",Bodoni Moda,Jost,"luxury, minimalist, high-end, sophisticated, refined, premium","Luxury minimalist brands, high-end fashion, premium products","https://fonts.google.com/share?selection.family=Bodoni+Moda:wght@400;500;600;700|Jost:wght@300;400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=Bodoni+Moda:wght@400;500;600;700&family=Jost:wght@300;400;500;600;700&display=swap');","fontFamily: { serif: ['Bodoni Moda', 'serif'], sans: ['Jost', 'sans-serif'] }","Bodoni's high contrast elegance. Jost for geometric body."
|
||||||
|
51,Tech/HUD Mono,"Mono + Mono",Share Tech Mono,Fira Code,"tech, futuristic, hud, sci-fi, data, monospaced, precise","Sci-fi interfaces, developer tools, cybersecurity, dashboards","https://fonts.google.com/share?selection.family=Fira+Code:wght@300;400;500;600;700|Share+Tech+Mono","@import url('https://fonts.googleapis.com/css2?family=Fira+Code:wght@300;400;500;600;700&family=Share+Tech+Mono&display=swap');","fontFamily: { hud: ['Share Tech Mono', 'monospace'], code: ['Fira Code', 'monospace'] }","Share Tech Mono has that classic sci-fi look."
|
||||||
|
52,Pixel Retro,"Display + Sans",Press Start 2P,VT323,"pixel, retro, gaming, 8-bit, nostalgic, arcade","Pixel art games, retro websites, creative portfolios","https://fonts.google.com/share?selection.family=Press+Start+2P|VT323","@import url('https://fonts.googleapis.com/css2?family=Press+Start+2P&family=VT323&display=swap');","fontFamily: { pixel: ['Press Start 2P', 'cursive'], terminal: ['VT323', 'monospace'] }","Press Start 2P is very wide/large. VT323 is better for body text."
|
||||||
|
53,Neubrutalist Bold,"Display + Sans",Lexend Mega,Public Sans,"bold, neubrutalist, loud, strong, geometric, quirky","Neubrutalist designs, Gen Z brands, bold marketing","https://fonts.google.com/share?selection.family=Lexend+Mega:wght@100..900|Public+Sans:wght@100..900","@import url('https://fonts.googleapis.com/css2?family=Lexend+Mega:wght@100..900&family=Public+Sans:wght@100..900&display=swap');","fontFamily: { mega: ['Lexend Mega', 'sans-serif'], body: ['Public Sans', 'sans-serif'] }","Lexend Mega has distinct character and variable weight."
|
||||||
|
54,Academic/Archival,"Serif + Serif",EB Garamond,Crimson Text,"academic, old-school, university, research, serious, traditional","University sites, archives, research papers, history","https://fonts.google.com/share?selection.family=Crimson+Text:wght@400;600;700|EB+Garamond:wght@400;500;600;700;800","@import url('https://fonts.googleapis.com/css2?family=Crimson+Text:wght@400;600;700&family=EB+Garamond:wght@400;500;600;700;800&display=swap');","fontFamily: { classic: ['EB Garamond', 'serif'], text: ['Crimson Text', 'serif'] }","Classic academic aesthetic. Very legible."
|
||||||
|
55,Spatial Clear,"Sans + Sans",Inter,Inter,"spatial, legible, glass, system, clean, neutral","Spatial computing, AR/VR, glassmorphism interfaces","https://fonts.google.com/share?selection.family=Inter:wght@300;400;500;600","@import url('https://fonts.googleapis.com/css2?family=Inter:wght@300;400;500;600&display=swap');","fontFamily: { sans: ['Inter', 'sans-serif'] }","Optimized for readability on dynamic backgrounds."
|
||||||
|
56,Kinetic Motion,"Display + Mono",Syncopate,Space Mono,"kinetic, motion, futuristic, speed, wide, tech","Music festivals, automotive, high-energy brands","https://fonts.google.com/share?selection.family=Space+Mono:wght@400;700|Syncopate:wght@400;700","@import url('https://fonts.googleapis.com/css2?family=Space+Mono:wght@400;700&family=Syncopate:wght@400;700&display=swap');","fontFamily: { display: ['Syncopate', 'sans-serif'], mono: ['Space Mono', 'monospace'] }","Syncopate's wide stance works well with motion effects."
|
||||||
|
57,Gen Z Brutal,"Display + Sans",Anton,Epilogue,"brutal, loud, shouty, meme, internet, bold","Gen Z marketing, streetwear, viral campaigns","https://fonts.google.com/share?selection.family=Anton|Epilogue:wght@400;500;600;700","@import url('https://fonts.googleapis.com/css2?family=Anton&family=Epilogue:wght@400;500;600;700&display=swap');","fontFamily: { display: ['Anton', 'sans-serif'], body: ['Epilogue', 'sans-serif'] }","Anton is impactful and condensed. Good for stickers/badges."
|
||||||
|
|
|
@ -0,0 +1,100 @@
|
||||||
|
No,Category,Issue,Platform,Description,Do,Don't,Code Example Good,Code Example Bad,Severity
|
||||||
|
1,Navigation,Smooth Scroll,Web,Anchor links should scroll smoothly to target section,Use scroll-behavior: smooth on html element,Jump directly without transition,html { scroll-behavior: smooth; },<a href='#section'> without CSS,High
|
||||||
|
2,Navigation,Sticky Navigation,Web,Fixed nav should not obscure content,Add padding-top to body equal to nav height,Let nav overlap first section content,pt-20 (if nav is h-20),No padding compensation,Medium
|
||||||
|
3,Navigation,Active State,All,Current page/section should be visually indicated,Highlight active nav item with color/underline,No visual feedback on current location,text-primary border-b-2,All links same style,Medium
|
||||||
|
4,Navigation,Back Button,Mobile,Users expect back to work predictably,Preserve navigation history properly,Break browser/app back button behavior,history.pushState(),location.replace(),High
|
||||||
|
5,Navigation,Deep Linking,All,URLs should reflect current state for sharing,Update URL on state/view changes,Static URLs for dynamic content,Use query params or hash,Single URL for all states,Medium
|
||||||
|
6,Navigation,Breadcrumbs,Web,Show user location in site hierarchy,Use for sites with 3+ levels of depth,Use for flat single-level sites,Home > Category > Product,Only on deep nested pages,Low
|
||||||
|
7,Animation,Excessive Motion,All,Too many animations cause distraction and motion sickness,Animate 1-2 key elements per view maximum,Animate everything that moves,Single hero animation,animate-bounce on 5+ elements,High
|
||||||
|
8,Animation,Duration Timing,All,Animations should feel responsive not sluggish,Use 150-300ms for micro-interactions,Use animations longer than 500ms for UI,transition-all duration-200,duration-1000,Medium
|
||||||
|
9,Animation,Reduced Motion,All,Respect user's motion preferences,Check prefers-reduced-motion media query,Ignore accessibility motion settings,@media (prefers-reduced-motion: reduce),No motion query check,High
|
||||||
|
10,Animation,Loading States,All,Show feedback during async operations,Use skeleton screens or spinners,Leave UI frozen with no feedback,animate-pulse skeleton,Blank screen while loading,High
|
||||||
|
11,Animation,Hover vs Tap,All,Hover effects don't work on touch devices,Use click/tap for primary interactions,Rely only on hover for important actions,onClick handler,onMouseEnter only,High
|
||||||
|
12,Animation,Continuous Animation,All,Infinite animations are distracting,Use for loading indicators only,Use for decorative elements,animate-spin on loader,animate-bounce on icons,Medium
|
||||||
|
13,Animation,Transform Performance,Web,Some CSS properties trigger expensive repaints,Use transform and opacity for animations,Animate width/height/top/left properties,transform: translateY(),top: 10px animation,Medium
|
||||||
|
14,Animation,Easing Functions,All,Linear motion feels robotic,Use ease-out for entering ease-in for exiting,Use linear for UI transitions,ease-out,linear,Low
|
||||||
|
15,Layout,Z-Index Management,Web,Stacking context conflicts cause hidden elements,Define z-index scale system (10 20 30 50),Use arbitrary large z-index values,z-10 z-20 z-50,z-[9999],High
|
||||||
|
16,Layout,Overflow Hidden,Web,Hidden overflow can clip important content,Test all content fits within containers,Blindly apply overflow-hidden,overflow-auto with scroll,overflow-hidden truncating content,Medium
|
||||||
|
17,Layout,Fixed Positioning,Web,Fixed elements can overlap or be inaccessible,Account for safe areas and other fixed elements,Stack multiple fixed elements carelessly,Fixed nav + fixed bottom with gap,Multiple overlapping fixed elements,Medium
|
||||||
|
18,Layout,Stacking Context,Web,New stacking contexts reset z-index,Understand what creates new stacking context,Expect z-index to work across contexts,Parent with z-index isolates children,z-index: 9999 not working,Medium
|
||||||
|
19,Layout,Content Jumping,Web,Layout shift when content loads is jarring,Reserve space for async content,Let images/content push layout around,aspect-ratio or fixed height,No dimensions on images,High
|
||||||
|
20,Layout,Viewport Units,Web,100vh can be problematic on mobile browsers,Use dvh or account for mobile browser chrome,Use 100vh for full-screen mobile layouts,min-h-dvh or min-h-screen,h-screen on mobile,Medium
|
||||||
|
21,Layout,Container Width,Web,Content too wide is hard to read,Limit max-width for text content (65-75ch),Let text span full viewport width,max-w-prose or max-w-3xl,Full width paragraphs,Medium
|
||||||
|
22,Touch,Touch Target Size,Mobile,Small buttons are hard to tap accurately,Minimum 44x44px touch targets,Tiny clickable areas,min-h-[44px] min-w-[44px],w-6 h-6 buttons,High
|
||||||
|
23,Touch,Touch Spacing,Mobile,Adjacent touch targets need adequate spacing,Minimum 8px gap between touch targets,Tightly packed clickable elements,gap-2 between buttons,gap-0 or gap-1,Medium
|
||||||
|
24,Touch,Gesture Conflicts,Mobile,Custom gestures can conflict with system,Avoid horizontal swipe on main content,Override system gestures,Vertical scroll primary,Horizontal swipe carousel only,Medium
|
||||||
|
25,Touch,Tap Delay,Mobile,300ms tap delay feels laggy,Use touch-action CSS or fastclick,Default mobile tap handling,touch-action: manipulation,No touch optimization,Medium
|
||||||
|
26,Touch,Pull to Refresh,Mobile,Accidental refresh is frustrating,Disable where not needed,Enable by default everywhere,overscroll-behavior: contain,Default overscroll,Low
|
||||||
|
27,Touch,Haptic Feedback,Mobile,Tactile feedback improves interaction feel,Use for confirmations and important actions,Overuse vibration feedback,navigator.vibrate(10),Vibrate on every tap,Low
|
||||||
|
28,Interaction,Focus States,All,Keyboard users need visible focus indicators,Use visible focus rings on interactive elements,Remove focus outline without replacement,focus:ring-2 focus:ring-blue-500,outline-none without alternative,High
|
||||||
|
29,Interaction,Hover States,Web,Visual feedback on interactive elements,Change cursor and add subtle visual change,No hover feedback on clickable elements,hover:bg-gray-100 cursor-pointer,No hover style,Medium
|
||||||
|
30,Interaction,Active States,All,Show immediate feedback on press/click,Add pressed/active state visual change,No feedback during interaction,active:scale-95,No active state,Medium
|
||||||
|
31,Interaction,Disabled States,All,Clearly indicate non-interactive elements,Reduce opacity and change cursor,Confuse disabled with normal state,opacity-50 cursor-not-allowed,Same style as enabled,Medium
|
||||||
|
32,Interaction,Loading Buttons,All,Prevent double submission during async actions,Disable button and show loading state,Allow multiple clicks during processing,disabled={loading} spinner,Button clickable while loading,High
|
||||||
|
33,Interaction,Error Feedback,All,Users need to know when something fails,Show clear error messages near problem,Silent failures with no feedback,Red border + error message,No indication of error,High
|
||||||
|
34,Interaction,Success Feedback,All,Confirm successful actions to users,Show success message or visual change,No confirmation of completed action,Toast notification or checkmark,Action completes silently,Medium
|
||||||
|
35,Interaction,Confirmation Dialogs,All,Prevent accidental destructive actions,Confirm before delete/irreversible actions,Delete without confirmation,Are you sure modal,Direct delete on click,High
|
||||||
|
36,Accessibility,Color Contrast,All,Text must be readable against background,Minimum 4.5:1 ratio for normal text,Low contrast text,#333 on white (7:1),#999 on white (2.8:1),High
|
||||||
|
37,Accessibility,Color Only,All,Don't convey information by color alone,Use icons/text in addition to color,Red/green only for error/success,Red text + error icon,Red border only for error,High
|
||||||
|
38,Accessibility,Alt Text,All,Images need text alternatives,Descriptive alt text for meaningful images,Empty or missing alt attributes,alt='Dog playing in park',alt='' for content images,High
|
||||||
|
39,Accessibility,Heading Hierarchy,Web,Screen readers use headings for navigation,Use sequential heading levels h1-h6,Skip heading levels or misuse for styling,h1 then h2 then h3,h1 then h4,Medium
|
||||||
|
40,Accessibility,ARIA Labels,All,Interactive elements need accessible names,Add aria-label for icon-only buttons,Icon buttons without labels,aria-label='Close menu',<button><Icon/></button>,High
|
||||||
|
41,Accessibility,Keyboard Navigation,Web,All functionality accessible via keyboard,Tab order matches visual order,Keyboard traps or illogical tab order,tabIndex for custom order,Unreachable elements,High
|
||||||
|
42,Accessibility,Screen Reader,All,Content should make sense when read aloud,Use semantic HTML and ARIA properly,Div soup with no semantics,<nav> <main> <article>,<div> for everything,Medium
|
||||||
|
43,Accessibility,Form Labels,All,Inputs must have associated labels,Use label with for attribute or wrap input,Placeholder-only inputs,<label for='email'>,placeholder='Email' only,High
|
||||||
|
44,Accessibility,Error Messages,All,Error messages must be announced,Use aria-live or role=alert for errors,Visual-only error indication,role='alert',Red border only,High
|
||||||
|
45,Accessibility,Skip Links,Web,Allow keyboard users to skip navigation,Provide skip to main content link,No skip link on nav-heavy pages,Skip to main content link,100 tabs to reach content,Medium
|
||||||
|
46,Performance,Image Optimization,All,Large images slow page load,Use appropriate size and format (WebP),Unoptimized full-size images,srcset with multiple sizes,4000px image for 400px display,High
|
||||||
|
47,Performance,Lazy Loading,All,Load content as needed,Lazy load below-fold images and content,Load everything upfront,loading='lazy',All images eager load,Medium
|
||||||
|
48,Performance,Code Splitting,Web,Large bundles slow initial load,Split code by route/feature,Single large bundle,dynamic import(),All code in main bundle,Medium
|
||||||
|
49,Performance,Caching,Web,Repeat visits should be fast,Set appropriate cache headers,No caching strategy,Cache-Control headers,Every request hits server,Medium
|
||||||
|
50,Performance,Font Loading,Web,Web fonts can block rendering,Use font-display swap or optional,Invisible text during font load,font-display: swap,FOIT (Flash of Invisible Text),Medium
|
||||||
|
51,Performance,Third Party Scripts,Web,External scripts can block rendering,Load non-critical scripts async/defer,Synchronous third-party scripts,async or defer attribute,<script src='...'> in head,Medium
|
||||||
|
52,Performance,Bundle Size,Web,Large JavaScript slows interaction,Monitor and minimize bundle size,Ignore bundle size growth,Bundle analyzer,No size monitoring,Medium
|
||||||
|
53,Performance,Render Blocking,Web,CSS/JS can block first paint,Inline critical CSS defer non-critical,Large blocking CSS files,Critical CSS inline,All CSS in head,Medium
|
||||||
|
54,Forms,Input Labels,All,Every input needs a visible label,Always show label above or beside input,Placeholder as only label,<label>Email</label><input>,placeholder='Email' only,High
|
||||||
|
55,Forms,Error Placement,All,Errors should appear near the problem,Show error below related input,Single error message at top of form,Error under each field,All errors at form top,Medium
|
||||||
|
56,Forms,Inline Validation,All,Validate as user types or on blur,Validate on blur for most fields,Validate only on submit,onBlur validation,Submit-only validation,Medium
|
||||||
|
57,Forms,Input Types,All,Use appropriate input types,Use email tel number url etc,Text input for everything,type='email',type='text' for email,Medium
|
||||||
|
58,Forms,Autofill Support,Web,Help browsers autofill correctly,Use autocomplete attribute properly,Block or ignore autofill,autocomplete='email',autocomplete='off' everywhere,Medium
|
||||||
|
59,Forms,Required Indicators,All,Mark required fields clearly,Use asterisk or (required) text,No indication of required fields,* required indicator,Guess which are required,Medium
|
||||||
|
60,Forms,Password Visibility,All,Let users see password while typing,Toggle to show/hide password,No visibility toggle,Show/hide password button,Password always hidden,Medium
|
||||||
|
61,Forms,Submit Feedback,All,Confirm form submission status,Show loading then success/error state,No feedback after submit,Loading -> Success message,Button click with no response,High
|
||||||
|
62,Forms,Input Affordance,All,Inputs should look interactive,Use distinct input styling,Inputs that look like plain text,Border/background on inputs,Borderless inputs,Medium
|
||||||
|
63,Forms,Mobile Keyboards,Mobile,Show appropriate keyboard for input type,Use inputmode attribute,Default keyboard for all inputs,inputmode='numeric',Text keyboard for numbers,Medium
|
||||||
|
64,Responsive,Mobile First,Web,Design for mobile then enhance for larger,Start with mobile styles then add breakpoints,Desktop-first causing mobile issues,Default mobile + md: lg: xl:,Desktop default + max-width queries,Medium
|
||||||
|
65,Responsive,Breakpoint Testing,Web,Test at all common screen sizes,Test at 320 375 414 768 1024 1440,Only test on your device,Multiple device testing,Single device development,Medium
|
||||||
|
66,Responsive,Touch Friendly,Web,Mobile layouts need touch-sized targets,Increase touch targets on mobile,Same tiny buttons on mobile,Larger buttons on mobile,Desktop-sized targets on mobile,High
|
||||||
|
67,Responsive,Readable Font Size,All,Text must be readable on all devices,Minimum 16px body text on mobile,Tiny text on mobile,text-base or larger,text-xs for body text,High
|
||||||
|
68,Responsive,Viewport Meta,Web,Set viewport for mobile devices,Use width=device-width initial-scale=1,Missing or incorrect viewport,<meta name='viewport'...>,No viewport meta tag,High
|
||||||
|
69,Responsive,Horizontal Scroll,Web,Avoid horizontal scrolling,Ensure content fits viewport width,Content wider than viewport,max-w-full overflow-x-hidden,Horizontal scrollbar on mobile,High
|
||||||
|
70,Responsive,Image Scaling,Web,Images should scale with container,Use max-width: 100% on images,Fixed width images overflow,max-w-full h-auto,width='800' fixed,Medium
|
||||||
|
71,Responsive,Table Handling,Web,Tables can overflow on mobile,Use horizontal scroll or card layout,Wide tables breaking layout,overflow-x-auto wrapper,Table overflows viewport,Medium
|
||||||
|
72,Typography,Line Height,All,Adequate line height improves readability,Use 1.5-1.75 for body text,Cramped or excessive line height,leading-relaxed (1.625),leading-none (1),Medium
|
||||||
|
73,Typography,Line Length,Web,Long lines are hard to read,Limit to 65-75 characters per line,Full-width text on large screens,max-w-prose,Full viewport width text,Medium
|
||||||
|
74,Typography,Font Size Scale,All,Consistent type hierarchy aids scanning,Use consistent modular scale,Random font sizes,Type scale (12 14 16 18 24 32),Arbitrary sizes,Medium
|
||||||
|
75,Typography,Font Loading,Web,Fonts should load without layout shift,Reserve space with fallback font,Layout shift when fonts load,font-display: swap + similar fallback,No fallback font,Medium
|
||||||
|
76,Typography,Contrast Readability,All,Body text needs good contrast,Use darker text on light backgrounds,Gray text on gray background,text-gray-900 on white,text-gray-400 on gray-100,High
|
||||||
|
77,Typography,Heading Clarity,All,Headings should stand out from body,Clear size/weight difference,Headings similar to body text,Bold + larger size,Same size as body,Medium
|
||||||
|
78,Feedback,Loading Indicators,All,Show system status during waits,Show spinner/skeleton for operations > 300ms,No feedback during loading,Skeleton or spinner,Frozen UI,High
|
||||||
|
79,Feedback,Empty States,All,Guide users when no content exists,Show helpful message and action,Blank empty screens,No items yet. Create one!,Empty white space,Medium
|
||||||
|
80,Feedback,Error Recovery,All,Help users recover from errors,Provide clear next steps,Error without recovery path,Try again button + help link,Error message only,Medium
|
||||||
|
81,Feedback,Progress Indicators,All,Show progress for multi-step processes,Step indicators or progress bar,No indication of progress,Step 2 of 4 indicator,No step information,Medium
|
||||||
|
82,Feedback,Toast Notifications,All,Transient messages for non-critical info,Auto-dismiss after 3-5 seconds,Toasts that never disappear,Auto-dismiss toast,Persistent toast,Medium
|
||||||
|
83,Feedback,Confirmation Messages,All,Confirm successful actions,Brief success message,Silent success,Saved successfully toast,No confirmation,Medium
|
||||||
|
84,Content,Truncation,All,Handle long content gracefully,Truncate with ellipsis and expand option,Overflow or broken layout,line-clamp-2 with expand,Overflow or cut off,Medium
|
||||||
|
85,Content,Date Formatting,All,Use locale-appropriate date formats,Use relative or locale-aware dates,Ambiguous date formats,2 hours ago or locale format,01/02/03,Low
|
||||||
|
86,Content,Number Formatting,All,Format large numbers for readability,Use thousand separators or abbreviations,Long unformatted numbers,"1.2K or 1,234",1234567,Low
|
||||||
|
87,Content,Placeholder Content,All,Show realistic placeholders during dev,Use realistic sample data,Lorem ipsum everywhere,Real sample content,Lorem ipsum,Low
|
||||||
|
88,Onboarding,User Freedom,All,Users should be able to skip tutorials,Provide Skip and Back buttons,Force linear unskippable tour,Skip Tutorial button,Locked overlay until finished,Medium
|
||||||
|
89,Search,Autocomplete,Web,Help users find results faster,Show predictions as user types,Require full type and enter,Debounced fetch + dropdown,No suggestions,Medium
|
||||||
|
90,Search,No Results,Web,Dead ends frustrate users,Show 'No results' with suggestions,Blank screen or '0 results',Try searching for X instead,No results found.,Medium
|
||||||
|
91,Data Entry,Bulk Actions,Web,Editing one by one is tedious,Allow multi-select and bulk edit,Single row actions only,Checkbox column + Action bar,Repeated actions per row,Low
|
||||||
|
92,AI Interaction,Disclaimer,All,Users need to know they talk to AI,Clearly label AI generated content,Present AI as human,AI Assistant label,Fake human name without label,High
|
||||||
|
93,AI Interaction,Streaming,All,Waiting for full text is slow,Stream text response token by token,Show loading spinner for 10s+,Typewriter effect,Spinner until 100% complete,Medium
|
||||||
|
94,Spatial UI,Gaze Hover,VisionOS,Elements should respond to eye tracking before pinch,Scale/highlight element on look,Static element until pinch,hoverEffect(),onTap only,High
|
||||||
|
95,Spatial UI,Depth Layering,VisionOS,UI needs Z-depth to separate content from environment,Use glass material and z-offset,Flat opaque panels blocking view,.glassBackgroundEffect(),bg-white,Medium
|
||||||
|
96,Sustainability,Auto-Play Video,Web,Video consumes massive data and energy,Click-to-play or pause when off-screen,Auto-play high-res video loops,playsInline muted preload='none',autoplay loop,Medium
|
||||||
|
97,Sustainability,Asset Weight,Web,Heavy 3D/Image assets increase carbon footprint,Compress and lazy load 3D models,Load 50MB textures,Draco compression,Raw .obj files,Medium
|
||||||
|
98,AI Interaction,Feedback Loop,All,AI needs user feedback to improve,Thumps up/down or 'Regenerate',Static output only,Feedback component,Read-only text,Low
|
||||||
|
99,Accessibility,Motion Sensitivity,All,Parallax/Scroll-jacking causes nausea,Respect prefers-reduced-motion,Force scroll effects,@media (prefers-reduced-motion),ScrollTrigger.create(),High
|
||||||
|
|
|
@ -0,0 +1,236 @@
|
||||||
|
#!/usr/bin/env python3
|
||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
"""
|
||||||
|
UI/UX Pro Max Core - BM25 search engine for UI/UX style guides
|
||||||
|
"""
|
||||||
|
|
||||||
|
import csv
|
||||||
|
import re
|
||||||
|
from pathlib import Path
|
||||||
|
from math import log
|
||||||
|
from collections import defaultdict
|
||||||
|
|
||||||
|
# ============ CONFIGURATION ============
|
||||||
|
DATA_DIR = Path(__file__).parent.parent / "data"
|
||||||
|
MAX_RESULTS = 3
|
||||||
|
|
||||||
|
CSV_CONFIG = {
|
||||||
|
"style": {
|
||||||
|
"file": "styles.csv",
|
||||||
|
"search_cols": ["Style Category", "Keywords", "Best For", "Type"],
|
||||||
|
"output_cols": ["Style Category", "Type", "Keywords", "Primary Colors", "Effects & Animation", "Best For", "Performance", "Accessibility", "Framework Compatibility", "Complexity"]
|
||||||
|
},
|
||||||
|
"prompt": {
|
||||||
|
"file": "prompts.csv",
|
||||||
|
"search_cols": ["Style Category", "AI Prompt Keywords (Copy-Paste Ready)", "CSS/Technical Keywords"],
|
||||||
|
"output_cols": ["Style Category", "AI Prompt Keywords (Copy-Paste Ready)", "CSS/Technical Keywords", "Implementation Checklist"]
|
||||||
|
},
|
||||||
|
"color": {
|
||||||
|
"file": "colors.csv",
|
||||||
|
"search_cols": ["Product Type", "Keywords", "Notes"],
|
||||||
|
"output_cols": ["Product Type", "Keywords", "Primary (Hex)", "Secondary (Hex)", "CTA (Hex)", "Background (Hex)", "Text (Hex)", "Border (Hex)", "Notes"]
|
||||||
|
},
|
||||||
|
"chart": {
|
||||||
|
"file": "charts.csv",
|
||||||
|
"search_cols": ["Data Type", "Keywords", "Best Chart Type", "Accessibility Notes"],
|
||||||
|
"output_cols": ["Data Type", "Keywords", "Best Chart Type", "Secondary Options", "Color Guidance", "Accessibility Notes", "Library Recommendation", "Interactive Level"]
|
||||||
|
},
|
||||||
|
"landing": {
|
||||||
|
"file": "landing.csv",
|
||||||
|
"search_cols": ["Pattern Name", "Keywords", "Conversion Optimization", "Section Order"],
|
||||||
|
"output_cols": ["Pattern Name", "Keywords", "Section Order", "Primary CTA Placement", "Color Strategy", "Conversion Optimization"]
|
||||||
|
},
|
||||||
|
"product": {
|
||||||
|
"file": "products.csv",
|
||||||
|
"search_cols": ["Product Type", "Keywords", "Primary Style Recommendation", "Key Considerations"],
|
||||||
|
"output_cols": ["Product Type", "Keywords", "Primary Style Recommendation", "Secondary Styles", "Landing Page Pattern", "Dashboard Style (if applicable)", "Color Palette Focus"]
|
||||||
|
},
|
||||||
|
"ux": {
|
||||||
|
"file": "ux-guidelines.csv",
|
||||||
|
"search_cols": ["Category", "Issue", "Description", "Platform"],
|
||||||
|
"output_cols": ["Category", "Issue", "Platform", "Description", "Do", "Don't", "Code Example Good", "Code Example Bad", "Severity"]
|
||||||
|
},
|
||||||
|
"typography": {
|
||||||
|
"file": "typography.csv",
|
||||||
|
"search_cols": ["Font Pairing Name", "Category", "Mood/Style Keywords", "Best For", "Heading Font", "Body Font"],
|
||||||
|
"output_cols": ["Font Pairing Name", "Category", "Heading Font", "Body Font", "Mood/Style Keywords", "Best For", "Google Fonts URL", "CSS Import", "Tailwind Config", "Notes"]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
STACK_CONFIG = {
|
||||||
|
"html-tailwind": {"file": "stacks/html-tailwind.csv"},
|
||||||
|
"react": {"file": "stacks/react.csv"},
|
||||||
|
"nextjs": {"file": "stacks/nextjs.csv"},
|
||||||
|
"vue": {"file": "stacks/vue.csv"},
|
||||||
|
"svelte": {"file": "stacks/svelte.csv"},
|
||||||
|
"swiftui": {"file": "stacks/swiftui.csv"},
|
||||||
|
"react-native": {"file": "stacks/react-native.csv"},
|
||||||
|
"flutter": {"file": "stacks/flutter.csv"}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Common columns for all stacks
|
||||||
|
_STACK_COLS = {
|
||||||
|
"search_cols": ["Category", "Guideline", "Description", "Do", "Don't"],
|
||||||
|
"output_cols": ["Category", "Guideline", "Description", "Do", "Don't", "Code Good", "Code Bad", "Severity", "Docs URL"]
|
||||||
|
}
|
||||||
|
|
||||||
|
AVAILABLE_STACKS = list(STACK_CONFIG.keys())
|
||||||
|
|
||||||
|
|
||||||
|
# ============ BM25 IMPLEMENTATION ============
|
||||||
|
class BM25:
|
||||||
|
"""BM25 ranking algorithm for text search"""
|
||||||
|
|
||||||
|
def __init__(self, k1=1.5, b=0.75):
|
||||||
|
self.k1 = k1
|
||||||
|
self.b = b
|
||||||
|
self.corpus = []
|
||||||
|
self.doc_lengths = []
|
||||||
|
self.avgdl = 0
|
||||||
|
self.idf = {}
|
||||||
|
self.doc_freqs = defaultdict(int)
|
||||||
|
self.N = 0
|
||||||
|
|
||||||
|
def tokenize(self, text):
|
||||||
|
"""Lowercase, split, remove punctuation, filter short words"""
|
||||||
|
text = re.sub(r'[^\w\s]', ' ', str(text).lower())
|
||||||
|
return [w for w in text.split() if len(w) > 2]
|
||||||
|
|
||||||
|
def fit(self, documents):
|
||||||
|
"""Build BM25 index from documents"""
|
||||||
|
self.corpus = [self.tokenize(doc) for doc in documents]
|
||||||
|
self.N = len(self.corpus)
|
||||||
|
if self.N == 0:
|
||||||
|
return
|
||||||
|
self.doc_lengths = [len(doc) for doc in self.corpus]
|
||||||
|
self.avgdl = sum(self.doc_lengths) / self.N
|
||||||
|
|
||||||
|
for doc in self.corpus:
|
||||||
|
seen = set()
|
||||||
|
for word in doc:
|
||||||
|
if word not in seen:
|
||||||
|
self.doc_freqs[word] += 1
|
||||||
|
seen.add(word)
|
||||||
|
|
||||||
|
for word, freq in self.doc_freqs.items():
|
||||||
|
self.idf[word] = log((self.N - freq + 0.5) / (freq + 0.5) + 1)
|
||||||
|
|
||||||
|
def score(self, query):
|
||||||
|
"""Score all documents against query"""
|
||||||
|
query_tokens = self.tokenize(query)
|
||||||
|
scores = []
|
||||||
|
|
||||||
|
for idx, doc in enumerate(self.corpus):
|
||||||
|
score = 0
|
||||||
|
doc_len = self.doc_lengths[idx]
|
||||||
|
term_freqs = defaultdict(int)
|
||||||
|
for word in doc:
|
||||||
|
term_freqs[word] += 1
|
||||||
|
|
||||||
|
for token in query_tokens:
|
||||||
|
if token in self.idf:
|
||||||
|
tf = term_freqs[token]
|
||||||
|
idf = self.idf[token]
|
||||||
|
numerator = tf * (self.k1 + 1)
|
||||||
|
denominator = tf + self.k1 * (1 - self.b + self.b * doc_len / self.avgdl)
|
||||||
|
score += idf * numerator / denominator
|
||||||
|
|
||||||
|
scores.append((idx, score))
|
||||||
|
|
||||||
|
return sorted(scores, key=lambda x: x[1], reverse=True)
|
||||||
|
|
||||||
|
|
||||||
|
# ============ SEARCH FUNCTIONS ============
|
||||||
|
def _load_csv(filepath):
|
||||||
|
"""Load CSV and return list of dicts"""
|
||||||
|
with open(filepath, 'r', encoding='utf-8') as f:
|
||||||
|
return list(csv.DictReader(f))
|
||||||
|
|
||||||
|
|
||||||
|
def _search_csv(filepath, search_cols, output_cols, query, max_results):
|
||||||
|
"""Core search function using BM25"""
|
||||||
|
if not filepath.exists():
|
||||||
|
return []
|
||||||
|
|
||||||
|
data = _load_csv(filepath)
|
||||||
|
|
||||||
|
# Build documents from search columns
|
||||||
|
documents = [" ".join(str(row.get(col, "")) for col in search_cols) for row in data]
|
||||||
|
|
||||||
|
# BM25 search
|
||||||
|
bm25 = BM25()
|
||||||
|
bm25.fit(documents)
|
||||||
|
ranked = bm25.score(query)
|
||||||
|
|
||||||
|
# Get top results with score > 0
|
||||||
|
results = []
|
||||||
|
for idx, score in ranked[:max_results]:
|
||||||
|
if score > 0:
|
||||||
|
row = data[idx]
|
||||||
|
results.append({col: row.get(col, "") for col in output_cols if col in row})
|
||||||
|
|
||||||
|
return results
|
||||||
|
|
||||||
|
|
||||||
|
def detect_domain(query):
|
||||||
|
"""Auto-detect the most relevant domain from query"""
|
||||||
|
query_lower = query.lower()
|
||||||
|
|
||||||
|
domain_keywords = {
|
||||||
|
"color": ["color", "palette", "hex", "#", "rgb"],
|
||||||
|
"chart": ["chart", "graph", "visualization", "trend", "bar", "pie", "scatter", "heatmap", "funnel"],
|
||||||
|
"landing": ["landing", "page", "cta", "conversion", "hero", "testimonial", "pricing", "section"],
|
||||||
|
"product": ["saas", "ecommerce", "e-commerce", "fintech", "healthcare", "gaming", "portfolio", "crypto", "dashboard"],
|
||||||
|
"prompt": ["prompt", "css", "implementation", "variable", "checklist", "tailwind"],
|
||||||
|
"style": ["style", "design", "ui", "minimalism", "glassmorphism", "neumorphism", "brutalism", "dark mode", "flat", "aurora"],
|
||||||
|
"ux": ["ux", "usability", "accessibility", "wcag", "touch", "scroll", "animation", "keyboard", "navigation", "mobile"],
|
||||||
|
"typography": ["font", "typography", "heading", "serif", "sans"]
|
||||||
|
}
|
||||||
|
|
||||||
|
scores = {domain: sum(1 for kw in keywords if kw in query_lower) for domain, keywords in domain_keywords.items()}
|
||||||
|
best = max(scores, key=scores.get)
|
||||||
|
return best if scores[best] > 0 else "style"
|
||||||
|
|
||||||
|
|
||||||
|
def search(query, domain=None, max_results=MAX_RESULTS):
|
||||||
|
"""Main search function with auto-domain detection"""
|
||||||
|
if domain is None:
|
||||||
|
domain = detect_domain(query)
|
||||||
|
|
||||||
|
config = CSV_CONFIG.get(domain, CSV_CONFIG["style"])
|
||||||
|
filepath = DATA_DIR / config["file"]
|
||||||
|
|
||||||
|
if not filepath.exists():
|
||||||
|
return {"error": f"File not found: {filepath}", "domain": domain}
|
||||||
|
|
||||||
|
results = _search_csv(filepath, config["search_cols"], config["output_cols"], query, max_results)
|
||||||
|
|
||||||
|
return {
|
||||||
|
"domain": domain,
|
||||||
|
"query": query,
|
||||||
|
"file": config["file"],
|
||||||
|
"count": len(results),
|
||||||
|
"results": results
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def search_stack(query, stack, max_results=MAX_RESULTS):
|
||||||
|
"""Search stack-specific guidelines"""
|
||||||
|
if stack not in STACK_CONFIG:
|
||||||
|
return {"error": f"Unknown stack: {stack}. Available: {', '.join(AVAILABLE_STACKS)}"}
|
||||||
|
|
||||||
|
filepath = DATA_DIR / STACK_CONFIG[stack]["file"]
|
||||||
|
|
||||||
|
if not filepath.exists():
|
||||||
|
return {"error": f"Stack file not found: {filepath}", "stack": stack}
|
||||||
|
|
||||||
|
results = _search_csv(filepath, _STACK_COLS["search_cols"], _STACK_COLS["output_cols"], query, max_results)
|
||||||
|
|
||||||
|
return {
|
||||||
|
"domain": "stack",
|
||||||
|
"stack": stack,
|
||||||
|
"query": query,
|
||||||
|
"file": STACK_CONFIG[stack]["file"],
|
||||||
|
"count": len(results),
|
||||||
|
"results": results
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,61 @@
|
||||||
|
#!/usr/bin/env python3
|
||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
"""
|
||||||
|
UI/UX Pro Max Search - BM25 search engine for UI/UX style guides
|
||||||
|
Usage: python search.py "<query>" [--domain <domain>] [--stack <stack>] [--max-results 3]
|
||||||
|
|
||||||
|
Domains: style, prompt, color, chart, landing, product, ux, typography
|
||||||
|
Stacks: html-tailwind, react, nextjs
|
||||||
|
"""
|
||||||
|
|
||||||
|
import argparse
|
||||||
|
from core import CSV_CONFIG, AVAILABLE_STACKS, MAX_RESULTS, search, search_stack
|
||||||
|
|
||||||
|
|
||||||
|
def format_output(result):
|
||||||
|
"""Format results for Claude consumption (token-optimized)"""
|
||||||
|
if "error" in result:
|
||||||
|
return f"Error: {result['error']}"
|
||||||
|
|
||||||
|
output = []
|
||||||
|
if result.get("stack"):
|
||||||
|
output.append(f"## UI Pro Max Stack Guidelines")
|
||||||
|
output.append(f"**Stack:** {result['stack']} | **Query:** {result['query']}")
|
||||||
|
else:
|
||||||
|
output.append(f"## UI Pro Max Search Results")
|
||||||
|
output.append(f"**Domain:** {result['domain']} | **Query:** {result['query']}")
|
||||||
|
output.append(f"**Source:** {result['file']} | **Found:** {result['count']} results\n")
|
||||||
|
|
||||||
|
for i, row in enumerate(result['results'], 1):
|
||||||
|
output.append(f"### Result {i}")
|
||||||
|
for key, value in row.items():
|
||||||
|
value_str = str(value)
|
||||||
|
if len(value_str) > 300:
|
||||||
|
value_str = value_str[:300] + "..."
|
||||||
|
output.append(f"- **{key}:** {value_str}")
|
||||||
|
output.append("")
|
||||||
|
|
||||||
|
return "\n".join(output)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
parser = argparse.ArgumentParser(description="UI Pro Max Search")
|
||||||
|
parser.add_argument("query", help="Search query")
|
||||||
|
parser.add_argument("--domain", "-d", choices=list(CSV_CONFIG.keys()), help="Search domain")
|
||||||
|
parser.add_argument("--stack", "-s", choices=AVAILABLE_STACKS, help="Stack-specific search (html-tailwind, react, nextjs)")
|
||||||
|
parser.add_argument("--max-results", "-n", type=int, default=MAX_RESULTS, help="Max results (default: 3)")
|
||||||
|
parser.add_argument("--json", action="store_true", help="Output as JSON")
|
||||||
|
|
||||||
|
args = parser.parse_args()
|
||||||
|
|
||||||
|
# Stack search takes priority
|
||||||
|
if args.stack:
|
||||||
|
result = search_stack(args.query, args.stack, args.max_results)
|
||||||
|
else:
|
||||||
|
result = search(args.query, args.domain, args.max_results)
|
||||||
|
|
||||||
|
if args.json:
|
||||||
|
import json
|
||||||
|
print(json.dumps(result, indent=2, ensure_ascii=False))
|
||||||
|
else:
|
||||||
|
print(format_output(result))
|
||||||
|
|
@ -0,0 +1,91 @@
|
||||||
|
<task id="_bmad/core/tasks/editorial-review-prose.xml"
|
||||||
|
name="Editorial Review - Prose"
|
||||||
|
description="Clinical copy-editor that reviews text for communication issues"
|
||||||
|
standalone="false">
|
||||||
|
|
||||||
|
<objective>Review text for communication issues that impede comprehension and output suggested fixes in a three-column table</objective>
|
||||||
|
|
||||||
|
<inputs>
|
||||||
|
<input name="content" required="true" desc="Cohesive unit of text to review (markdown, plain text, or text-heavy XML)" />
|
||||||
|
<input name="reader_type" required="false" default="humans" desc="'humans' (default) for standard editorial, 'llm' for precision focus" />
|
||||||
|
</inputs>
|
||||||
|
|
||||||
|
<llm critical="true">
|
||||||
|
<i>MANDATORY: Execute ALL steps in the flow section IN EXACT ORDER</i>
|
||||||
|
<i>DO NOT skip steps or change the sequence</i>
|
||||||
|
<i>HALT immediately when halt-conditions are met</i>
|
||||||
|
<i>Each action xml tag within step xml tag is a REQUIRED action to complete that step</i>
|
||||||
|
|
||||||
|
<i>You are a clinical copy-editor: precise, professional, neither warm nor cynical</i>
|
||||||
|
<i>Apply Microsoft Writing Style Guide principles as your baseline</i>
|
||||||
|
<i>Focus on communication issues that impede comprehension - not style preferences</i>
|
||||||
|
<i>NEVER rewrite for preference - only fix genuine issues</i>
|
||||||
|
|
||||||
|
<i critical="true">CONTENT IS SACROSANCT: Never challenge ideas—only clarify how they're expressed.</i>
|
||||||
|
|
||||||
|
<principles>
|
||||||
|
<i>Minimal intervention: Apply the smallest fix that achieves clarity</i>
|
||||||
|
<i>Preserve structure: Fix prose within existing structure, never restructure</i>
|
||||||
|
<i>Skip code/markup: Detect and skip code blocks, frontmatter, structural markup</i>
|
||||||
|
<i>When uncertain: Flag with a query rather than suggesting a definitive change</i>
|
||||||
|
<i>Deduplicate: Same issue in multiple places = one entry with locations listed</i>
|
||||||
|
<i>No conflicts: Merge overlapping fixes into single entries</i>
|
||||||
|
<i>Respect author voice: Preserve intentional stylistic choices</i>
|
||||||
|
</principles>
|
||||||
|
|
||||||
|
</llm>
|
||||||
|
|
||||||
|
<flow>
|
||||||
|
<step n="1" title="Validate Input">
|
||||||
|
<action>Check if content is empty or contains fewer than 3 words</action>
|
||||||
|
<action if="empty or fewer than 3 words">HALT with error: "Content too short for editorial review (minimum 3 words required)"</action>
|
||||||
|
<action>Validate reader_type is "humans" or "llm" (or not provided, defaulting to "humans")</action>
|
||||||
|
<action if="reader_type is invalid">HALT with error: "Invalid reader_type. Must be 'humans' or 'llm'"</action>
|
||||||
|
<action>Identify content type (markdown, plain text, XML with text)</action>
|
||||||
|
<action>Note any code blocks, frontmatter, or structural markup to skip</action>
|
||||||
|
</step>
|
||||||
|
|
||||||
|
<step n="2" title="Analyze Style">
|
||||||
|
<action>Analyze the style, tone, and voice of the input text</action>
|
||||||
|
<action>Note any intentional stylistic choices to preserve (informal tone, technical jargon, rhetorical patterns)</action>
|
||||||
|
<action>Calibrate review approach based on reader_type parameter</action>
|
||||||
|
<action if="reader_type='llm'">Prioritize: unambiguous references, consistent terminology, explicit structure, no hedging</action>
|
||||||
|
<action if="reader_type='humans'">Prioritize: clarity, flow, readability, natural progression</action>
|
||||||
|
</step>
|
||||||
|
|
||||||
|
<step n="3" title="Editorial Review" critical="true">
|
||||||
|
<action>Review all prose sections (skip code blocks, frontmatter, structural markup)</action>
|
||||||
|
<action>Identify communication issues that impede comprehension</action>
|
||||||
|
<action>For each issue, determine the minimal fix that achieves clarity</action>
|
||||||
|
<action>Deduplicate: If same issue appears multiple times, create one entry listing all locations</action>
|
||||||
|
<action>Merge overlapping issues into single entries (no conflicting suggestions)</action>
|
||||||
|
<action>For uncertain fixes, phrase as query: "Consider: [suggestion]?" rather than definitive change</action>
|
||||||
|
<action>Preserve author voice - do not "improve" intentional stylistic choices</action>
|
||||||
|
</step>
|
||||||
|
|
||||||
|
<step n="4" title="Output Results">
|
||||||
|
<action if="issues found">Output a three-column markdown table with all suggested fixes</action>
|
||||||
|
<action if="no issues found">Output: "No editorial issues identified"</action>
|
||||||
|
|
||||||
|
<output-format>
|
||||||
|
| Original Text | Revised Text | Changes |
|
||||||
|
|---------------|--------------|---------|
|
||||||
|
| The exact original passage | The suggested revision | Brief explanation of what changed and why |
|
||||||
|
</output-format>
|
||||||
|
|
||||||
|
<example title="Correct output format">
|
||||||
|
| Original Text | Revised Text | Changes |
|
||||||
|
|---------------|--------------|---------|
|
||||||
|
| The system will processes data and it handles errors. | The system processes data and handles errors. | Fixed subject-verb agreement ("will processes" to "processes"); removed redundant "it" |
|
||||||
|
| Users can chose from options (lines 12, 45, 78) | Users can choose from options | Fixed spelling: "chose" to "choose" (appears in 3 locations) |
|
||||||
|
</example>
|
||||||
|
</step>
|
||||||
|
</flow>
|
||||||
|
|
||||||
|
<halt-conditions>
|
||||||
|
<condition>HALT with error if content is empty or fewer than 3 words</condition>
|
||||||
|
<condition>HALT with error if reader_type is not "humans" or "llm"</condition>
|
||||||
|
<condition>If no issues found after thorough review, output "No editorial issues identified" (this is valid completion, not an error)</condition>
|
||||||
|
</halt-conditions>
|
||||||
|
|
||||||
|
</task>
|
||||||
|
|
@ -0,0 +1,198 @@
|
||||||
|
<?xml version="1.0"?>
|
||||||
|
<!-- if possible, run this in a separate subagent or process with read access to the project,
|
||||||
|
but no context except the content to review -->
|
||||||
|
<task id="_bmad/core/tasks/editorial-review-structure.xml"
|
||||||
|
name="Editorial Review - Structure"
|
||||||
|
description="Structural editor that proposes cuts, reorganization,
|
||||||
|
and simplification while preserving comprehension"
|
||||||
|
standalone="false">
|
||||||
|
<objective>Review document structure and propose substantive changes
|
||||||
|
to improve clarity and flow-run this BEFORE copy editing</objective>
|
||||||
|
<inputs>
|
||||||
|
<input name="content" required="true"
|
||||||
|
desc="Document to review (markdown, plain text, or structured content)"/>
|
||||||
|
<input name="purpose" required="false"
|
||||||
|
desc="Document's intended purpose (e.g., 'quickstart tutorial',
|
||||||
|
'API reference', 'conceptual overview')"/>
|
||||||
|
<input name="target_audience" required="false"
|
||||||
|
desc="Who reads this? (e.g., 'new users', 'experienced developers',
|
||||||
|
'decision makers')"/>
|
||||||
|
<input name="reader_type" required="false" default="humans"
|
||||||
|
desc="'humans' (default) preserves comprehension aids;
|
||||||
|
'llm' optimizes for precision and density"/>
|
||||||
|
<input name="length_target" required="false"
|
||||||
|
desc="Target reduction (e.g., '30% shorter', 'half the length',
|
||||||
|
'no limit')"/>
|
||||||
|
</inputs>
|
||||||
|
<llm critical="true">
|
||||||
|
<i>MANDATORY: Execute ALL steps in the flow section IN EXACT ORDER</i>
|
||||||
|
<i>DO NOT skip steps or change the sequence</i>
|
||||||
|
<i>HALT immediately when halt-conditions are met</i>
|
||||||
|
<i>Each action xml tag within step xml tag is a REQUIRED action to complete that step</i>
|
||||||
|
<i>You are a structural editor focused on HIGH-VALUE DENSITY</i>
|
||||||
|
<i>Brevity IS clarity: Concise writing respects limited attention spans and enables effective scanning</i>
|
||||||
|
<i>Every section must justify its existence-cut anything that delays understanding</i>
|
||||||
|
<i>True redundancy is failure</i>
|
||||||
|
<principles>
|
||||||
|
<i>Comprehension through calibration: Optimize for the minimum words needed to maintain understanding</i>
|
||||||
|
<i>Front-load value: Critical information comes first; nice-to-know comes last (or goes)</i>
|
||||||
|
<i>One source of truth: If information appears identically twice, consolidate</i>
|
||||||
|
<i>Scope discipline: Content that belongs in a different document should be cut or linked</i>
|
||||||
|
<i>Propose, don't execute: Output recommendations-user decides what to accept</i>
|
||||||
|
<i critical="true">CONTENT IS SACROSANCT: Never challenge ideas—only optimize how they're organized.</i>
|
||||||
|
</principles>
|
||||||
|
<human-reader-principles>
|
||||||
|
<i>These elements serve human comprehension and engagement-preserve unless clearly wasteful:</i>
|
||||||
|
<i>Visual aids: Diagrams, images, and flowcharts anchor understanding</i>
|
||||||
|
<i>Expectation-setting: "What You'll Learn" helps readers confirm they're in the right place</i>
|
||||||
|
<i>Reader's Journey: Organize content biologically (linear progression), not logically (database)</i>
|
||||||
|
<i>Mental models: Overview before details prevents cognitive overload</i>
|
||||||
|
<i>Warmth: Encouraging tone reduces anxiety for new users</i>
|
||||||
|
<i>Whitespace: Admonitions and callouts provide visual breathing room</i>
|
||||||
|
<i>Summaries: Recaps help retention; they're reinforcement, not redundancy</i>
|
||||||
|
<i>Examples: Concrete illustrations make abstract concepts accessible</i>
|
||||||
|
<i>Engagement: "Flow" techniques (transitions, variety) are functional, not "fluff"-they maintain attention</i>
|
||||||
|
</human-reader-principles>
|
||||||
|
<llm-reader-principles>
|
||||||
|
<i>When reader_type='llm', optimize for PRECISION and UNAMBIGUITY:</i>
|
||||||
|
<i>Dependency-first: Define concepts before usage to minimize hallucination risk</i>
|
||||||
|
<i>Cut emotional language, encouragement, and orientation sections</i>
|
||||||
|
<i>
|
||||||
|
IF concept is well-known from training (e.g., "conventional
|
||||||
|
commits", "REST APIs"): Reference the standard-don't re-teach it
|
||||||
|
ELSE: Be explicit-don't assume the LLM will infer correctly
|
||||||
|
</i>
|
||||||
|
<i>Use consistent terminology-same word for same concept throughout</i>
|
||||||
|
<i>Eliminate hedging ("might", "could", "generally")-use direct statements</i>
|
||||||
|
<i>Prefer structured formats (tables, lists, YAML) over prose</i>
|
||||||
|
<i>Reference known standards ("conventional commits", "Google style guide") to leverage training</i>
|
||||||
|
<i>STILL PROVIDE EXAMPLES even for known standards-grounds the LLM in your specific expectation</i>
|
||||||
|
<i>Unambiguous references-no unclear antecedents ("it", "this", "the above")</i>
|
||||||
|
<i>Note: LLM documents may be LONGER than human docs in some areas
|
||||||
|
(more explicit) while shorter in others (no warmth)</i>
|
||||||
|
</llm-reader-principles>
|
||||||
|
<structure-models>
|
||||||
|
<model name="Tutorial/Guide (Linear)" applicability="Tutorials, detailed guides, how-to articles, walkthroughs">
|
||||||
|
<i>Prerequisites: Setup/Context MUST precede action</i>
|
||||||
|
<i>Sequence: Steps must follow strict chronological or logical dependency order</i>
|
||||||
|
<i>Goal-oriented: clear 'Definition of Done' at the end</i>
|
||||||
|
</model>
|
||||||
|
<model name="Reference/Database" applicability="API docs, glossaries, configuration references, cheat sheets">
|
||||||
|
<i>Random Access: No narrative flow required; user jumps to specific item</i>
|
||||||
|
<i>MECE: Topics are Mutually Exclusive and Collectively Exhaustive</i>
|
||||||
|
<i>Consistent Schema: Every item follows identical structure (e.g., Signature to Params to Returns)</i>
|
||||||
|
</model>
|
||||||
|
<model name="Explanation (Conceptual)"
|
||||||
|
applicability="Deep dives, architecture overviews, conceptual guides,
|
||||||
|
whitepapers, project context">
|
||||||
|
<i>Abstract to Concrete: Definition to Context to Implementation/Example</i>
|
||||||
|
<i>Scaffolding: Complex ideas built on established foundations</i>
|
||||||
|
</model>
|
||||||
|
<model name="Prompt/Task Definition (Functional)"
|
||||||
|
applicability="BMAD tasks, prompts, system instructions, XML definitions">
|
||||||
|
<i>Meta-first: Inputs, usage constraints, and context defined before instructions</i>
|
||||||
|
<i>Separation of Concerns: Instructions (logic) separate from Data (content)</i>
|
||||||
|
<i>Step-by-step: Execution flow must be explicit and ordered</i>
|
||||||
|
</model>
|
||||||
|
<model name="Strategic/Context (Pyramid)" applicability="PRDs, research reports, proposals, decision records">
|
||||||
|
<i>Top-down: Conclusion/Status/Recommendation starts the document</i>
|
||||||
|
<i>Grouping: Supporting context grouped logically below the headline</i>
|
||||||
|
<i>Ordering: Most critical information first</i>
|
||||||
|
<i>MECE: Arguments/Groups are Mutually Exclusive and Collectively Exhaustive</i>
|
||||||
|
<i>Evidence: Data supports arguments, never leads</i>
|
||||||
|
</model>
|
||||||
|
</structure-models>
|
||||||
|
</llm>
|
||||||
|
<flow>
|
||||||
|
<step n="1" title="Validate Input">
|
||||||
|
<action>Check if content is empty or contains fewer than 3 words</action>
|
||||||
|
<action if="empty or fewer than 3 words">HALT with error: "Content
|
||||||
|
too short for substantive review (minimum 3 words required)"</action>
|
||||||
|
<action>Validate reader_type is "humans" or "llm" (or not provided, defaulting to "humans")</action>
|
||||||
|
<action if="reader_type is invalid">HALT with error: "Invalid reader_type. Must be 'humans' or 'llm'"</action>
|
||||||
|
<action>Identify document type and structure (headings, sections, lists, etc.)</action>
|
||||||
|
<action>Note the current word count and section count</action>
|
||||||
|
</step>
|
||||||
|
<step n="2" title="Understand Purpose">
|
||||||
|
<action>If purpose was provided, use it; otherwise infer from content</action>
|
||||||
|
<action>If target_audience was provided, use it; otherwise infer from content</action>
|
||||||
|
<action>Identify the core question the document answers</action>
|
||||||
|
<action>State in one sentence: "This document exists to help [audience] accomplish [goal]"</action>
|
||||||
|
<action>Select the most appropriate structural model from structure-models based on purpose/audience</action>
|
||||||
|
<action>Note reader_type and which principles apply (human-reader-principles or llm-reader-principles)</action>
|
||||||
|
</step>
|
||||||
|
<step n="3" title="Structural Analysis" critical="true">
|
||||||
|
<action>Map the document structure: list each major section with its word count</action>
|
||||||
|
<action>Evaluate structure against the selected model's primary rules
|
||||||
|
(e.g., 'Does recommendation come first?' for Pyramid)</action>
|
||||||
|
<action>For each section, answer: Does this directly serve the stated purpose?</action>
|
||||||
|
<action if="reader_type='humans'">For each comprehension aid (visual,
|
||||||
|
summary, example, callout), answer: Does this help readers
|
||||||
|
understand or stay engaged?</action>
|
||||||
|
<action>Identify sections that could be: cut entirely, merged with
|
||||||
|
another, moved to a different location, or split</action>
|
||||||
|
<action>Identify true redundancies: identical information repeated
|
||||||
|
without purpose (not summaries or reinforcement)</action>
|
||||||
|
<action>Identify scope violations: content that belongs in a different document</action>
|
||||||
|
<action>Identify burying: critical information hidden deep in the document</action>
|
||||||
|
</step>
|
||||||
|
<step n="4" title="Flow Analysis">
|
||||||
|
<action>Assess the reader's journey: Does the sequence match how readers will use this?</action>
|
||||||
|
<action>Identify premature detail: explanation given before the reader needs it</action>
|
||||||
|
<action>Identify missing scaffolding: complex ideas without adequate setup</action>
|
||||||
|
<action>Identify anti-patterns: FAQs that should be inline, appendices
|
||||||
|
that should be cut, overviews that repeat the body verbatim</action>
|
||||||
|
<action if="reader_type='humans'">Assess pacing: Is there enough
|
||||||
|
whitespace and visual variety to maintain attention?</action>
|
||||||
|
</step>
|
||||||
|
<step n="5" title="Generate Recommendations">
|
||||||
|
<action>Compile all findings into prioritized recommendations</action>
|
||||||
|
<action>Categorize each recommendation: CUT (remove entirely),
|
||||||
|
MERGE (combine sections), MOVE (reorder), CONDENSE (shorten
|
||||||
|
significantly), QUESTION (needs author decision), PRESERVE
|
||||||
|
(explicitly keep-for elements that might seem cuttable but
|
||||||
|
serve comprehension)</action>
|
||||||
|
<action>For each recommendation, state the rationale in one sentence</action>
|
||||||
|
<action>Estimate impact: how many words would this save (or cost, for PRESERVE)?</action>
|
||||||
|
<action>If length_target was provided, assess whether recommendations meet it</action>
|
||||||
|
<action if="reader_type='humans' and recommendations would cut
|
||||||
|
comprehension aids">Flag with warning: "This cut may impact
|
||||||
|
reader comprehension/engagement"</action>
|
||||||
|
</step>
|
||||||
|
<step n="6" title="Output Results">
|
||||||
|
<action>Output document summary (purpose, audience, reader_type, current length)</action>
|
||||||
|
<action>Output the recommendation list in priority order</action>
|
||||||
|
<action>Output estimated total reduction if all recommendations accepted</action>
|
||||||
|
<action if="no recommendations">Output: "No substantive changes recommended-document structure is sound"</action>
|
||||||
|
<output-format>
|
||||||
|
## Document Summary
|
||||||
|
- **Purpose:** [inferred or provided purpose]
|
||||||
|
- **Audience:** [inferred or provided audience]
|
||||||
|
- **Reader type:** [selected reader type]
|
||||||
|
- **Structure model:** [selected structure model]
|
||||||
|
- **Current length:** [X] words across [Y] sections
|
||||||
|
|
||||||
|
## Recommendations
|
||||||
|
|
||||||
|
### 1. [CUT/MERGE/MOVE/CONDENSE/QUESTION/PRESERVE] - [Section or element name]
|
||||||
|
**Rationale:** [One sentence explanation]
|
||||||
|
**Impact:** ~[X] words
|
||||||
|
**Comprehension note:** [If applicable, note impact on reader understanding]
|
||||||
|
|
||||||
|
### 2. ...
|
||||||
|
|
||||||
|
## Summary
|
||||||
|
- **Total recommendations:** [N]
|
||||||
|
- **Estimated reduction:** [X] words ([Y]% of original)
|
||||||
|
- **Meets length target:** [Yes/No/No target specified]
|
||||||
|
- **Comprehension trade-offs:** [Note any cuts that sacrifice reader engagement for brevity]
|
||||||
|
</output-format>
|
||||||
|
</step>
|
||||||
|
</flow>
|
||||||
|
<halt-conditions>
|
||||||
|
<condition>HALT with error if content is empty or fewer than 3 words</condition>
|
||||||
|
<condition>HALT with error if reader_type is not "humans" or "llm"</condition>
|
||||||
|
<condition>If no structural issues found, output "No substantive changes
|
||||||
|
recommended" (this is valid completion, not an error)</condition>
|
||||||
|
</halt-conditions>
|
||||||
|
</task>
|
||||||
|
|
@ -9,6 +9,11 @@
|
||||||
</inputs>
|
</inputs>
|
||||||
|
|
||||||
<llm critical="true">
|
<llm critical="true">
|
||||||
|
<i>MANDATORY: Execute ALL steps in the flow section IN EXACT ORDER</i>
|
||||||
|
<i>DO NOT skip steps or change the sequence</i>
|
||||||
|
<i>HALT immediately when halt-conditions are met</i>
|
||||||
|
<i>Each action xml tag within step xml tag is a REQUIRED action to complete that step</i>
|
||||||
|
|
||||||
<i>You are a cynical, jaded reviewer with zero patience for sloppy work</i>
|
<i>You are a cynical, jaded reviewer with zero patience for sloppy work</i>
|
||||||
<i>The content was submitted by a clueless weasel and you expect to find problems</i>
|
<i>The content was submitted by a clueless weasel and you expect to find problems</i>
|
||||||
<i>Be skeptical of everything</i>
|
<i>Be skeptical of everything</i>
|
||||||
|
|
|
||||||
|
|
@ -49,6 +49,23 @@ async function install(options) {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Copy shared resources (e.g., Knowledge Base) to project
|
||||||
|
// This enables workflows like design-system-generator to access KB via {project-root}/_bmad/resources
|
||||||
|
const bmadDir = path.join(projectRoot, '_bmad');
|
||||||
|
const resourcesSource = path.join(__dirname, '../../../../resources');
|
||||||
|
const resourcesDest = path.join(bmadDir, 'resources');
|
||||||
|
|
||||||
|
if (await fs.pathExists(resourcesSource)) {
|
||||||
|
// Only copy if destination doesn't exist or is outdated
|
||||||
|
if (!(await fs.pathExists(resourcesDest))) {
|
||||||
|
logger.log(chalk.yellow('Installing shared resources (UI/UX Knowledge Base)...'));
|
||||||
|
await fs.copy(resourcesSource, resourcesDest, { overwrite: false });
|
||||||
|
logger.log(chalk.green('✓ Shared resources installed'));
|
||||||
|
} else {
|
||||||
|
logger.log(chalk.dim(' Shared resources already present, skipping'));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
logger.log(chalk.green('✓ BMM Module installation complete'));
|
logger.log(chalk.green('✓ BMM Module installation complete'));
|
||||||
return true;
|
return true;
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
|
|
|
||||||
|
|
@ -36,10 +36,12 @@ agent:
|
||||||
- "NEVER lie about tests being written or passing - tests must actually exist and pass 100%"
|
- "NEVER lie about tests being written or passing - tests must actually exist and pass 100%"
|
||||||
|
|
||||||
menu:
|
menu:
|
||||||
|
- trigger: generate-design-system
|
||||||
|
workflow: "{project-root}/_bmad/bmm/workflows/4-implementation/generate-design-system/workflow.yaml"
|
||||||
|
description: "Generate DEV-Ready design system files from UX specification"
|
||||||
- trigger: DS or fuzzy match on dev-story
|
- trigger: DS or fuzzy match on dev-story
|
||||||
workflow: "{project-root}/_bmad/bmm/workflows/4-implementation/dev-story/workflow.yaml"
|
workflow: "{project-root}/_bmad/bmm/workflows/4-implementation/dev-story/workflow.yaml"
|
||||||
description: "[DS] Execute Dev Story workflow (full BMM path with sprint-status)"
|
description: "[DS] Execute Dev Story workflow (full BMM path with sprint-status)"
|
||||||
|
|
||||||
- trigger: CR or fuzzy match on code-review
|
- trigger: CR or fuzzy match on code-review
|
||||||
workflow: "{project-root}/_bmad/bmm/workflows/4-implementation/code-review/workflow.yaml"
|
workflow: "{project-root}/_bmad/bmm/workflows/4-implementation/code-review/workflow.yaml"
|
||||||
description: "[CR] Perform a thorough clean context code review (Highly Recommended, use fresh context and different LLM)"
|
description: "[CR] Perform a thorough clean context code review (Highly Recommended, use fresh context and different LLM)"
|
||||||
|
|
|
||||||
|
|
@ -43,12 +43,12 @@ project_knowledge: # Artifacts from research, document-project output, other lon
|
||||||
prompt: "Where should non-ephemeral project knowledge be searched for and stored\n(docs, research, references)?"
|
prompt: "Where should non-ephemeral project knowledge be searched for and stored\n(docs, research, references)?"
|
||||||
default: "docs"
|
default: "docs"
|
||||||
result: "{project-root}/{value}"
|
result: "{project-root}/{value}"
|
||||||
|
# NOTE: Design System Generator resources (UI/UX Pro Max KB) are automatically
|
||||||
|
# installed to _bmad/resources/ by the BMM module installer
|
||||||
tea_use_mcp_enhancements:
|
tea_use_mcp_enhancements:
|
||||||
prompt: "Test Architect Playwright MCP capabilities (healing, exploratory, verification) are optionally available.\nYou will have to setup your MCPs yourself; refer to https://docs.bmad-method.org/explanation/features/tea-overview for configuration examples.\nWould you like to enable MCP enhancements in Test Architect?"
|
prompt: "Test Architect Playwright MCP capabilities (healing, exploratory, verification) are optionally available.\nYou will have to setup your MCPs yourself; refer to https://docs.bmad-method.org/explanation/features/tea-overview for configuration examples.\nWould you like to enable MCP enhancements in Test Architect?"
|
||||||
default: false
|
default: false
|
||||||
result: "{value}"
|
result: "{value}"
|
||||||
|
|
||||||
tea_use_playwright_utils:
|
tea_use_playwright_utils:
|
||||||
prompt:
|
prompt:
|
||||||
- "Are you using playwright-utils (@seontechnologies/playwright-utils) in your project?\nYou must install packages yourself, or use test architect's *framework command."
|
- "Are you using playwright-utils (@seontechnologies/playwright-utils) in your project?\nYou must install packages yourself, or use test architect's *framework command."
|
||||||
|
|
|
||||||
|
|
@ -56,6 +56,103 @@ Check for existing brand requirements:
|
||||||
If yes, I'll extract and document your brand colors and create semantic color mappings.
|
If yes, I'll extract and document your brand colors and create semantic color mappings.
|
||||||
If no, I'll generate theme options based on your project's personality and emotional goals from our earlier discussion."
|
If no, I'll generate theme options based on your project's personality and emotional goals from our earlier discussion."
|
||||||
|
|
||||||
|
### 1.5 Knowledge Base Integration (Auto)
|
||||||
|
|
||||||
|
Before generating design options, automatically query the UI/UX Pro Max knowledge base for professional recommendations.
|
||||||
|
|
||||||
|
#### Prerequisite: Extract Variables from Frontmatter
|
||||||
|
|
||||||
|
Before executing searches, extract the following from the current document's frontmatter or previous step context:
|
||||||
|
|
||||||
|
- `{industry}` - From frontmatter field `industry` or `productType` (e.g., "SaaS", "E-commerce")
|
||||||
|
- `{style_keywords}` - From frontmatter field `style`, `visualStyle`, or `emotionalGoals` (e.g., "modern minimal")
|
||||||
|
|
||||||
|
**If variables are not available:**
|
||||||
|
- Use project name or product description as fallback search terms
|
||||||
|
- Or ask user: "What industry/style keywords should I use for design recommendations?"
|
||||||
|
|
||||||
|
#### Color Palette Search
|
||||||
|
|
||||||
|
Execute the following command using extracted context:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python {kb_path}/scripts/search.py "{industry} {style_keywords}" --domain color --json
|
||||||
|
```
|
||||||
|
|
||||||
|
> **Note:** Path uses `kb_path` from config. Update `kb_path` if the KB location changes.
|
||||||
|
|
||||||
|
**Parse JSON Output Fields:**
|
||||||
|
- `Primary (Hex)` - Primary brand color
|
||||||
|
- `Secondary (Hex)` - Secondary accent color
|
||||||
|
- `CTA (Hex)` - Call-to-action button color
|
||||||
|
- `Background (Hex)` - Background color recommendation
|
||||||
|
- `Text (Hex)` - Text color for readability
|
||||||
|
- `Border (Hex)` - Border/divider color
|
||||||
|
|
||||||
|
**Present to User:**
|
||||||
|
"🎨 **Knowledge Base Color Recommendations:**
|
||||||
|
|
||||||
|
Based on your project's industry ({industry}) and style ({style_keywords}), here are professional color palette suggestions:
|
||||||
|
|
||||||
|
| Role | Hex Code | Preview |
|
||||||
|
|------|----------|---------|
|
||||||
|
| Primary | {Primary (Hex)} | ██████ |
|
||||||
|
| Secondary | {Secondary (Hex)} | ██████ |
|
||||||
|
| CTA | {CTA (Hex)} | ██████ |
|
||||||
|
| Background | {Background (Hex)} | ██████ |
|
||||||
|
| Text | {Text (Hex)} | ██████ |
|
||||||
|
| Border | {Border (Hex)} | ██████ |
|
||||||
|
|
||||||
|
**What would you like to do with these recommendations?**
|
||||||
|
[1] Accept - Use these as the starting point
|
||||||
|
[2] Modify - Adjust these colors to your preference
|
||||||
|
[3] Skip - Generate fresh options without these suggestions"
|
||||||
|
|
||||||
|
#### Typography Search
|
||||||
|
|
||||||
|
After color recommendations, execute typography search:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python {kb_path}/scripts/search.py "{style_keywords}" --domain typography --json
|
||||||
|
```
|
||||||
|
|
||||||
|
**Parse JSON Output Fields:**
|
||||||
|
- `Font Pairing Name` - Name of the font pairing (e.g., "Geometric Modern")
|
||||||
|
- `Google Fonts URL` - Ready-to-use Google Fonts import link
|
||||||
|
- `CSS Import` - CSS @import statement
|
||||||
|
- `Tailwind Config` - Tailwind CSS configuration snippet
|
||||||
|
- `Notes` - Additional usage notes
|
||||||
|
|
||||||
|
**Present to User:**
|
||||||
|
"📝 **Knowledge Base Typography Recommendations:**
|
||||||
|
|
||||||
|
**{Font Pairing Name}**
|
||||||
|
|
||||||
|
| Property | Value |
|
||||||
|
|----------|-------|
|
||||||
|
| Google Fonts | {Google Fonts URL} |
|
||||||
|
| CSS Import | `{CSS Import}` |
|
||||||
|
| Tailwind Config | ```{Tailwind Config}``` |
|
||||||
|
|
||||||
|
*{Notes}*
|
||||||
|
|
||||||
|
**What would you like to do with these recommendations?**
|
||||||
|
[1] Accept - Use these font recommendations
|
||||||
|
[2] Modify - Adjust font choices
|
||||||
|
[3] Skip - Define typography from scratch"
|
||||||
|
|
||||||
|
#### Fallback Handling
|
||||||
|
|
||||||
|
If the search command fails, returns no results, or variables are unavailable:
|
||||||
|
|
||||||
|
"ℹ️ **Note:** Knowledge base search returned no specific recommendations for your criteria. Proceeding with standard design exploration.
|
||||||
|
|
||||||
|
This is normal for unique combinations - we'll create custom options tailored to your needs."
|
||||||
|
|
||||||
|
**Then proceed to Generate Color Theme Options normally.**
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
### 2. Generate Color Theme Options (If no brand guidelines)
|
### 2. Generate Color Theme Options (If no brand guidelines)
|
||||||
|
|
||||||
Create visual exploration opportunities:
|
Create visual exploration opportunities:
|
||||||
|
|
@ -196,6 +293,8 @@ When user selects 'C', append the content directly to the document using the str
|
||||||
## SUCCESS METRICS:
|
## SUCCESS METRICS:
|
||||||
|
|
||||||
✅ Brand guidelines assessed and incorporated if available
|
✅ Brand guidelines assessed and incorporated if available
|
||||||
|
✅ Knowledge base integration executed before color generation
|
||||||
|
✅ User presented with Accept/Modify/Skip choices for KB recommendations
|
||||||
✅ Color system established with accessibility consideration
|
✅ Color system established with accessibility consideration
|
||||||
✅ Typography system defined with appropriate hierarchy
|
✅ Typography system defined with appropriate hierarchy
|
||||||
✅ Spacing and layout foundation created
|
✅ Spacing and layout foundation created
|
||||||
|
|
|
||||||
|
|
@ -48,6 +48,137 @@ Establish UX consistency patterns for common situations like buttons, forms, nav
|
||||||
|
|
||||||
## UX PATTERNS SEQUENCE:
|
## UX PATTERNS SEQUENCE:
|
||||||
|
|
||||||
|
### 0.5 Knowledge Base Integration (Auto)
|
||||||
|
|
||||||
|
Before defining patterns, automatically query the UI/UX Pro Max knowledge base for UX best practices and accessibility guidelines.
|
||||||
|
|
||||||
|
#### Prerequisite: Extract Variables from Context
|
||||||
|
|
||||||
|
Extract the following from frontmatter or previous step context:
|
||||||
|
|
||||||
|
- `{product_type}` - From frontmatter field `productCategory` OR `projectType` OR `industry` (e.g., "Dashboard", "E-commerce", "Mobile App")
|
||||||
|
- `{pattern_focus}` - From user journey analysis in step 10 (e.g., "forms", "navigation", "checkout")
|
||||||
|
|
||||||
|
**Variable Extraction Priority:**
|
||||||
|
1. Check frontmatter for `productCategory` → use if exists
|
||||||
|
2. Check frontmatter for `projectType` → use if exists
|
||||||
|
3. Check frontmatter for `industry` → use if exists
|
||||||
|
4. If none found → ask user: "What type of product is this? (e.g., Dashboard, E-commerce, SaaS)"
|
||||||
|
|
||||||
|
#### General UX Best Practices Search
|
||||||
|
|
||||||
|
Execute the following command for universal UX guidelines:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python {kb_path}/scripts/search.py "animation accessibility" --domain ux --json
|
||||||
|
```
|
||||||
|
|
||||||
|
> **Note:** Path uses `kb_path` from config. Update `kb_path` if the KB location changes.
|
||||||
|
|
||||||
|
**Parse JSON Output Fields:**
|
||||||
|
- `Category` - Pattern category (e.g., "Animation", "Forms", "Navigation")
|
||||||
|
- `Issue` - Specific issue being addressed
|
||||||
|
- `Platform` - Target platform (Web, iOS, Android, All)
|
||||||
|
- `Description` - Detailed explanation of the issue
|
||||||
|
- `Do` - Recommended practice
|
||||||
|
- `Don't` - Anti-pattern to avoid
|
||||||
|
- `Severity` - Priority level (High, Medium, Low)
|
||||||
|
- `Code Example Good` - Example of correct implementation
|
||||||
|
- `Code Example Bad` - Example of incorrect implementation
|
||||||
|
|
||||||
|
**Sorting Algorithm (MUST follow exactly):**
|
||||||
|
1. Parse all items from JSON `results` array
|
||||||
|
2. Assign numeric priority: High=1, Medium=2, Low=3
|
||||||
|
3. Sort by numeric priority (ascending = High first)
|
||||||
|
4. Within same severity, maintain original JSON order
|
||||||
|
5. Present sorted results in table
|
||||||
|
|
||||||
|
**Present to User:**
|
||||||
|
"📋 **Knowledge Base UX Best Practices:**
|
||||||
|
|
||||||
|
Based on universal UX and accessibility guidelines, here are recommendations to consider:
|
||||||
|
|
||||||
|
| Severity | Platform | Category | Issue | Description | ✅ Do | ❌ Don't |
|
||||||
|
|----------|----------|----------|-------|-------------|-------|---------|
|
||||||
|
| 🔴 High | {Platform} | {Category} | {Issue} | {Description} | {Do} | {Don't} |
|
||||||
|
| 🟡 Medium | {Platform} | {Category} | {Issue} | {Description} | {Do} | {Don't} |
|
||||||
|
| 🟢 Low | {Platform} | {Category} | {Issue} | {Description} | {Do} | {Don't} |
|
||||||
|
|
||||||
|
**Code Examples:**
|
||||||
|
```
|
||||||
|
✅ Good: {Code Example Good}
|
||||||
|
❌ Bad: {Code Example Bad}
|
||||||
|
```
|
||||||
|
|
||||||
|
**What would you like to do with these recommendations?**
|
||||||
|
[1] Accept all - Include these in our pattern definitions
|
||||||
|
[2] Select specific - Choose which recommendations to include
|
||||||
|
[3] Skip - Define patterns without these suggestions"
|
||||||
|
|
||||||
|
**Handle User Selection:**
|
||||||
|
|
||||||
|
- **If user selects [1] Accept all:**
|
||||||
|
- Store ALL Do/Don't pairs as reference for pattern definition
|
||||||
|
- Prefix each subsequent pattern with: "(KB: {Issue})" to show origin
|
||||||
|
- Proceed to Product-Specific Search
|
||||||
|
|
||||||
|
- **If user selects [2] Select specific:**
|
||||||
|
- Ask: "Enter recommendation numbers to include (e.g., 1,3,5):"
|
||||||
|
- Store only selected recommendations
|
||||||
|
- Proceed to Product-Specific Search
|
||||||
|
|
||||||
|
- **If user selects [3] Skip:**
|
||||||
|
- Do not store KB recommendations
|
||||||
|
- Proceed to Product-Specific Search
|
||||||
|
|
||||||
|
#### Product-Specific UX Search
|
||||||
|
|
||||||
|
After general guidelines, search for product-specific patterns:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python {kb_path}/scripts/search.py "{product_type}" --domain ux --json
|
||||||
|
```
|
||||||
|
|
||||||
|
**Present to User:**
|
||||||
|
"🎯 **Product-Specific UX Recommendations ({product_type}):**
|
||||||
|
|
||||||
|
| Severity | Platform | Issue | Description | ✅ Do | ❌ Don't |
|
||||||
|
|----------|----------|-------|-------------|-------|---------|
|
||||||
|
| {Severity} | {Platform} | {Issue} | {Description} | {Do} | {Don't} |
|
||||||
|
|
||||||
|
These recommendations are tailored for {product_type} applications.
|
||||||
|
|
||||||
|
**Include these in our pattern definitions?**
|
||||||
|
[1] Yes, include all
|
||||||
|
[2] Select specific ones
|
||||||
|
[3] Skip"
|
||||||
|
|
||||||
|
**Handle User Selection:**
|
||||||
|
|
||||||
|
- **If user selects [1] Yes, include all:**
|
||||||
|
- Merge with previously accepted recommendations
|
||||||
|
- Proceed to Identify Pattern Categories
|
||||||
|
|
||||||
|
- **If user selects [2] Select specific ones:**
|
||||||
|
- Ask: "Enter recommendation numbers to include (e.g., 1,2):"
|
||||||
|
- Merge selected with previously accepted recommendations
|
||||||
|
- Proceed to Identify Pattern Categories
|
||||||
|
|
||||||
|
- **If user selects [3] Skip:**
|
||||||
|
- Proceed to Identify Pattern Categories with only general recommendations (if any)
|
||||||
|
|
||||||
|
#### Fallback Handling
|
||||||
|
|
||||||
|
If the search command fails or returns no results:
|
||||||
|
|
||||||
|
"ℹ️ **Note:** Knowledge base search returned no specific recommendations for your criteria. Proceeding with collaborative pattern definition.
|
||||||
|
|
||||||
|
We'll define patterns based on your product's unique needs."
|
||||||
|
|
||||||
|
**Then proceed to Identify Pattern Categories normally.**
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
### 1. Identify Pattern Categories
|
### 1. Identify Pattern Categories
|
||||||
|
|
||||||
Determine which patterns need definition for your product:
|
Determine which patterns need definition for your product:
|
||||||
|
|
@ -208,6 +339,9 @@ When user selects 'C', append the content directly to the document using the str
|
||||||
|
|
||||||
## SUCCESS METRICS:
|
## SUCCESS METRICS:
|
||||||
|
|
||||||
|
✅ Knowledge base queried for general UX and accessibility guidelines
|
||||||
|
✅ Product-specific UX recommendations presented (sorted by severity)
|
||||||
|
✅ User given choice to accept/select/skip KB recommendations
|
||||||
✅ Critical pattern categories identified and prioritized
|
✅ Critical pattern categories identified and prioritized
|
||||||
✅ Consistency patterns clearly defined and documented
|
✅ Consistency patterns clearly defined and documented
|
||||||
✅ Patterns integrated with chosen design system
|
✅ Patterns integrated with chosen design system
|
||||||
|
|
@ -226,6 +360,11 @@ When user selects 'C', append the content directly to the document using the str
|
||||||
❌ Not presenting A/P/C menu after content generation
|
❌ Not presenting A/P/C menu after content generation
|
||||||
❌ Appending content without user selecting 'C'
|
❌ Appending content without user selecting 'C'
|
||||||
|
|
||||||
|
❌ **KB INTEGRATION**: Not querying knowledge base before pattern definition
|
||||||
|
❌ **KB INTEGRATION**: Ignoring user's Accept/Select/Skip choice
|
||||||
|
❌ **KB INTEGRATION**: Not sorting results by severity (High → Medium → Low)
|
||||||
|
❌ **KB INTEGRATION**: Missing Platform or Description fields in output table
|
||||||
|
|
||||||
❌ **CRITICAL**: Reading only partial step file - leads to incomplete understanding and poor decisions
|
❌ **CRITICAL**: Reading only partial step file - leads to incomplete understanding and poor decisions
|
||||||
❌ **CRITICAL**: Proceeding with 'C' without fully reading and understanding the next step file
|
❌ **CRITICAL**: Proceeding with 'C' without fully reading and understanding the next step file
|
||||||
❌ **CRITICAL**: Making decisions without complete understanding of step requirements and protocols
|
❌ **CRITICAL**: Making decisions without complete understanding of step requirements and protocols
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,9 @@
|
||||||
---
|
---
|
||||||
stepsCompleted: []
|
stepsCompleted: []
|
||||||
inputDocuments: []
|
inputDocuments: null
|
||||||
|
componentLibrary: ""
|
||||||
|
effectsLibrary: ""
|
||||||
|
referenceSites: null
|
||||||
---
|
---
|
||||||
|
|
||||||
# UX Design Specification {{project_name}}
|
# UX Design Specification {{project_name}}
|
||||||
|
|
@ -10,4 +13,15 @@ inputDocuments: []
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
## Component Resources
|
||||||
|
|
||||||
|
| Category | Library / Resource | Notes |
|
||||||
|
|----------|-------------------|-------|
|
||||||
|
| **Base UI Library** | *(e.g., shadcn/ui, Radix, Chakra)* | |
|
||||||
|
| **Effects Library** | *(e.g., Framer Motion, GSAP)* | |
|
||||||
|
| **Icon Set** | *(e.g., Lucide, Heroicons)* | |
|
||||||
|
| **Reference Sites** | *(e.g., dribbble.com/xyz)* | |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
<!-- UX design content will be appended sequentially through collaborative workflow steps -->
|
<!-- UX design content will be appended sequentially through collaborative workflow steps -->
|
||||||
|
|
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue