@xenonbyte/da-vinci-workflow 0.1.8 → 0.1.10

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 (31) hide show
  1. package/CHANGELOG.md +18 -0
  2. package/README.md +97 -1
  3. package/README.zh-CN.md +97 -1
  4. package/SKILL.md +57 -0
  5. package/docs/mode-use-cases.md +29 -7
  6. package/docs/visual-adapters.md +255 -0
  7. package/docs/visual-assist-presets/README.md +31 -0
  8. package/docs/visual-assist-presets/desktop-app.md +36 -0
  9. package/docs/visual-assist-presets/mobile-app.md +36 -0
  10. package/docs/visual-assist-presets/tablet-app.md +36 -0
  11. package/docs/visual-assist-presets/web-app.md +36 -0
  12. package/docs/workflow-examples.md +48 -18
  13. package/docs/zh-CN/mode-use-cases.md +16 -0
  14. package/docs/zh-CN/visual-adapters.md +257 -0
  15. package/docs/zh-CN/visual-assist-presets/README.md +31 -0
  16. package/docs/zh-CN/visual-assist-presets/desktop-app.md +32 -0
  17. package/docs/zh-CN/visual-assist-presets/mobile-app.md +31 -0
  18. package/docs/zh-CN/visual-assist-presets/tablet-app.md +31 -0
  19. package/docs/zh-CN/visual-assist-presets/web-app.md +32 -0
  20. package/docs/zh-CN/workflow-examples.md +48 -18
  21. package/examples/greenfield-spec-markupflow/DA-VINCI.md +14 -0
  22. package/examples/greenfield-spec-markupflow/README.md +9 -2
  23. package/examples/greenfield-spec-markupflow/design-registry.md +13 -4
  24. package/examples/greenfield-spec-markupflow/pencil-bindings.md +4 -4
  25. package/examples/greenfield-spec-markupflow/pencil-design.md +15 -2
  26. package/package.json +1 -1
  27. package/references/artifact-templates.md +38 -0
  28. package/references/checkpoints.md +9 -2
  29. package/references/design-inputs.md +13 -0
  30. package/references/page-mapping.md +12 -0
  31. package/references/pencil-design-to-code.md +8 -0
@@ -149,6 +149,12 @@ Use this structure:
149
149
  - CTA tone
150
150
  - navigation tone
151
151
 
152
+ ## Visual Assist
153
+ - Preferred adapters
154
+ - Scope
155
+ - Fallback
156
+ - Require Adapter
157
+
152
158
  ## Do
153
159
  - approved stylistic moves
154
160
 
@@ -162,6 +168,13 @@ Use this structure:
162
168
  - inferred baseline
