platform-requirements.template.yaml 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  1. # WDS Platform Requirements Template
  2. # Save to: A-Project-Brief/platform-requirements.yaml
  3. project:
  4. name: "Project Name"
  5. type: "mobile_app" # mobile_app | web_app | desktop_app | api
  6. wds_version: "6.0"
  7. created_at: "YYYY-MM-DDTHH:MM:SSZ"
  8. platform:
  9. frontend:
  10. framework: "framework-name" # react_native | react | vue | angular | svelte
  11. version: "X.X"
  12. state_management: "library" # zustand | redux | mobx | context
  13. navigation: "library" # react_navigation | react_router | vue_router
  14. styling: "approach" # tailwind | styled_components | css_modules
  15. ui_library: "library" # shadcn | mui | chakra (optional)
  16. backend:
  17. framework: "framework-name" # supabase | firebase | express | fastapi | django
  18. version: "X.X"
  19. auth: "auth-provider" # supabase_auth | firebase_auth | auth0 | custom
  20. database: "database-type" # postgresql | mysql | mongodb | firestore
  21. storage: "storage-provider" # supabase_storage | s3 | cloudinary
  22. api: "api-type" # rest | graphql | grpc
  23. database:
  24. type: "database-type" # postgresql | mysql | mongodb
  25. version: "XX"
  26. orm: "orm-library" # prisma | typeorm | mongoose (optional)
  27. deployment:
  28. frontend: "platform" # expo_eas | vercel | netlify | aws
  29. backend: "platform" # supabase_cloud | firebase | heroku | aws
  30. ci_cd: "platform" # github_actions | gitlab_ci | circle_ci
  31. hosting: "platform" # vercel | netlify | aws (if web app)
  32. integrations:
  33. - name: "integration-name"
  34. provider: "provider-name"
  35. required: true # true | false
  36. purpose: "[Why this integration is needed]"
  37. - name: "integration-name"
  38. provider: "provider-name"
  39. required: false
  40. purpose: "[Why this integration is needed]"
  41. constraints:
  42. - "[Technical constraint 1]"
  43. - "[Technical constraint 2]"
  44. - "[Business constraint 1]"
  45. - "[Regulatory constraint 1]"
  46. performance_requirements:
  47. - "[Performance requirement 1]"
  48. - "[Performance requirement 2]"
  49. - "[Performance requirement 3]"
  50. security_requirements:
  51. - "[Security requirement 1]"
  52. - "[Security requirement 2]"
  53. - "[Security requirement 3]"
  54. wds_metadata:
  55. project_brief: "A-Project-Brief/project-brief.md"
  56. trigger_map: "B-Trigger-Map/trigger-map.md"
  57. scenarios: "C-UX-Scenarios/"
  58. design_system: "D-Design-System/"