mirror of
https://github.com/bmad-code-org/BMAD-METHOD.git
synced 2026-01-30 04:32:02 +00:00
12d3492e0c
* feat: add link auditor tools and fix broken docs links - Add audit-doc-links.js to scan docs for broken links with auto-resolution - Add fix-doc-links.js to apply suggested fixes (dry-run by default) - Remove stale "Back to Core Concepts" breadcrumb links - Update BMad acronym to "Breakthrough Method of Agile AI Driven Development" - Update README links to docs.bmad-method.org - Simplify upgrade callout in getting-started tutorial Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * docs: reorganize docs structure and archive v4 tutorial - Remove unused section index files (tutorials, how-to, explanation, reference) - Move getting-started-bmadv4.md to _archive - Update quick-start-bmgd.md to remove archived file reference - Update upgrade-to-v6.md - Update astro.config.mjs for new structure Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix: ignore underscore directories in link checker Update check-doc-links.js to skip _archive, _planning, and other underscore-prefixed directories when validating links. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * docs: add v4 users section to README Add links to v4 documentation archive and upgrade guide for users migrating from previous versions. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * feat: convert docs to site-relative links and add validation tools - Convert all relative links (./ ../) to site-relative paths (/path/) - Strip .md extensions and use trailing slashes for Astro/Starlight - Add fix-doc-links.js to convert relative links to site-relative - Add validate-doc-links.js to check links point to existing files - Remove old audit-doc-links.js and check-doc-links.js - Update build-docs.js to use new validation script - Add npm scripts: docs:fix-links, docs:validate-links - Update style guide with validation steps Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * docs: standardize acronym to BMad across documentation Replace incorrect "BMAD" with correct "BMad" in text and frontmatter while preserving "BMAD-METHOD" in GitHub URLs. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * docs: fix BMad acronym and remove draft README - Correct acronym to "Breakthrough Method of Agile AI Driven Development" - Remove unused README-draft.md Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * docs: standardize BMad acronym in README Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * docs: standardize FAQ format across all FAQ pages - Add TOC with jump links under "## Questions" - Use ### headers for questions (no Q: prefix) - Direct answers without **A:** prefix - Remove horizontal rules and "Related Documentation" sections - End each FAQ with issue/Discord CTA - Update style guide with new FAQ guidelines - Delete redundant faq/index.md (sidebar handles navigation) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix: use repo-relative links with .md for GitHub compatibility Convert all documentation links to repo-relative format (/docs/path/file.md) so they work when browsing on GitHub. The rehype plugin strips /docs/ prefix and converts .md to trailing slash at build time for Astro/Starlight. - Update rehype-markdown-links.js to strip /docs/ prefix from absolute paths - Update fix-doc-links.js to generate /docs/ prefixed paths with .md extension - Convert 217 links across 64 files to new format Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix: handle /docs/ prefix in link validator Update resolveLink to strip /docs/ prefix from repo-relative links before checking if files exist. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * docs: restore FAQ index page Re-add the FAQ index page that was accidentally deleted, with updated repo-relative link format. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com> Co-authored-by: Alex Verkhovsky <alexey.verkhovsky@gmail.com>
118 lines
2.3 KiB
Markdown
118 lines
2.3 KiB
Markdown
---
|
|
title: "How to Create a UX Design"
|
|
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.
|
|
|
|
---
|
|
|
|
## When to Use This
|
|
|
|
- UX is primary competitive advantage
|
|
- Complex user workflows needing design thinking
|
|
- Innovative interaction patterns
|
|
- Design system creation
|
|
- Accessibility-critical experiences
|
|
|
|
---
|
|
|
|
## When to Skip This
|
|
|
|
- Simple CRUD interfaces
|
|
- Internal tools with standard patterns
|
|
- Changes to existing screens you're happy with
|
|
- Quick Flow projects
|
|
|
|
---
|
|
|
|
## Prerequisites
|
|
|
|
- BMad Method installed
|
|
- UX Designer agent available
|
|
- PRD completed
|
|
|
|
---
|
|
|
|
## Steps
|
|
|
|
### 1. Load the UX Designer Agent
|
|
|
|
Start a fresh chat and load the UX Designer agent.
|
|
|
|
### 2. Run the UX Design Workflow
|
|
|
|
```
|
|
*create-ux-design
|
|
```
|
|
|
|
### 3. Provide Context
|
|
|
|
Point the agent to your PRD and describe:
|
|
- Key user journeys
|
|
- UX priorities
|
|
- Any existing design patterns
|
|
|
|
### 4. Collaborate on Design
|
|
|
|
The workflow uses a collaborative approach:
|
|
|
|
1. **Visual exploration** - Generate multiple options
|
|
2. **Informed decisions** - Evaluate with user needs
|
|
3. **Collaborative design** - Refine iteratively
|
|
4. **Living documentation** - Evolves with project
|
|
|
|
### 5. Review the UX Spec
|
|
|
|
The agent produces comprehensive UX documentation.
|
|
|
|
---
|
|
|
|
## What You Get
|
|
|
|
The `ux-spec.md` document includes:
|
|
|
|
- User journeys
|
|
- Wireframes and mockups
|
|
- Interaction specifications
|
|
- Design system (components, patterns, tokens)
|
|
- Epic breakdown (UX stories)
|
|
|
|
---
|
|
|
|
## Example
|
|
|
|
Dashboard redesign produces:
|
|
- Card-based layout with split-pane toggle
|
|
- 5 card components
|
|
- 12 color tokens
|
|
- Responsive grid
|
|
- 3 epics (Layout, Visualization, Accessibility)
|
|
|
|
---
|
|
|
|
## Integration
|
|
|
|
The UX spec feeds into:
|
|
- PRD updates
|
|
- Epic and story creation
|
|
- Architecture decisions (Phase 3)
|
|
|
|
---
|
|
|
|
## Tips
|
|
|
|
- Focus on user problems, not solutions first
|
|
- Generate multiple options before deciding
|
|
- Consider accessibility from the start
|
|
- Document component reusability
|
|
|
|
---
|
|
|
|
## Related
|
|
|
|
- [Create PRD](/docs/how-to/workflows/create-prd.md) - Create requirements first
|
|
- [Create Architecture](/docs/how-to/workflows/create-architecture.md) - Technical design
|
|
- [Create Epics and Stories](/docs/how-to/workflows/create-epics-and-stories.md) - Work breakdown
|