speccrew 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (153) hide show
  1. package/.speccrew/agents/speccrew-feature-designer.md +142 -0
  2. package/.speccrew/agents/speccrew-product-manager.md +61 -0
  3. package/.speccrew/agents/speccrew-system-designer.md +200 -0
  4. package/.speccrew/agents/speccrew-system-developer.md +238 -0
  5. package/.speccrew/agents/speccrew-task-worker.md +80 -0
  6. package/.speccrew/agents/speccrew-team-leader.md +92 -0
  7. package/.speccrew/agents/speccrew-test-manager.md +313 -0
  8. package/.speccrew/skills/speccrew-create-agents/SKILL.md +98 -0
  9. package/.speccrew/skills/speccrew-create-agents/templates/agents/designer-agent.md +54 -0
  10. package/.speccrew/skills/speccrew-create-agents/templates/agents/dev-agent.md +79 -0
  11. package/.speccrew/skills/speccrew-create-agents/templates/agents/test-agent.md +80 -0
  12. package/.speccrew/skills/speccrew-dev-backend/SKILL.md +205 -0
  13. package/.speccrew/skills/speccrew-dev-backend/templates/TASK-RECORD-TEMPLATE.md +118 -0
  14. package/.speccrew/skills/speccrew-dev-desktop/SKILL.md +258 -0
  15. package/.speccrew/skills/speccrew-dev-desktop/templates/TASK-RECORD-TEMPLATE.md +161 -0
  16. package/.speccrew/skills/speccrew-dev-frontend/SKILL.md +202 -0
  17. package/.speccrew/skills/speccrew-dev-frontend/templates/TASK-RECORD-TEMPLATE.md +115 -0
  18. package/.speccrew/skills/speccrew-dev-mobile/SKILL.md +200 -0
  19. package/.speccrew/skills/speccrew-dev-mobile/templates/TASK-RECORD-TEMPLATE.md +125 -0
  20. package/.speccrew/skills/speccrew-fd-api-contract/SKILL.md +73 -0
  21. package/.speccrew/skills/speccrew-fd-api-contract/templates/API-CONTRACT-TEMPLATE.md +96 -0
  22. package/.speccrew/skills/speccrew-fd-feature-design/SKILL.md +395 -0
  23. package/.speccrew/skills/speccrew-fd-feature-design/templates/FEATURE-SPEC-TEMPLATE.md +387 -0
  24. package/.speccrew/skills/speccrew-get-timestamp/SKILL.md +80 -0
  25. package/.speccrew/skills/speccrew-get-timestamp/scripts/get-timestamp.js +35 -0
  26. package/.speccrew/skills/speccrew-knowledge-bizs-api-analyze/SKILL.md +1116 -0
  27. package/.speccrew/skills/speccrew-knowledge-bizs-api-analyze/templates/FEATURE-DETAIL-TEMPLATE-FASTAPI.md +462 -0
  28. package/.speccrew/skills/speccrew-knowledge-bizs-api-analyze/templates/FEATURE-DETAIL-TEMPLATE-JAVA.md +480 -0
  29. package/.speccrew/skills/speccrew-knowledge-bizs-api-analyze/templates/FEATURE-DETAIL-TEMPLATE-NET.md +464 -0
  30. package/.speccrew/skills/speccrew-knowledge-bizs-api-analyze/templates/FEATURE-DETAIL-TEMPLATE.md +480 -0
  31. package/.speccrew/skills/speccrew-knowledge-bizs-api-analyze/templates/MODULE-OVERVIEW-TEMPLATE.md +367 -0
  32. package/.speccrew/skills/speccrew-knowledge-bizs-dispatch/SKILL.md +667 -0
  33. package/.speccrew/skills/speccrew-knowledge-bizs-dispatch/STATUS-FORMATS.md +74 -0
  34. package/.speccrew/skills/speccrew-knowledge-bizs-dispatch/scripts/batch-orchestrator.js +176 -0
  35. package/.speccrew/skills/speccrew-knowledge-bizs-dispatch/scripts/get-next-batch.js +150 -0
  36. package/.speccrew/skills/speccrew-knowledge-bizs-dispatch/scripts/get-pending-features.js +106 -0
  37. package/.speccrew/skills/speccrew-knowledge-bizs-dispatch/scripts/mark-stale.js +249 -0
  38. package/.speccrew/skills/speccrew-knowledge-bizs-dispatch/scripts/process-batch-results.js +848 -0
  39. package/.speccrew/skills/speccrew-knowledge-bizs-dispatch/scripts/update-feature-status.js +226 -0
  40. package/.speccrew/skills/speccrew-knowledge-bizs-init-features/SKILL.md +264 -0
  41. package/.speccrew/skills/speccrew-knowledge-bizs-init-features/examples/features.json +34 -0
  42. package/.speccrew/skills/speccrew-knowledge-bizs-init-features/scripts/generate-inventory.js +867 -0
  43. package/.speccrew/skills/speccrew-knowledge-bizs-init-features/scripts/test-inventory.js +26 -0
  44. package/.speccrew/skills/speccrew-knowledge-bizs-module-classify/SKILL.md +165 -0
  45. package/.speccrew/skills/speccrew-knowledge-bizs-module-classify/scripts/apply-module-mapping.js +208 -0
  46. package/.speccrew/skills/speccrew-knowledge-bizs-module-classify/scripts/extract-module-summary.js +180 -0
  47. package/.speccrew/skills/speccrew-knowledge-bizs-module-classify/scripts/reindex-modules.js +358 -0
  48. package/.speccrew/skills/speccrew-knowledge-bizs-ui-analyze/SKILL.md +1055 -0
  49. package/.speccrew/skills/speccrew-knowledge-bizs-ui-analyze/templates/FEATURE-DETAIL-TEMPLATE-UI-DESKTOP.md +303 -0
  50. package/.speccrew/skills/speccrew-knowledge-bizs-ui-analyze/templates/FEATURE-DETAIL-TEMPLATE-UI-ELECTRON.md +327 -0
  51. package/.speccrew/skills/speccrew-knowledge-bizs-ui-analyze/templates/FEATURE-DETAIL-TEMPLATE-UI-MINIAPP.md +292 -0
  52. package/.speccrew/skills/speccrew-knowledge-bizs-ui-analyze/templates/FEATURE-DETAIL-TEMPLATE-UI-MOBILE.md +281 -0
  53. package/.speccrew/skills/speccrew-knowledge-bizs-ui-analyze/templates/FEATURE-DETAIL-TEMPLATE-UI.md +324 -0
  54. package/.speccrew/skills/speccrew-knowledge-bizs-ui-style-extract/SKILL.md +270 -0
  55. package/.speccrew/skills/speccrew-knowledge-bizs-ui-style-extract/templates/COMPONENT-PATTERN-TEMPLATE.md +33 -0
  56. package/.speccrew/skills/speccrew-knowledge-bizs-ui-style-extract/templates/LAYOUT-PATTERN-TEMPLATE.md +33 -0
  57. package/.speccrew/skills/speccrew-knowledge-bizs-ui-style-extract/templates/PAGE-TYPE-TEMPLATE.md +33 -0
  58. package/.speccrew/skills/speccrew-knowledge-graph-query/SKILL.md +229 -0
  59. package/.speccrew/skills/speccrew-knowledge-graph-query/scripts/graph-query.js +549 -0
  60. package/.speccrew/skills/speccrew-knowledge-graph-write/SKILL.md +181 -0
  61. package/.speccrew/skills/speccrew-knowledge-graph-write/scripts/graph-write.js +651 -0
  62. package/.speccrew/skills/speccrew-knowledge-module-summarize/SKILL.md +305 -0
  63. package/.speccrew/skills/speccrew-knowledge-module-summarize/templates/MODULE-OVERVIEW-TEMPLATE.md +400 -0
  64. package/.speccrew/skills/speccrew-knowledge-system-summarize/SKILL.md +351 -0
  65. package/.speccrew/skills/speccrew-knowledge-system-summarize/templates/SYSTEM-OVERVIEW-TEMPLATE.md +294 -0
  66. package/.speccrew/skills/speccrew-knowledge-techs-dispatch/SKILL.md +683 -0
  67. package/.speccrew/skills/speccrew-knowledge-techs-dispatch/STATUS-FORMATS.md +550 -0
  68. package/.speccrew/skills/speccrew-knowledge-techs-dispatch/templates/techs-manifest-EXAMPLE.json +35 -0
  69. package/.speccrew/skills/speccrew-knowledge-techs-generate/SKILL.md +1087 -0
  70. package/.speccrew/skills/speccrew-knowledge-techs-generate/templates/ARCHITECTURE-TEMPLATE.md +240 -0
  71. package/.speccrew/skills/speccrew-knowledge-techs-generate/templates/COLOR-SYSTEM-TEMPLATE.md +68 -0
  72. package/.speccrew/skills/speccrew-knowledge-techs-generate/templates/COMPONENT-LIBRARY-TEMPLATE.md +86 -0
  73. package/.speccrew/skills/speccrew-knowledge-techs-generate/templates/CONVENTIONS-BUILD-TEMPLATE.md +466 -0
  74. package/.speccrew/skills/speccrew-knowledge-techs-generate/templates/CONVENTIONS-DATA-TEMPLATE.md +432 -0
  75. package/.speccrew/skills/speccrew-knowledge-techs-generate/templates/CONVENTIONS-DESIGN-TEMPLATE.md +1209 -0
  76. package/.speccrew/skills/speccrew-knowledge-techs-generate/templates/CONVENTIONS-DEV-TEMPLATE.md +1433 -0
  77. package/.speccrew/skills/speccrew-knowledge-techs-generate/templates/CONVENTIONS-SYSTEM-TEST-TEMPLATE.md +1052 -0
  78. package/.speccrew/skills/speccrew-knowledge-techs-generate/templates/CONVENTIONS-UNIT-TEST-TEMPLATE.md +946 -0
  79. package/.speccrew/skills/speccrew-knowledge-techs-generate/templates/INDEX-TEMPLATE.md +29 -0
  80. package/.speccrew/skills/speccrew-knowledge-techs-generate/templates/PAGE-LAYOUTS-TEMPLATE.md +69 -0
  81. package/.speccrew/skills/speccrew-knowledge-techs-generate/templates/PAGE-TYPE-SUMMARY-TEMPLATE.md +74 -0
  82. package/.speccrew/skills/speccrew-knowledge-techs-generate/templates/TECH-STACK-TEMPLATE.md +232 -0
  83. package/.speccrew/skills/speccrew-knowledge-techs-generate-conventions/SKILL.md +628 -0
  84. package/.speccrew/skills/speccrew-knowledge-techs-generate-ui-style/SKILL.md +392 -0
  85. package/.speccrew/skills/speccrew-knowledge-techs-index/SKILL.md +489 -0
  86. package/.speccrew/skills/speccrew-knowledge-techs-index/templates/INDEX-TEMPLATE.md +243 -0
  87. package/.speccrew/skills/speccrew-knowledge-techs-init/SKILL.md +269 -0
  88. package/.speccrew/skills/speccrew-knowledge-techs-ui-analyze/SKILL.md +562 -0
  89. package/.speccrew/skills/speccrew-knowledge-techs-ui-analyze/templates/BUSINESS-COMPONENTS-TEMPLATE.md +171 -0
  90. package/.speccrew/skills/speccrew-knowledge-techs-ui-analyze/templates/COMMON-COMPONENTS-TEMPLATE.md +177 -0
  91. package/.speccrew/skills/speccrew-knowledge-techs-ui-analyze/templates/COMPONENT-INDIVIDUAL-TEMPLATE.md +80 -0
  92. package/.speccrew/skills/speccrew-knowledge-techs-ui-analyze/templates/COMPONENT-LIBRARY-TEMPLATE.md +118 -0
  93. package/.speccrew/skills/speccrew-knowledge-techs-ui-analyze/templates/LAYOUT-INDIVIDUAL-TEMPLATE.md +97 -0
  94. package/.speccrew/skills/speccrew-knowledge-techs-ui-analyze/templates/LAYOUT-PATTERNS-TEMPLATE.md +208 -0
  95. package/.speccrew/skills/speccrew-knowledge-techs-ui-analyze/templates/NAVIGATION-PATTERNS-TEMPLATE.md +157 -0
  96. package/.speccrew/skills/speccrew-knowledge-techs-ui-analyze/templates/PAGE-TYPE-INDIVIDUAL-TEMPLATE.md +123 -0
  97. package/.speccrew/skills/speccrew-knowledge-techs-ui-analyze/templates/PAGE-TYPE-SUMMARY-TEMPLATE.md +58 -0
  98. package/.speccrew/skills/speccrew-knowledge-techs-ui-analyze/templates/SPACING-TEMPLATE.md +119 -0
  99. package/.speccrew/skills/speccrew-knowledge-techs-ui-analyze/templates/STYLE-SYSTEM-TEMPLATE.md +117 -0
  100. package/.speccrew/skills/speccrew-knowledge-techs-ui-analyze/templates/TYPOGRAPHY-TEMPLATE.md +107 -0
  101. package/.speccrew/skills/speccrew-knowledge-techs-ui-analyze/templates/UI-STYLE-GUIDE-TEMPLATE.md +171 -0
  102. package/.speccrew/skills/speccrew-pm-requirement-analysis/SKILL.md +434 -0
  103. package/.speccrew/skills/speccrew-pm-requirement-analysis/templates/BIZS-MODELING-TEMPLATE.md +332 -0
  104. package/.speccrew/skills/speccrew-pm-requirement-analysis/templates/PRD-TEMPLATE.md +200 -0
  105. package/.speccrew/skills/speccrew-pm-requirement-assess/SKILL.md +195 -0
  106. package/.speccrew/skills/speccrew-project-diagnosis/SKILL.md +208 -0
  107. package/.speccrew/skills/speccrew-project-diagnosis/templates/DIAGNOSIS-REPORT-TEMPLATE.md +202 -0
  108. package/.speccrew/skills/speccrew-sd-backend/SKILL.md +188 -0
  109. package/.speccrew/skills/speccrew-sd-backend/templates/INDEX-TEMPLATE.md +85 -0
  110. package/.speccrew/skills/speccrew-sd-backend/templates/SD-BACKEND-TEMPLATE.md +269 -0
  111. package/.speccrew/skills/speccrew-sd-desktop/SKILL.md +192 -0
  112. package/.speccrew/skills/speccrew-sd-desktop/templates/INDEX-TEMPLATE.md +271 -0
  113. package/.speccrew/skills/speccrew-sd-desktop/templates/SD-DESKTOP-TEMPLATE.md +673 -0
  114. package/.speccrew/skills/speccrew-sd-frontend/SKILL.md +176 -0
  115. package/.speccrew/skills/speccrew-sd-frontend/templates/INDEX-TEMPLATE.md +184 -0
  116. package/.speccrew/skills/speccrew-sd-frontend/templates/SD-FRONTEND-TEMPLATE.md +382 -0
  117. package/.speccrew/skills/speccrew-sd-mobile/SKILL.md +189 -0
  118. package/.speccrew/skills/speccrew-sd-mobile/templates/INDEX-TEMPLATE.md +219 -0
  119. package/.speccrew/skills/speccrew-sd-mobile/templates/SD-MOBILE-TEMPLATE.md +534 -0
  120. package/.speccrew/skills/speccrew-test-case-design/SKILL.md +284 -0
  121. package/.speccrew/skills/speccrew-test-case-design/templates/TEST-CASE-DESIGN-TEMPLATE.md +263 -0
  122. package/.speccrew/skills/speccrew-test-code-gen/SKILL.md +313 -0
  123. package/.speccrew/skills/speccrew-test-code-gen/templates/TEST-CODE-PLAN-TEMPLATE.md +180 -0
  124. package/.speccrew/skills/speccrew-test-execute/SKILL.md +283 -0
  125. package/.speccrew/skills/speccrew-test-execute/templates/BUG-REPORT-TEMPLATE.md +50 -0
  126. package/.speccrew/skills/speccrew-test-execute/templates/TEST-REPORT-TEMPLATE.md +57 -0
  127. package/.speccrew/skills/speccrew-workflow-diagnose/SKILL.md +155 -0
  128. package/LICENSE +21 -0
  129. package/README.ar.md +318 -0
  130. package/README.en.md +318 -0
  131. package/README.es.md +318 -0
  132. package/README.md +340 -0
  133. package/bin/cli.js +62 -0
  134. package/lib/commands/doctor.js +138 -0
  135. package/lib/commands/init.js +231 -0
  136. package/lib/commands/list.js +114 -0
  137. package/lib/commands/uninstall.js +117 -0
  138. package/lib/commands/update.js +351 -0
  139. package/lib/ide-adapters.js +73 -0
  140. package/lib/utils.js +104 -0
  141. package/package.json +28 -0
  142. package/workspace-template/docs/configs/document-templates.json +667 -0
  143. package/workspace-template/docs/configs/platform-mapping.json +194 -0
  144. package/workspace-template/docs/configs/tech-stack-mappings.json +313 -0
  145. package/workspace-template/docs/configs/validation-rules.json +87 -0
  146. package/workspace-template/docs/rules/mermaid-rule.md +114 -0
  147. package/workspace-template/docs/solutions/Agent/346/212/200/350/203/275/345/256/232/344/271/211+/351/234/200/346/261/202/346/226/207/346/241/243+UML/344/275/277/347/224/250/346/250/241/346/235/277/357/274/210ISA-95/345/205/255/346/256/265/345/274/217/350/236/215/345/220/210/347/211/210/357/274/211.md +586 -0
  148. package/workspace-template/docs/solutions/agent-knowledge-map.md +238 -0
  149. package/workspace-template/docs/solutions/bizs-knowledge-pipeline.md +678 -0
  150. package/workspace-template/docs/solutions/harness.md +410 -0
  151. package/workspace-template/docs/solutions/knowledge-incremental-sync-spec.md +943 -0
  152. package/workspace-template/docs/solutions/techs-knowledge-pipeline.md +803 -0
  153. package/workspace-template/docs/solutions/workspace-structure.md +318 -0
