sdtk-kit 0.3.0 → 0.3.2
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 +72 -37
- package/assets/manifest/toolkit-bundle.sha256.txt +24 -17
- package/assets/toolkit/toolkit/AGENTS.md +5 -3
- package/assets/toolkit/toolkit/scripts/init-feature.ps1 +9 -1
- package/assets/toolkit/toolkit/skills/sdtk-api-design-spec/SKILL.md +6 -4
- package/assets/toolkit/toolkit/skills/sdtk-api-design-spec/references/API_DESIGN_CREATION_RULES.md +12 -208
- package/assets/toolkit/toolkit/skills/sdtk-api-design-spec/references/API_DESIGN_FLOWCHART_CREATION_RULES.md +451 -0
- package/assets/toolkit/toolkit/skills/sdtk-api-design-spec/references/FLOWCHART_CREATION_RULES.md +15 -392
- package/assets/toolkit/toolkit/skills/sdtk-api-design-spec/scripts/generate_api_design_detail.py +95 -4
- package/assets/toolkit/toolkit/skills/sdtk-api-doc/SKILL.md +4 -2
- package/assets/toolkit/toolkit/skills/sdtk-api-doc/references/API_DESIGN_FLOWCHART_CREATION_RULES.md +451 -0
- package/assets/toolkit/toolkit/skills/sdtk-api-doc/references/FLOWCHART_CREATION_RULES.md +15 -392
- package/assets/toolkit/toolkit/skills/sdtk-api-doc/references/YAML_CREATION_RULES.md +128 -0
- package/assets/toolkit/toolkit/skills/sdtk-arch/SKILL.md +3 -2
- package/assets/toolkit/toolkit/skills/sdtk-arch/references/API_DESIGN_CREATION_RULES.md +12 -208
- package/assets/toolkit/toolkit/skills/sdtk-arch/references/API_DESIGN_FLOWCHART_CREATION_RULES.md +451 -0
- package/assets/toolkit/toolkit/skills/sdtk-arch/references/FLOWCHART_CREATION_RULES.md +15 -392
- package/assets/toolkit/toolkit/skills/sdtk-arch/references/YAML_CREATION_RULES.md +128 -0
- package/assets/toolkit/toolkit/templates/README.md +9 -2
- package/assets/toolkit/toolkit/templates/docs/api/API_DESIGN_CREATION_RULES.md +12 -208
- package/assets/toolkit/toolkit/templates/docs/api/API_DESIGN_DETAIL_TEMPLATE.md +1 -2
- package/assets/toolkit/toolkit/templates/docs/api/API_DESIGN_FLOWCHART_CREATION_RULES.md +451 -0
- package/assets/toolkit/toolkit/templates/docs/api/API_ENDPOINTS_TEMPLATE.md +1 -1
- package/assets/toolkit/toolkit/templates/docs/api/FLOWCHART_CREATION_RULES.md +15 -392
- package/assets/toolkit/toolkit/templates/docs/api/YAML_CREATION_RULES.md +128 -0
- package/assets/toolkit/toolkit/templates/docs/design/DESIGN_LAYOUT_TEMPLATE.md +1 -1
- package/package.json +44 -45
- package/src/commands/help.js +7 -1
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
{
|
|
2
|
-
"buildTimestamp": "2026-03-
|
|
2
|
+
"buildTimestamp": "2026-03-03T11:32:21Z",
|
|
3
3
|
"files": [
|
|
4
4
|
{
|
|
5
5
|
"path": "toolkit/AGENTS.md",
|
|
6
|
-
"sha256": "
|
|
7
|
-
"size":
|
|
6
|
+
"sha256": "c6eeae87c70925803869ae90d0aa033eb12852c174019f373f62382d25b3a7e3",
|
|
7
|
+
"size": 5060
|
|
8
8
|
},
|
|
9
9
|
{
|
|
10
10
|
"path": "toolkit/install.ps1",
|
|
@@ -23,8 +23,8 @@
|
|
|
23
23
|
},
|
|
24
24
|
{
|
|
25
25
|
"path": "toolkit/scripts/init-feature.ps1",
|
|
26
|
-
"sha256": "
|
|
27
|
-
"size":
|
|
26
|
+
"sha256": "5c1f5442fd3c26b8bf62db4b25e9f1c4207258c7fe52f12ed533968f77dfbf65",
|
|
27
|
+
"size": 10557
|
|
28
28
|
},
|
|
29
29
|
{
|
|
30
30
|
"path": "toolkit/scripts/install-codex-skills.ps1",
|
|
@@ -48,38 +48,58 @@
|
|
|
48
48
|
},
|
|
49
49
|
{
|
|
50
50
|
"path": "toolkit/skills/sdtk-api-design-spec/references/API_DESIGN_CREATION_RULES.md",
|
|
51
|
-
"sha256": "
|
|
52
|
-
"size":
|
|
51
|
+
"sha256": "9adf1e46833411a861fb7426c37baac69689b9e3120a8ed1e4a3224de44a8dd2",
|
|
52
|
+
"size": 634
|
|
53
|
+
},
|
|
54
|
+
{
|
|
55
|
+
"path": "toolkit/skills/sdtk-api-design-spec/references/API_DESIGN_FLOWCHART_CREATION_RULES.md",
|
|
56
|
+
"sha256": "13f26a3307894b9bfb570d75f6db4ccb61104064d19661ec2a26a1b9984f4c97",
|
|
57
|
+
"size": 12827
|
|
53
58
|
},
|
|
54
59
|
{
|
|
55
60
|
"path": "toolkit/skills/sdtk-api-design-spec/references/FLOWCHART_CREATION_RULES.md",
|
|
56
|
-
"sha256": "
|
|
57
|
-
"size":
|
|
61
|
+
"sha256": "decffe52425e22b3dd82e9c8f3768aefbb209ec58237107d84f583fee876ea8f",
|
|
62
|
+
"size": 791
|
|
58
63
|
},
|
|
59
64
|
{
|
|
60
65
|
"path": "toolkit/skills/sdtk-api-design-spec/scripts/generate_api_design_detail.py",
|
|
61
|
-
"sha256": "
|
|
62
|
-
"size":
|
|
66
|
+
"sha256": "c6147e7b01632cb6ffa017af43e4e5c9e1f98d160ed812ade1d087b1f3ca5490",
|
|
67
|
+
"size": 24583
|
|
63
68
|
},
|
|
64
69
|
{
|
|
65
70
|
"path": "toolkit/skills/sdtk-api-design-spec/SKILL.md",
|
|
66
|
-
"sha256": "
|
|
67
|
-
"size":
|
|
71
|
+
"sha256": "49817620680d1abe9620c7615885e5d5e688982c98110db18bc3ce5fc79f01b4",
|
|
72
|
+
"size": 3685
|
|
73
|
+
},
|
|
74
|
+
{
|
|
75
|
+
"path": "toolkit/skills/sdtk-api-doc/references/API_DESIGN_FLOWCHART_CREATION_RULES.md",
|
|
76
|
+
"sha256": "13f26a3307894b9bfb570d75f6db4ccb61104064d19661ec2a26a1b9984f4c97",
|
|
77
|
+
"size": 12827
|
|
68
78
|
},
|
|
69
79
|
{
|
|
70
80
|
"path": "toolkit/skills/sdtk-api-doc/references/FLOWCHART_CREATION_RULES.md",
|
|
71
|
-
"sha256": "
|
|
72
|
-
"size":
|
|
81
|
+
"sha256": "decffe52425e22b3dd82e9c8f3768aefbb209ec58237107d84f583fee876ea8f",
|
|
82
|
+
"size": 791
|
|
83
|
+
},
|
|
84
|
+
{
|
|
85
|
+
"path": "toolkit/skills/sdtk-api-doc/references/YAML_CREATION_RULES.md",
|
|
86
|
+
"sha256": "f29c6774019ef0789dfb88678e1ab31d4d8eb7b3ab69b2115368ef5d879e5276",
|
|
87
|
+
"size": 5997
|
|
73
88
|
},
|
|
74
89
|
{
|
|
75
90
|
"path": "toolkit/skills/sdtk-api-doc/SKILL.md",
|
|
76
|
-
"sha256": "
|
|
77
|
-
"size":
|
|
91
|
+
"sha256": "d93980bc0332f25852a5e4b0e5187bde7185a5ede70c59c8ebaf542afdb42188",
|
|
92
|
+
"size": 1966
|
|
78
93
|
},
|
|
79
94
|
{
|
|
80
95
|
"path": "toolkit/skills/sdtk-arch/references/API_DESIGN_CREATION_RULES.md",
|
|
81
|
-
"sha256": "
|
|
82
|
-
"size":
|
|
96
|
+
"sha256": "9adf1e46833411a861fb7426c37baac69689b9e3120a8ed1e4a3224de44a8dd2",
|
|
97
|
+
"size": 634
|
|
98
|
+
},
|
|
99
|
+
{
|
|
100
|
+
"path": "toolkit/skills/sdtk-arch/references/API_DESIGN_FLOWCHART_CREATION_RULES.md",
|
|
101
|
+
"sha256": "13f26a3307894b9bfb570d75f6db4ccb61104064d19661ec2a26a1b9984f4c97",
|
|
102
|
+
"size": 12827
|
|
83
103
|
},
|
|
84
104
|
{
|
|
85
105
|
"path": "toolkit/skills/sdtk-arch/references/FLOW_ACTION_SPEC_CREATION_RULES.md",
|
|
@@ -88,13 +108,18 @@
|
|
|
88
108
|
},
|
|
89
109
|
{
|
|
90
110
|
"path": "toolkit/skills/sdtk-arch/references/FLOWCHART_CREATION_RULES.md",
|
|
91
|
-
"sha256": "
|
|
92
|
-
"size":
|
|
111
|
+
"sha256": "decffe52425e22b3dd82e9c8f3768aefbb209ec58237107d84f583fee876ea8f",
|
|
112
|
+
"size": 791
|
|
113
|
+
},
|
|
114
|
+
{
|
|
115
|
+
"path": "toolkit/skills/sdtk-arch/references/YAML_CREATION_RULES.md",
|
|
116
|
+
"sha256": "f29c6774019ef0789dfb88678e1ab31d4d8eb7b3ab69b2115368ef5d879e5276",
|
|
117
|
+
"size": 5997
|
|
93
118
|
},
|
|
94
119
|
{
|
|
95
120
|
"path": "toolkit/skills/sdtk-arch/SKILL.md",
|
|
96
|
-
"sha256": "
|
|
97
|
-
"size":
|
|
121
|
+
"sha256": "ddf57e65096fc6f1bdd0f2c829f2580d2d7edb99f79d3cba7a3f68e69d373f46",
|
|
122
|
+
"size": 2489
|
|
98
123
|
},
|
|
99
124
|
{
|
|
100
125
|
"path": "toolkit/skills/sdtk-ba/SKILL.md",
|
|
@@ -188,18 +213,23 @@
|
|
|
188
213
|
},
|
|
189
214
|
{
|
|
190
215
|
"path": "toolkit/templates/docs/api/API_DESIGN_CREATION_RULES.md",
|
|
191
|
-
"sha256": "
|
|
192
|
-
"size":
|
|
216
|
+
"sha256": "9adf1e46833411a861fb7426c37baac69689b9e3120a8ed1e4a3224de44a8dd2",
|
|
217
|
+
"size": 634
|
|
193
218
|
},
|
|
194
219
|
{
|
|
195
220
|
"path": "toolkit/templates/docs/api/API_DESIGN_DETAIL_TEMPLATE.md",
|
|
196
|
-
"sha256": "
|
|
197
|
-
"size":
|
|
221
|
+
"sha256": "d2aa0ee3a7c5351700b3bffb4ba66e8056ed955f55903c744c694624730038cb",
|
|
222
|
+
"size": 1181
|
|
223
|
+
},
|
|
224
|
+
{
|
|
225
|
+
"path": "toolkit/templates/docs/api/API_DESIGN_FLOWCHART_CREATION_RULES.md",
|
|
226
|
+
"sha256": "13f26a3307894b9bfb570d75f6db4ccb61104064d19661ec2a26a1b9984f4c97",
|
|
227
|
+
"size": 12827
|
|
198
228
|
},
|
|
199
229
|
{
|
|
200
230
|
"path": "toolkit/templates/docs/api/API_ENDPOINTS_TEMPLATE.md",
|
|
201
|
-
"sha256": "
|
|
202
|
-
"size":
|
|
231
|
+
"sha256": "7dd9840e7a9c268fd7671791c0e80cfbcf54c3c2ff8bbacd85e44662f238ac9c",
|
|
232
|
+
"size": 5102
|
|
203
233
|
},
|
|
204
234
|
{
|
|
205
235
|
"path": "toolkit/templates/docs/api/feature_api_flow_list_TEMPLATE.txt",
|
|
@@ -213,8 +243,13 @@
|
|
|
213
243
|
},
|
|
214
244
|
{
|
|
215
245
|
"path": "toolkit/templates/docs/api/FLOWCHART_CREATION_RULES.md",
|
|
216
|
-
"sha256": "
|
|
217
|
-
"size":
|
|
246
|
+
"sha256": "decffe52425e22b3dd82e9c8f3768aefbb209ec58237107d84f583fee876ea8f",
|
|
247
|
+
"size": 791
|
|
248
|
+
},
|
|
249
|
+
{
|
|
250
|
+
"path": "toolkit/templates/docs/api/YAML_CREATION_RULES.md",
|
|
251
|
+
"sha256": "f29c6774019ef0789dfb88678e1ab31d4d8eb7b3ab69b2115368ef5d879e5276",
|
|
252
|
+
"size": 5997
|
|
218
253
|
},
|
|
219
254
|
{
|
|
220
255
|
"path": "toolkit/templates/docs/architecture/ARCH_DESIGN_TEMPLATE.md",
|
|
@@ -228,7 +263,7 @@
|
|
|
228
263
|
},
|
|
229
264
|
{
|
|
230
265
|
"path": "toolkit/templates/docs/design/DESIGN_LAYOUT_TEMPLATE.md",
|
|
231
|
-
"sha256": "
|
|
266
|
+
"sha256": "26fc80a5bced4b67debea943a49c729532a576146a81994f7e28615c3debe681",
|
|
232
267
|
"size": 845
|
|
233
268
|
},
|
|
234
269
|
{
|
|
@@ -288,8 +323,8 @@
|
|
|
288
323
|
},
|
|
289
324
|
{
|
|
290
325
|
"path": "toolkit/templates/README.md",
|
|
291
|
-
"sha256": "
|
|
292
|
-
"size":
|
|
326
|
+
"sha256": "0ccb7a0509cf92aa91ebea95996dfffd5b52edd6ab4bbefbb827e4ed495abc31",
|
|
327
|
+
"size": 2683
|
|
293
328
|
},
|
|
294
329
|
{
|
|
295
330
|
"path": "toolkit/templates/SHARED_PLANNING.md",
|
|
@@ -297,7 +332,7 @@
|
|
|
297
332
|
"size": 3255
|
|
298
333
|
}
|
|
299
334
|
],
|
|
300
|
-
"sourceCommit": "
|
|
301
|
-
"version": "0.2
|
|
302
|
-
"fileCount":
|
|
335
|
+
"sourceCommit": "bf9a10e9ccde3a1c4809836b2da20fc6e3ad07df",
|
|
336
|
+
"version": "0.3.2",
|
|
337
|
+
"fileCount": 66
|
|
303
338
|
}
|
|
@@ -1,22 +1,27 @@
|
|
|
1
|
-
|
|
1
|
+
c6eeae87c70925803869ae90d0aa033eb12852c174019f373f62382d25b3a7e3 toolkit/AGENTS.md
|
|
2
2
|
cc717ae87a0dbcf5aef2204d45211fe59f9506f9d03314eb283eddb3a5997279 toolkit/install.ps1
|
|
3
3
|
fdf45036d4c0079cdb03e65efb7b5a84ea130e67a4c82522bb93c2bb73aa6661 toolkit/runtimes/claude/CLAUDE_TEMPLATE.md
|
|
4
4
|
4154c15c71f44d2f2caf07fb41722fa65d4f9ec7e78f798ee084effd12345c62 toolkit/runtimes/codex/CODEX_TEMPLATE.md
|
|
5
|
-
|
|
5
|
+
5c1f5442fd3c26b8bf62db4b25e9f1c4207258c7fe52f12ed533968f77dfbf65 toolkit/scripts/init-feature.ps1
|
|
6
6
|
68a82e421d0309e47cdb79e949b1044c17375ad7fd52e2ab9ccdc9dd33f8cdd0 toolkit/scripts/install-codex-skills.ps1
|
|
7
7
|
e0d462bd6dcdb17cc003d459063ff341bd2e4f60b245cda9b7e9b9e94b3cf01f toolkit/scripts/uninstall-codex-skills.ps1
|
|
8
8
|
de2921da9ce504487d9c7d97bf862b65d0ba00b9f1593a4fbfadf41ac36adb49 toolkit/sdtk.config.json
|
|
9
9
|
21b1b0212f85c76dc6a89ae5936b39c4c1df7837a333f7a3db337f3039babb7b toolkit/sdtk.config.profiles.example.json
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
10
|
+
9adf1e46833411a861fb7426c37baac69689b9e3120a8ed1e4a3224de44a8dd2 toolkit/skills/sdtk-api-design-spec/references/API_DESIGN_CREATION_RULES.md
|
|
11
|
+
13f26a3307894b9bfb570d75f6db4ccb61104064d19661ec2a26a1b9984f4c97 toolkit/skills/sdtk-api-design-spec/references/API_DESIGN_FLOWCHART_CREATION_RULES.md
|
|
12
|
+
decffe52425e22b3dd82e9c8f3768aefbb209ec58237107d84f583fee876ea8f toolkit/skills/sdtk-api-design-spec/references/FLOWCHART_CREATION_RULES.md
|
|
13
|
+
c6147e7b01632cb6ffa017af43e4e5c9e1f98d160ed812ade1d087b1f3ca5490 toolkit/skills/sdtk-api-design-spec/scripts/generate_api_design_detail.py
|
|
14
|
+
49817620680d1abe9620c7615885e5d5e688982c98110db18bc3ce5fc79f01b4 toolkit/skills/sdtk-api-design-spec/SKILL.md
|
|
15
|
+
13f26a3307894b9bfb570d75f6db4ccb61104064d19661ec2a26a1b9984f4c97 toolkit/skills/sdtk-api-doc/references/API_DESIGN_FLOWCHART_CREATION_RULES.md
|
|
16
|
+
decffe52425e22b3dd82e9c8f3768aefbb209ec58237107d84f583fee876ea8f toolkit/skills/sdtk-api-doc/references/FLOWCHART_CREATION_RULES.md
|
|
17
|
+
f29c6774019ef0789dfb88678e1ab31d4d8eb7b3ab69b2115368ef5d879e5276 toolkit/skills/sdtk-api-doc/references/YAML_CREATION_RULES.md
|
|
18
|
+
d93980bc0332f25852a5e4b0e5187bde7185a5ede70c59c8ebaf542afdb42188 toolkit/skills/sdtk-api-doc/SKILL.md
|
|
19
|
+
9adf1e46833411a861fb7426c37baac69689b9e3120a8ed1e4a3224de44a8dd2 toolkit/skills/sdtk-arch/references/API_DESIGN_CREATION_RULES.md
|
|
20
|
+
13f26a3307894b9bfb570d75f6db4ccb61104064d19661ec2a26a1b9984f4c97 toolkit/skills/sdtk-arch/references/API_DESIGN_FLOWCHART_CREATION_RULES.md
|
|
17
21
|
b1ed7f7cad8f4098bd305fa9aaea6cdf1c78cf909284547baa50235fa677d8c0 toolkit/skills/sdtk-arch/references/FLOW_ACTION_SPEC_CREATION_RULES.md
|
|
18
|
-
|
|
19
|
-
|
|
22
|
+
decffe52425e22b3dd82e9c8f3768aefbb209ec58237107d84f583fee876ea8f toolkit/skills/sdtk-arch/references/FLOWCHART_CREATION_RULES.md
|
|
23
|
+
f29c6774019ef0789dfb88678e1ab31d4d8eb7b3ab69b2115368ef5d879e5276 toolkit/skills/sdtk-arch/references/YAML_CREATION_RULES.md
|
|
24
|
+
ddf57e65096fc6f1bdd0f2c829f2580d2d7edb99f79d3cba7a3f68e69d373f46 toolkit/skills/sdtk-arch/SKILL.md
|
|
20
25
|
7bc02ad898b5e7dc36282026dcc718818600a507d18046a9e80d8e6eba588131 toolkit/skills/sdtk-ba/SKILL.md
|
|
21
26
|
8eabb7bdb821a91766ccd5b5fdcc1a4e876b51052cd6c6429b98b4d9946e2b1a toolkit/skills/sdtk-design-layout/SKILL.md
|
|
22
27
|
7a7f5a799247896a8ddebc5cefec25450bf9284d34044b6b69b13e4535c005a1 toolkit/skills/sdtk-dev/SKILL.md
|
|
@@ -35,15 +40,17 @@ ae0bc9b120c19a142f10cc79168a8f7d6bf8a37e48341fc16cbc74bbdc2e692c toolkit/skills
|
|
|
35
40
|
7c21e74f5eee712c6b65665b4f10483ed008113186a92dc0a4673ce1fcd3ef5c toolkit/skills/sdtk-test-case-spec/references/TEST_CASE_CREATION_RULES.md
|
|
36
41
|
4d1e813908114f2be68007fb7373973e2c6e0aebc5a6305b8b19443d5ae477d0 toolkit/skills/sdtk-test-case-spec/scripts/validate_test_case_spec.py
|
|
37
42
|
72ca16e07c286910333243954610e116217ca2abb3a5e276cbe91e92eb826ad5 toolkit/skills/sdtk-test-case-spec/SKILL.md
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
43
|
+
9adf1e46833411a861fb7426c37baac69689b9e3120a8ed1e4a3224de44a8dd2 toolkit/templates/docs/api/API_DESIGN_CREATION_RULES.md
|
|
44
|
+
d2aa0ee3a7c5351700b3bffb4ba66e8056ed955f55903c744c694624730038cb toolkit/templates/docs/api/API_DESIGN_DETAIL_TEMPLATE.md
|
|
45
|
+
13f26a3307894b9bfb570d75f6db4ccb61104064d19661ec2a26a1b9984f4c97 toolkit/templates/docs/api/API_DESIGN_FLOWCHART_CREATION_RULES.md
|
|
46
|
+
7dd9840e7a9c268fd7671791c0e80cfbcf54c3c2ff8bbacd85e44662f238ac9c toolkit/templates/docs/api/API_ENDPOINTS_TEMPLATE.md
|
|
41
47
|
56e2b2a150ff737b856bb75e58fea603d09fe5c26d9fe5d5ea0516b4eb4703e8 toolkit/templates/docs/api/feature_api_flow_list_TEMPLATE.txt
|
|
42
48
|
7a86c642f2d5826b2ce76fddb8ed0bcb300af4eb654e70e16576057927654d7a toolkit/templates/docs/api/FEATURE_API_TEMPLATE.yaml
|
|
43
|
-
|
|
49
|
+
decffe52425e22b3dd82e9c8f3768aefbb209ec58237107d84f583fee876ea8f toolkit/templates/docs/api/FLOWCHART_CREATION_RULES.md
|
|
50
|
+
f29c6774019ef0789dfb88678e1ab31d4d8eb7b3ab69b2115368ef5d879e5276 toolkit/templates/docs/api/YAML_CREATION_RULES.md
|
|
44
51
|
bc32ad83f06dc60ada7312f8d05f56b12da2d5e99c275fbc7895cf1e34a6c358 toolkit/templates/docs/architecture/ARCH_DESIGN_TEMPLATE.md
|
|
45
52
|
d4cec8811e2a336a0ab8dd6e68998753cf7eca927207cdb8afc20666a5c452f7 toolkit/templates/docs/database/DATABASE_SPEC_TEMPLATE.md
|
|
46
|
-
|
|
53
|
+
26fc80a5bced4b67debea943a49c729532a576146a81994f7e28615c3debe681 toolkit/templates/docs/design/DESIGN_LAYOUT_TEMPLATE.md
|
|
47
54
|
b7bb3ed90857029f3e7c38f628bac8e04f4ba0ea506c9bbf940765da55b19df1 toolkit/templates/docs/dev/FEATURE_IMPL_PLAN_TEMPLATE.md
|
|
48
55
|
35488641da64f1bca10c985f66c495da85257d193aad1879a5bd9152e6bbc8c5 toolkit/templates/docs/product/BACKLOG_TEMPLATE.md
|
|
49
56
|
8c04fe6dcfdc1f2de178dddcafe9ea92803f1a94b1bbc9ef351be632cf04af94 toolkit/templates/docs/product/PRD_TEMPLATE.md
|
|
@@ -55,5 +62,5 @@ e8d3554fc4893a8a57fbf006e58f37f21347de5f31ce02f0717e97d29b387eea toolkit/templa
|
|
|
55
62
|
b1ed7f7cad8f4098bd305fa9aaea6cdf1c78cf909284547baa50235fa677d8c0 toolkit/templates/docs/specs/FLOW_ACTION_SPEC_CREATION_RULES.md
|
|
56
63
|
afa6ac33875037495e28238a2c3fae2f4dcbb12f318c3cec0696fe45465cdf2a toolkit/templates/docs/specs/FLOW_ACTION_SPEC_TEMPLATE.md
|
|
57
64
|
f9dc0d49ceeeb8814d77670e43f09b5221f46d406fb1e89eb575c1ab39bc022a toolkit/templates/QUALITY_CHECKLIST.md
|
|
58
|
-
|
|
65
|
+
0ccb7a0509cf92aa91ebea95996dfffd5b52edd6ab4bbefbb827e4ed495abc31 toolkit/templates/README.md
|
|
59
66
|
2b5d4d10019e3c9b3219d92b8123acc85872d9c76230107206e7a270a5ece5a2 toolkit/templates/SHARED_PLANNING.md
|
|
@@ -90,9 +90,12 @@ In addition to `ARCH_DESIGN`, ARCH may generate:
|
|
|
90
90
|
- `off`: skip unless explicitly requested.
|
|
91
91
|
|
|
92
92
|
## 7) Mandatory Rule References
|
|
93
|
-
- API YAML
|
|
93
|
+
- API YAML docs:
|
|
94
|
+
- `toolkit/templates/docs/api/YAML_CREATION_RULES.md`
|
|
95
|
+
- API design detail + flow docs:
|
|
96
|
+
- `toolkit/templates/docs/api/API_DESIGN_FLOWCHART_CREATION_RULES.md`
|
|
97
|
+
- Compatibility notes kept for legacy references:
|
|
94
98
|
- `toolkit/templates/docs/api/FLOWCHART_CREATION_RULES.md`
|
|
95
|
-
- API design detail docs:
|
|
96
99
|
- `toolkit/templates/docs/api/API_DESIGN_CREATION_RULES.md`
|
|
97
100
|
- Screen flow-action specs:
|
|
98
101
|
- `toolkit/templates/docs/specs/FLOW_ACTION_SPEC_CREATION_RULES.md`
|
|
@@ -100,4 +103,3 @@ In addition to `ARCH_DESIGN`, ARCH may generate:
|
|
|
100
103
|
- `toolkit/templates/docs/qa/TEST_CASE_CREATION_RULES.md`
|
|
101
104
|
- Flow-action numbering policy:
|
|
102
105
|
- Use one global numbering mode for the whole document (no per-screen reset).
|
|
103
|
-
|
|
@@ -35,7 +35,7 @@ function Render-Template {
|
|
|
35
35
|
[Parameter(Mandatory = $true)][hashtable]$Tokens
|
|
36
36
|
)
|
|
37
37
|
|
|
38
|
-
$content = Get-Content -Raw -Path $TemplatePath
|
|
38
|
+
$content = Get-Content -Raw -Path $TemplatePath -Encoding UTF8
|
|
39
39
|
# Strip BOM if present (Windows PowerShell 5.1 may read BOM into string)
|
|
40
40
|
if ($content.Length -gt 0 -and $content[0] -eq [char]0xFEFF) {
|
|
41
41
|
$content = $content.Substring(1)
|
|
@@ -112,6 +112,14 @@ if ($ProjectPath) {
|
|
|
112
112
|
$projectRoot = Resolve-Path (Join-Path $toolkitRoot '..')
|
|
113
113
|
}
|
|
114
114
|
|
|
115
|
+
# Warn if legacy Docs/ compatibility folder exists at project root
|
|
116
|
+
$legacyDocs = Join-Path $projectRoot 'Docs'
|
|
117
|
+
if ((Test-Path -LiteralPath $legacyDocs) -and ($env:OS -eq 'Windows_NT')) {
|
|
118
|
+
Write-Host "[WARN] Legacy 'Docs/' folder detected at project root." -ForegroundColor Yellow
|
|
119
|
+
Write-Host " On Windows, 'docs/' and 'Docs/' resolve to same folder." -ForegroundColor Yellow
|
|
120
|
+
Write-Host " Consider: git mv Docs tmp-docs && git mv tmp-docs docs" -ForegroundColor Yellow
|
|
121
|
+
}
|
|
122
|
+
|
|
115
123
|
$templateRoot = Join-Path $toolkitRoot 'templates'
|
|
116
124
|
|
|
117
125
|
if (-not (Test-Path -LiteralPath $templateRoot)) {
|
|
@@ -21,22 +21,26 @@ description: Generate detailed API design markdown (`[FEATURE_KEY]_API_DESIGN_DE
|
|
|
21
21
|
- Fallback: a specified flow list path
|
|
22
22
|
|
|
23
23
|
## Core Rules
|
|
24
|
-
- Apply `./references/
|
|
24
|
+
- Apply `./references/API_DESIGN_FLOWCHART_CREATION_RULES.md` first.
|
|
25
25
|
- Keep endpoint contracts consistent with source YAML.
|
|
26
26
|
- Keep process flow source synchronized with flow list (`*_api_flow_list.txt`).
|
|
27
27
|
- Keep one visible flowchart per API section (embed image), avoid duplicate preview rendering.
|
|
28
|
+
- Keep `Process Flow` sections implementation-readable:
|
|
29
|
+
- include YAML-derived flow summary / notes / login bullets
|
|
30
|
+
- keep error sections aligned with actual flow exits, not `None`
|
|
28
31
|
|
|
29
32
|
## Generation Procedure
|
|
30
33
|
1. Resolve input files (`yaml`, `flow_list`, `output`).
|
|
31
34
|
2. Parse YAML endpoints (method, path, request schema, success/error schema).
|
|
32
35
|
3. Parse flow blocks from flow list (`@startuml ... @enduml`) and map by `METHOD + path`.
|
|
33
36
|
4. Generate detailed markdown sections per API:
|
|
37
|
+
- Flow summary / notes / login bullets from YAML `description`
|
|
34
38
|
- Process flow source block (`text` fenced block)
|
|
35
39
|
- Embedded flowchart image
|
|
36
40
|
- Path parameter table
|
|
37
41
|
- Request table (hierarchy levels + type + format + required)
|
|
38
42
|
- Success response table
|
|
39
|
-
- Error response table
|
|
43
|
+
- Error response table (explicit schema if defined, otherwise shared envelope + inferred business statuses from flow)
|
|
40
44
|
5. Generate/update `.puml` per API under `docs/api/flows`.
|
|
41
45
|
6. Render `.svg` images under `docs/api/images`.
|
|
42
46
|
7. Validate:
|
|
@@ -74,5 +78,3 @@ python "toolkit/skills/sdtk-api-design-spec/scripts/generate_api_design_detail.p
|
|
|
74
78
|
- `auto` (default): generate API design detail when ARCH has API scope and YAML/flow sources are available.
|
|
75
79
|
- `on`: always generate API design detail for API scope (fail if required sources are missing).
|
|
76
80
|
- `off`: skip unless user explicitly requests.
|
|
77
|
-
|
|
78
|
-
|
package/assets/toolkit/toolkit/skills/sdtk-api-design-spec/references/API_DESIGN_CREATION_RULES.md
CHANGED
|
@@ -1,212 +1,16 @@
|
|
|
1
|
-
# API
|
|
1
|
+
# API DESIGN CREATION RULES (Compatibility Note)
|
|
2
2
|
|
|
3
|
-
This
|
|
3
|
+
This file is kept only for backward compatibility.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Do not use this file as the primary source of truth anymore.
|
|
6
|
+
The active rule source for API design detail and API flowchart behavior is now:
|
|
7
|
+
- `API_DESIGN_FLOWCHART_CREATION_RULES_FINAL.md` (root)
|
|
8
|
+
- `templates/docs/api/API_DESIGN_FLOWCHART_CREATION_RULES.md` (toolkit)
|
|
6
9
|
|
|
7
|
-
|
|
8
|
-
-
|
|
9
|
-
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
| No | Sheet Pattern | Purpose |
|
|
14
|
-
| ---: | --- | --- |
|
|
15
|
-
| 1 | `History` | Global workbook change history |
|
|
16
|
-
| 2 | `API detail (...)` | One API per sheet |
|
|
17
|
-
|
|
18
|
-
Observed baseline in `API_design.xlsx`:
|
|
19
|
-
- 1 history sheet.
|
|
20
|
-
- 5 API detail sheets (list/create/detail/update/logical delete).
|
|
21
|
-
|
|
22
|
-
## 3. Workbook Rules
|
|
23
|
-
|
|
24
|
-
### 3.1 Sheet Naming
|
|
25
|
-
|
|
26
|
-
- Use one API per sheet.
|
|
27
|
-
- Recommended naming style:
|
|
28
|
-
- `API detail (<domain action>)`
|
|
29
|
-
- Keep API sheet order stable (for example: list -> create -> detail -> update -> delete).
|
|
30
|
-
|
|
31
|
-
### 3.2 History Sheet
|
|
32
|
-
|
|
33
|
-
- Keep `History` as the first sheet.
|
|
34
|
-
- Header layout:
|
|
35
|
-
- `A3=Date`
|
|
36
|
-
- `C3=Version`
|
|
37
|
-
- `F3=Editor`
|
|
38
|
-
- `M3=Edit content`
|
|
39
|
-
- Append rows only. Do not rewrite historical rows.
|
|
40
|
-
|
|
41
|
-
## 4. API Detail Sheet Layout
|
|
42
|
-
|
|
43
|
-
### 4.1 Header Metadata Block
|
|
44
|
-
|
|
45
|
-
Use this label/value map:
|
|
46
|
-
|
|
47
|
-
| No | Label Cell Group | Value Cell Group | Meaning |
|
|
48
|
-
| ---: | --- | --- | --- |
|
|
49
|
-
| 1 | `Q1:X1` | `Y1:AQ1` | System name |
|
|
50
|
-
| 2 | `Q2:X2` | `Y2:AQ2` | System ID |
|
|
51
|
-
| 3 | `Q3:X3` | `Y3:AQ3` | Subsystem name |
|
|
52
|
-
| 4 | `Q4:X4` | `Y4:AQ4` | Function name |
|
|
53
|
-
| 5 | `AR1:AV1` | `AW1:BC1` | Created by |
|
|
54
|
-
| 6 | `AR2:AV2` | `AW2:BC2` | Created date |
|
|
55
|
-
| 7 | `AR3:AV3` | `AW3:BC3` | Revised by |
|
|
56
|
-
| 8 | `AR4:AV4` | `AW4:BC4` | Revised date |
|
|
57
|
-
|
|
58
|
-
Also keep document title block:
|
|
59
|
-
- `A1:P4` = document title area.
|
|
60
|
-
|
|
61
|
-
### 4.2 Mandatory Section Order
|
|
62
|
-
|
|
63
|
-
Each API sheet must keep this order:
|
|
64
|
-
1. Process flow section
|
|
65
|
-
2. `Parameters:`
|
|
66
|
-
3. Request parameter section (JSON format)
|
|
67
|
-
4. Success response section (JSON format)
|
|
68
|
-
5. Error response section (JSON format)
|
|
69
|
-
|
|
70
|
-
### 4.3 Endpoint Title Placement
|
|
71
|
-
|
|
72
|
-
- Put endpoint summary at top flow area: `B7`.
|
|
73
|
-
- Format: `<METHOD> <PATH> <summary>`
|
|
74
|
-
- Repeat the same endpoint summary in contract area:
|
|
75
|
-
- Column `A`, one row above `Parameters:`.
|
|
76
|
-
- Both endpoint strings must be identical.
|
|
77
|
-
|
|
78
|
-
### 4.4 Flowchart Placement
|
|
79
|
-
|
|
80
|
-
- Put PlantUML text in `BG8` (multi-line content in one cell).
|
|
81
|
-
- `BG6` can contain tool/reference note.
|
|
82
|
-
- Helper + main flows can be placed in one cell value if clearly separated.
|
|
83
|
-
- Flow syntax/content standards follow:
|
|
84
|
-
- `Example/Docs/API/FLOWCHART_CREATION_RULES.md`
|
|
85
|
-
|
|
86
|
-
## 5. Endpoint and Parameter Rules
|
|
87
|
-
|
|
88
|
-
### 5.1 Path Parameter Block
|
|
89
|
-
|
|
90
|
-
- Anchor row: column `B` equals `Parameters:`.
|
|
91
|
-
- Parameter rows:
|
|
92
|
-
- parameter key in column `C`
|
|
93
|
-
- description in column `K`
|
|
94
|
-
- Include every path placeholder from endpoint path.
|
|
95
|
-
- Keep parameter order aligned with placeholder order.
|
|
96
|
-
|
|
97
|
-
### 5.2 Consistency Checks
|
|
98
|
-
|
|
99
|
-
- Every `{placeholder}` in path must exist exactly once in the parameter rows.
|
|
100
|
-
- Avoid duplicate parameter names unless explicitly documented.
|
|
101
|
-
- Remove stale parameter rows after endpoint rename.
|
|
102
|
-
|
|
103
|
-
## 6. Request/Response Table Rules
|
|
104
|
-
|
|
105
|
-
### 6.1 Common Column Model
|
|
106
|
-
|
|
107
|
-
| No | Column Group | Meaning |
|
|
108
|
-
| ---: | --- | --- |
|
|
109
|
-
| 1 | `A:B` | Row No |
|
|
110
|
-
| 2 | `C:J` | Item label |
|
|
111
|
-
| 3 | `K:N` | Hierarchy level 1 |
|
|
112
|
-
| 4 | `O:R` | Hierarchy level 2 |
|
|
113
|
-
| 5 | `S:V` | Hierarchy level 3 |
|
|
114
|
-
| 6 | `W:Z` | Hierarchy level 4 |
|
|
115
|
-
| 7 | `AA:AD` | Hierarchy level 5 |
|
|
116
|
-
| 8 | `AE:AH` | Hierarchy level 6 |
|
|
117
|
-
| 9 | `AI:AK` | Data type |
|
|
118
|
-
|
|
119
|
-
### 6.2 Request Header Mode
|
|
120
|
-
|
|
121
|
-
For write/search request tables, include:
|
|
122
|
-
- `No`
|
|
123
|
-
- `Item Name`
|
|
124
|
-
- `Item`
|
|
125
|
-
- `Type`
|
|
126
|
-
- `Format`
|
|
127
|
-
- `Length`
|
|
128
|
-
- `Required`
|
|
129
|
-
|
|
130
|
-
Column groups:
|
|
131
|
-
- `AL:AN` -> `Format`
|
|
132
|
-
- `AO:AP` -> `Length`
|
|
133
|
-
- `AQ:AR` -> `Required`
|
|
134
|
-
|
|
135
|
-
### 6.3 Response Header Mode
|
|
136
|
-
|
|
137
|
-
For response tables, include:
|
|
138
|
-
- `No`
|
|
139
|
-
- `Item Name`
|
|
140
|
-
- `Item`
|
|
141
|
-
- `Type`
|
|
142
|
-
- `Note`
|
|
143
|
-
|
|
144
|
-
Column group:
|
|
145
|
-
- `AL:AN` -> `Note`
|
|
146
|
-
|
|
147
|
-
### 6.4 GET Request Body Rule
|
|
148
|
-
|
|
149
|
-
- If API has no JSON request body, set request body to:
|
|
150
|
-
- `None`
|
|
151
|
-
|
|
152
|
-
### 6.5 Hierarchy Modeling Rule
|
|
153
|
-
|
|
154
|
-
- Use hierarchy columns (level 1 to level 6) to represent nesting.
|
|
155
|
-
- Represent root wrapper explicitly (for example `data`).
|
|
156
|
-
- For array object children, define parent array node first, then child fields at deeper levels.
|
|
157
|
-
|
|
158
|
-
## 7. Status and Error Contract Rules
|
|
159
|
-
|
|
160
|
-
- Success response must include `status` at minimum.
|
|
161
|
-
- Error response must include:
|
|
162
|
-
- `status`
|
|
163
|
-
- `data` (message or detail payload)
|
|
164
|
-
- If status detail references an external code table, note that in response notes.
|
|
165
|
-
|
|
166
|
-
## 8. Type and Format Rules
|
|
167
|
-
|
|
168
|
-
- Use stable type keywords:
|
|
169
|
-
- `string`
|
|
170
|
-
- `integer`
|
|
171
|
-
- `number`
|
|
172
|
-
- `object`
|
|
173
|
-
- `array`
|
|
174
|
-
- If datetime format is constrained, write it in `Format` or `Note` (for example `yyyymmddHHMMSS`).
|
|
175
|
-
- Business constraints (constant flags, nullable behavior, etc.) go to `Note`.
|
|
176
|
-
|
|
177
|
-
## 9. Recommended Generation Procedure
|
|
178
|
-
|
|
179
|
-
1. Duplicate an existing API detail sheet.
|
|
180
|
-
2. Update metadata fields (`Q..BC` blocks).
|
|
181
|
-
3. Update endpoint title in `B7`.
|
|
182
|
-
4. Update PlantUML in `BG8`.
|
|
183
|
-
5. Update repeated endpoint title above `Parameters:`.
|
|
184
|
-
6. Update path parameters (`C/K` rows).
|
|
185
|
-
7. Update request section:
|
|
186
|
-
- `None` for no-body APIs.
|
|
187
|
-
- request table for body APIs.
|
|
188
|
-
8. Update success response table.
|
|
189
|
-
9. Update error response table.
|
|
190
|
-
10. Append one new row in `History`.
|
|
191
|
-
|
|
192
|
-
## 10. Quality Gate Checklist Before Handoff
|
|
193
|
-
|
|
194
|
-
- Section order is complete and unchanged.
|
|
195
|
-
- Endpoint title in `B7` matches the endpoint title above `Parameters:`.
|
|
196
|
-
- Path placeholders and parameter rows are 1:1 matched.
|
|
197
|
-
- Request/response sections use correct header mode.
|
|
198
|
-
- `No` is sequential in every table.
|
|
199
|
-
- Hierarchy columns reflect actual payload nesting.
|
|
200
|
-
- `status` and error payload structure are documented.
|
|
201
|
-
- PlantUML in `BG8` matches endpoint behavior.
|
|
202
|
-
- `History` has a new appended entry.
|
|
203
|
-
|
|
204
|
-
## 11. Known Pitfalls and Prevention
|
|
205
|
-
|
|
206
|
-
| No | Pitfall | Prevention Rule |
|
|
207
|
-
| ---: | --- | --- |
|
|
208
|
-
| 1 | Endpoint placeholder renamed but parameter rows not synced | Run path-vs-parameter check for every API sheet |
|
|
209
|
-
| 2 | Request/response headers mixed (`Note` vs `Required`) | Use section-specific header mode only |
|
|
210
|
-
| 3 | Nested array fields placed at wrong hierarchy level | Define parent array first, then child fields deeper |
|
|
211
|
-
| 4 | Endpoint summary mismatch between top and contract blocks | Maintain a single canonical endpoint title string and reuse it |
|
|
10
|
+
Use that file for:
|
|
11
|
+
- API design detail markdown structure
|
|
12
|
+
- flowchart integration and synchronization rules
|
|
13
|
+
- error section rules
|
|
14
|
+
- flow summary / notes / login rules
|
|
212
15
|
|
|
16
|
+
This compatibility note should remain only until all references are migrated.
|