design-delivery.template.yaml 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104
  1. # WDS Design Delivery Template
  2. # Copy this template to: deliveries/DD-XXX-name.yaml
  3. delivery:
  4. id: "DD-XXX" # Format: DD-001, DD-002, etc.
  5. name: "Feature Name" # Human-readable name
  6. type: "user_flow" # user_flow | feature | component
  7. status: "ready" # ready | in_progress | blocked
  8. priority: "high" # high | medium | low
  9. created_by: "wds-ux-expert"
  10. created_at: "YYYY-MM-DDTHH:MM:SSZ"
  11. updated_at: "YYYY-MM-DDTHH:MM:SSZ"
  12. version: "1.0"
  13. description: |
  14. [Describe what this delivery contains and why it matters.
  15. Include the complete user flow and key features.]
  16. user_value:
  17. problem: "[What user problem does this solve?]"
  18. solution: "[How does this feature solve it?]"
  19. success_criteria:
  20. - "[Measurable success criterion 1]"
  21. - "[Measurable success criterion 2]"
  22. - "[Measurable success criterion 3]"
  23. design_artifacts:
  24. scenarios:
  25. - id: "XX-scenario-name"
  26. path: "C-UX-Scenarios/XX-scenario-name/"
  27. screens: ["screen1", "screen2"]
  28. - id: "XX-scenario-name"
  29. path: "C-UX-Scenarios/XX-scenario-name/"
  30. screens: ["screen1"]
  31. user_flows:
  32. - name: "Flow Name"
  33. path: "C-UX-Scenarios/flows/flow-name.excalidraw"
  34. entry: "entry-screen"
  35. exit: "exit-screen"
  36. design_system:
  37. components:
  38. - "Component Name (variants)"
  39. - "Component Name (variants)"
  40. path: "D-Design-System/"
  41. technical_requirements:
  42. platform:
  43. frontend: "framework-name" # From platform-requirements.yaml
  44. backend: "framework-name" # From platform-requirements.yaml
  45. integrations:
  46. - name: "integration-name"
  47. purpose: "[Why this integration is needed]"
  48. required: true # true | false
  49. - name: "integration-name"
  50. purpose: "[Why this integration is needed]"
  51. required: false
  52. data_models:
  53. - name: "ModelName"
  54. fields: ["field1", "field2", "field3"]
  55. - name: "ModelName"
  56. fields: ["field1", "field2"]
  57. acceptance_criteria:
  58. functional:
  59. - "[Functional requirement 1]"
  60. - "[Functional requirement 2]"
  61. - "[Functional requirement 3]"
  62. non_functional:
  63. - "[Performance requirement]"
  64. - "[Accessibility requirement]"
  65. - "[Security requirement]"
  66. edge_cases:
  67. - "[Edge case 1] → [Expected behavior]"
  68. - "[Edge case 2] → [Expected behavior]"
  69. - "[Edge case 3] → [Expected behavior]"
  70. testing_guidance:
  71. user_testing:
  72. - "[User testing instruction 1]"
  73. - "[User testing instruction 2]"
  74. qa_testing:
  75. - "[QA testing instruction 1]"
  76. - "[QA testing instruction 2]"
  77. - "[QA testing instruction 3]"
  78. estimated_complexity:
  79. size: "medium" # small | medium | large
  80. effort: "2-3 weeks" # Time estimate
  81. risk: "low" # low | medium | high
  82. dependencies: [] # List of DD-XXX IDs needed first
  83. notes: |
  84. [Any special considerations, important context, or
  85. critical details that the development team should know.]