- Deleted the `list` command for design runs. - Removed the `update` command and its associated documentation. - Introduced `design-sync` command to synchronize finalized design system references to brainstorming artifacts. - Updated command references in `COMMAND_REFERENCE.md`, `GETTING_STARTED.md`, and `GETTING_STARTED_CN.md` to reflect the new command structure. - Ensured all related documentation and output styles are consistent with the new command naming and functionality.
14 KiB
name, description, argument-hint, allowed-tools
| name | description | argument-hint | allowed-tools |
|---|---|---|---|
| design-sync | Synchronize finalized design system references to brainstorming artifacts, preparing them for /workflow:plan consumption | --session <session_id> [--selected-prototypes "<list>"] | Read(*), Write(*), Edit(*), TodoWrite(*), Glob(*), Bash(*) |
Design Sync Command
Overview
Synchronize finalized design system references to brainstorming artifacts, preparing them for /workflow:plan consumption. This command updates references only (via @ notation), not content duplication.
Core Philosophy
- Reference-Only Updates: Use @ references, no content duplication
- Main Claude Execution: Direct updates by main Claude (no Agent handoff)
- Synthesis Alignment: Update role analysis documents UI/UX Guidelines section
- Plan-Ready Output: Ensure design artifacts discoverable by task-generate
- Minimal Reading: Verify file existence, don't read design content
Execution Protocol
Phase 1: Session & Artifact Validation
# Validate session
CHECK: .workflow/.active-* marker files; VALIDATE: session_id matches active session
# Verify design artifacts in latest design run
latest_design = find_latest_path_matching(".workflow/WFS-{session}/design-run-*")
# Detect design system structure
IF exists({latest_design}/style-extraction/style-1/design-tokens.json):
design_system_mode = "separate"; design_tokens_path = "style-extraction/style-1/design-tokens.json"; style_guide_path = "style-extraction/style-1/style-guide.md"
ELSE:
ERROR: "No design tokens found. Run /workflow:ui-design:style-extract first"
VERIFY: {latest_design}/{design_tokens_path}, {latest_design}/{style_guide_path}, {latest_design}/prototypes/*.html
REPORT: "📋 Design system mode: {design_system_mode} | Tokens: {design_tokens_path}"
# Prototype selection
selected_list = --selected-prototypes ? parse_comma_separated(--selected-prototypes) : Glob({latest_design}/prototypes/*.html)
VALIDATE: Specified prototypes exist IF --selected-prototypes
REPORT: "Found {count} design artifacts, {prototype_count} prototypes"
Phase 1.1: Memory Check (Skip if Already Updated)
# Check if role analysis documents contains current design run reference
synthesis_spec_path = ".workflow/WFS-{session}/.brainstorming/role analysis documents"
current_design_run = basename(latest_design) # e.g., "design-run-20250109-143022"
IF exists(synthesis_spec_path):
synthesis_content = Read(synthesis_spec_path)
IF "## UI/UX Guidelines" in synthesis_content AND current_design_run in synthesis_content:
REPORT: "✅ Design system references already updated (found in memory)"
REPORT: " Skipping: Phase 2-5 (Load Target Artifacts, Update Synthesis, Update UI Designer Guide, Completion)"
EXIT 0
Phase 2: Load Target Artifacts Only
What to Load: Only the files we need to update, not the design files we're referencing.
# Load target brainstorming artifacts (files to be updated)
Read(.workflow/WFS-{session}/.brainstorming/role analysis documents)
IF exists(.workflow/WFS-{session}/.brainstorming/ui-designer/analysis.md): Read(analysis.md)
# Optional: Read prototype notes for descriptions (minimal context)
FOR each selected_prototype IN selected_list:
Read({latest_design}/prototypes/{selected_prototype}-notes.md) # Extract: layout_strategy, page_name only
# Note: Do NOT read design-tokens.json, style-guide.md, or prototype HTML. Only verify existence and generate @ references.
Phase 3: Update Synthesis Specification
Update .brainstorming/role analysis documents with design system references.
Target Section: ## UI/UX Guidelines
Content Template:
## UI/UX Guidelines
### Design System Reference
**Finalized Design Tokens**: @../{design_id}/{design_tokens_path}
**Style Guide**: @../{design_id}/{style_guide_path}
**Design System Mode**: {design_system_mode}
### Implementation Requirements
**Token Adherence**: All UI implementations MUST use design token CSS custom properties
**Accessibility**: WCAG AA compliance validated in design-tokens.json
**Responsive**: Mobile-first design using token-based breakpoints
**Component Patterns**: Follow patterns documented in style-guide.md
### Reference Prototypes
{FOR each selected_prototype:
- **{page_name}**: @../{design_id}/prototypes/{prototype}.html | Layout: {layout_strategy from notes}
}
### Design System Assets
```json
{"design_tokens": "{design_id}/{design_tokens_path}", "style_guide": "{design_id}/{style_guide_path}", "design_system_mode": "{design_system_mode}", "prototypes": [{FOR each: "{design_id}/prototypes/{prototype}.html"}]}
**Implementation**:
```bash
# Option 1: Edit existing section
Edit(file_path=".workflow/WFS-{session}/.brainstorming/role analysis documents",
old_string="## UI/UX Guidelines\n[existing content]",
new_string="## UI/UX Guidelines\n\n[new design reference content]")
# Option 2: Append if section doesn't exist
IF section not found:
Edit(file_path="...", old_string="[end of document]", new_string="\n\n## UI/UX Guidelines\n\n[new design reference content]")
Phase 4A: Update Relevant Role Analysis Documents
Discovery: Find role analysis.md files affected by design outputs
# Always update ui-designer
ui_designer_files = Glob(".workflow/WFS-{session}/.brainstorming/ui-designer/analysis*.md")
# Conditionally update other roles
has_animations = exists({latest_design}/animation-extraction/animation-tokens.json)
has_layouts = exists({latest_design}/layout-extraction/layout-templates.json)
IF has_animations: ux_expert_files = Glob(".workflow/WFS-{session}/.brainstorming/ux-expert/analysis*.md")
IF has_layouts: architect_files = Glob(".workflow/WFS-{session}/.brainstorming/system-architect/analysis*.md")
IF selected_list: pm_files = Glob(".workflow/WFS-{session}/.brainstorming/product-manager/analysis*.md")
Content Templates:
ui-designer/analysis.md (append if not exists):
## Design System Implementation Reference
**Design Tokens**: @../../{design_id}/{design_tokens_path}
**Style Guide**: @../../{design_id}/{style_guide_path}
**Prototypes**: {FOR each: @../../{design_id}/prototypes/{prototype}.html}
*Reference added by /workflow:ui-design:update*
ux-expert/analysis.md (if animations):
## Animation & Interaction Reference
**Animations**: @../../{design_id}/animation-extraction/animation-tokens.json
**Prototypes**: {FOR each: @../../{design_id}/prototypes/{prototype}.html}
*Reference added by /workflow:ui-design:update*
system-architect/analysis.md (if layouts):
## Layout Structure Reference
**Layout Templates**: @../../{design_id}/layout-extraction/layout-templates.json
*Reference added by /workflow:ui-design:update*
product-manager/analysis.md (if prototypes):
## Prototype Validation Reference
**Prototypes**: {FOR each: @../../{design_id}/prototypes/{prototype}.html}
*Reference added by /workflow:ui-design:update*
Implementation:
FOR file IN [ui_designer_files, ux_expert_files, architect_files, pm_files]:
IF file exists AND section_not_exists(file):
Edit(file, old_string="[end of document]", new_string="\n\n{role-specific section}")
Phase 4B: Create UI Designer Design System Reference
Create or update .brainstorming/ui-designer/design-system-reference.md:
# UI Designer Design System Reference
## Design System Integration
This style guide references the finalized design system from the design refinement phase.
**Design Tokens**: @../../{design_id}/{design_tokens_path}
**Style Guide**: @../../{design_id}/{style_guide_path}
**Design System Mode**: {design_system_mode}
## Implementation Guidelines
1. **Use CSS Custom Properties**: All styles reference design tokens
2. **Follow Semantic HTML**: Use HTML5 semantic elements
3. **Maintain Accessibility**: WCAG AA compliance required
4. **Responsive Design**: Mobile-first with token-based breakpoints
## Reference Prototypes
{FOR each selected_prototype:
- **{page_name}**: @../../{design_id}/prototypes/{prototype}.html
}
## Token System
For complete token definitions and usage examples, see:
- Design Tokens: @../../{design_id}/{design_tokens_path}
- Style Guide: @../../{design_id}/{style_guide_path}
---
*Auto-generated by /workflow:ui-design:update | Last updated: {timestamp}*
Implementation:
Write(file_path=".workflow/WFS-{session}/.brainstorming/ui-designer/design-system-reference.md",
content="[generated content with @ references]")
Phase 5: Completion
TodoWrite({todos: [
{content: "Validate session and design system artifacts", status: "completed", activeForm: "Validating artifacts"},
{content: "Load target brainstorming artifacts", status: "completed", activeForm: "Loading target files"},
{content: "Update role analysis documents with design references", status: "completed", activeForm: "Updating synthesis spec"},
{content: "Update relevant role analysis.md documents", status: "completed", activeForm: "Updating role analysis files"},
{content: "Create/update ui-designer/design-system-reference.md", status: "completed", activeForm: "Creating design system reference"}
]});
Completion Message:
✅ Design system references updated for session: WFS-{session}
Updated artifacts:
✓ role analysis documents - UI/UX Guidelines section with @ references
✓ {role_count} role analysis.md files - Design system references
✓ ui-designer/design-system-reference.md - Design system reference guide
Design system assets ready for /workflow:plan:
- design-tokens.json | style-guide.md | {prototype_count} reference prototypes
Next: /workflow:plan [--agent] "<task description>"
The plan phase will automatically discover and utilize the design system.
Output Structure
Updated Files:
.workflow/WFS-{session}/.brainstorming/
├── role analysis documents # Updated with UI/UX Guidelines section
├── ui-designer/
│ ├── analysis*.md # Updated with design system references
│ └── design-system-reference.md # New or updated design reference guide
├── ux-expert/analysis*.md # Updated if animations exist
├── product-manager/analysis*.md # Updated if prototypes exist
└── system-architect/analysis*.md # Updated if layouts exist
@ Reference Format (role analysis documents):
@../{design_id}/style-extraction/style-1/design-tokens.json
@../{design_id}/style-extraction/style-1/style-guide.md
@../{design_id}/prototypes/{prototype}.html
@ Reference Format (ui-designer/design-system-reference.md):
@../../{design_id}/style-extraction/style-1/design-tokens.json
@../../{design_id}/style-extraction/style-1/style-guide.md
@../../{design_id}/prototypes/{prototype}.html
@ Reference Format (role analysis.md files):
@../../{design_id}/style-extraction/style-1/design-tokens.json
@../../{design_id}/animation-extraction/animation-tokens.json
@../../{design_id}/layout-extraction/layout-templates.json
@../../{design_id}/prototypes/{prototype}.html
Integration with /workflow:plan
After this update, /workflow:plan will discover design assets through:
Phase 3: Intelligent Analysis (/workflow:tools:concept-enhanced)
- Reads role analysis documents → Discovers @ references → Includes design system context in ANALYSIS_RESULTS.md
Phase 4: Task Generation (/workflow:tools:task-generate)
- Reads ANALYSIS_RESULTS.md → Discovers design assets → Includes design system paths in task JSON files
Example Task JSON (generated by task-generate):
{
"task_id": "IMPL-001",
"context": {
"design_system": {
"tokens": "{design_id}/style-extraction/style-1/design-tokens.json",
"style_guide": "{design_id}/style-extraction/style-1/style-guide.md",
"prototypes": ["{design_id}/prototypes/dashboard-variant-1.html"]
}
}
}
Error Handling
- Missing design artifacts: Error with message "Run /workflow:ui-design:style-extract and /workflow:ui-design:generate first"
- role analysis documents not found: Warning, create minimal version with just UI/UX Guidelines
- ui-designer/ directory missing: Create directory and file
- Edit conflicts: Preserve existing content, append or replace only UI/UX Guidelines section
- Invalid prototype names: Skip invalid entries, continue with valid ones
Validation Checks
After update, verify:
- role analysis documents contains UI/UX Guidelines section
- UI/UX Guidelines include @ references (not content duplication)
- ui-designer/analysis*.md updated with design system references
- ui-designer/design-system-reference.md created or updated
- Relevant role analysis.md files updated (ux-expert, product-manager, system-architect)
- All @ referenced files exist and are accessible
- @ reference paths are relative and correct
Key Features
- Reference-Only Updates: Uses @ notation for file references, no content duplication, lightweight and maintainable
- Main Claude Direct Execution: No Agent handoff (preserves context), simple reference generation, reliable path resolution
- Plan-Ready Output:
/workflow:planPhase 3 can discover design system, task generation includes design asset paths, clear integration points - Minimal Reading: Only reads target files to update, verifies design file existence (no content reading), optional prototype notes for descriptions
- Flexible Prototype Selection: Auto-select all prototypes (default), manual selection via --selected-prototypes parameter, validates existence
Integration Points
- Input: Design system artifacts from
/workflow:ui-design:style-extractand/workflow:ui-design:generate - Output: Updated role analysis documents, role analysis.md files, ui-designer/design-system-reference.md with @ references
- Next Phase:
/workflow:plandiscovers and utilizes design system through @ references - Auto Integration: Automatically triggered by
/workflow:ui-design:autoworkflow