sdtk-kit 0.3.1 → 0.3.3
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/README.md +5 -2
- package/assets/manifest/toolkit-bundle.manifest.json +138 -38
- package/assets/manifest/toolkit-bundle.sha256.txt +37 -17
- package/assets/toolkit/toolkit/AGENTS.md +20 -14
- package/assets/toolkit/toolkit/install.ps1 +94 -3
- package/assets/toolkit/toolkit/runtimes/claude/CLAUDE_TEMPLATE.md +32 -10
- 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/skills-claude/api-design-spec/SKILL.md +76 -0
- package/assets/toolkit/toolkit/skills-claude/api-doc/SKILL.md +46 -0
- package/assets/toolkit/toolkit/skills-claude/arch/SKILL.md +70 -0
- package/assets/toolkit/toolkit/skills-claude/ba/SKILL.md +49 -0
- package/assets/toolkit/toolkit/skills-claude/design-layout/SKILL.md +25 -0
- package/assets/toolkit/toolkit/skills-claude/dev/SKILL.md +45 -0
- package/assets/toolkit/toolkit/skills-claude/dev-backend/SKILL.md +20 -0
- package/assets/toolkit/toolkit/skills-claude/dev-frontend/SKILL.md +18 -0
- package/assets/toolkit/toolkit/skills-claude/orchestrator/SKILL.md +63 -0
- package/assets/toolkit/toolkit/skills-claude/pm/SKILL.md +52 -0
- package/assets/toolkit/toolkit/skills-claude/qa/SKILL.md +47 -0
- package/assets/toolkit/toolkit/skills-claude/screen-design-spec/SKILL.md +68 -0
- package/assets/toolkit/toolkit/skills-claude/test-case-spec/SKILL.md +63 -0
- package/assets/toolkit/toolkit/templates/README.md +3 -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/package.json +44 -45
- package/src/commands/help.js +1 -1
package/README.md
CHANGED
|
@@ -16,7 +16,7 @@ npm link
|
|
|
16
16
|
|
|
17
17
|
```bash
|
|
18
18
|
# 1. Initialize workspace with runtime adapter
|
|
19
|
-
sdtk init --runtime
|
|
19
|
+
sdtk init --runtime claude
|
|
20
20
|
|
|
21
21
|
# 2. Store GitHub token for entitlement
|
|
22
22
|
sdtk auth --token ghp_xxxxxxxxxxxx
|
|
@@ -24,6 +24,9 @@ sdtk auth --verify
|
|
|
24
24
|
|
|
25
25
|
# 3. Generate feature documentation (17 files)
|
|
26
26
|
sdtk generate --feature-key USER_PROFILE --feature-name "User Profile"
|
|
27
|
+
# Codex runtime remains available:
|
|
28
|
+
# sdtk init --runtime codex
|
|
29
|
+
|
|
27
30
|
```
|
|
28
31
|
|
|
29
32
|
## Commands
|
|
@@ -41,6 +44,7 @@ Creates:
|
|
|
41
44
|
- `sdtk.config.json` -- project configuration
|
|
42
45
|
- `sdtk.config.profiles.example.json` -- stack profile examples
|
|
43
46
|
- `CODEX.md` or `CLAUDE.md` -- runtime adapter
|
|
47
|
+
- for `--runtime claude`, local `.claude/skills` and `.claude/skills/references` are installed unless `--skip-skills` is used
|
|
44
48
|
|
|
45
49
|
### `sdtk auth`
|
|
46
50
|
|
|
@@ -128,4 +132,3 @@ npm run verify:payload
|
|
|
128
132
|
# Smoke test npm pack
|
|
129
133
|
npm run pack:smoke
|
|
130
134
|
```
|
|
131
|
-
|
|
@@ -1,20 +1,20 @@
|
|
|
1
1
|
{
|
|
2
|
-
"buildTimestamp": "2026-03-
|
|
2
|
+
"buildTimestamp": "2026-03-07T00:53:22Z",
|
|
3
3
|
"files": [
|
|
4
4
|
{
|
|
5
5
|
"path": "toolkit/AGENTS.md",
|
|
6
|
-
"sha256": "
|
|
7
|
-
"size":
|
|
6
|
+
"sha256": "868430474b46e4e8d27ed26b780a794936e84cf4f0278f2cc3d061f54877f498",
|
|
7
|
+
"size": 5113
|
|
8
8
|
},
|
|
9
9
|
{
|
|
10
10
|
"path": "toolkit/install.ps1",
|
|
11
|
-
"sha256": "
|
|
12
|
-
"size":
|
|
11
|
+
"sha256": "531da17e88a05b6946a5012f7b13a2871212df1fe0d052720f9511e02aba7e32",
|
|
12
|
+
"size": 8830
|
|
13
13
|
},
|
|
14
14
|
{
|
|
15
15
|
"path": "toolkit/runtimes/claude/CLAUDE_TEMPLATE.md",
|
|
16
|
-
"sha256": "
|
|
17
|
-
"size":
|
|
16
|
+
"sha256": "0f3e0bfe1b5165250f0da4da5790a9e6220023752713088a0076eb7f17fd6397",
|
|
17
|
+
"size": 1933
|
|
18
18
|
},
|
|
19
19
|
{
|
|
20
20
|
"path": "toolkit/runtimes/codex/CODEX_TEMPLATE.md",
|
|
@@ -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",
|
|
@@ -186,20 +211,90 @@
|
|
|
186
211
|
"sha256": "72ca16e07c286910333243954610e116217ca2abb3a5e276cbe91e92eb826ad5",
|
|
187
212
|
"size": 2652
|
|
188
213
|
},
|
|
214
|
+
{
|
|
215
|
+
"path": "toolkit/skills-claude/api-design-spec/SKILL.md",
|
|
216
|
+
"sha256": "123873681ff65792a9a269b264155c65a5feb68b23e4eeb1e68cb7da1a137d54",
|
|
217
|
+
"size": 3252
|
|
218
|
+
},
|
|
219
|
+
{
|
|
220
|
+
"path": "toolkit/skills-claude/api-doc/SKILL.md",
|
|
221
|
+
"sha256": "57176bb3d74e19ef5feb1a8d59d8c7c1714634f67e1d51bf4667d3f189093319",
|
|
222
|
+
"size": 2240
|
|
223
|
+
},
|
|
224
|
+
{
|
|
225
|
+
"path": "toolkit/skills-claude/arch/SKILL.md",
|
|
226
|
+
"sha256": "5ab03dc8a928c6528d1ccaad427a15c686427e8fd9114421da495d9223652337",
|
|
227
|
+
"size": 4108
|
|
228
|
+
},
|
|
229
|
+
{
|
|
230
|
+
"path": "toolkit/skills-claude/ba/SKILL.md",
|
|
231
|
+
"sha256": "1956fd69ff1a0adb54c8abbf06b37bd5c21b7f0ca597b6d8b94dfed0606cd2e4",
|
|
232
|
+
"size": 2551
|
|
233
|
+
},
|
|
234
|
+
{
|
|
235
|
+
"path": "toolkit/skills-claude/design-layout/SKILL.md",
|
|
236
|
+
"sha256": "9765f229108c5aff27457489707218570ad83dc362353a79c2f5a78607adf4de",
|
|
237
|
+
"size": 840
|
|
238
|
+
},
|
|
239
|
+
{
|
|
240
|
+
"path": "toolkit/skills-claude/dev/SKILL.md",
|
|
241
|
+
"sha256": "cea9f6512bc805d5b22a84a4ef8dbd229b4f7a3f073f9e125e933e6e79a206d5",
|
|
242
|
+
"size": 2505
|
|
243
|
+
},
|
|
244
|
+
{
|
|
245
|
+
"path": "toolkit/skills-claude/dev-backend/SKILL.md",
|
|
246
|
+
"sha256": "142a8fe088a4b0326ca79e00200cb5f562c53728b7adc83e6b749db6e29f1d0d",
|
|
247
|
+
"size": 841
|
|
248
|
+
},
|
|
249
|
+
{
|
|
250
|
+
"path": "toolkit/skills-claude/dev-frontend/SKILL.md",
|
|
251
|
+
"sha256": "1631bd51bc3d0106c18f4c00412f6279626bdce9f0e310822d5dcdff08063a88",
|
|
252
|
+
"size": 800
|
|
253
|
+
},
|
|
254
|
+
{
|
|
255
|
+
"path": "toolkit/skills-claude/orchestrator/SKILL.md",
|
|
256
|
+
"sha256": "c8e8303f1833e71cacdf20b1f398e476b44b3de14fbffad9a404c2a68fa713a3",
|
|
257
|
+
"size": 4046
|
|
258
|
+
},
|
|
259
|
+
{
|
|
260
|
+
"path": "toolkit/skills-claude/pm/SKILL.md",
|
|
261
|
+
"sha256": "b34621fe61957e573c616ad816d591a60a6c8d1333d0bfb71f39f45b93331cb0",
|
|
262
|
+
"size": 3043
|
|
263
|
+
},
|
|
264
|
+
{
|
|
265
|
+
"path": "toolkit/skills-claude/qa/SKILL.md",
|
|
266
|
+
"sha256": "eb0a540d28144855b5026e7b40ce965c4049a9b56f6e7ffd9732964006f63d1a",
|
|
267
|
+
"size": 2687
|
|
268
|
+
},
|
|
269
|
+
{
|
|
270
|
+
"path": "toolkit/skills-claude/screen-design-spec/SKILL.md",
|
|
271
|
+
"sha256": "5686da60872f1a3c6791e9a740897d4a564f40d53d54902a47fbc3165e68a1ec",
|
|
272
|
+
"size": 3261
|
|
273
|
+
},
|
|
274
|
+
{
|
|
275
|
+
"path": "toolkit/skills-claude/test-case-spec/SKILL.md",
|
|
276
|
+
"sha256": "efd43e2087961f4e30177144c42e06b6c9b3d73f9533dad34f9ce1284fcdf126",
|
|
277
|
+
"size": 2625
|
|
278
|
+
},
|
|
189
279
|
{
|
|
190
280
|
"path": "toolkit/templates/docs/api/API_DESIGN_CREATION_RULES.md",
|
|
191
|
-
"sha256": "
|
|
192
|
-
"size":
|
|
281
|
+
"sha256": "9adf1e46833411a861fb7426c37baac69689b9e3120a8ed1e4a3224de44a8dd2",
|
|
282
|
+
"size": 634
|
|
193
283
|
},
|
|
194
284
|
{
|
|
195
285
|
"path": "toolkit/templates/docs/api/API_DESIGN_DETAIL_TEMPLATE.md",
|
|
196
|
-
"sha256": "
|
|
197
|
-
"size":
|
|
286
|
+
"sha256": "d2aa0ee3a7c5351700b3bffb4ba66e8056ed955f55903c744c694624730038cb",
|
|
287
|
+
"size": 1181
|
|
288
|
+
},
|
|
289
|
+
{
|
|
290
|
+
"path": "toolkit/templates/docs/api/API_DESIGN_FLOWCHART_CREATION_RULES.md",
|
|
291
|
+
"sha256": "13f26a3307894b9bfb570d75f6db4ccb61104064d19661ec2a26a1b9984f4c97",
|
|
292
|
+
"size": 12827
|
|
198
293
|
},
|
|
199
294
|
{
|
|
200
295
|
"path": "toolkit/templates/docs/api/API_ENDPOINTS_TEMPLATE.md",
|
|
201
|
-
"sha256": "
|
|
202
|
-
"size":
|
|
296
|
+
"sha256": "7dd9840e7a9c268fd7671791c0e80cfbcf54c3c2ff8bbacd85e44662f238ac9c",
|
|
297
|
+
"size": 5102
|
|
203
298
|
},
|
|
204
299
|
{
|
|
205
300
|
"path": "toolkit/templates/docs/api/feature_api_flow_list_TEMPLATE.txt",
|
|
@@ -213,8 +308,13 @@
|
|
|
213
308
|
},
|
|
214
309
|
{
|
|
215
310
|
"path": "toolkit/templates/docs/api/FLOWCHART_CREATION_RULES.md",
|
|
216
|
-
"sha256": "
|
|
217
|
-
"size":
|
|
311
|
+
"sha256": "decffe52425e22b3dd82e9c8f3768aefbb209ec58237107d84f583fee876ea8f",
|
|
312
|
+
"size": 791
|
|
313
|
+
},
|
|
314
|
+
{
|
|
315
|
+
"path": "toolkit/templates/docs/api/YAML_CREATION_RULES.md",
|
|
316
|
+
"sha256": "f29c6774019ef0789dfb88678e1ab31d4d8eb7b3ab69b2115368ef5d879e5276",
|
|
317
|
+
"size": 5997
|
|
218
318
|
},
|
|
219
319
|
{
|
|
220
320
|
"path": "toolkit/templates/docs/architecture/ARCH_DESIGN_TEMPLATE.md",
|
|
@@ -288,8 +388,8 @@
|
|
|
288
388
|
},
|
|
289
389
|
{
|
|
290
390
|
"path": "toolkit/templates/README.md",
|
|
291
|
-
"sha256": "
|
|
292
|
-
"size":
|
|
391
|
+
"sha256": "0ccb7a0509cf92aa91ebea95996dfffd5b52edd6ab4bbefbb827e4ed495abc31",
|
|
392
|
+
"size": 2683
|
|
293
393
|
},
|
|
294
394
|
{
|
|
295
395
|
"path": "toolkit/templates/SHARED_PLANNING.md",
|
|
@@ -297,7 +397,7 @@
|
|
|
297
397
|
"size": 3255
|
|
298
398
|
}
|
|
299
399
|
],
|
|
300
|
-
"sourceCommit": "
|
|
301
|
-
"version": "0.3.
|
|
302
|
-
"fileCount":
|
|
400
|
+
"sourceCommit": "4437ad41659a38e9e80dcbf32cb03f9b6df64e0d",
|
|
401
|
+
"version": "0.3.3",
|
|
402
|
+
"fileCount": 79
|
|
303
403
|
}
|
|
@@ -1,22 +1,27 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
1
|
+
868430474b46e4e8d27ed26b780a794936e84cf4f0278f2cc3d061f54877f498 toolkit/AGENTS.md
|
|
2
|
+
531da17e88a05b6946a5012f7b13a2871212df1fe0d052720f9511e02aba7e32 toolkit/install.ps1
|
|
3
|
+
0f3e0bfe1b5165250f0da4da5790a9e6220023752713088a0076eb7f17fd6397 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,12 +40,27 @@ 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
|
+
123873681ff65792a9a269b264155c65a5feb68b23e4eeb1e68cb7da1a137d54 toolkit/skills-claude/api-design-spec/SKILL.md
|
|
44
|
+
57176bb3d74e19ef5feb1a8d59d8c7c1714634f67e1d51bf4667d3f189093319 toolkit/skills-claude/api-doc/SKILL.md
|
|
45
|
+
5ab03dc8a928c6528d1ccaad427a15c686427e8fd9114421da495d9223652337 toolkit/skills-claude/arch/SKILL.md
|
|
46
|
+
1956fd69ff1a0adb54c8abbf06b37bd5c21b7f0ca597b6d8b94dfed0606cd2e4 toolkit/skills-claude/ba/SKILL.md
|
|
47
|
+
9765f229108c5aff27457489707218570ad83dc362353a79c2f5a78607adf4de toolkit/skills-claude/design-layout/SKILL.md
|
|
48
|
+
cea9f6512bc805d5b22a84a4ef8dbd229b4f7a3f073f9e125e933e6e79a206d5 toolkit/skills-claude/dev/SKILL.md
|
|
49
|
+
142a8fe088a4b0326ca79e00200cb5f562c53728b7adc83e6b749db6e29f1d0d toolkit/skills-claude/dev-backend/SKILL.md
|
|
50
|
+
1631bd51bc3d0106c18f4c00412f6279626bdce9f0e310822d5dcdff08063a88 toolkit/skills-claude/dev-frontend/SKILL.md
|
|
51
|
+
c8e8303f1833e71cacdf20b1f398e476b44b3de14fbffad9a404c2a68fa713a3 toolkit/skills-claude/orchestrator/SKILL.md
|
|
52
|
+
b34621fe61957e573c616ad816d591a60a6c8d1333d0bfb71f39f45b93331cb0 toolkit/skills-claude/pm/SKILL.md
|
|
53
|
+
eb0a540d28144855b5026e7b40ce965c4049a9b56f6e7ffd9732964006f63d1a toolkit/skills-claude/qa/SKILL.md
|
|
54
|
+
5686da60872f1a3c6791e9a740897d4a564f40d53d54902a47fbc3165e68a1ec toolkit/skills-claude/screen-design-spec/SKILL.md
|
|
55
|
+
efd43e2087961f4e30177144c42e06b6c9b3d73f9533dad34f9ce1284fcdf126 toolkit/skills-claude/test-case-spec/SKILL.md
|
|
56
|
+
9adf1e46833411a861fb7426c37baac69689b9e3120a8ed1e4a3224de44a8dd2 toolkit/templates/docs/api/API_DESIGN_CREATION_RULES.md
|
|
57
|
+
d2aa0ee3a7c5351700b3bffb4ba66e8056ed955f55903c744c694624730038cb toolkit/templates/docs/api/API_DESIGN_DETAIL_TEMPLATE.md
|
|
58
|
+
13f26a3307894b9bfb570d75f6db4ccb61104064d19661ec2a26a1b9984f4c97 toolkit/templates/docs/api/API_DESIGN_FLOWCHART_CREATION_RULES.md
|
|
59
|
+
7dd9840e7a9c268fd7671791c0e80cfbcf54c3c2ff8bbacd85e44662f238ac9c toolkit/templates/docs/api/API_ENDPOINTS_TEMPLATE.md
|
|
41
60
|
56e2b2a150ff737b856bb75e58fea603d09fe5c26d9fe5d5ea0516b4eb4703e8 toolkit/templates/docs/api/feature_api_flow_list_TEMPLATE.txt
|
|
42
61
|
7a86c642f2d5826b2ce76fddb8ed0bcb300af4eb654e70e16576057927654d7a toolkit/templates/docs/api/FEATURE_API_TEMPLATE.yaml
|
|
43
|
-
|
|
62
|
+
decffe52425e22b3dd82e9c8f3768aefbb209ec58237107d84f583fee876ea8f toolkit/templates/docs/api/FLOWCHART_CREATION_RULES.md
|
|
63
|
+
f29c6774019ef0789dfb88678e1ab31d4d8eb7b3ab69b2115368ef5d879e5276 toolkit/templates/docs/api/YAML_CREATION_RULES.md
|
|
44
64
|
bc32ad83f06dc60ada7312f8d05f56b12da2d5e99c275fbc7895cf1e34a6c358 toolkit/templates/docs/architecture/ARCH_DESIGN_TEMPLATE.md
|
|
45
65
|
d4cec8811e2a336a0ab8dd6e68998753cf7eca927207cdb8afc20666a5c452f7 toolkit/templates/docs/database/DATABASE_SPEC_TEMPLATE.md
|
|
46
66
|
26fc80a5bced4b67debea943a49c729532a576146a81994f7e28615c3debe681 toolkit/templates/docs/design/DESIGN_LAYOUT_TEMPLATE.md
|
|
@@ -55,5 +75,5 @@ e8d3554fc4893a8a57fbf006e58f37f21347de5f31ce02f0717e97d29b387eea toolkit/templa
|
|
|
55
75
|
b1ed7f7cad8f4098bd305fa9aaea6cdf1c78cf909284547baa50235fa677d8c0 toolkit/templates/docs/specs/FLOW_ACTION_SPEC_CREATION_RULES.md
|
|
56
76
|
afa6ac33875037495e28238a2c3fae2f4dcbb12f318c3cec0696fe45465cdf2a toolkit/templates/docs/specs/FLOW_ACTION_SPEC_TEMPLATE.md
|
|
57
77
|
f9dc0d49ceeeb8814d77670e43f09b5221f46d406fb1e89eb575c1ab39bc022a toolkit/templates/QUALITY_CHECKLIST.md
|
|
58
|
-
|
|
78
|
+
0ccb7a0509cf92aa91ebea95996dfffd5b52edd6ab4bbefbb827e4ed495abc31 toolkit/templates/README.md
|
|
59
79
|
2b5d4d10019e3c9b3219d92b8123acc85872d9c76230107206e7a270a5ece5a2 toolkit/templates/SHARED_PLANNING.md
|
|
@@ -59,9 +59,9 @@ Notes:
|
|
|
59
59
|
## 5) Feature Bootstrap
|
|
60
60
|
Run from project root:
|
|
61
61
|
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
62
|
+
```
|
|
63
|
+
sdtk generate --feature-key YOUR_FEATURE --feature-name "Your Feature"
|
|
64
|
+
```
|
|
65
65
|
|
|
66
66
|
## 6) ARCH Deliverables (Extended)
|
|
67
67
|
In addition to `ARCH_DESIGN`, ARCH may generate:
|
|
@@ -90,14 +90,20 @@ In addition to `ARCH_DESIGN`, ARCH may generate:
|
|
|
90
90
|
- `off`: skip unless explicitly requested.
|
|
91
91
|
|
|
92
92
|
## 7) Mandatory Rule References
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
-
|
|
100
|
-
|
|
101
|
-
-
|
|
102
|
-
|
|
103
|
-
|
|
93
|
+
Rule files are installed locally by the runtime. Skills resolve these at:
|
|
94
|
+
- Claude Code: `.claude/skills/references/`
|
|
95
|
+
- Codex: `$CODEX_HOME/skills/<skill>/references/`
|
|
96
|
+
|
|
97
|
+
Available rule files:
|
|
98
|
+
- `YAML_CREATION_RULES.md` — API YAML docs
|
|
99
|
+
- `API_DESIGN_FLOWCHART_CREATION_RULES.md` — API design detail + flow docs
|
|
100
|
+
- `FLOWCHART_CREATION_RULES.md` — Flowchart (legacy compat)
|
|
101
|
+
- `API_DESIGN_CREATION_RULES.md` — API design (legacy compat)
|
|
102
|
+
- `FLOW_ACTION_SPEC_CREATION_RULES.md` — Screen flow-action specs
|
|
103
|
+
- `TEST_CASE_CREATION_RULES.md` — QA test-case specs
|
|
104
|
+
- `numbering-rules.md` — Flow-action numbering policy
|
|
105
|
+
- `figma-mcp.md` — Figma MCP integration
|
|
106
|
+
- `excel-image-export.md` — Excel image export
|
|
107
|
+
|
|
108
|
+
Flow-action numbering policy:
|
|
109
|
+
- Use one global numbering mode for the whole document (no per-screen reset).
|
|
@@ -80,6 +80,94 @@ function Install-RuntimeAdapter {
|
|
|
80
80
|
throw "Unsupported runtime: $RuntimeName"
|
|
81
81
|
}
|
|
82
82
|
|
|
83
|
+
function Install-ClaudeSkills {
|
|
84
|
+
param(
|
|
85
|
+
[Parameter(Mandatory = $true)][string]$ToolkitRoot,
|
|
86
|
+
[Parameter(Mandatory = $true)][string]$ProjectRoot,
|
|
87
|
+
[Parameter(Mandatory = $true)][bool]$Overwrite
|
|
88
|
+
)
|
|
89
|
+
|
|
90
|
+
$skillsSource = Join-Path $ToolkitRoot 'skills-claude'
|
|
91
|
+
$skillsDest = Join-Path $ProjectRoot '.claude/skills'
|
|
92
|
+
|
|
93
|
+
if (-not (Test-Path -LiteralPath $skillsSource)) {
|
|
94
|
+
throw "Claude skills source not found: $skillsSource"
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
$skillCount = 0
|
|
98
|
+
foreach ($skillDir in (Get-ChildItem -Path $skillsSource -Directory)) {
|
|
99
|
+
$srcFile = Join-Path $skillDir.FullName 'SKILL.md'
|
|
100
|
+
if (-not (Test-Path -LiteralPath $srcFile)) { continue }
|
|
101
|
+
|
|
102
|
+
$destFile = Join-Path $skillsDest "$($skillDir.Name)/SKILL.md"
|
|
103
|
+
Copy-File -SourcePath $srcFile -DestinationPath $destFile -Overwrite $Overwrite
|
|
104
|
+
$skillCount++
|
|
105
|
+
}
|
|
106
|
+
|
|
107
|
+
# Install reference files
|
|
108
|
+
$refDest = Join-Path $skillsDest 'references'
|
|
109
|
+
if (-not (Test-Path -LiteralPath $refDest)) {
|
|
110
|
+
New-Item -ItemType Directory -Force -Path $refDest | Out-Null
|
|
111
|
+
}
|
|
112
|
+
|
|
113
|
+
$refCount = 0
|
|
114
|
+
$missingRefs = @()
|
|
115
|
+
|
|
116
|
+
# 6 files from toolkit/templates/docs/
|
|
117
|
+
$templateRefs = @(
|
|
118
|
+
@{ Src = 'templates/docs/api/YAML_CREATION_RULES.md' },
|
|
119
|
+
@{ Src = 'templates/docs/api/API_DESIGN_FLOWCHART_CREATION_RULES.md' },
|
|
120
|
+
@{ Src = 'templates/docs/api/FLOWCHART_CREATION_RULES.md' },
|
|
121
|
+
@{ Src = 'templates/docs/api/API_DESIGN_CREATION_RULES.md' },
|
|
122
|
+
@{ Src = 'templates/docs/specs/FLOW_ACTION_SPEC_CREATION_RULES.md' },
|
|
123
|
+
@{ Src = 'templates/docs/qa/TEST_CASE_CREATION_RULES.md' }
|
|
124
|
+
)
|
|
125
|
+
|
|
126
|
+
foreach ($ref in $templateRefs) {
|
|
127
|
+
$srcPath = Join-Path $ToolkitRoot $ref.Src
|
|
128
|
+
$fileName = Split-Path -Leaf $srcPath
|
|
129
|
+
$destPath = Join-Path $refDest $fileName
|
|
130
|
+
if (Test-Path -LiteralPath $srcPath) {
|
|
131
|
+
Copy-File -SourcePath $srcPath -DestinationPath $destPath -Overwrite $Overwrite
|
|
132
|
+
$refCount++
|
|
133
|
+
} else {
|
|
134
|
+
$missingRefs += $srcPath
|
|
135
|
+
}
|
|
136
|
+
}
|
|
137
|
+
|
|
138
|
+
# 3 files from toolkit/skills/sdtk-screen-design-spec/references/
|
|
139
|
+
$screenRefs = @('numbering-rules.md', 'figma-mcp.md', 'excel-image-export.md')
|
|
140
|
+
foreach ($fileName in $screenRefs) {
|
|
141
|
+
$srcPath = Join-Path $ToolkitRoot "skills/sdtk-screen-design-spec/references/$fileName"
|
|
142
|
+
$destPath = Join-Path $refDest $fileName
|
|
143
|
+
if (Test-Path -LiteralPath $srcPath) {
|
|
144
|
+
Copy-File -SourcePath $srcPath -DestinationPath $destPath -Overwrite $Overwrite
|
|
145
|
+
$refCount++
|
|
146
|
+
} else {
|
|
147
|
+
$missingRefs += $srcPath
|
|
148
|
+
}
|
|
149
|
+
}
|
|
150
|
+
|
|
151
|
+
# Fail-fast: abort if any reference files are missing
|
|
152
|
+
if ($missingRefs.Count -gt 0) {
|
|
153
|
+
$list = ($missingRefs | ForEach-Object { " - $_" }) -join "`n"
|
|
154
|
+
throw "Claude install failed. Missing reference files:`n$list"
|
|
155
|
+
}
|
|
156
|
+
|
|
157
|
+
# Strict count assertions
|
|
158
|
+
$expectedSkills = 13
|
|
159
|
+
$expectedRefs = 9
|
|
160
|
+
if ($skillCount -ne $expectedSkills) {
|
|
161
|
+
throw "Claude install failed. Expected $expectedSkills skills but installed $skillCount."
|
|
162
|
+
}
|
|
163
|
+
if ($refCount -ne $expectedRefs) {
|
|
164
|
+
throw "Claude install failed. Expected $expectedRefs reference files but installed $refCount."
|
|
165
|
+
}
|
|
166
|
+
|
|
167
|
+
Write-Host " Skills installed: $skillCount"
|
|
168
|
+
Write-Host " Reference files : $refCount"
|
|
169
|
+
}
|
|
170
|
+
|
|
83
171
|
$toolkitRoot = Resolve-Path $PSScriptRoot
|
|
84
172
|
$canonicalRulesPath = Join-Path $toolkitRoot 'templates/docs/api/FLOWCHART_CREATION_RULES.md'
|
|
85
173
|
$canonicalRulesHash = Get-FileSha256 -Path $canonicalRulesPath
|
|
@@ -136,8 +224,10 @@ if (($Runtime -eq 'codex') -and (-not $SkipSkills)) {
|
|
|
136
224
|
& $skillInstaller | Out-Host
|
|
137
225
|
}
|
|
138
226
|
}
|
|
139
|
-
elseif (($Runtime -eq 'claude') -and (-not $SkipSkills)
|
|
140
|
-
Write-
|
|
227
|
+
elseif (($Runtime -eq 'claude') -and (-not $SkipSkills)) {
|
|
228
|
+
Write-Host ""
|
|
229
|
+
Write-Host "Installing Claude Code skills..."
|
|
230
|
+
Install-ClaudeSkills -ToolkitRoot $toolkitRoot -ProjectRoot $projectRoot -Overwrite ([bool]$Force)
|
|
141
231
|
}
|
|
142
232
|
|
|
143
233
|
if (-not $Quiet) {
|
|
@@ -148,7 +238,8 @@ if (-not $Quiet) {
|
|
|
148
238
|
if ($Runtime -eq 'codex') {
|
|
149
239
|
Write-Host "2) Restart Codex (to load runtime adapter and skills)"
|
|
150
240
|
} else {
|
|
151
|
-
Write-Host "2) Restart Claude Code (to load CLAUDE.md
|
|
241
|
+
Write-Host "2) Restart Claude Code (to load CLAUDE.md + skills)"
|
|
242
|
+
Write-Host " Commands: /orchestrator /pm /ba /arch /dev /qa"
|
|
152
243
|
}
|
|
153
244
|
Write-Host '3) Generate feature docs:'
|
|
154
245
|
Write-Host ' sdtk generate --feature-key YOUR_FEATURE --feature-name "Your Feature"'
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# CLAUDE.md
|
|
2
2
|
|
|
3
|
-
Version:
|
|
4
|
-
Last Updated: 2026-
|
|
3
|
+
Version: 2.0
|
|
4
|
+
Last Updated: 2026-03-05
|
|
5
5
|
Owner: SDTK Core Team
|
|
6
6
|
|
|
7
7
|
This file defines runtime guidance for Claude Code sessions in projects using SDTK.
|
|
@@ -9,24 +9,46 @@ This file defines runtime guidance for Claude Code sessions in projects using SD
|
|
|
9
9
|
## 1) Rule Priority
|
|
10
10
|
1. Explicit user request
|
|
11
11
|
2. `AGENTS.md` (project root)
|
|
12
|
-
3.
|
|
12
|
+
3. Installed skill content (`.claude/skills/*/SKILL.md`)
|
|
13
13
|
4. This file (`CLAUDE.md`)
|
|
14
|
-
5.
|
|
14
|
+
5. `sdtk.config.json`
|
|
15
15
|
|
|
16
16
|
## 2) Runtime Model
|
|
17
17
|
- Primary workflow: PM -> BA -> ARCH -> DEV -> QA
|
|
18
|
-
-
|
|
18
|
+
- Entry point: `/orchestrator` (recommended) or `/pm`
|
|
19
|
+
- Role commands: `/pm`, `/ba`, `/arch`, `/dev`, `/qa`
|
|
20
|
+
- Sub-skill commands: `/api-doc`, `/api-design-spec`, `/screen-design-spec`, `/design-layout`, `/test-case-spec`, `/dev-backend`, `/dev-frontend`
|
|
19
21
|
- Shared state files:
|
|
20
22
|
- `SHARED_PLANNING.md`
|
|
21
23
|
- `QUALITY_CHECKLIST.md`
|
|
22
24
|
|
|
23
25
|
## 3) Minimal Session Flow
|
|
24
|
-
1. Start with `/pm` to define feature scope.
|
|
26
|
+
1. Start with `/orchestrator` or `/pm` to define feature scope.
|
|
25
27
|
2. Move phase-by-phase without skipping gates.
|
|
26
28
|
3. Keep traceability from requirements to design, implementation, and tests.
|
|
27
29
|
4. Require code review completion before QA release decision.
|
|
28
30
|
|
|
29
|
-
## 4)
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
31
|
+
## 4) Installed Skills
|
|
32
|
+
Skills are installed at `.claude/skills/` and provide slash commands:
|
|
33
|
+
|
|
34
|
+
| Command | Purpose |
|
|
35
|
+
|---------|---------|
|
|
36
|
+
| `/orchestrator` | Full 6-phase SDLC orchestration |
|
|
37
|
+
| `/pm` | PM initiation + planning |
|
|
38
|
+
| `/ba` | Business analysis |
|
|
39
|
+
| `/arch` | Solution architecture |
|
|
40
|
+
| `/dev` | Development + code review |
|
|
41
|
+
| `/qa` | QA testing + release decision |
|
|
42
|
+
| `/api-doc` | OpenAPI YAML + flow diagrams |
|
|
43
|
+
| `/api-design-spec` | API design detail spec |
|
|
44
|
+
| `/screen-design-spec` | Screen flow-action spec |
|
|
45
|
+
| `/design-layout` | UI screen layout wireframes |
|
|
46
|
+
| `/test-case-spec` | QA test-case spec |
|
|
47
|
+
| `/dev-backend` | Backend code conventions |
|
|
48
|
+
| `/dev-frontend` | Frontend code conventions |
|
|
49
|
+
|
|
50
|
+
Rule reference files are installed at `.claude/skills/references/`.
|
|
51
|
+
|
|
52
|
+
## 5) References
|
|
53
|
+
- `sdtk.config.json`
|
|
54
|
+
- `.claude/skills/references/` (rule files)
|
|
@@ -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
|
-
|