@@ -0,0 +1,117 @@
1
+ ---
2
+ template_name: style-system
3
+ description: Style system documentation (color, typography, spacing)
4
+ output_file: styles/color-system.md
5
+ ---
6
+
7
+ # Color System
8
+
9
+ <cite>
10
+ **Files Referenced in This Document**
11
+ {{source_files}}
12
+ </cite>
13
+
14
+ > **Target Audience**: devcrew-designer-{{platform_id}}, devcrew-dev-{{platform_id}}
15
+
16
+ ## Overview
17
+
18
+ The color system provides a consistent palette for {{platform_name}}.
19
+
20
+ ## Brand Colors
21
+
22
+ ### Primary Palette
23
+
24
+ | Token Name | Hex Value | RGB Value | Usage |
25
+ |------------|-----------|-----------|-------|
26
+ {{primary_palette_table}}
27
+
28
+ ### Secondary Palette
29
+
30
+ | Token Name | Hex Value | RGB Value | Usage |
31
+ |------------|-----------|-----------|-------|
32
+ {{secondary_palette_table}}
33
+
34
+ ## Semantic Colors
35
+
36
+ ### Status Colors
37
+
38
+ | Status | Light Mode | Dark Mode | Usage |
39
+ |--------|------------|-----------|-------|
40
+ {{status_colors_table}}
41
+
42
+ ### Feedback Colors
43
+
44
+ | Type | Color | Usage Examples |
45
+ |------|-------|----------------|
46
+ {{feedback_colors_table}}
47
+
48
+ ## Neutral Colors
49
+
50
+ ### Gray Scale
51
+
52
+ | Token | Hex Value | Usage |
53
+ |-------|-----------|-------|
54
+ {{gray_scale_table}}
55
+
56
+ ### Text Colors
57
+
58
+ | Token | Hex Value | Usage |
59
+ |-------|-----------|-------|
60
+ {{text_colors_table}}
61
+
62
+ ## Background Colors
63
+
64
+ | Token | Hex Value | Usage |
65
+ |-------|-----------|-------|
66
+ {{background_colors_table}}
67
+
68
+ ## Border Colors
69
+
70
+ | Token | Hex Value | Usage |
71
+ |-------|-----------|-------|
72
+ {{border_colors_table}}
73
+
74
+ ## CSS Variables
75
+
76
+ ```css
77
+ :root {
78
+ {{css_variables}}
79
+ }
80
+
81
+ [data-theme="dark"] {
82
+ {{dark_mode_variables}}
83
+ }
84
+ ```
85
+
86
+ ## Usage Guidelines
87
+
88
+ ### Do's
89
+
90
+ - ✅ Use semantic color tokens (e.g., `--color-primary`) instead of hardcoded values
91
+ - ✅ Use status colors consistently for their intended purposes
92
+ - ✅ Ensure sufficient contrast ratios for accessibility
93
+ - ✅ Test colors in both light and dark modes
94
+
95
+ ### Don'ts
96
+
97
+ - ❌ Use colors outside the defined palette without approval
98
+ - ❌ Mix multiple primary colors in the same context
99
+ - ❌ Use status colors for non-status purposes
100
+ - ❌ Ignore color blindness accessibility
101
+
102
+ ## Color Combinations
103
+
104
+ ### Safe Combinations
105
+
106
+ {{safe_combinations_table}}
107
+
108
+ ### Contrast Requirements
109
+
110
+ | Text Size | Minimum Contrast | Recommended Contrast |
111
+ |-----------|------------------|---------------------|
112
+ {{contrast_requirements_table}}
113
+
114
+ ---
115
+
116
+ **Section Source**
117
+ {{section_source_files}}
@@ -0,0 +1,107 @@
1
+ ---
2
+ template_name: typography
3
+ description: Typography system documentation
4
+ output_file: styles/typography.md
5
+ ---
6
+
7
+ # Typography System
8
+
9
+ <cite>
10
+ **Files Referenced in This Document**
11
+ {{source_files}}
12
+ </cite>
13
+
14
+ > **Target Audience**: devcrew-designer-{{platform_id}}, devcrew-dev-{{platform_id}}
15
+
16
+ ## Overview
17
+
18
+ The typography system defines font families, sizes, weights, and line heights for {{platform_name}}.
19
+
20
+ ## Font Families
21
+
22
+ ### Primary Font
23
+
24
+ | Property | Value | Usage |
25
+ |----------|-------|-------|
26
+ {{primary_font_table}}
27
+
28
+ ### Fallback Fonts
29
+
30
+ ```css
31
+ font-family: {{font_stack}};
32
+ ```
33
+
34
+ ### Monospace Font
35
+
36
+ | Property | Value | Usage |
37
+ |----------|-------|-------|
38
+ {{monospace_font_table}}
39
+
40
+ ## Type Scale
41
+
42
+ ### Heading Styles
43
+
44
+ | Level | Size | Weight | Line Height | Letter Spacing | Usage |
45
+ |-------|------|--------|-------------|----------------|-------|
46
+ {{heading_styles_table}}
47
+
48
+ ### Body Text Styles
49
+
50
+ | Style | Size | Weight | Line Height | Usage |
51
+ |-------|------|--------|-------------|-------|
52
+ {{body_styles_table}}
53
+
54
+ ### Special Text Styles
55
+
56
+ | Style | Size | Weight | Line Height | Usage |
57
+ |-------|------|--------|-------------|-------|
58
+ {{special_styles_table}}
59
+
60
+ ## Font Weights
61
+
62
+ | Token | Value | Usage |
63
+ |-------|-------|-------|
64
+ {{font_weights_table}}
65
+
66
+ ## Line Heights
67
+
68
+ | Token | Value | Usage |
69
+ |-------|-------|-------|
70
+ {{line_heights_table}}
71
+
72
+ ## Letter Spacing
73
+
74
+ | Token | Value | Usage |
75
+ |-------|-------|-------|
76
+ {{letter_spacing_table}}
77
+
78
+ ## CSS Classes
79
+
80
+ ```css
81
+ {{typography_css_classes}}
82
+ ```
83
+
84
+ ## Responsive Typography
85
+
86
+ ### Mobile Adjustments
87
+
88
+ | Element | Desktop | Tablet | Mobile |
89
+ |---------|---------|--------|--------|
90
+ {{responsive_typography_table}}
91
+
92
+ ## Usage Guidelines
93
+
94
+ ### Hierarchy
95
+
96
+ {{typography_hierarchy_guidelines}}
97
+
98
+ ### Readability
99
+
100
+ - Optimal line length: {{optimal_line_length}}
101
+ - Minimum font size: {{minimum_font_size}}
102
+ - Recommended line height for body text: {{recommended_line_height}}
103
+
104
+ ---
105
+
106
+ **Section Source**
107
+ {{section_source_files}}
@@ -0,0 +1,171 @@
1
+ ---
2
+ template_name: ui-style-guide
3
+ description: Main UI style guide template for frontend platforms
4
+ output_file: ui-style-guide.md
5
+ ---
6
+
7
+ # {{platform_name}} UI Style Guide
8
+
9
+ <cite>
10
+ **Files Referenced in This Document**
11
+ {{source_files}}
12
+ </cite>
13
+
14
+ > **Target Audience**: devcrew-designer-{{platform_id}}, devcrew-dev-{{platform_id}}
15
+
16
+ ## Table of Contents
17
+
18
+ 1. [Project Overview](#project-overview)
19
+ 2. [Platform Summary](#platform-summary)
20
+ 3. [Design System](#design-system)
21
+ 4. [Component Architecture](#component-architecture)
22
+ 5. [Layout Patterns](#layout-patterns)
23
+ 6. [Page Type Guide](#page-type-guide)
24
+ 7. [Styling Conventions](#styling-conventions)
25
+ 8. [Best Practices](#best-practices)
26
+
27
+ ## Project Overview
28
+
29
+ ### Technology Stack
30
+
31
+ | Category | Technology | Version |
32
+ |----------|------------|---------|
33
+ | Framework | {{framework}} | {{framework_version}} |
34
+ | UI Library | {{ui_library}} | {{ui_library_version}} |
35
+ | Build Tool | {{build_tool}} | {{build_tool_version}} |
36
+ | Language | {{language}} | {{language_version}} |
37
+
38
+ ### Directory Structure
39
+
40
+ ```
41
+ src/
42
+ ├── views/ # Page components
43
+ ├── components/ # Reusable components
44
+ ├── layouts/ # Layout components
45
+ ├── styles/ # Global styles
46
+ └── assets/ # Static assets
47
+ ```
48
+
49
+ ## Platform Summary
50
+
51
+ ### Supported Platforms
52
+
53
+ | Platform | Resolution Range | Target Device |
54
+ |----------|------------------|---------------|
55
+ | {{platform_details}} |
56
+
57
+ ### Browser Support
58
+
59
+ - {{browser_support_list}}
60
+
61
+ ## Design System
62
+
63
+ ### Color Palette
64
+
65
+ | Color Name | Hex Value | Usage |
66
+ |------------|-----------|-------|
67
+ | Primary | {{primary_color}} | Buttons, links, active states |
68
+ | Success | {{success_color}} | Success messages, positive actions |
69
+ | Warning | {{warning_color}} | Warnings, caution states |
70
+ | Error | {{error_color}} | Errors, destructive actions |
71
+ | Info | {{info_color}} | Informational messages |
72
+
73
+ ### Typography
74
+
75
+ | Element | Font Family | Size | Weight | Line Height |
76
+ |---------|-------------|------|--------|-------------|
77
+ | H1 | {{heading_font}} | {{h1_size}} | 600 | 1.2 |
78
+ | H2 | {{heading_font}} | {{h2_size}} | 600 | 1.3 |
79
+ | Body | {{body_font}} | {{body_size}} | 400 | 1.5 |
80
+ | Small | {{body_font}} | {{small_size}} | 400 | 1.4 |
81
+
82
+ ### Spacing System
83
+
84
+ | Token | Value | Usage |
85
+ |-------|-------|-------|
86
+ | xs | {{xs_spacing}} | Tight spacing, icons |
87
+ | sm | {{sm_spacing}} | Compact elements |
88
+ | md | {{md_spacing}} | Default spacing |
89
+ | lg | {{lg_spacing}} | Section spacing |
90
+ | xl | {{xl_spacing}} | Large sections |
91
+
92
+ ## Component Architecture
93
+
94
+ ### Component Categories
95
+
96
+ 1. **UI Framework Components**: {{ui_framework_name}} built-in components
97
+ 2. **Common Components**: Project-wide reusable components
98
+ 3. **Business Components**: Domain-specific components
99
+
100
+ ### Component Usage Patterns
101
+
102
+ See detailed documentation:
103
+ - [Component Library](components/component-library.md)
104
+ - [Common Components](components/common-components.md)
105
+ - [Business Components](components/business-components.md)
106
+
107
+ ## Layout Patterns
108
+
109
+ ### Available Layouts
110
+
111
+ See [Layout Patterns](layouts/page-layouts.md) for detailed information.
112
+
113
+ ### Navigation Patterns
114
+
115
+ See [Navigation Patterns](layouts/navigation-patterns.md) for detailed information.
116
+
117
+ ## Page Type Guide
118
+
119
+ ### Page Type Overview
120
+
121
+ See [Page Type Summary](page-types/page-type-summary.md) for the complete list of page types.
122
+
123
+ ### Page Type Selection
124
+
125
+ | Business Scenario | Recommended Page Type | Reference |
126
+ |-------------------|----------------------|-----------|
127
+ {{page_type_selection_table}}
128
+
129
+ ## Styling Conventions
130
+
131
+ ### CSS Methodology
132
+
133
+ - **Approach**: {{css_methodology}}
134
+ - **Preprocessor**: {{preprocessor}}
135
+ - **Naming Convention**: {{naming_convention}}
136
+
137
+ ### Style File Organization
138
+
139
+ ```
140
+ styles/
141
+ ├── variables/ # CSS variables
142
+ ├── mixins/ # SCSS/LESS mixins
143
+ ├── components/ # Component-specific styles
144
+ └── utilities/ # Utility classes
145
+ ```
146
+
147
+ See detailed style system:
148
+ - [Color System](styles/color-system.md)
149
+ - [Typography](styles/typography.md)
150
+ - [Spacing System](styles/spacing-system.md)
151
+
152
+ ## Best Practices
153
+
154
+ ### Do's
155
+
156
+ - ✅ Use the design system tokens for consistency
157
+ - ✅ Follow the established naming conventions
158
+ - ✅ Reuse existing components before creating new ones
159
+ - ✅ Test responsive behavior across breakpoints
160
+
161
+ ### Don'ts
162
+
163
+ - ❌ Hardcode colors or spacing values
164
+ - ❌ Create one-off components without justification
165
+ - ❌ Bypass the layout system
166
+ - ❌ Ignore accessibility guidelines
167
+
168
+ ---
169
+
170
+ **Section Source**
171
+ {{section_source_files}}