163
169
  ```
164
170
 
171
+ Field meaning:
172
+
173
+ - `Preferred adapters`: desired local-skill priority order
174
+ - `Scope`: allowed presentation-quality influence areas only
175
+ - `Fallback`: what to do when preferred adapters are unavailable
176
+ - `Require Adapter`: whether missing adapters should block the workflow
177
+
165
178
  Use this artifact as a project-level visual contract. Generate it when the project does not already have one.
166
179
 
167
180
  Recommended path:
@@ -224,6 +237,14 @@ Use this structure:
224
237
  - Which `.pen` file is authoritative
225
238
  - Why that file should be preferred over live-only or external sources
226
239
 
240
+ ## Visual Adapter Resolution
241
+ - Requested adapters
242
+ - Resolved primary adapter
243
+ - Secondary helpers
244
+ - Status: active / fallback / unavailable
245
+ - Scope
246
+ - Fallback reason if native Da Vinci rules were used
247
+
227
248
  ## Historical Or Secondary Sources
228
249
  - Legacy files
229
250
  - Alternate explorations
@@ -252,6 +273,15 @@ Use this structure:
252
273
  - Route or identifier
253
274
  - Purpose
254
275
 
276
+ ## Implementation Surfaces
277
+ - Activity / fragment / tab / dialog / sheet / overlay
278
+ - Which canonical page each surface belongs to
279
+
280
+ ## Subpages And Overlays
281
+ - Subpage name
282
+ - Overlay name
283
+ - When each one appears
284
+
255
285
  ## States Per Page
256
286
  - Empty
257
287
  - Loading
@@ -272,6 +302,8 @@ Use this structure:
272
302
 
273
303
  Use this artifact for every mode. It is the canonical page list.
274
304
 
305
+ For complex products, do not stop at route names. Record implementation surfaces, subpages, and overlays when they materially affect design work.
306
+
275
307
  Recommended path:
276
308
 
277
309
  - `.da-vinci/page-map.md`
@@ -404,6 +436,12 @@ Use this structure:
404
436
  - project-local persisted path under `.da-vinci/designs/` when available
405
437
  - Active pages
406
438
 
439
+ ## Visual Adapter Use
440
+ - Resolved primary adapter
441
+ - Secondary helpers
442
+ - How it affected composition, hierarchy, or motion guidance
443
+ - Whether native Da Vinci fallback was used
444
+
407
445
  ## Page Mapping
408
446
  - Requirement -> Pencil page
409
447
 
@@ -36,6 +36,7 @@ Use the design checkpoint to confirm:
36
36
  - `DA-VINCI.md` exists or has been intentionally generated for the current project
37
37
  - the current Pencil pages follow the same visual baseline
38
38
  - later pages are not re-inventing the product style from scratch
39
+ - `redesign-from-code` is not treating the old UI layout as the new design baseline
39
40
 
40
41
  ## `discovery checkpoint`
41
42
 
@@ -93,12 +94,18 @@ Check:
93
94
  - major layout strategy matches the design artifact
94
95
  - Pencil names and artifact names are aligned enough to implement from
95
96
  - Pencil pages follow the current `DA-VINCI.md` visual contract
97
+ - each page has a clear visual anchor or primary working surface
98
+ - section hierarchy is readable without relying on decorative chrome
99
+ - the design does not collapse into generic card-grid or border-heavy filler UI
100
+ - motion ideas, if present, improve hierarchy or affordance instead of adding noise
101
+ - complex pages with multiple fragments, subpages, overlays, or materially different states are decomposed clearly enough to design and implement from
102
+ - `redesign-from-code` output is a fresh composition driven by page responsibility and state, not a skin-swap of the old UI
96
103
 
97
104
  Result meanings:
98
105
 
99
106
  - `PASS`: safe to generate implementation tasks
100
- - `WARN`: minor design gaps exist
101
- - `BLOCK`: design is not ready to drive implementation
107
+ - `WARN`: minor design gaps exist, but the visual direction is still coherent
108
+ - `BLOCK`: design is not ready to drive implementation, or the result is generic, cluttered, or materially below the intended visual bar
102
109
 
103
110
  ## `mapping checkpoint`
104
111
 
@@ -7,6 +7,7 @@ Use this reference when collecting product form factor, UI direction, and design
7
7
  Check for `DA-VINCI.md` first, then check whether the project already has persisted Pencil files under `.da-vinci/designs/`.
8
8
 
9
9
  - if it exists, treat it as the project visual contract
10
+ - if `DA-VINCI.md` declares preferred visual adapters, treat them as optional design-assist preferences
10
11
  - if `.da-vinci/designs/*.pen` exists, treat those files as project-local design inputs and record the exact preferred path in `design-registry.md`
11
12
  - if it does not exist, generate it from the best stable inputs before broad Pencil page generation
12
13
  - avoid re-deriving the visual language page by page
@@ -40,6 +41,11 @@ Collect or infer:
40
41
  - existing layout shell
41
42
  - responsive priority
42
43
 
44
+ 5. visual assist preferences
45
+ - preferred visual adapter names
46
+ - whether adapter use is required or optional
47
+ - fallback expectation when adapters are unavailable
48
+
43
49
  ## Inference Order
44
50
 
45
51
  Infer in this order:
@@ -68,3 +74,10 @@ Write stable answers into `design-brief.md`.
68
74
  If `DA-VINCI.md` did not already exist, generate it from those stable answers and save it as the project visual baseline.
69
75
 
70
76
  If Pencil creates or updates a baseline during the workflow, save or export the `.pen` file into `.da-vinci/designs/` when possible and register that exact path in `design-registry.md`.
77
+
78
+ If the project requests a visual adapter:
79
+
80
+ - try to resolve it from locally available skills
81
+ - choose one primary adapter when multiple helpers are available
82
+ - record the requested adapters, resolved primary adapter, any secondary helpers, and fallback result in `design-registry.md`
83
+ - if no adapter is available, continue with native Da Vinci design rules unless the user explicitly required a specific adapter
@@ -14,14 +14,17 @@ Treat `pencil-bindings.md` as the source of truth for:
14
14
 
15
15
  - implementation page -> Pencil page
16
16
  - route -> Pencil screen
17
+ - implementation surface -> Pencil surface
17
18
  - shared region -> Pencil region
18
19
 
19
20
  ## Mapping Rules
20
21
 
21
22
  - define one canonical implementation page name per page
23
+ - decompose complex pages into subpages, states, overlays, and implementation surfaces when layout changes materially
22
24
  - define one canonical Pencil page or screen per implementation page when possible
23
25
  - if multiple implementation pages share one Pencil page, record the reason
24
26
  - if one implementation page needs multiple Pencil screens, record the sub-page or state split
27
+ - if one Android page hosts multiple fragments or tabs, map each meaningful surface separately instead of treating the container as one redesign target
25
28
 
26
29
  ## Minimum Binding Shape
27
30
 
@@ -43,6 +46,14 @@ For shared regions:
43
46
  - `App sidebar` -> `Navigation Shell`
44
47
  ```
45
48
 
49
+ For complex surface decomposition:
50
+
51
+ ```md
52
+ - `HomeActivity/HomeFragment[loaded]` -> `Home Loaded`
53
+ - `HomeActivity/HomeFragment[empty]` -> `Home Empty`
54
+ - `HomeActivity/FilterBottomSheet` -> `Home Filters Sheet`
55
+ ```
56
+
46
57
  ## When To Block
47
58
 
48
59
  Treat bindings as insufficient when:
@@ -50,6 +61,7 @@ Treat bindings as insufficient when:
50
61
  - no active `.pen` source is registered
51
62
  - the only known Pencil source is a live or external session and no project-local persistence path is recorded
52
63
  - the implementation page has no Pencil source
64
+ - a complex page with multiple fragments, tabs, overlays, or materially different states has been flattened into one ambiguous design target
53
65
  - the Pencil page exists but cannot be traced to a route or page responsibility
54
66
  - shared layout regions are undefined and implementation would guess too much
55
67
 
@@ -28,6 +28,14 @@ When MCP is available, read:
28
28
 
29
29
  Prefer structural reads over screenshots.
30
30
 
31
+ ## Visual Adapter Use
32
+
33
+ If the project resolved a visual adapter:
34
+
35
+ - use it to refine composition, hierarchy, spacing discipline, and motion suggestions before or during Pencil design work
36
+ - do not let it override behavior, route truth, or page-state truth
37
+ - treat it as a presentation-quality assistant, not as a replacement for Pencil or requirements
38
+
31
39
  ## Map Pencil To Frontend
32
40
 
33
41
  Use these default mappings: