ldy26098
/
BMAD-METHOD
mirror of https://github.com/bmad-code-org/BMAD-METHOD.git
1
0
Fork 0
Code Packages Projects Releases Wiki Activity
BMAD-METHOD/docs/docs-guide.md

192 lines
7.7 KiB
Markdown
Raw Blame History

# WDS Documentation
Complete documentation for Whiteport Design Studio - a design-first methodology for creating software that people love.
---
## 🚀 Getting Started
**New to WDS?** Start here:
- **[About WDS](getting-started/about-wds.md)** - What WDS is and why it exists (5 min)
- **[Installation](getting-started/installation.md)** - Set up WDS in your project (5 min)
- **[Quick Start](getting-started/quick-start.md)** - Your first 5 minutes with WDS
- **[Where to Go Next](getting-started/where-to-go-next.md)** - Choose your learning path
**Quick Path:** Install → Quick Start → Choose your path
---
## 📖 The WDS Method
**What WDS is:** A design-focused methodology that can be done with pen & paper, design tools, or with WDS agents.
- **[WDS Method Overview](method/wds-method-guide.md)** - Complete methodology guide
- **[Phase 1: Product Exploration](method/phase-1-product-exploration-guide.md)** - Strategic foundation
- **[Phase 2: Trigger Mapping](method/phase-2-trigger-mapping-guide.md)** - User psychology & business goals
- **[Phase 3: UX Scenarios](method/phase-3-ux-scenarios-guide.md)** - User journeys & scenario outlines
- **[Phase 4: UX Design](method/phase-4-ux-design-guide.md)** - Page specifications & prototypes
**These guides are tool-agnostic** - explaining the methodology regardless of how you apply it.
---
## 🧠 Strategic Design Models
**Foundational frameworks from thought leaders** that inform WDS methodology.
- **[Models Guide](models/models-guide.md)** - Introduction to strategic frameworks
- **[Customer Awareness Cycle](models/customer-awareness-cycle.md)** - Eugene Schwartz (meet users where they are)
- **[Impact/Effect Mapping](models/impact-effect-mapping.md)** - Mijo Balic, Ingrid Domingues, Gojko Adzic (strategic connections)
- **[Golden Circle](models/golden-circle.md)** - Simon Sinek (start with WHY)
- **[Action Mapping](models/action-mapping.md)** - Cathy Moore (focus on what people DO)
- **[Kathy Sierra Badass Users](models/kathy-sierra-badass-users.md)** - Kathy Sierra (make users awesome)
**These are external frameworks** with full attribution to original creators. Our methods build on these giants' shoulders.
---
## 🎓 Learn WDS
**How to use WDS with AI agents:** Step-by-step course using WDS agents + Cursor/Windsurf.
- **[Complete WDS Course](learn-wds/)** - Sequential learning path
- **[Course Overview](learn-wds/00-course-overview.md)** - What you'll learn
- **[Module 01: Why WDS Matters](learn-wds/module-01-why-wds-matters/)** - The problem & solution
- **[Module 02: Installation & Setup](learn-wds/module-02-installation-setup/)** - Get WDS running
- **[Module 03: Alignment & Signoff](learn-wds/module-03-alignment-signoff/)** - Stakeholder alignment
- **[Module 04: Product Brief](learn-wds/module-04-product-brief/)** - Create strategic foundation
- **[Module 05: Trigger Mapping](learn-wds/module-05-map-triggers-outcomes/)** - Map user psychology
- **[Module 06+](learn-wds/)** - Continue through all phases
**This course is WDS-specific** - teaching you to use Saga, Freya, and Idunn agents.
---
## 📋 Deliverables
**What you create with WDS:** Specifications for each deliverable.
- **[Product Brief](deliverables/product-brief.md)** - Strategic vision & positioning
- **[Trigger Map](deliverables/trigger-map.md)** - User psychology & business goals
- **[Platform PRD](deliverables/platform-prd.md)** - Technical requirements
- **[Page Specifications](deliverables/page-specifications.md)** - Detailed page specs
- **[Design System](deliverables/design-system.md)** - Component library
- **[Design Delivery PRD](deliverables/design-delivery-prd.md)** - Complete handoff package
- **[Project Pitch](deliverables/project-pitch.md)** - External presentations
- **[Service Agreement](deliverables/service-agreement.md)** - Client contracts
**These specs are universal** - defining structure regardless of how you create them.
---
## 🎨 Examples
**See WDS in action:** Real projects showing complete WDS workflows and documentation.
- **[Examples Overview](examples/)** - Browse all examples with descriptions
- **[WDS Presentation](examples/WDS-Presentation/)** - Marketing landing page project
- Product brief, trigger map, scenarios
- Desktop concept sketches
- Benefits-first content strategy
- **[WDS v6 Conversion](examples/wds-v6-conversion/)** - Meta example using WDS to build WDS
- Complete session logs with context preservation
- Strategic framework development (CAC, Golden Circle, Kathy Sierra, Action Mapping)
- Long-term project management patterns
- Agent collaboration workflows
**These are real projects** - not sanitized demos. Copy patterns, adapt structure, learn from decisions.
---
## 🤖 Agent Activation
**Using WDS agents:** Quick activation guides for Saga, Freya, and Idunn.
- **[Agent Launchers](getting-started/agent-activation/agent-launchers.md)** - Quick reference
- **[Saga WDS Analyst](getting-started/agent-activation/wds-saga-analyst.md)** - Business analysis
- **[Freya WDS Designer](getting-started/agent-activation/wds-freya-ux.md)** - UX design
- **[Idunn WDS PM](getting-started/agent-activation/wds-idunn-pm.md)** - Product management
- **[Mimir Orchestrator](getting-started/agent-activation/wds-mimir.md)** - Workflow coordination
---
## 📚 Reference
**Additional documentation:**
- **[Workflows Guide](wds-workflows-guide.md)** - Complete workflow reference
- **[Agent Activation Flow](getting-started/agent-activation/activation/)** - How agents initialize
---
## 🎯 Choose Your Path
### I need to...
**Understand the methodology (tool-agnostic)**
→ Start with [WDS Method Overview](method/wds-method-guide.md)
→ Read phase guides as needed
**Learn to use WDS with AI agents**
→ Take the [Complete WDS Course](learn-wds/)
→ Follow sequential modules
**See what WDS creates**
→ Browse [Deliverables](deliverables/)
→ Check [Examples](examples/)
**Start using WDS now**
→ Follow [Getting Started](getting-started/getting-started-overview.md)
→ Activate an agent and go!
**Reference specific information**
→ Use [Workflows Guide](wds-workflows-guide.md)
→ Jump to relevant phase guide
---
## 💡 Documentation Structure
```
docs/
├── getting-started/ # Quick start guides (15 min total)
├── models/ # External strategic frameworks
├── method/ # Whiteport's methodology guides
├── learn-wds/ # WDS-specific course (agent-driven)
├── deliverables/ # Specifications for what you create
├── examples/ # Real project examples
└── README.md # This navigation hub
```
**Four clear purposes:**
1. **models/** → "What are the foundational frameworks?" (external, attributed)
2. **method/** → "How does WDS methodology work?" (Whiteport instruments)
3. **learn-wds/** → "How do I use WDS agents?" (WDS-specific)
4. **examples/** → "Show me a real project" (reference implementation)
---
## 🌐 External Resources
### Community and Support
- **[Discord Community](https://discord.gg/gk8jAdXWmj)** - Get help from the community
- **[GitHub Issues](https://github.com/whiteport-collective/whiteport-design-studio/issues)** - Report bugs or request features
- **[YouTube Channel](https://www.youtube.com/@WhiteportCollective)** - Video tutorials
### Additional Documentation
- **[BMad Method Documentation](../../bmm/docs/)** - Development workflows (BMM integrates with WDS)
- **[IDE Setup Guides](../../../../docs/ide-info/)** - Configure your development environment
---
**Ready to begin?** → [Start with Getting Started](getting-started/getting-started-overview.md)
---
_Whiteport Design Studio - Providing a thinking partner to every designer on the planet_
View Git Blame Copy Permalink