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.
- package/.speccrew/agents/speccrew-feature-designer.md +142 -0
- package/.speccrew/agents/speccrew-product-manager.md +61 -0
- package/.speccrew/agents/speccrew-system-designer.md +200 -0
- package/.speccrew/agents/speccrew-system-developer.md +238 -0
- package/.speccrew/agents/speccrew-task-worker.md +80 -0
- package/.speccrew/agents/speccrew-team-leader.md +92 -0
- package/.speccrew/agents/speccrew-test-manager.md +313 -0
- package/.speccrew/skills/speccrew-create-agents/SKILL.md +98 -0
- package/.speccrew/skills/speccrew-create-agents/templates/agents/designer-agent.md +54 -0
- package/.speccrew/skills/speccrew-create-agents/templates/agents/dev-agent.md +79 -0
- package/.speccrew/skills/speccrew-create-agents/templates/agents/test-agent.md +80 -0
- package/.speccrew/skills/speccrew-dev-backend/SKILL.md +205 -0
- package/.speccrew/skills/speccrew-dev-backend/templates/TASK-RECORD-TEMPLATE.md +118 -0
- package/.speccrew/skills/speccrew-dev-desktop/SKILL.md +258 -0
- package/.speccrew/skills/speccrew-dev-desktop/templates/TASK-RECORD-TEMPLATE.md +161 -0
- package/.speccrew/skills/speccrew-dev-frontend/SKILL.md +202 -0
- package/.speccrew/skills/speccrew-dev-frontend/templates/TASK-RECORD-TEMPLATE.md +115 -0
- package/.speccrew/skills/speccrew-dev-mobile/SKILL.md +200 -0
- package/.speccrew/skills/speccrew-dev-mobile/templates/TASK-RECORD-TEMPLATE.md +125 -0
- package/.speccrew/skills/speccrew-fd-api-contract/SKILL.md +73 -0
- package/.speccrew/skills/speccrew-fd-api-contract/templates/API-CONTRACT-TEMPLATE.md +96 -0
- package/.speccrew/skills/speccrew-fd-feature-design/SKILL.md +395 -0
- package/.speccrew/skills/speccrew-fd-feature-design/templates/FEATURE-SPEC-TEMPLATE.md +387 -0
- package/.speccrew/skills/speccrew-get-timestamp/SKILL.md +80 -0
- package/.speccrew/skills/speccrew-get-timestamp/scripts/get-timestamp.js +35 -0
- package/.speccrew/skills/speccrew-knowledge-bizs-api-analyze/SKILL.md +1116 -0
- package/.speccrew/skills/speccrew-knowledge-bizs-api-analyze/templates/FEATURE-DETAIL-TEMPLATE-FASTAPI.md +462 -0
- package/.speccrew/skills/speccrew-knowledge-bizs-api-analyze/templates/FEATURE-DETAIL-TEMPLATE-JAVA.md +480 -0
- package/.speccrew/skills/speccrew-knowledge-bizs-api-analyze/templates/FEATURE-DETAIL-TEMPLATE-NET.md +464 -0
- package/.speccrew/skills/speccrew-knowledge-bizs-api-analyze/templates/FEATURE-DETAIL-TEMPLATE.md +480 -0
- package/.speccrew/skills/speccrew-knowledge-bizs-api-analyze/templates/MODULE-OVERVIEW-TEMPLATE.md +367 -0
- package/.speccrew/skills/speccrew-knowledge-bizs-dispatch/SKILL.md +667 -0
- package/.speccrew/skills/speccrew-knowledge-bizs-dispatch/STATUS-FORMATS.md +74 -0
- package/.speccrew/skills/speccrew-knowledge-bizs-dispatch/scripts/batch-orchestrator.js +176 -0
- package/.speccrew/skills/speccrew-knowledge-bizs-dispatch/scripts/get-next-batch.js +150 -0
- package/.speccrew/skills/speccrew-knowledge-bizs-dispatch/scripts/get-pending-features.js +106 -0
- package/.speccrew/skills/speccrew-knowledge-bizs-dispatch/scripts/mark-stale.js +249 -0
- package/.speccrew/skills/speccrew-knowledge-bizs-dispatch/scripts/process-batch-results.js +848 -0
- package/.speccrew/skills/speccrew-knowledge-bizs-dispatch/scripts/update-feature-status.js +226 -0
- package/.speccrew/skills/speccrew-knowledge-bizs-init-features/SKILL.md +264 -0
- package/.speccrew/skills/speccrew-knowledge-bizs-init-features/examples/features.json +34 -0
- package/.speccrew/skills/speccrew-knowledge-bizs-init-features/scripts/generate-inventory.js +867 -0
- package/.speccrew/skills/speccrew-knowledge-bizs-init-features/scripts/test-inventory.js +26 -0
- package/.speccrew/skills/speccrew-knowledge-bizs-module-classify/SKILL.md +165 -0
- package/.speccrew/skills/speccrew-knowledge-bizs-module-classify/scripts/apply-module-mapping.js +208 -0
- package/.speccrew/skills/speccrew-knowledge-bizs-module-classify/scripts/extract-module-summary.js +180 -0
- package/.speccrew/skills/speccrew-knowledge-bizs-module-classify/scripts/reindex-modules.js +358 -0
- package/.speccrew/skills/speccrew-knowledge-bizs-ui-analyze/SKILL.md +1055 -0
- package/.speccrew/skills/speccrew-knowledge-bizs-ui-analyze/templates/FEATURE-DETAIL-TEMPLATE-UI-DESKTOP.md +303 -0
- package/.speccrew/skills/speccrew-knowledge-bizs-ui-analyze/templates/FEATURE-DETAIL-TEMPLATE-UI-ELECTRON.md +327 -0
- package/.speccrew/skills/speccrew-knowledge-bizs-ui-analyze/templates/FEATURE-DETAIL-TEMPLATE-UI-MINIAPP.md +292 -0
- package/.speccrew/skills/speccrew-knowledge-bizs-ui-analyze/templates/FEATURE-DETAIL-TEMPLATE-UI-MOBILE.md +281 -0
- package/.speccrew/skills/speccrew-knowledge-bizs-ui-analyze/templates/FEATURE-DETAIL-TEMPLATE-UI.md +324 -0
- package/.speccrew/skills/speccrew-knowledge-bizs-ui-style-extract/SKILL.md +270 -0
- package/.speccrew/skills/speccrew-knowledge-bizs-ui-style-extract/templates/COMPONENT-PATTERN-TEMPLATE.md +33 -0
- package/.speccrew/skills/speccrew-knowledge-bizs-ui-style-extract/templates/LAYOUT-PATTERN-TEMPLATE.md +33 -0
- package/.speccrew/skills/speccrew-knowledge-bizs-ui-style-extract/templates/PAGE-TYPE-TEMPLATE.md +33 -0
- package/.speccrew/skills/speccrew-knowledge-graph-query/SKILL.md +229 -0
- package/.speccrew/skills/speccrew-knowledge-graph-query/scripts/graph-query.js +549 -0
- package/.speccrew/skills/speccrew-knowledge-graph-write/SKILL.md +181 -0
- package/.speccrew/skills/speccrew-knowledge-graph-write/scripts/graph-write.js +651 -0
- package/.speccrew/skills/speccrew-knowledge-module-summarize/SKILL.md +305 -0
- package/.speccrew/skills/speccrew-knowledge-module-summarize/templates/MODULE-OVERVIEW-TEMPLATE.md +400 -0
- package/.speccrew/skills/speccrew-knowledge-system-summarize/SKILL.md +351 -0
- package/.speccrew/skills/speccrew-knowledge-system-summarize/templates/SYSTEM-OVERVIEW-TEMPLATE.md +294 -0
- package/.speccrew/skills/speccrew-knowledge-techs-dispatch/SKILL.md +683 -0
- package/.speccrew/skills/speccrew-knowledge-techs-dispatch/STATUS-FORMATS.md +550 -0
- package/.speccrew/skills/speccrew-knowledge-techs-dispatch/templates/techs-manifest-EXAMPLE.json +35 -0
- package/.speccrew/skills/speccrew-knowledge-techs-generate/SKILL.md +1087 -0
- package/.speccrew/skills/speccrew-knowledge-techs-generate/templates/ARCHITECTURE-TEMPLATE.md +240 -0
- package/.speccrew/skills/speccrew-knowledge-techs-generate/templates/COLOR-SYSTEM-TEMPLATE.md +68 -0
- package/.speccrew/skills/speccrew-knowledge-techs-generate/templates/COMPONENT-LIBRARY-TEMPLATE.md +86 -0
- package/.speccrew/skills/speccrew-knowledge-techs-generate/templates/CONVENTIONS-BUILD-TEMPLATE.md +466 -0
- package/.speccrew/skills/speccrew-knowledge-techs-generate/templates/CONVENTIONS-DATA-TEMPLATE.md +432 -0
- package/.speccrew/skills/speccrew-knowledge-techs-generate/templates/CONVENTIONS-DESIGN-TEMPLATE.md +1209 -0
- package/.speccrew/skills/speccrew-knowledge-techs-generate/templates/CONVENTIONS-DEV-TEMPLATE.md +1433 -0
- package/.speccrew/skills/speccrew-knowledge-techs-generate/templates/CONVENTIONS-SYSTEM-TEST-TEMPLATE.md +1052 -0
- package/.speccrew/skills/speccrew-knowledge-techs-generate/templates/CONVENTIONS-UNIT-TEST-TEMPLATE.md +946 -0
- package/.speccrew/skills/speccrew-knowledge-techs-generate/templates/INDEX-TEMPLATE.md +29 -0
- package/.speccrew/skills/speccrew-knowledge-techs-generate/templates/PAGE-LAYOUTS-TEMPLATE.md +69 -0
- package/.speccrew/skills/speccrew-knowledge-techs-generate/templates/PAGE-TYPE-SUMMARY-TEMPLATE.md +74 -0
- package/.speccrew/skills/speccrew-knowledge-techs-generate/templates/TECH-STACK-TEMPLATE.md +232 -0
- package/.speccrew/skills/speccrew-knowledge-techs-generate-conventions/SKILL.md +628 -0
- package/.speccrew/skills/speccrew-knowledge-techs-generate-ui-style/SKILL.md +392 -0
- package/.speccrew/skills/speccrew-knowledge-techs-index/SKILL.md +489 -0
- package/.speccrew/skills/speccrew-knowledge-techs-index/templates/INDEX-TEMPLATE.md +243 -0
- package/.speccrew/skills/speccrew-knowledge-techs-init/SKILL.md +269 -0
- package/.speccrew/skills/speccrew-knowledge-techs-ui-analyze/SKILL.md +562 -0
- package/.speccrew/skills/speccrew-knowledge-techs-ui-analyze/templates/BUSINESS-COMPONENTS-TEMPLATE.md +171 -0
- package/.speccrew/skills/speccrew-knowledge-techs-ui-analyze/templates/COMMON-COMPONENTS-TEMPLATE.md +177 -0
- package/.speccrew/skills/speccrew-knowledge-techs-ui-analyze/templates/COMPONENT-INDIVIDUAL-TEMPLATE.md +80 -0
- package/.speccrew/skills/speccrew-knowledge-techs-ui-analyze/templates/COMPONENT-LIBRARY-TEMPLATE.md +118 -0
- package/.speccrew/skills/speccrew-knowledge-techs-ui-analyze/templates/LAYOUT-INDIVIDUAL-TEMPLATE.md +97 -0
- package/.speccrew/skills/speccrew-knowledge-techs-ui-analyze/templates/LAYOUT-PATTERNS-TEMPLATE.md +208 -0
- package/.speccrew/skills/speccrew-knowledge-techs-ui-analyze/templates/NAVIGATION-PATTERNS-TEMPLATE.md +157 -0
- package/.speccrew/skills/speccrew-knowledge-techs-ui-analyze/templates/PAGE-TYPE-INDIVIDUAL-TEMPLATE.md +123 -0
- package/.speccrew/skills/speccrew-knowledge-techs-ui-analyze/templates/PAGE-TYPE-SUMMARY-TEMPLATE.md +58 -0
- package/.speccrew/skills/speccrew-knowledge-techs-ui-analyze/templates/SPACING-TEMPLATE.md +119 -0
- package/.speccrew/skills/speccrew-knowledge-techs-ui-analyze/templates/STYLE-SYSTEM-TEMPLATE.md +117 -0
- package/.speccrew/skills/speccrew-knowledge-techs-ui-analyze/templates/TYPOGRAPHY-TEMPLATE.md +107 -0
- package/.speccrew/skills/speccrew-knowledge-techs-ui-analyze/templates/UI-STYLE-GUIDE-TEMPLATE.md +171 -0
- package/.speccrew/skills/speccrew-pm-requirement-analysis/SKILL.md +434 -0
- package/.speccrew/skills/speccrew-pm-requirement-analysis/templates/BIZS-MODELING-TEMPLATE.md +332 -0
- package/.speccrew/skills/speccrew-pm-requirement-analysis/templates/PRD-TEMPLATE.md +200 -0
- package/.speccrew/skills/speccrew-pm-requirement-assess/SKILL.md +195 -0
- package/.speccrew/skills/speccrew-project-diagnosis/SKILL.md +208 -0
- package/.speccrew/skills/speccrew-project-diagnosis/templates/DIAGNOSIS-REPORT-TEMPLATE.md +202 -0
- package/.speccrew/skills/speccrew-sd-backend/SKILL.md +188 -0
- package/.speccrew/skills/speccrew-sd-backend/templates/INDEX-TEMPLATE.md +85 -0
- package/.speccrew/skills/speccrew-sd-backend/templates/SD-BACKEND-TEMPLATE.md +269 -0
- package/.speccrew/skills/speccrew-sd-desktop/SKILL.md +192 -0
- package/.speccrew/skills/speccrew-sd-desktop/templates/INDEX-TEMPLATE.md +271 -0
- package/.speccrew/skills/speccrew-sd-desktop/templates/SD-DESKTOP-TEMPLATE.md +673 -0
- package/.speccrew/skills/speccrew-sd-frontend/SKILL.md +176 -0
- package/.speccrew/skills/speccrew-sd-frontend/templates/INDEX-TEMPLATE.md +184 -0
- package/.speccrew/skills/speccrew-sd-frontend/templates/SD-FRONTEND-TEMPLATE.md +382 -0
- package/.speccrew/skills/speccrew-sd-mobile/SKILL.md +189 -0
- package/.speccrew/skills/speccrew-sd-mobile/templates/INDEX-TEMPLATE.md +219 -0
- package/.speccrew/skills/speccrew-sd-mobile/templates/SD-MOBILE-TEMPLATE.md +534 -0
- package/.speccrew/skills/speccrew-test-case-design/SKILL.md +284 -0
- package/.speccrew/skills/speccrew-test-case-design/templates/TEST-CASE-DESIGN-TEMPLATE.md +263 -0
- package/.speccrew/skills/speccrew-test-code-gen/SKILL.md +313 -0
- package/.speccrew/skills/speccrew-test-code-gen/templates/TEST-CODE-PLAN-TEMPLATE.md +180 -0
- package/.speccrew/skills/speccrew-test-execute/SKILL.md +283 -0
- package/.speccrew/skills/speccrew-test-execute/templates/BUG-REPORT-TEMPLATE.md +50 -0
- package/.speccrew/skills/speccrew-test-execute/templates/TEST-REPORT-TEMPLATE.md +57 -0
- package/.speccrew/skills/speccrew-workflow-diagnose/SKILL.md +155 -0
- package/LICENSE +21 -0
- package/README.ar.md +318 -0
- package/README.en.md +318 -0
- package/README.es.md +318 -0
- package/README.md +340 -0
- package/bin/cli.js +62 -0
- package/lib/commands/doctor.js +138 -0
- package/lib/commands/init.js +231 -0
- package/lib/commands/list.js +114 -0
- package/lib/commands/uninstall.js +117 -0
- package/lib/commands/update.js +351 -0
- package/lib/ide-adapters.js +73 -0
- package/lib/utils.js +104 -0
- package/package.json +28 -0
- package/workspace-template/docs/configs/document-templates.json +667 -0
- package/workspace-template/docs/configs/platform-mapping.json +194 -0
- package/workspace-template/docs/configs/tech-stack-mappings.json +313 -0
- package/workspace-template/docs/configs/validation-rules.json +87 -0
- package/workspace-template/docs/rules/mermaid-rule.md +114 -0
- 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
- package/workspace-template/docs/solutions/agent-knowledge-map.md +238 -0
- package/workspace-template/docs/solutions/bizs-knowledge-pipeline.md +678 -0
- package/workspace-template/docs/solutions/harness.md +410 -0
- package/workspace-template/docs/solutions/knowledge-incremental-sync-spec.md +943 -0
- package/workspace-template/docs/solutions/techs-knowledge-pipeline.md +803 -0
- package/workspace-template/docs/solutions/workspace-structure.md +318 -0
|
@@ -0,0 +1,240 @@
|
|
|
1
|
+
# {{platform_name}} Architecture Conventions
|
|
2
|
+
|
|
3
|
+
<cite>
|
|
4
|
+
**Files Referenced in This Document**
|
|
5
|
+
{{#each source_files}}
|
|
6
|
+
- [{{name}}](file://{{path}})
|
|
7
|
+
{{/each}}
|
|
8
|
+
</cite>
|
|
9
|
+
|
|
10
|
+
> **Target Audience**: devcrew-designer-{{platform_id}}, devcrew-dev-{{platform_id}}, devcrew-test-{{platform_id}}
|
|
11
|
+
|
|
12
|
+
## Table of Contents
|
|
13
|
+
|
|
14
|
+
1. [Introduction](#introduction)
|
|
15
|
+
2. [Project Structure](#project-structure)
|
|
16
|
+
3. [Core Components](#core-components)
|
|
17
|
+
4. [Architecture Overview](#architecture-overview)
|
|
18
|
+
5. [Detailed Component Analysis](#detailed-component-analysis)
|
|
19
|
+
6. [Dependency Analysis](#dependency-analysis)
|
|
20
|
+
7. [Performance Considerations](#performance-considerations)
|
|
21
|
+
8. [Troubleshooting Guide](#troubleshooting-guide)
|
|
22
|
+
9. [Conclusion](#conclusion)
|
|
23
|
+
10. [Appendix](#appendix)
|
|
24
|
+
|
|
25
|
+
## Introduction
|
|
26
|
+
|
|
27
|
+
This architecture conventions document defines the layered architecture design, module organization, component interaction patterns, error handling strategies, security considerations, and performance guidelines for the {{platform_name}} platform.
|
|
28
|
+
|
|
29
|
+
## Project Structure
|
|
30
|
+
|
|
31
|
+
{{platform_name}} uses the following directory structure:
|
|
32
|
+
|
|
33
|
+
```
|
|
34
|
+
{{directory_structure}}
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
```mermaid
|
|
38
|
+
graph TB
|
|
39
|
+
{{#each structure_components}}
|
|
40
|
+
{{id}}["{{name}}"]
|
|
41
|
+
{{/each}}
|
|
42
|
+
{{#each structure_relations}}
|
|
43
|
+
{{from}} --> {{to}}
|
|
44
|
+
{{/each}}
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
**Diagram Source**
|
|
48
|
+
{{#each structure_sources}}
|
|
49
|
+
- [{{name}}](file://{{path}}#L{{start}}-L{{end}})
|
|
50
|
+
{{/each}}
|
|
51
|
+
|
|
52
|
+
**Section Source**
|
|
53
|
+
{{#each project_structure_sources}}
|
|
54
|
+
- [{{name}}](file://{{path}}#L{{start}}-L{{end}})
|
|
55
|
+
{{/each}}
|
|
56
|
+
|
|
57
|
+
## Core Components
|
|
58
|
+
|
|
59
|
+
### Layer Organization
|
|
60
|
+
|
|
61
|
+
| Layer | Responsibility | Key Components |
|
|
62
|
+
|-------|---------------|----------------|
|
|
63
|
+
{{#each layers}}
|
|
64
|
+
| {{name}} | {{responsibility}} | {{components}} |
|
|
65
|
+
{{/each}}
|
|
66
|
+
|
|
67
|
+
### Component Overview
|
|
68
|
+
|
|
69
|
+
{{component_overview}}
|
|
70
|
+
|
|
71
|
+
**Section Source**
|
|
72
|
+
{{#each core_components_sources}}
|
|
73
|
+
- [{{name}}](file://{{path}}#L{{start}}-L{{end}})
|
|
74
|
+
{{/each}}
|
|
75
|
+
|
|
76
|
+
## Architecture Overview
|
|
77
|
+
|
|
78
|
+
{{architecture_overview}}
|
|
79
|
+
|
|
80
|
+
```mermaid
|
|
81
|
+
graph TB
|
|
82
|
+
subgraph "{{platform_name}} Architecture"
|
|
83
|
+
{{#each arch_layers}}
|
|
84
|
+
subgraph "{{name}}"
|
|
85
|
+
{{#each components}}
|
|
86
|
+
{{id}}["{{label}}"]
|
|
87
|
+
{{/each}}
|
|
88
|
+
end
|
|
89
|
+
{{/each}}
|
|
90
|
+
end
|
|
91
|
+
{{#each arch_relations}}
|
|
92
|
+
{{from}} --> {{to}}
|
|
93
|
+
{{/each}}
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
**Diagram Source**
|
|
97
|
+
{{#each architecture_sources}}
|
|
98
|
+
- [{{name}}](file://{{path}}#L{{start}}-L{{end}})
|
|
99
|
+
{{/each}}
|
|
100
|
+
|
|
101
|
+
**Section Source**
|
|
102
|
+
{{#each architecture_overview_sources}}
|
|
103
|
+
- [{{name}}](file://{{path}}#L{{start}}-L{{end}})
|
|
104
|
+
{{/each}}
|
|
105
|
+
|
|
106
|
+
## Detailed Component Analysis
|
|
107
|
+
|
|
108
|
+
{{#each component_analysis}}
|
|
109
|
+
### {{name}}
|
|
110
|
+
|
|
111
|
+
{{description}}
|
|
112
|
+
|
|
113
|
+
{{#if has_diagram}}
|
|
114
|
+
```mermaid
|
|
115
|
+
{{diagram_type}}
|
|
116
|
+
{{diagram_content}}
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
**Diagram Source**
|
|
120
|
+
{{#each diagram_sources}}
|
|
121
|
+
- [{{name}}](file://{{path}}#L{{start}}-L{{end}})
|
|
122
|
+
{{/each}}
|
|
123
|
+
{{/if}}
|
|
124
|
+
|
|
125
|
+
**Section Source**
|
|
126
|
+
{{#each sources}}
|
|
127
|
+
- [{{name}}](file://{{path}}#L{{start}}-L{{end}})
|
|
128
|
+
{{/each}}
|
|
129
|
+
|
|
130
|
+
{{/each}}
|
|
131
|
+
|
|
132
|
+
## Dependency Analysis
|
|
133
|
+
|
|
134
|
+
### Module Dependencies
|
|
135
|
+
|
|
136
|
+
```mermaid
|
|
137
|
+
graph LR
|
|
138
|
+
{{#each modules}}
|
|
139
|
+
{{id}}["{{name}}"]
|
|
140
|
+
{{/each}}
|
|
141
|
+
{{#each module_deps}}
|
|
142
|
+
{{from}} --> {{to}}
|
|
143
|
+
{{/each}}
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
**Diagram Source**
|
|
147
|
+
{{#each dependency_sources}}
|
|
148
|
+
- [{{name}}](file://{{path}}#L{{start}}-L{{end}})
|
|
149
|
+
{{/each}}
|
|
150
|
+
|
|
151
|
+
### Dependency Rules
|
|
152
|
+
|
|
153
|
+
{{#each dependency_rules}}
|
|
154
|
+
- **{{from}}** → **{{to}}**: {{rule}}
|
|
155
|
+
{{/each}}
|
|
156
|
+
|
|
157
|
+
**Section Source**
|
|
158
|
+
{{#each dependency_analysis_sources}}
|
|
159
|
+
- [{{name}}](file://{{path}}#L{{start}}-L{{end}})
|
|
160
|
+
{{/each}}
|
|
161
|
+
|
|
162
|
+
## Performance Considerations
|
|
163
|
+
|
|
164
|
+
### Performance Guidelines
|
|
165
|
+
|
|
166
|
+
{{#each performance_guidelines}}
|
|
167
|
+
#### {{category}}
|
|
168
|
+
|
|
169
|
+
{{description}}
|
|
170
|
+
|
|
171
|
+
**Best Practices:**
|
|
172
|
+
{{#each practices}}
|
|
173
|
+
- {{this}}
|
|
174
|
+
{{/each}}
|
|
175
|
+
|
|
176
|
+
{{/each}}
|
|
177
|
+
|
|
178
|
+
### Caching Strategy
|
|
179
|
+
|
|
180
|
+
{{caching_strategy}}
|
|
181
|
+
|
|
182
|
+
[This section provides general guidance, no specific file reference required]
|
|
183
|
+
|
|
184
|
+
## Troubleshooting Guide
|
|
185
|
+
|
|
186
|
+
{{#each troubleshooting}}
|
|
187
|
+
### {{issue}}
|
|
188
|
+
|
|
189
|
+
**Symptoms:**
|
|
190
|
+
{{#each symptoms}}
|
|
191
|
+
- {{this}}
|
|
192
|
+
{{/each}}
|
|
193
|
+
|
|
194
|
+
**Diagnostic Steps:**
|
|
195
|
+
{{#each steps}}
|
|
196
|
+
{{number}}. {{action}}
|
|
197
|
+
{{/each}}
|
|
198
|
+
|
|
199
|
+
**Solutions:**
|
|
200
|
+
{{#each solutions}}
|
|
201
|
+
- {{this}}
|
|
202
|
+
{{/each}}
|
|
203
|
+
|
|
204
|
+
{{/each}}
|
|
205
|
+
|
|
206
|
+
**Section Source**
|
|
207
|
+
{{#each troubleshooting_sources}}
|
|
208
|
+
- [{{name}}](file://{{path}}#L{{start}}-L{{end}})
|
|
209
|
+
{{/each}}
|
|
210
|
+
|
|
211
|
+
## Conclusion
|
|
212
|
+
|
|
213
|
+
{{conclusion}}
|
|
214
|
+
|
|
215
|
+
[This section is a summary, no specific file reference required]
|
|
216
|
+
|
|
217
|
+
## Appendix
|
|
218
|
+
|
|
219
|
+
### Best Practices
|
|
220
|
+
|
|
221
|
+
{{#each best_practices}}
|
|
222
|
+
- {{this}}
|
|
223
|
+
{{/each}}
|
|
224
|
+
|
|
225
|
+
### Anti-Patterns to Avoid
|
|
226
|
+
|
|
227
|
+
{{#each anti_patterns}}
|
|
228
|
+
- {{this}}
|
|
229
|
+
{{/each}}
|
|
230
|
+
|
|
231
|
+
### Related Documentation
|
|
232
|
+
|
|
233
|
+
{{#each related_docs}}
|
|
234
|
+
- [{{name}}]({{path}})
|
|
235
|
+
{{/each}}
|
|
236
|
+
|
|
237
|
+
**Section Source**
|
|
238
|
+
{{#each appendix_sources}}
|
|
239
|
+
- [{{name}}](file://{{path}}#L{{start}}-L{{end}})
|
|
240
|
+
{{/each}}
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
<!-- AI-TAG: platform_id-ui-colors -->
|
|
2
|
+
# Color System - platform_id
|
|
3
|
+
|
|
4
|
+
<cite>
|
|
5
|
+
**Files Referenced in This Document**
|
|
6
|
+
- [styles_dir](relative_pathstyles_source_path)
|
|
7
|
+
</cite>
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## 1. Color System Overview
|
|
12
|
+
|
|
13
|
+
> platform_id uses color_approach (e.g., CSS Variables / SCSS / Theme Provider).
|
|
14
|
+
|
|
15
|
+
## 2. Theme Colors
|
|
16
|
+
|
|
17
|
+
<!-- AI-TAG: THEME_COLORS -->
|
|
18
|
+
|
|
19
|
+
| Color Name | CSS Variable | Light Mode | Dark Mode | Usage |
|
|
20
|
+
|-----------|-------------|------------|-----------|-------|
|
|
21
|
+
| name | variable | light_value | dark_value | usage |
|
|
22
|
+
|
|
23
|
+
## 3. Functional Colors
|
|
24
|
+
|
|
25
|
+
<!-- AI-TAG: FUNCTIONAL_COLORS -->
|
|
26
|
+
|
|
27
|
+
| Function | Color Name | Value | Usage Scenario |
|
|
28
|
+
|----------|-----------|-------|----------------|
|
|
29
|
+
| Success | name | value | scenario |
|
|
30
|
+
| Warning | name | value | scenario |
|
|
31
|
+
| Error | name | value | scenario |
|
|
32
|
+
| Info | name | value | scenario |
|
|
33
|
+
|
|
34
|
+
## 4. Semantic Color Tokens
|
|
35
|
+
|
|
36
|
+
<!-- AI-TAG: SEMANTIC_TOKENS -->
|
|
37
|
+
|
|
38
|
+
| Token | Resolves To | Description |
|
|
39
|
+
|-------|------------|-------------|
|
|
40
|
+
| token | resolved_color | description |
|
|
41
|
+
|
|
42
|
+
## 5. Typography Scale
|
|
43
|
+
|
|
44
|
+
<!-- AI-TAG: TYPOGRAPHY -->
|
|
45
|
+
|
|
46
|
+
| Level | Font Size | Line Height | Font Weight | Usage |
|
|
47
|
+
|-------|----------|-------------|-------------|-------|
|
|
48
|
+
| level | size | line_height | weight | usage |
|
|
49
|
+
|
|
50
|
+
## 6. Spacing System
|
|
51
|
+
|
|
52
|
+
<!-- AI-TAG: SPACING -->
|
|
53
|
+
|
|
54
|
+
| Token | Value | Usage |
|
|
55
|
+
|-------|-------|-------|
|
|
56
|
+
| token | value | usage |
|
|
57
|
+
|
|
58
|
+
## 7. Agent Usage Guide
|
|
59
|
+
|
|
60
|
+
| Agent Role | How to Use This Document |
|
|
61
|
+
|-----------|------------------------|
|
|
62
|
+
| Design Agent | 参考色彩和排版规范保持视觉一致性 |
|
|
63
|
+
| Dev Agent | 使用 CSS 变量/Token 而非硬编码颜色值 |
|
|
64
|
+
|
|
65
|
+
---
|
|
66
|
+
|
|
67
|
+
**Section Source**
|
|
68
|
+
- [styles_dir](relative_pathstyles_source_path)
|
package/.speccrew/skills/speccrew-knowledge-techs-generate/templates/COMPONENT-LIBRARY-TEMPLATE.md
ADDED
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
<!-- AI-TAG: platform_id-ui-components -->
|
|
2
|
+
# Component Library - platform_id
|
|
3
|
+
|
|
4
|
+
<cite>
|
|
5
|
+
**Files Referenced in This Document**
|
|
6
|
+
- [components_dir](relative_pathcomponents_source_path)
|
|
7
|
+
</cite>
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## 1. Component Overview
|
|
12
|
+
|
|
13
|
+
> Total: total_count components across category_count categories
|
|
14
|
+
|
|
15
|
+
## 2. Component Categories
|
|
16
|
+
|
|
17
|
+
<!-- AI-TAG: COMPONENT_CATEGORIES -->
|
|
18
|
+
<!-- Fill a subsection for each component category discovered in the source code -->
|
|
19
|
+
|
|
20
|
+
### 2.1 CategoryName Components
|
|
21
|
+
|
|
22
|
+
| Component | Props | Events | Slots | Description | Source |
|
|
23
|
+
|-----------|-------|--------|-------|-------------|--------|
|
|
24
|
+
| ComponentName | key_props | key_events | key_slots | description | [Source](relative_pathsource_file) |
|
|
25
|
+
|
|
26
|
+
## 3. Core Component API Reference
|
|
27
|
+
|
|
28
|
+
<!-- AI-TAG: API_REFERENCE -->
|
|
29
|
+
<!-- For each of the top 5-8 most commonly used components, provide detailed API -->
|
|
30
|
+
|
|
31
|
+
### 3.1 ComponentName
|
|
32
|
+
|
|
33
|
+
**Description:** description
|
|
34
|
+
|
|
35
|
+
**Props:**
|
|
36
|
+
|
|
37
|
+
| Prop | Type | Required | Default | Description |
|
|
38
|
+
|------|------|----------|---------|-------------|
|
|
39
|
+
| prop | type | required | default | description |
|
|
40
|
+
|
|
41
|
+
**Events:**
|
|
42
|
+
|
|
43
|
+
| Event | Payload | Description |
|
|
44
|
+
|-------|---------|-------------|
|
|
45
|
+
| event | payload_type | description |
|
|
46
|
+
|
|
47
|
+
**Slots:**
|
|
48
|
+
|
|
49
|
+
| Slot | Description |
|
|
50
|
+
|------|-------------|
|
|
51
|
+
| slot_name | description |
|
|
52
|
+
|
|
53
|
+
**Usage Example:**
|
|
54
|
+
|
|
55
|
+
```vue
|
|
56
|
+
<!-- Provide a realistic usage example from actual project code -->
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
**Best Practices:**
|
|
60
|
+
- practice_1
|
|
61
|
+
- practice_2
|
|
62
|
+
|
|
63
|
+
## 4. Component Composition Patterns
|
|
64
|
+
|
|
65
|
+
<!-- AI-TAG: COMPOSITION_PATTERNS -->
|
|
66
|
+
<!-- Document common patterns of combining components -->
|
|
67
|
+
|
|
68
|
+
| Pattern Name | Components Used | Scenario | Example |
|
|
69
|
+
|-------------|----------------|----------|---------|
|
|
70
|
+
| pattern | components | scenario | brief_example |
|
|
71
|
+
|
|
72
|
+
## 5. Agent Usage Guide
|
|
73
|
+
|
|
74
|
+
<!-- AI-TAG: AGENT_GUIDE -->
|
|
75
|
+
|
|
76
|
+
| Agent Role | How to Use This Document |
|
|
77
|
+
|-----------|------------------------|
|
|
78
|
+
| Solution Agent | 查阅组件能力边界,评估方案可行性 |
|
|
79
|
+
| Design Agent | 参考组件 API 约束设计交互方案 |
|
|
80
|
+
| Dev Agent | 查阅 Props/Events/Slots 实现功能 |
|
|
81
|
+
| Test Agent | 根据 Props 边界和 Events 设计测试用例 |
|
|
82
|
+
|
|
83
|
+
---
|
|
84
|
+
|
|
85
|
+
**Section Source**
|
|
86
|
+
- [components_dir](relative_pathcomponents_source_path)
|