ma-agents 2.22.2 → 3.0.0

package/lib/bmad-cache/wds/eslint.config.mjs

@@ -0,0 +1,152 @@
+import js from '@eslint/js';
+import eslintConfigPrettier from 'eslint-config-prettier/flat';
+import nodePlugin from 'eslint-plugin-n';
+import unicorn from 'eslint-plugin-unicorn';
+import yml from 'eslint-plugin-yml';
+
+export default [
+  // Global ignores for files/folders that should not be linted
+  {
+    ignores: [
+      'dist/**',
+      'coverage/**',
+      '**/*.min.js',
+      'test/template-test-generator/**',
+      'test/template-test-generator/**/*.js',
+      'test/template-test-generator/**/*.md',
+      'test/fixtures/**',
+      'test/fixtures/**/*.yaml',
+      '_bmad/**',
+      '_bmad*/**',
+      // Build output
+      'build/**',
+      // Website uses ESM/Astro - separate linting ecosystem
+      'website/**',
+      // Gitignored patterns
+      'z*/**', // z-samples, z1, z2, etc.
+      '.claude/**',
+      '.codex/**',
+      '.github/chatmodes/**',
+      '.agent/**',
+      '.agentvibes/**',
+      '.kiro/**',
+      '.roo/**',
+      'test-project-install/**',
+      'sample-project/**',
+      'tools/template-test-generator/test-scenarios/**',
+      'src/modules/*/sub-modules/**',
+      '.bundler-temp/**',
+    ],
+  },
+
+  // Base JavaScript recommended rules
+  js.configs.recommended,
+
+  // Node.js rules
+  ...nodePlugin.configs['flat/mixed-esm-and-cjs'],
+
+  // Unicorn rules (modern best practices)
+  unicorn.configs.recommended,
+
+  // YAML linting
+  ...yml.configs['flat/recommended'],
+
+  // Place Prettier last to disable conflicting stylistic rules
+  eslintConfigPrettier,
+
+  // Project-specific tweaks
+  {
+    rules: {
+      // Allow console for CLI tools in this repo
+      'no-console': 'off',
+      // Enforce .yaml file extension for consistency
+      'yml/file-extension': [
+        'error',
+        {
+          extension: 'yaml',
+          caseSensitive: true,
+        },
+      ],
+      // Prefer double quotes in YAML wherever quoting is used, but allow the other to avoid escapes
+      'yml/quotes': [
+        'error',
+        {
+          prefer: 'double',
+          avoidEscape: true,
+        },
+      ],
+      // Relax some Unicorn rules that are too opinionated for this codebase
+      'unicorn/prevent-abbreviations': 'off',
+      'unicorn/no-null': 'off',
+    },
+  },
+
+  // CLI scripts under tools/** and test/**
+  {
+    files: ['tools/**/*.js', 'tools/**/*.mjs', 'test/**/*.js'],
+    rules: {
+      // Allow CommonJS patterns for Node CLI scripts
+      'unicorn/prefer-module': 'off',
+      'unicorn/import-style': 'off',
+      'unicorn/no-process-exit': 'off',
+      'n/no-process-exit': 'off',
+      'unicorn/no-await-expression-member': 'off',
+      'unicorn/prefer-top-level-await': 'off',
+      // Avoid failing CI on incidental unused vars in internal scripts
+      'no-unused-vars': 'off',
+      // Reduce style-only churn in internal tools
+      'unicorn/prefer-ternary': 'off',
+      'unicorn/filename-case': 'off',
+      'unicorn/no-array-reduce': 'off',
+      'unicorn/no-array-callback-reference': 'off',
+      'unicorn/consistent-function-scoping': 'off',
+      'n/no-extraneous-require': 'off',
+      'n/no-extraneous-import': 'off',
+      'n/no-unpublished-require': 'off',
+      'n/no-unpublished-import': 'off',
+      // Some scripts intentionally use globals provided at runtime
+      'no-undef': 'off',
+      // Additional relaxed rules for legacy/internal scripts
+      'no-useless-catch': 'off',
+      'unicorn/prefer-number-properties': 'off',
+      'no-unreachable': 'off',
+      'unicorn/text-encoding-identifier-case': 'off',
+    },
+  },
+
+  // Module installer scripts use CommonJS for compatibility
+  {
+    files: ['**/_module-installer/**/*.js'],
+    rules: {
+      // Allow CommonJS patterns for installer scripts
+      'unicorn/prefer-module': 'off',
+      'n/no-missing-require': 'off',
+      'n/no-unpublished-require': 'off',
+    },
+  },
+
+  // ESLint config file should not be checked for publish-related Node rules
+  {
+    files: ['eslint.config.mjs'],
+    rules: {
+      'n/no-unpublished-import': 'off',
+    },
+  },
+
+  // GitHub workflow files in this repo may use empty mapping values
+  {
+    files: ['.github/workflows/**/*.yaml'],
+    rules: {
+      'yml/no-empty-mapping-value': 'off',
+    },
+  },
+
+  // Other GitHub YAML files may intentionally use empty values and reserved filenames
+  {
+    files: ['.github/**/*.yaml'],
+    rules: {
+      'yml/no-empty-mapping-value': 'off',
+      'unicorn/filename-case': 'off',
+    },
+  },
+];

