sdtk-kit 0.3.5 → 0.3.6
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/assets/manifest/toolkit-bundle.manifest.json +15 -15
- package/assets/manifest/toolkit-bundle.sha256.txt +6 -6
- package/assets/toolkit/toolkit/skills/sdtk-arch/SKILL.md +16 -11
- package/assets/toolkit/toolkit/skills/sdtk-arch/references/FLOW_ACTION_SPEC_CREATION_RULES.md +22 -5
- package/assets/toolkit/toolkit/skills/sdtk-screen-design-spec/SKILL.md +17 -10
- package/assets/toolkit/toolkit/skills/sdtk-screen-design-spec/references/FLOW_ACTION_SPEC_CREATION_RULES.md +22 -5
- package/assets/toolkit/toolkit/templates/docs/specs/FLOW_ACTION_SPEC_CREATION_RULES.md +22 -5
- package/assets/toolkit/toolkit/templates/docs/specs/FLOW_ACTION_SPEC_TEMPLATE.md +14 -14
- package/package.json +1 -1
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
|
-
"version": "0.3.
|
|
3
|
-
"sourceCommit": "
|
|
4
|
-
"buildTimestamp": "2026-03-
|
|
2
|
+
"version": "0.3.6",
|
|
3
|
+
"sourceCommit": "f15ad683ea08ad6974f2f6c6572a95411be3eac0",
|
|
4
|
+
"buildTimestamp": "2026-03-12T06:10:16Z",
|
|
5
5
|
"fileCount": 81,
|
|
6
6
|
"files": [
|
|
7
7
|
{
|
|
@@ -116,8 +116,8 @@
|
|
|
116
116
|
},
|
|
117
117
|
{
|
|
118
118
|
"path": "toolkit/skills/sdtk-arch/references/FLOW_ACTION_SPEC_CREATION_RULES.md",
|
|
119
|
-
"sha256": "
|
|
120
|
-
"size":
|
|
119
|
+
"sha256": "096c720bfb51cd44d2cf4241313f25874f9b6a1baa6874523a6ea8dcdb7a21b8",
|
|
120
|
+
"size": 6736
|
|
121
121
|
},
|
|
122
122
|
{
|
|
123
123
|
"path": "toolkit/skills/sdtk-arch/references/FLOWCHART_CREATION_RULES.md",
|
|
@@ -131,8 +131,8 @@
|
|
|
131
131
|
},
|
|
132
132
|
{
|
|
133
133
|
"path": "toolkit/skills/sdtk-arch/SKILL.md",
|
|
134
|
-
"sha256": "
|
|
135
|
-
"size":
|
|
134
|
+
"sha256": "87ac00226478a8198ea9f218e221de8f49f34ccdae3fde2f26a5a1b6b7216feb",
|
|
135
|
+
"size": 3156
|
|
136
136
|
},
|
|
137
137
|
{
|
|
138
138
|
"path": "toolkit/skills/sdtk-ba/SKILL.md",
|
|
@@ -186,8 +186,8 @@
|
|
|
186
186
|
},
|
|
187
187
|
{
|
|
188
188
|
"path": "toolkit/skills/sdtk-screen-design-spec/references/FLOW_ACTION_SPEC_CREATION_RULES.md",
|
|
189
|
-
"sha256": "
|
|
190
|
-
"size":
|
|
189
|
+
"sha256": "096c720bfb51cd44d2cf4241313f25874f9b6a1baa6874523a6ea8dcdb7a21b8",
|
|
190
|
+
"size": 6736
|
|
191
191
|
},
|
|
192
192
|
{
|
|
193
193
|
"path": "toolkit/skills/sdtk-screen-design-spec/references/numbering-rules.md",
|
|
@@ -206,8 +206,8 @@
|
|
|
206
206
|
},
|
|
207
207
|
{
|
|
208
208
|
"path": "toolkit/skills/sdtk-screen-design-spec/SKILL.md",
|
|
209
|
-
"sha256": "
|
|
210
|
-
"size":
|
|
209
|
+
"sha256": "6e66a8c258a94be377d756cf80835968aa30a66ba200a8ac151558ab5bb675d3",
|
|
210
|
+
"size": 3771
|
|
211
211
|
},
|
|
212
212
|
{
|
|
213
213
|
"path": "toolkit/skills/sdtk-test-case-spec/references/TEST_CASE_CREATION_RULES.md",
|
|
@@ -386,13 +386,13 @@
|
|
|
386
386
|
},
|
|
387
387
|
{
|
|
388
388
|
"path": "toolkit/templates/docs/specs/FLOW_ACTION_SPEC_CREATION_RULES.md",
|
|
389
|
-
"sha256": "
|
|
390
|
-
"size":
|
|
389
|
+
"sha256": "096c720bfb51cd44d2cf4241313f25874f9b6a1baa6874523a6ea8dcdb7a21b8",
|
|
390
|
+
"size": 6736
|
|
391
391
|
},
|
|
392
392
|
{
|
|
393
393
|
"path": "toolkit/templates/docs/specs/FLOW_ACTION_SPEC_TEMPLATE.md",
|
|
394
|
-
"sha256": "
|
|
395
|
-
"size":
|
|
394
|
+
"sha256": "df87638e4e997beeee22f1e6a5cbbab83b6ed5fe2bf0ac5f3b816a1e852bba5d",
|
|
395
|
+
"size": 4386
|
|
396
396
|
},
|
|
397
397
|
{
|
|
398
398
|
"path": "toolkit/templates/QUALITY_CHECKLIST.md",
|
|
@@ -20,10 +20,10 @@ f29c6774019ef0789dfb88678e1ab31d4d8eb7b3ab69b2115368ef5d879e5276 toolkit/skills
|
|
|
20
20
|
2c4bc8edda84f20bf05130fdf19b9abd562dd87b03508301dff9ccd877b52a2f toolkit/skills/sdtk-api-doc/SKILL.md
|
|
21
21
|
9adf1e46833411a861fb7426c37baac69689b9e3120a8ed1e4a3224de44a8dd2 toolkit/skills/sdtk-arch/references/API_DESIGN_CREATION_RULES.md
|
|
22
22
|
13f26a3307894b9bfb570d75f6db4ccb61104064d19661ec2a26a1b9984f4c97 toolkit/skills/sdtk-arch/references/API_DESIGN_FLOWCHART_CREATION_RULES.md
|
|
23
|
-
|
|
23
|
+
096c720bfb51cd44d2cf4241313f25874f9b6a1baa6874523a6ea8dcdb7a21b8 toolkit/skills/sdtk-arch/references/FLOW_ACTION_SPEC_CREATION_RULES.md
|
|
24
24
|
decffe52425e22b3dd82e9c8f3768aefbb209ec58237107d84f583fee876ea8f toolkit/skills/sdtk-arch/references/FLOWCHART_CREATION_RULES.md
|
|
25
25
|
f29c6774019ef0789dfb88678e1ab31d4d8eb7b3ab69b2115368ef5d879e5276 toolkit/skills/sdtk-arch/references/YAML_CREATION_RULES.md
|
|
26
|
-
|
|
26
|
+
87ac00226478a8198ea9f218e221de8f49f34ccdae3fde2f26a5a1b6b7216feb toolkit/skills/sdtk-arch/SKILL.md
|
|
27
27
|
0a7c6aa20be2e29aa2124355264ee45847df76f635437c2d05ddd26f7121f12e toolkit/skills/sdtk-ba/SKILL.md
|
|
28
28
|
8eabb7bdb821a91766ccd5b5fdcc1a4e876b51052cd6c6429b98b4d9946e2b1a toolkit/skills/sdtk-design-layout/SKILL.md
|
|
29
29
|
7a7f5a799247896a8ddebc5cefec25450bf9284d34044b6b69b13e4535c005a1 toolkit/skills/sdtk-dev/SKILL.md
|
|
@@ -34,11 +34,11 @@ e6560b5a0c893d66117eedac3762bb0758553a80bcd1e7c24c84ba91f6ab7f9c toolkit/skills
|
|
|
34
34
|
564c536395227511ac9be215e41a3b5604e2f249da28319417ca75a6bfe8ed3b toolkit/skills/sdtk-qa/SKILL.md
|
|
35
35
|
97f65fd84c80e4836c9bbb82d8b7fc81527336c55dbbd82ea5e69672e21b22e4 toolkit/skills/sdtk-screen-design-spec/references/excel-image-export.md
|
|
36
36
|
a9b414a07d76e63331ffc832dea2381357f9a99e2cd82ea74f713b3a9d7acee7 toolkit/skills/sdtk-screen-design-spec/references/figma-mcp.md
|
|
37
|
-
|
|
37
|
+
096c720bfb51cd44d2cf4241313f25874f9b6a1baa6874523a6ea8dcdb7a21b8 toolkit/skills/sdtk-screen-design-spec/references/FLOW_ACTION_SPEC_CREATION_RULES.md
|
|
38
38
|
4edd3318634fbc142f1ce3161fc3ac93d901a6bb7f0add1d1bed7fc25293c4d9 toolkit/skills/sdtk-screen-design-spec/references/numbering-rules.md
|
|
39
39
|
b54b14cc75c02c3fe9f89547b3f09baf1d7d036ef5f3d9f40487516e22351c45 toolkit/skills/sdtk-screen-design-spec/scripts/renumber_flow_action_spec_global.py
|
|
40
40
|
ae0bc9b120c19a142f10cc79168a8f7d6bf8a37e48341fc16cbc74bbdc2e692c toolkit/skills/sdtk-screen-design-spec/scripts/validate_flow_action_spec_numbering.py
|
|
41
|
-
|
|
41
|
+
6e66a8c258a94be377d756cf80835968aa30a66ba200a8ac151558ab5bb675d3 toolkit/skills/sdtk-screen-design-spec/SKILL.md
|
|
42
42
|
7c21e74f5eee712c6b65665b4f10483ed008113186a92dc0a4673ce1fcd3ef5c toolkit/skills/sdtk-test-case-spec/references/TEST_CASE_CREATION_RULES.md
|
|
43
43
|
4d1e813908114f2be68007fb7373973e2c6e0aebc5a6305b8b19443d5ae477d0 toolkit/skills/sdtk-test-case-spec/scripts/validate_test_case_spec.py
|
|
44
44
|
727a9870a455e9c455b2c405cb52c6b9867f229fa56d8ce9408e66b6f6cae4a5 toolkit/skills/sdtk-test-case-spec/SKILL.md
|
|
@@ -74,8 +74,8 @@ e8d3554fc4893a8a57fbf006e58f37f21347de5f31ce02f0717e97d29b387eea toolkit/templa
|
|
|
74
74
|
7c21e74f5eee712c6b65665b4f10483ed008113186a92dc0a4673ce1fcd3ef5c toolkit/templates/docs/qa/TEST_CASE_CREATION_RULES.md
|
|
75
75
|
4b64a123d6e22edefa17a23a1eff766cf612ec5fa2f78b34bf50eecb39abf06a toolkit/templates/docs/qa/TEST_CASE_TEMPLATE.md
|
|
76
76
|
3b5f911d5e0eb042efc388ef3a441285a57d2dc02ae032d080934495e2d06f4d toolkit/templates/docs/specs/BA_SPEC_TEMPLATE.md
|
|
77
|
-
|
|
78
|
-
|
|
77
|
+
096c720bfb51cd44d2cf4241313f25874f9b6a1baa6874523a6ea8dcdb7a21b8 toolkit/templates/docs/specs/FLOW_ACTION_SPEC_CREATION_RULES.md
|
|
78
|
+
df87638e4e997beeee22f1e6a5cbbab83b6ed5fe2bf0ac5f3b816a1e852bba5d toolkit/templates/docs/specs/FLOW_ACTION_SPEC_TEMPLATE.md
|
|
79
79
|
f9dc0d49ceeeb8814d77670e43f09b5221f46d406fb1e89eb575c1ab39bc022a toolkit/templates/QUALITY_CHECKLIST.md
|
|
80
80
|
0ccb7a0509cf92aa91ebea95996dfffd5b52edd6ab4bbefbb827e4ed495abc31 toolkit/templates/README.md
|
|
81
81
|
2b5d4d10019e3c9b3219d92b8123acc85872d9c76230107206e7a270a5ece5a2 toolkit/templates/SHARED_PLANNING.md
|
|
@@ -25,22 +25,27 @@ description: Solution Architect workflow for SDTK. Use when you need to convert
|
|
|
25
25
|
- `governance/ai/core/SDTK_API_PATH_STYLE_POLICY.md` for canonical resource naming and multi-word path style
|
|
26
26
|
4. If architecture output includes screen flow-action specs, read and apply `./references/FLOW_ACTION_SPEC_CREATION_RULES.md`.
|
|
27
27
|
5. If API detail spec is required, use `sdtk-api-design-spec` to build/update `docs/api/[FEATURE_KEY]_API_DESIGN_DETAIL.md` using YAML + flow list.
|
|
28
|
-
6. For
|
|
29
|
-
|
|
28
|
+
6. For UI-scope features, enforce this generation sequence:
|
|
29
|
+
a. Generate/update `docs/design/DESIGN_LAYOUT_[FEATURE_KEY].md` first (using `sdtk-design-layout`).
|
|
30
|
+
b. Then generate/update `docs/specs/[FEATURE_KEY]_FLOW_ACTION_SPEC.md` (using `sdtk-screen-design-spec`).
|
|
31
|
+
c. The flow-action spec must reference the design-layout doc as its design source when no Figma/screenshot is available (Design Source Type: `generated-draft`).
|
|
32
|
+
7. For complex UI flow-action specs, use `sdtk-screen-design-spec` to build/update `docs/specs/[FEATURE_KEY]_FLOW_ACTION_SPEC.md`.
|
|
33
|
+
8. Define:
|
|
30
34
|
- System components + data model
|
|
31
35
|
- API endpoints and flows
|
|
32
36
|
- Screen layouts
|
|
33
37
|
- Security/authz decisions
|
|
34
|
-
|
|
38
|
+
9. Create/update:
|
|
35
39
|
- OpenAPI YAML + API endpoint markdown
|
|
36
40
|
- API flow list
|
|
37
41
|
- API design detail spec (when `orchestration.apiDesignDetailMode` is `auto/on`)
|
|
38
42
|
- Database spec (if DB impact exists)
|
|
39
|
-
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
11.
|
|
45
|
-
12.
|
|
46
|
-
13.
|
|
43
|
+
- Design layout (if UI impact exists) - must be created before flow-action spec
|
|
44
|
+
- Flow-action spec (if UI impact exists) - must reference design layout as fallback source
|
|
45
|
+
10. Ensure mapping UC/BR -> DB/API/screens and run output hygiene checks:
|
|
46
|
+
- EN artifacts use English narrative text (except clearly marked original-language appendix blocks)
|
|
47
|
+
- No mojibake/encoding corruption in markdown/yaml/txt outputs
|
|
48
|
+
11. For benchmark runs, apply `governance/ai/core/SDTK_BENCHMARK_OQ_POLICY.md`: keep benchmark-expected open questions explicitly OPEN unless the requirement source resolves them.
|
|
49
|
+
12. If anything is unclear, record OQ-xx in ARCH_DESIGN "Open Questions" and escalate to `@pm` for a decision.
|
|
50
|
+
13. Update shared state + Phase 3 checklist.
|
|
51
|
+
14. Handoff: `@dev please implement ...`.
|
package/assets/toolkit/toolkit/skills/sdtk-arch/references/FLOW_ACTION_SPEC_CREATION_RULES.md
CHANGED
|
@@ -32,9 +32,9 @@ If a section is not in scope, keep the section and mark explicitly as `N/A` with
|
|
|
32
32
|
|
|
33
33
|
- Every table must include a `No` column (sequential numbering).
|
|
34
34
|
- Use stable headers for action tables:
|
|
35
|
-
- `No |
|
|
35
|
+
- `No | Item Name | Item Type | Attribute | DB Column | Size | Default Value | Action | Description | Note`
|
|
36
36
|
- Use stable headers for API mapping tables:
|
|
37
|
-
- `No | Trigger/When | UI item (No /
|
|
37
|
+
- `No | Trigger/When | UI item (No / Item Name) | API to call | Data usage / Notes`
|
|
38
38
|
- Use stable headers for screen mapping:
|
|
39
39
|
- `No | Screen (section) | Screen ID | Read/Search APIs | Write APIs | Notes / Q&A refs`
|
|
40
40
|
- Table rows must keep column count consistent with the header (no broken or merged rows).
|
|
@@ -43,7 +43,7 @@ If a section is not in scope, keep the section and mark explicitly as `N/A` with
|
|
|
43
43
|
### 3.1 Language and Encoding Standards (EN Artifacts)
|
|
44
44
|
|
|
45
45
|
- For EN artifacts (`docs/en/**` or explicitly requested EN version), narrative text must be English.
|
|
46
|
-
- JP labels
|
|
46
|
+
- JP labels, if provided by the input, should be kept in a clearly marked appendix or note column, not in the default item table columns.
|
|
47
47
|
- Do not leave mixed-language fragments in one sentence/cell (for example VI+EN mixed text).
|
|
48
48
|
- If original VI/JP text is required for traceability, keep it in a clearly marked appendix block (`Original Text`), then provide EN translation.
|
|
49
49
|
- Save files as UTF-8 and avoid mojibake/broken glyphs (`�`, `ↁE`, garbled sequences).
|
|
@@ -69,12 +69,29 @@ For each screen section:
|
|
|
69
69
|
- Provide metadata:
|
|
70
70
|
- official screen name
|
|
71
71
|
- Screen ID
|
|
72
|
-
-
|
|
73
|
-
-
|
|
72
|
+
- Design Source Type
|
|
73
|
+
- Design Source Reference
|
|
74
|
+
- Embed one representative image per screen (from Figma, screenshot, or generated layout).
|
|
74
75
|
- Provide one action table.
|
|
75
76
|
- Provide one API mapping table.
|
|
76
77
|
- If a screen has dialogs, create explicit dialog sub-sections with their own tables and API mapping.
|
|
77
78
|
|
|
79
|
+
## 5.1 Design Source Modes
|
|
80
|
+
|
|
81
|
+
Each screen section must declare a design source using one of these modes:
|
|
82
|
+
|
|
83
|
+
| Mode | When | Design Source Reference |
|
|
84
|
+
|------|------|----------------------|
|
|
85
|
+
| `source-backed` | Figma URL or screenshot is available | Figma URL or screenshot path |
|
|
86
|
+
| `generated-draft` | No Figma/screenshot, but feature has UI scope | Section reference in `docs/design/DESIGN_LAYOUT_[FEATURE_KEY].md` |
|
|
87
|
+
| `none` | Feature has no UI scope for this screen | State `N/A - no UI scope` |
|
|
88
|
+
|
|
89
|
+
Rules:
|
|
90
|
+
- For UI-scope features, `none` is only valid when the specific screen truly has no visual layout.
|
|
91
|
+
- When using `generated-draft`, the `DESIGN_LAYOUT_[FEATURE_KEY].md` must exist before the flow-action spec is finalized.
|
|
92
|
+
- The flow-action spec and the design-layout doc must remain separate documents.
|
|
93
|
+
- When Figma becomes available later, update the source mode from `generated-draft` to `source-backed`.
|
|
94
|
+
|
|
78
95
|
## 6. API Traceability Rules
|
|
79
96
|
|
|
80
97
|
- Every actionable UI event that changes state must map to a write API.
|
|
@@ -15,29 +15,36 @@ description: Create/update screen flow-action specifications from requirement so
|
|
|
15
15
|
## Required Inputs
|
|
16
16
|
- Feature key/name
|
|
17
17
|
- Primary requirement sources (BA spec, architecture, customer design docs)
|
|
18
|
-
- Screen source references
|
|
18
|
+
- Screen source references, using one of these design source modes:
|
|
19
|
+
- `source-backed`: Figma URLs and/or requirement screenshots
|
|
20
|
+
- `generated-draft`: generated layout from `docs/design/DESIGN_LAYOUT_[FEATURE_KEY].md` (used when no Figma/screenshot is available for a UI-scope feature)
|
|
19
21
|
- API endpoint source (`docs/api/[FEATURE_KEY]_ENDPOINTS.md`) when available
|
|
20
22
|
|
|
21
23
|
## Process
|
|
22
24
|
1. Read requirement sources and identify in-scope screens, dialogs, and transitions.
|
|
23
25
|
2. Read and apply rules from `./references/FLOW_ACTION_SPEC_CREATION_RULES.md`.
|
|
24
|
-
3.
|
|
25
|
-
|
|
26
|
-
-
|
|
27
|
-
-
|
|
26
|
+
3. Determine design source mode per screen:
|
|
27
|
+
- If Figma URL or screenshot exists: use `source-backed`.
|
|
28
|
+
- If no Figma/screenshot but feature has UI scope: use `generated-draft` and reference the corresponding section in `docs/design/DESIGN_LAYOUT_[FEATURE_KEY].md`. That file must exist before finalizing the flow-action spec.
|
|
29
|
+
- If screen has no UI scope: use `none`.
|
|
30
|
+
4. Build/update section `Feature overview` and `Screen flow action` (PlantUML).
|
|
31
|
+
5. For each screen/dialog:
|
|
32
|
+
- Add metadata (screen ID, Design Source Type, Design Source Reference)
|
|
33
|
+
- Add screen image reference (from Figma, screenshot, or generated layout)
|
|
28
34
|
- Add UI item/action table with `No` column
|
|
29
35
|
- Add API mapping table (trigger -> API -> data usage)
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
36
|
+
6. Build/update `System processing flow` from use-case and process sources.
|
|
37
|
+
7. Build/update `Open questions` for unresolved behavior/API/data points.
|
|
38
|
+
8. Build/update `Screen - API Mapping` summary section.
|
|
39
|
+
9. Validate:
|
|
34
40
|
- global numbering consistency (no screen-level reset)
|
|
35
41
|
- no broken image paths
|
|
36
42
|
- PlantUML renderability
|
|
37
43
|
- consistency with API endpoints spec
|
|
38
44
|
- EN artifact hygiene (no VI leftovers, no mojibake, no merged heading lines)
|
|
39
45
|
- for legacy specs with per-screen reset numbering: run renumber migration first
|
|
40
|
-
|
|
46
|
+
- every UI-scope screen declares a Design Source Type (`source-backed` or `generated-draft`)
|
|
47
|
+
10. Update document history and handoff to ARCH/DEV.
|
|
41
48
|
|
|
42
49
|
## Rule References
|
|
43
50
|
- Core rules: `./references/FLOW_ACTION_SPEC_CREATION_RULES.md`
|
|
@@ -32,9 +32,9 @@ If a section is not in scope, keep the section and mark explicitly as `N/A` with
|
|
|
32
32
|
|
|
33
33
|
- Every table must include a `No` column (sequential numbering).
|
|
34
34
|
- Use stable headers for action tables:
|
|
35
|
-
- `No |
|
|
35
|
+
- `No | Item Name | Item Type | Attribute | DB Column | Size | Default Value | Action | Description | Note`
|
|
36
36
|
- Use stable headers for API mapping tables:
|
|
37
|
-
- `No | Trigger/When | UI item (No /
|
|
37
|
+
- `No | Trigger/When | UI item (No / Item Name) | API to call | Data usage / Notes`
|
|
38
38
|
- Use stable headers for screen mapping:
|
|
39
39
|
- `No | Screen (section) | Screen ID | Read/Search APIs | Write APIs | Notes / Q&A refs`
|
|
40
40
|
- Table rows must keep column count consistent with the header (no broken or merged rows).
|
|
@@ -43,7 +43,7 @@ If a section is not in scope, keep the section and mark explicitly as `N/A` with
|
|
|
43
43
|
### 3.1 Language and Encoding Standards (EN Artifacts)
|
|
44
44
|
|
|
45
45
|
- For EN artifacts (`docs/en/**` or explicitly requested EN version), narrative text must be English.
|
|
46
|
-
- JP labels
|
|
46
|
+
- JP labels, if provided by the input, should be kept in a clearly marked appendix or note column, not in the default item table columns.
|
|
47
47
|
- Do not leave mixed-language fragments in one sentence/cell (for example VI+EN mixed text).
|
|
48
48
|
- If original VI/JP text is required for traceability, keep it in a clearly marked appendix block (`Original Text`), then provide EN translation.
|
|
49
49
|
- Save files as UTF-8 and avoid mojibake/broken glyphs (`�`, `ↁE`, garbled sequences).
|
|
@@ -69,12 +69,29 @@ For each screen section:
|
|
|
69
69
|
- Provide metadata:
|
|
70
70
|
- official screen name
|
|
71
71
|
- Screen ID
|
|
72
|
-
-
|
|
73
|
-
-
|
|
72
|
+
- Design Source Type
|
|
73
|
+
- Design Source Reference
|
|
74
|
+
- Embed one representative image per screen (from Figma, screenshot, or generated layout).
|
|
74
75
|
- Provide one action table.
|
|
75
76
|
- Provide one API mapping table.
|
|
76
77
|
- If a screen has dialogs, create explicit dialog sub-sections with their own tables and API mapping.
|
|
77
78
|
|
|
79
|
+
## 5.1 Design Source Modes
|
|
80
|
+
|
|
81
|
+
Each screen section must declare a design source using one of these modes:
|
|
82
|
+
|
|
83
|
+
| Mode | When | Design Source Reference |
|
|
84
|
+
|------|------|----------------------|
|
|
85
|
+
| `source-backed` | Figma URL or screenshot is available | Figma URL or screenshot path |
|
|
86
|
+
| `generated-draft` | No Figma/screenshot, but feature has UI scope | Section reference in `docs/design/DESIGN_LAYOUT_[FEATURE_KEY].md` |
|
|
87
|
+
| `none` | Feature has no UI scope for this screen | State `N/A - no UI scope` |
|
|
88
|
+
|
|
89
|
+
Rules:
|
|
90
|
+
- For UI-scope features, `none` is only valid when the specific screen truly has no visual layout.
|
|
91
|
+
- When using `generated-draft`, the `DESIGN_LAYOUT_[FEATURE_KEY].md` must exist before the flow-action spec is finalized.
|
|
92
|
+
- The flow-action spec and the design-layout doc must remain separate documents.
|
|
93
|
+
- When Figma becomes available later, update the source mode from `generated-draft` to `source-backed`.
|
|
94
|
+
|
|
78
95
|
## 6. API Traceability Rules
|
|
79
96
|
|
|
80
97
|
- Every actionable UI event that changes state must map to a write API.
|
|
@@ -32,9 +32,9 @@ If a section is not in scope, keep the section and mark explicitly as `N/A` with
|
|
|
32
32
|
|
|
33
33
|
- Every table must include a `No` column (sequential numbering).
|
|
34
34
|
- Use stable headers for action tables:
|
|
35
|
-
- `No |
|
|
35
|
+
- `No | Item Name | Item Type | Attribute | DB Column | Size | Default Value | Action | Description | Note`
|
|
36
36
|
- Use stable headers for API mapping tables:
|
|
37
|
-
- `No | Trigger/When | UI item (No /
|
|
37
|
+
- `No | Trigger/When | UI item (No / Item Name) | API to call | Data usage / Notes`
|
|
38
38
|
- Use stable headers for screen mapping:
|
|
39
39
|
- `No | Screen (section) | Screen ID | Read/Search APIs | Write APIs | Notes / Q&A refs`
|
|
40
40
|
- Table rows must keep column count consistent with the header (no broken or merged rows).
|
|
@@ -43,7 +43,7 @@ If a section is not in scope, keep the section and mark explicitly as `N/A` with
|
|
|
43
43
|
### 3.1 Language and Encoding Standards (EN Artifacts)
|
|
44
44
|
|
|
45
45
|
- For EN artifacts (`docs/en/**` or explicitly requested EN version), narrative text must be English.
|
|
46
|
-
- JP labels
|
|
46
|
+
- JP labels, if provided by the input, should be kept in a clearly marked appendix or note column, not in the default item table columns.
|
|
47
47
|
- Do not leave mixed-language fragments in one sentence/cell (for example VI+EN mixed text).
|
|
48
48
|
- If original VI/JP text is required for traceability, keep it in a clearly marked appendix block (`Original Text`), then provide EN translation.
|
|
49
49
|
- Save files as UTF-8 and avoid mojibake/broken glyphs (`�`, `ↁE`, garbled sequences).
|
|
@@ -69,12 +69,29 @@ For each screen section:
|
|
|
69
69
|
- Provide metadata:
|
|
70
70
|
- official screen name
|
|
71
71
|
- Screen ID
|
|
72
|
-
-
|
|
73
|
-
-
|
|
72
|
+
- Design Source Type
|
|
73
|
+
- Design Source Reference
|
|
74
|
+
- Embed one representative image per screen (from Figma, screenshot, or generated layout).
|
|
74
75
|
- Provide one action table.
|
|
75
76
|
- Provide one API mapping table.
|
|
76
77
|
- If a screen has dialogs, create explicit dialog sub-sections with their own tables and API mapping.
|
|
77
78
|
|
|
79
|
+
## 5.1 Design Source Modes
|
|
80
|
+
|
|
81
|
+
Each screen section must declare a design source using one of these modes:
|
|
82
|
+
|
|
83
|
+
| Mode | When | Design Source Reference |
|
|
84
|
+
|------|------|----------------------|
|
|
85
|
+
| `source-backed` | Figma URL or screenshot is available | Figma URL or screenshot path |
|
|
86
|
+
| `generated-draft` | No Figma/screenshot, but feature has UI scope | Section reference in `docs/design/DESIGN_LAYOUT_[FEATURE_KEY].md` |
|
|
87
|
+
| `none` | Feature has no UI scope for this screen | State `N/A - no UI scope` |
|
|
88
|
+
|
|
89
|
+
Rules:
|
|
90
|
+
- For UI-scope features, `none` is only valid when the specific screen truly has no visual layout.
|
|
91
|
+
- When using `generated-draft`, the `DESIGN_LAYOUT_[FEATURE_KEY].md` must exist before the flow-action spec is finalized.
|
|
92
|
+
- The flow-action spec and the design-layout doc must remain separate documents.
|
|
93
|
+
- When Figma becomes available later, update the source mode from `generated-draft` to `source-backed`.
|
|
94
|
+
|
|
78
95
|
## 6. API Traceability Rules
|
|
79
96
|
|
|
80
97
|
- Every actionable UI event that changes state must map to a write API.
|
|
@@ -66,26 +66,26 @@ B --> C : open dialog
|
|
|
66
66
|
## 3) Screen layout spec by flow action
|
|
67
67
|
|
|
68
68
|
> Standard item table format:
|
|
69
|
-
> `No |
|
|
69
|
+
> `No | Item Name | Item Type | Attribute | DB Column | Size | Default Value | Action | Description | Note`
|
|
70
70
|
|
|
71
71
|
### 3.1 Screen A
|
|
72
72
|
|
|
73
73
|
Information:
|
|
74
|
-
- JP: TBD
|
|
75
74
|
- Screen ID: SCR-01
|
|
76
|
-
-
|
|
75
|
+
- Design Source Type: source-backed | generated-draft | none
|
|
76
|
+
- Design Source Reference: Figma URL | screenshot path | `docs/design/DESIGN_LAYOUT_{{FEATURE_KEY}}.md` section reference | `N/A - no UI scope`
|
|
77
77
|
|
|
78
78
|
Screen image:
|
|
79
79
|

|
|
80
80
|
|
|
81
|
-
| No |
|
|
82
|
-
| ---: | --- | --- | --- | --- | --- | --- | --- | --- | --- |
|
|
83
|
-
| 1 | Item A
|
|
84
|
-
| 2 | Item B
|
|
81
|
+
| No | Item Name | Item Type | Attribute | DB Column | Size | Default Value | Action | Description | Note |
|
|
82
|
+
| ---: | --- | --- | --- | --- | --- | --- | --- | --- | --- |
|
|
83
|
+
| 1 | Item A | Button | - | - | - | - | Click | TBD | TBD |
|
|
84
|
+
| 2 | Item B | Input | string | column_a | 100 | empty | Input | TBD | TBD |
|
|
85
85
|
|
|
86
86
|
#### API Mapping (Draft)
|
|
87
87
|
|
|
88
|
-
| No | Trigger/When | UI item (No /
|
|
88
|
+
| No | Trigger/When | UI item (No / Item Name) | API to call | Data usage / Notes |
|
|
89
89
|
| ---: | --- | --- | --- | --- |
|
|
90
90
|
| 1 | Initial load | Main area | `GET /api/...` | Load initial dataset |
|
|
91
91
|
| 2 | Click search | No 1 | `POST /api/.../search` | Refresh grid |
|
|
@@ -95,20 +95,20 @@ Screen image:
|
|
|
95
95
|
### 3.2 Screen B
|
|
96
96
|
|
|
97
97
|
Information:
|
|
98
|
-
- JP: TBD
|
|
99
98
|
- Screen ID: SCR-02
|
|
100
|
-
-
|
|
99
|
+
- Design Source Type: source-backed | generated-draft | none
|
|
100
|
+
- Design Source Reference: Figma URL | screenshot path | `docs/design/DESIGN_LAYOUT_{{FEATURE_KEY}}.md` section reference | `N/A - no UI scope`
|
|
101
101
|
|
|
102
102
|
Screen image:
|
|
103
103
|

|
|
104
104
|
|
|
105
|
-
| No |
|
|
106
|
-
| ---: | --- | --- | --- | --- | --- | --- | --- | --- | --- |
|
|
107
|
-
| 3 | Item C
|
|
105
|
+
| No | Item Name | Item Type | Attribute | DB Column | Size | Default Value | Action | Description | Note |
|
|
106
|
+
| ---: | --- | --- | --- | --- | --- | --- | --- | --- | --- |
|
|
107
|
+
| 3 | Item C | Toggle | boolean | flag_a | - | false | Toggle | TBD | TBD |
|
|
108
108
|
|
|
109
109
|
#### API Mapping (Draft)
|
|
110
110
|
|
|
111
|
-
| No | Trigger/When | UI item (No /
|
|
111
|
+
| No | Trigger/When | UI item (No / Item Name) | API to call | Data usage / Notes |
|
|
112
112
|
| ---: | --- | --- | --- | --- |
|
|
113
113
|
| 1 | Change mode | No 3 | `POST /api/.../edit/{uuid}` | Persist mode |
|
|
114
114
|
|