package/lib/bmad-cache/wds/package.json

@@ -0,0 +1,82 @@
+{
+  "$schema": "https://json.schemastore.org/package.json",
+  "name": "bmad-wds",
+  "version": "0.3.1",
+  "private": true,
+  "description": "Whiteport Design Studio - BMAD expansion module for strategic design methodology",
+  "keywords": [
+    "design",
+    "ux",
+    "methodology",
+    "agents",
+    "wds",
+    "bmad"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/bmad-code-org/bmad-method-wds-expansion.git"
+  },
+  "license": "MIT",
+  "author": "Mårten Angner",
+  "scripts": {
+    "format:check": "prettier --check \"**/*.{js,cjs,mjs,json,yaml}\"",
+    "format:fix": "prettier --write \"**/*.{js,cjs,mjs,json,yaml}\"",
+    "lint": "eslint . --ext .js,.cjs,.mjs,.yaml --max-warnings=0",
+    "lint:fix": "eslint . --ext .js,.cjs,.mjs,.yaml --fix",
+    "lint:md": "markdownlint-cli2 \"**/*.md\"",
+    "prepare": "husky",
+    "test": "npm run lint && npm run lint:md && npm run format:check"
+  },
+  "lint-staged": {
+    "*.{js,cjs,mjs}": [
+      "npm run lint:fix",
+      "npm run format:fix"
+    ],
+    "*.yaml": [
+      "eslint --fix",
+      "npm run format:fix"
+    ],
+    "*.json": [
+      "npm run format:fix"
+    ],
+    "*.md": [
+      "markdownlint-cli2"
+    ]
+  },
+  "devDependencies": {
+    "@astrojs/sitemap": "^3.6.0",
+    "@astrojs/starlight": "^0.37.0",
+    "@eslint/js": "^9.33.0",
+    "archiver": "^7.0.1",
+    "astro": "^5.16.0",
+    "c8": "^10.1.3",
+    "csv-parse": "^6.1.0",
+    "eslint": "^9.33.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-n": "^17.21.3",
+    "eslint-plugin-unicorn": "^60.0.0",
+    "eslint-plugin-yml": "^1.18.0",
+    "glob": "^11.0.3",
+    "husky": "^9.1.7",
+    "ignore": "^7.0.5",
+    "jest": "^30.0.4",
+    "js-yaml": "^4.1.0",
+    "lint-staged": "^16.1.1",
+    "markdownlint-cli2": "^0.19.1",
+    "prettier": "^3.7.4",
+    "prettier-plugin-packagejson": "^2.5.19",
+    "semver": "^7.6.3",
+    "sharp": "^0.33.5",
+    "wrap-ansi": "^7.0.0",
+    "xml2js": "^0.6.2",
+    "yaml": "^2.7.0",
+    "yaml-eslint-parser": "^1.2.3",
+    "yaml-lint": "^1.7.0"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/lib/bmad-cache/wds/prettier.config.mjs

@@ -0,0 +1,32 @@
+export default {
+  $schema: 'https://json.schemastore.org/prettierrc',
+  printWidth: 140,
+  tabWidth: 2,
+  useTabs: false,
+  semi: true,
+  singleQuote: true,
+  trailingComma: 'all',
+  bracketSpacing: true,
+  arrowParens: 'always',
+  endOfLine: 'lf',
+  proseWrap: 'preserve',
+  overrides: [
+    {
+      files: ['*.md'],
+      options: { proseWrap: 'preserve' },
+    },
+    {
+      files: ['*.yaml'],
+      options: { singleQuote: false },
+    },
+    {
+      files: ['*.json', '*.jsonc'],
+      options: { singleQuote: false },
+    },
+    {
+      files: ['*.cjs'],
+      options: { parser: 'babel' },
+    },
+  ],
+  plugins: ['prettier-plugin-packagejson'],
+};

package/lib/bmad-cache/wds/src/agents/wds-agent-freya-ux/bmad-skill-manifest.yaml

@@ -0,0 +1,12 @@
+type: agent
+name: wds-agent-freya-ux
+displayName: Freya
+title: WDS Designer
+icon: "\U0001F3A8"
+capabilities: "UX design, scenarios, specifications, visual design, design systems, design delivery, product evolution"
+role: Strategic UX Designer + Design Thinking Partner
+identity: "Freya, Norse goddess of beauty, magic, and strategy. Thinks WITH you, not FOR you. Starts with WHY before HOW - design without strategy is decoration. Creates artifacts developers can trust: detailed specs, prototypes, and design systems. Core beliefs: Strategy then Design then Specification. Psychology drives design. Content is strategy - every word triggers user psychology."
+communicationStyle: "Creative collaborator who brings strategic depth. Asks 'WHY?' before 'WHAT?' - connecting design choices to business goals and user psychology. Explores one challenge deeply rather than skimming many. Keeps responses focused and actionable - leads with decisions, follows with rationale. Suggests workshops when strategic thinking is needed."
+principles: "Domain: Phases 4 (UX Design), 5 (Agentic Development), 6 (Asset Generation), 7 (Design System - optional), 8 (Product Evolution). Hand over other domains to specialist agents. Replaces BMM Sally (UX Designer) when WDS is installed. Load strategic context BEFORE designing - always connect to Trigger Map. Specifications must be logical and complete. Prototypes validate before production. Design systems grow organically from actual usage. AI-assisted design via Stitch when spec + sketch ready. Load micro-guides when entering workflows. HARM: Producing output that looks complete but doesn't follow the template. HELP: Reading the actual template into context before writing."
+module: wds
+canonicalId: wds-agent-freya-ux

package/lib/bmad-cache/wds/src/agents/wds-agent-saga-analyst/bmad-skill-manifest.yaml

@@ -0,0 +1,12 @@
+type: agent
+name: wds-agent-saga-analyst
+displayName: Saga
+title: WDS Analyst
+icon: "\U0001F4DA"
+capabilities: "strategic analysis, product briefs, trigger mapping, alignment & signoff, brainstorming, research"
+role: Strategic Business Analyst + Product Discovery Partner
+identity: "Saga, goddess of stories and wisdom. Treats analysis like a treasure hunt - excited by clues, thrilled by patterns. Builds understanding through conversation, not interrogation. Creates the North Star documents (Product Brief + Trigger Map) that coordinate all teams from vision to delivery."
+communicationStyle: "Asks questions that spark 'aha!' moments while structuring insights with precision. Listens deeply, reflects back naturally, confirms understanding before moving forward. Professional, direct, efficient - analysis feels like working with a skilled colleague."
+principles: "Domain: Phases 1 (Product Brief), 2 (Trigger Mapping). Hand over other domains to specialist agents. Replaces BMM Mary (Analyst) when WDS is installed. Discovery through conversation - one question at a time, listen deeply. Connect business goals to user psychology through trigger mapping. Find and treat as bible: **/project-context.md. Alliterative persona names for user archetypes. Load micro-guides when entering workflows. When generating artifacts, offer Dream Up mode selection. HARM: Producing output that looks complete but doesn't follow the template. HELP: Reading the actual template into context before writing."
+module: wds
+canonicalId: wds-agent-saga-analyst

package/lib/bmad-cache/wds/src/module-help.csv

@@ -0,0 +1,18 @@
+module,skill,display-name,menu-code,description,action,args,phase,after,before,required,output-location,outputs
+Web Design Studio,bmad-wds-saga,Wake Saga,SAGA,Strategic Analyst agent for Phases 1-2. Scans repos and offers next steps.,,0-wds-agents,,,false,,
+Web Design Studio,bmad-wds-freya,Wake Freya,FREYA,UX Designer agent for Phases 3-4. Checks prerequisites and offers next steps.,,0-wds-agents,,,false,,
+Web Design Studio,bmad-wds-alignment,Alignment & Signoff,AS,Stakeholder buy-in pitch and service agreement. Skip if building your own product.,,0-wds-pitch,,,false,design_artifacts/A-Product-Brief,"pitch service-agreement signoff"
+Web Design Studio,bmad-wds-project-brief,Project Brief,PB,Define product vision positioning and success criteria. Every design decision traces back to this.,,1-wds-strategy,,,true,design_artifacts/A-Product-Brief,project-brief.md
+Web Design Studio,bmad-wds-trigger-mapping,Trigger Mapping,TM,Map business goals to user psychology. Create personas and score features against driving forces.,,1-wds-strategy,bmad-wds-project-brief,,true,design_artifacts/B-Trigger-Map,"trigger-map.md personas/ feature-impact-analysis.md"
+Web Design Studio,bmad-wds-platform-requirements,Platform Requirements,PR,Technical boundaries: platforms devices integrations constraints. Skip for simple landing pages.,,1-wds-strategy,bmad-wds-project-brief,,false,design_artifacts/A-Product-Brief,platform-requirements.md
+Web Design Studio,bmad-wds-outline-scenarios,Outline Scenarios,OS,Define user journeys as persona+goal+outcome. Each connects to a Trigger Map driving force.,,2-wds-design,bmad-wds-trigger-mapping,,true,design_artifacts/C-UX-Scenarios,scenario-overview.md
+Web Design Studio,bmad-wds-conceptual-sketching,Conceptual Sketching,CS,Fast rough visual exploration before detailed specification. Skip for straightforward scenarios.,,2-wds-design,bmad-wds-outline-scenarios,,false,design_artifacts/C-UX-Scenarios,sketches
+Web Design Studio,bmad-wds-storyboarding,Storyboarding,SB,Sequence the user journey through screens with entry points transitions and error paths. Skip for simple scenarios.,,2-wds-design,bmad-wds-outline-scenarios,,false,design_artifacts/C-UX-Scenarios,storyboards
+Web Design Studio,bmad-wds-conceptual-specs,Conceptual Specifications,SP,Document every design decision for every element on every page. Developers build directly from this.,,2-wds-design,bmad-wds-outline-scenarios,,true,design_artifacts/C-UX-Scenarios,"page-specs scenario-specs"
+Web Design Studio,bmad-wds-functional-components,Functional Components,FI,Extract reusable patterns from specs into component definitions. Skip if Design System Mode None.,,2-wds-design,bmad-wds-conceptual-specs,,false,design_artifacts/C-UX-Scenarios,component-candidates
+Web Design Studio,bmad-wds-visual-design,Visual Design,VD,Transform specs into styled HTML prototypes with Figma round-trips.,,2-wds-design,bmad-wds-conceptual-specs,,false,design_artifacts/C-UX-Scenarios,"html-prototypes visual-designs"
+Web Design Studio,bmad-wds-design-system,Design System,DS,Manage component library and design tokens. Skip if Design System Mode None.,,2-wds-design,bmad-wds-functional-components,,false,design_artifacts/D-Design-System,"components/ design-tokens.md"
+Web Design Studio,bmad-wds-design-delivery,Design Delivery,DD,Validate specs are complete and package as DD yaml files for development handoff.,,2-wds-design,bmad-wds-conceptual-specs,,true,design_artifacts/E-PRD/Design-Deliveries,"delivery-package acceptance-criteria"
+Web Design Studio,bmad-wds-agentic-development,Agentic Development,AD,Iterative build-verify cycle with design log tracking and browser verification.,,3-wds-build,bmad-wds-design-delivery,,false,_progress/agent-experiences,experience-documents
+Web Design Studio,bmad-wds-usability-testing,Acceptance Testing,AT,Test on real users in their environment with retrospective think-aloud sessions.,,3-wds-build,bmad-wds-agentic-development,,false,design_artifacts/F-Testing,"test-results findings"
+Web Design Studio,bmad-wds-product-evolution,Product Evolution,PE,Continuous improvement: feedback to Trigger Map to spec update to code to verify.,,3-wds-build,bmad-wds-usability-testing,,false,design_artifacts,updated-artifacts

package/lib/bmad-cache/wds/src/module.yaml

@@ -0,0 +1,148 @@
+code: wds
+name: "WDS: Whiteport Design Studio"
+header: "Whiteport Design Studio for Professional UX Design processes"
+subheader: "Configure the settings for the WDS design-first methodology"
+description: ""
+default_selected: false
+recommendedModules: [bmm]
+requiredModules: [core]
+
+# Core config values automatically inherited:
+## user_name
+## communication_language
+## document_output_language
+## output_folder
+## bmad_folder
+## install_user_docs
+## kb_install
+## project_knowledge
+
+project_knowledge:
+  prompt: "Where should long-term project knowledge be stored? (docs, research, references)"
+  default: "docs"
+  result: "{project-root}/{value}"
+
+project_type:
+  prompt: "What type of project are you working on?"
+  default: "digital_product"
+  result: "{value}"
+  single-select:
+    - value: "digital_product"
+      label: "Digital Product - Web/mobile application or platform"
+    - value: "landing_page"
+      label: "Landing Page - Marketing or campaign page"
+    - value: "website"
+      label: "Website - Multi-page website or portal"
+    - value: "other"
+      label: "Other - Custom or specialized project"
+
+design_artifacts:
+  prompt: "Where should design system output be created? (Trigger Map, Scenarios, Testing, etc...)"
+  default: "design-artifacts"
+  result: "{project-root}/{value}"
+
+design_system_mode:
+  prompt: "How will you manage design system components?"
+  default: "none"
+  result: "{value}"
+  single-select:
+    - value: "none"
+      label: "1. None - Ad-hoc styling, no reusable components"
+    - value: "building"
+      label: "2. Building - Design system grows organically from your design work"
+    - value: "component_library"
+      label: "3. Component Library - Use shadcn/Radix/MUI + apply your branding"
+    - value: "existing"
+      label: "4. Existing - Import your design system from previous projects"
+
+methodology_version:
+  prompt: "Which WDS methodology version would you like to use?"
+  default: "wds-v6"
+  result: "{value}"
+  single-select:
+    - value: "wds-v6"
+      label: "WDS v6 (Recommended) - Modern numbered phases (1-8)"
+    - value: "wps2c-v4"
+      label: "WPS2C v4 (Legacy) - Letter-based phases (A-G)"
+    - value: "custom"
+      label: "Custom - Define your own methodology"
+
+product_languages:
+  prompt: "Which languages will your product support? (Select all that apply)"
+  default: ["en"]
+  required: true
+  result: "{value}"
+  multi-select:
+    - value: "en"
+      label: "English"
+    - value: "sv"
+      label: "Swedish"
+    - value: "no"
+      label: "Norwegian"
+    - value: "da"
+      label: "Danish"
+    - value: "fi"
+      label: "Finnish"
+    - value: "de"
+      label: "German"
+    - value: "es"
+      label: "Spanish"
+    - value: "fr"
+      label: "French"
+    - value: "it"
+      label: "Italian"
+    - value: "pt"
+      label: "Portuguese"
+    - value: "nl"
+      label: "Dutch"
+    - value: "pl"
+      label: "Polish"
+    - value: "ru"
+      label: "Russian"
+    - value: "ja"
+      label: "Japanese"
+    - value: "zh"
+      label: "Chinese"
+    - value: "ko"
+      label: "Korean"
+    - value: "ar"
+      label: "Arabic"
+    - value: "other"
+      label: "Other"
+
+design_experience:
+  prompt: "What is your design experience level?"
+  default: "intermediate"
+  result: "{value}"
+  single-select:
+    - value: "beginner"
+      label: "Beginner - New to UX design, provide detailed guidance"
+    - value: "intermediate"
+      label: "Intermediate - Familiar with design concepts, balanced approach"
+    - value: "expert"
+      label: "Expert - Experienced designer, be direct and efficient"
+
+# Directories to create during installation (declarative, no code execution)
+directories:
+  - "{design_artifacts}"
+  - "{project_knowledge}"
+
+# WDS folder structure to create within design_artifacts directory
+wds_folders:
+  - A-Product-Brief
+  - B-Trigger-Map
+  - C-UX-Scenarios
+  - D-Design-System
+  - E-PRD
+  - E-PRD/Design-Deliveries
+  - F-Testing
+  - G-Product-Development
+
+post-install-notes: |
+  Thank you for choosing to install the Whiteport Design System,
+  A design-first methodology for creating software that people love!
+
+  For Support and UX community, https://discord.com/channels/1377115244018532404/1451339058218405919
+  Github Issues, PRs: https://github.com/bmad-code-org/bmad-method-wds-expansion/issues
+
+  License: MIT

package/lib/bmad-cache/wds/src/workflows/wds-1-project-brief/bmad-skill-manifest.yaml

@@ -0,0 +1 @@
+type: skill

package/lib/bmad-cache/wds/src/workflows/wds-1-project-brief/templates/platform-requirements.template.yaml

@@ -0,0 +1,69 @@
+# WDS Platform Requirements Template
+# Save to: A-Project-Brief/platform-requirements.yaml
+
+project:
+  name: "Project Name"
+  type: "mobile_app" # mobile_app | web_app | desktop_app | api
+  wds_version: "6.0"
+  created_at: "YYYY-MM-DDTHH:MM:SSZ"
+
+platform:
+  frontend:
+    framework: "framework-name" # react_native | react | vue | angular | svelte
+    version: "X.X"
+    state_management: "library" # zustand | redux | mobx | context
+    navigation: "library" # react_navigation | react_router | vue_router
+    styling: "approach" # tailwind | styled_components | css_modules
+    ui_library: "library" # shadcn | mui | chakra (optional)
+
+  backend:
+    framework: "framework-name" # supabase | firebase | express | fastapi | django
+    version: "X.X"
+    auth: "auth-provider" # supabase_auth | firebase_auth | auth0 | custom
+    database: "database-type" # postgresql | mysql | mongodb | firestore
+    storage: "storage-provider" # supabase_storage | s3 | cloudinary
+    api: "api-type" # rest | graphql | grpc
+
+  database:
+    type: "database-type" # postgresql | mysql | mongodb
+    version: "XX"
+    orm: "orm-library" # prisma | typeorm | mongoose (optional)
+
+  deployment:
+    frontend: "platform" # expo_eas | vercel | netlify | aws
+    backend: "platform" # supabase_cloud | firebase | heroku | aws
+    ci_cd: "platform" # github_actions | gitlab_ci | circle_ci
+    hosting: "platform" # vercel | netlify | aws (if web app)
+
+integrations:
+  - name: "integration-name"
+    provider: "provider-name"
+    required: true # true | false
+    purpose: "[Why this integration is needed]"
+
+  - name: "integration-name"
+    provider: "provider-name"
+    required: false
+    purpose: "[Why this integration is needed]"
+
+constraints:
+  - "[Technical constraint 1]"
+  - "[Technical constraint 2]"
+  - "[Business constraint 1]"
+  - "[Regulatory constraint 1]"
+
+performance_requirements:
+  - "[Performance requirement 1]"
+  - "[Performance requirement 2]"
+  - "[Performance requirement 3]"
+
+security_requirements:
+  - "[Security requirement 1]"
+  - "[Security requirement 2]"
+  - "[Security requirement 3]"
+
+wds_metadata:
+  project_brief: "A-Project-Brief/project-brief.md"
+  trigger_map: "B-Trigger-Map/trigger-map.md"
+  scenarios: "C-UX-Scenarios/"
+  design_system: "D-Design-System/"

package/lib/bmad-cache/wds/src/workflows/wds-2-trigger-mapping/bmad-skill-manifest.yaml

@@ -0,0 +1 @@
+type: skill

package/lib/bmad-cache/wds/src/workflows/wds-3-scenarios/bmad-skill-manifest.yaml

@@ -0,0 +1 @@
+type: skill

package/lib/bmad-cache/wds/src/workflows/wds-4-ux-design/bmad-skill-manifest.yaml

@@ -0,0 +1 @@
+type: skill

package/lib/bmad-cache/wds/src/workflows/wds-4-ux-design/templates/design-delivery.template.yaml

@@ -0,0 +1,104 @@
+# WDS Design Delivery Template
+# Copy this template to: deliveries/DD-XXX-name.yaml
+
+delivery:
+  id: "DD-XXX" # Format: DD-001, DD-002, etc.
+  name: "Feature Name" # Human-readable name
+  type: "user_flow" # user_flow | feature | component
+  status: "ready" # ready | in_progress | blocked
+  priority: "high" # high | medium | low
+  created_by: "wds-ux-expert"
+  created_at: "YYYY-MM-DDTHH:MM:SSZ"
+  updated_at: "YYYY-MM-DDTHH:MM:SSZ"
+  version: "1.0"
+
+description: |
+  [Describe what this delivery contains and why it matters.
+   Include the complete user flow and key features.]
+
+user_value:
+  problem: "[What user problem does this solve?]"
+  solution: "[How does this feature solve it?]"
+  success_criteria:
+    - "[Measurable success criterion 1]"
+    - "[Measurable success criterion 2]"
+    - "[Measurable success criterion 3]"
+
+design_artifacts:
+  scenarios:
+    - id: "XX-scenario-name"
+      path: "C-UX-Scenarios/XX-scenario-name/"
+      screens: ["screen1", "screen2"]
+
+    - id: "XX-scenario-name"
+      path: "C-UX-Scenarios/XX-scenario-name/"
+      screens: ["screen1"]
+
+  user_flows:
+    - name: "Flow Name"
+      path: "C-UX-Scenarios/flows/flow-name.excalidraw"
+      entry: "entry-screen"
+      exit: "exit-screen"
+
+  design_system:
+    components:
+      - "Component Name (variants)"
+      - "Component Name (variants)"
+    path: "D-Design-System/"
+
+technical_requirements:
+  platform:
+    frontend: "framework-name" # From platform-requirements.yaml
+    backend: "framework-name" # From platform-requirements.yaml
+
+  integrations:
+    - name: "integration-name"
+      purpose: "[Why this integration is needed]"
+      required: true # true | false
+
+    - name: "integration-name"
+      purpose: "[Why this integration is needed]"
+      required: false
+
+  data_models:
+    - name: "ModelName"
+      fields: ["field1", "field2", "field3"]
+
+    - name: "ModelName"
+      fields: ["field1", "field2"]
+
+acceptance_criteria:
+  functional:
+    - "[Functional requirement 1]"
+    - "[Functional requirement 2]"
+    - "[Functional requirement 3]"
+
+  non_functional:
+    - "[Performance requirement]"
+    - "[Accessibility requirement]"
+    - "[Security requirement]"
+
+  edge_cases:
+    - "[Edge case 1] → [Expected behavior]"
+    - "[Edge case 2] → [Expected behavior]"
+    - "[Edge case 3] → [Expected behavior]"
+
+testing_guidance:
+  user_testing:
+    - "[User testing instruction 1]"
+    - "[User testing instruction 2]"
+
+  qa_testing:
+    - "[QA testing instruction 1]"
+    - "[QA testing instruction 2]"
+    - "[QA testing instruction 3]"
+
+estimated_complexity:
+  size: "medium" # small | medium | large
+  effort: "2-3 weeks" # Time estimate
+  risk: "low" # low | medium | high
+  dependencies: [] # List of DD-XXX IDs needed first
+
+notes: |
+  [Any special considerations, important context, or
+   critical details that the development team should know.]