sdtk-kit 0.3.6 → 0.3.8
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 +10 -1
- package/assets/manifest/toolkit-bundle.manifest.json +116 -56
- package/assets/manifest/toolkit-bundle.sha256.txt +38 -26
- package/assets/toolkit/toolkit/AGENTS.md +31 -9
- package/assets/toolkit/toolkit/skills/sdtk-api-design-spec/SKILL.md +4 -0
- package/assets/toolkit/toolkit/skills/sdtk-api-design-spec/references/API_DESIGN_CREATION_RULES.md +7 -1
- package/assets/toolkit/toolkit/skills/sdtk-api-design-spec/references/API_DESIGN_FLOWCHART_CREATION_RULES.md +17 -0
- package/assets/toolkit/toolkit/skills/sdtk-api-doc/SKILL.md +4 -0
- package/assets/toolkit/toolkit/skills/sdtk-api-doc/references/API_DESIGN_FLOWCHART_CREATION_RULES.md +17 -0
- package/assets/toolkit/toolkit/skills/sdtk-arch/SKILL.md +34 -2
- package/assets/toolkit/toolkit/skills/sdtk-arch/references/API_DESIGN_CREATION_RULES.md +7 -1
- package/assets/toolkit/toolkit/skills/sdtk-arch/references/API_DESIGN_FLOWCHART_CREATION_RULES.md +17 -0
- package/assets/toolkit/toolkit/skills/sdtk-arch/references/FLOW_ACTION_SPEC_CREATION_RULES.md +56 -9
- package/assets/toolkit/toolkit/skills/sdtk-ba/SKILL.md +4 -0
- package/assets/toolkit/toolkit/skills/sdtk-design-layout/SKILL.md +20 -0
- package/assets/toolkit/toolkit/skills/sdtk-design-layout/scripts/render_design_layout_images.py +213 -0
- package/assets/toolkit/toolkit/skills/sdtk-dev/SKILL.md +75 -5
- package/assets/toolkit/toolkit/skills/sdtk-dev/prompts/code-quality-reviewer.md +35 -0
- package/assets/toolkit/toolkit/skills/sdtk-dev/prompts/implementer.md +61 -0
- package/assets/toolkit/toolkit/skills/sdtk-dev/prompts/spec-reviewer.md +42 -0
- package/assets/toolkit/toolkit/skills/sdtk-dev-backend/SKILL.md +4 -0
- package/assets/toolkit/toolkit/skills/sdtk-dev-frontend/SKILL.md +4 -0
- package/assets/toolkit/toolkit/skills/sdtk-orchestrator/SKILL.md +38 -2
- package/assets/toolkit/toolkit/skills/sdtk-pm/SKILL.md +4 -0
- package/assets/toolkit/toolkit/skills/sdtk-qa/SKILL.md +36 -6
- package/assets/toolkit/toolkit/skills/sdtk-screen-design-spec/SKILL.md +10 -3
- package/assets/toolkit/toolkit/skills/sdtk-screen-design-spec/references/FLOW_ACTION_SPEC_CREATION_RULES.md +56 -9
- package/assets/toolkit/toolkit/skills/sdtk-test-case-spec/SKILL.md +11 -0
- package/assets/toolkit/toolkit/skills/skills.catalog.yaml +302 -0
- package/assets/toolkit/toolkit/templates/docs/api/API_DESIGN_CREATION_RULES.md +7 -1
- package/assets/toolkit/toolkit/templates/docs/api/API_DESIGN_DETAIL_TEMPLATE.md +6 -0
- package/assets/toolkit/toolkit/templates/docs/api/API_DESIGN_FLOWCHART_CREATION_RULES.md +17 -0
- package/assets/toolkit/toolkit/templates/docs/specs/FLOW_ACTION_SPEC_CREATION_RULES.md +56 -9
- package/assets/toolkit/toolkit/templates/docs/specs/FLOW_ACTION_SPEC_TEMPLATE.md +14 -2
- package/assets/toolkit/toolkit/templates/handoffs/ARCH_TO_DEV.md +31 -0
- package/assets/toolkit/toolkit/templates/handoffs/BA_TO_ARCH.md +28 -0
- package/assets/toolkit/toolkit/templates/handoffs/DEV_STAGE1_SPEC_REVIEW.md +26 -0
- package/assets/toolkit/toolkit/templates/handoffs/DEV_STAGE2_CODE_QUALITY_REVIEW.md +20 -0
- package/assets/toolkit/toolkit/templates/handoffs/DEV_TO_QA.md +23 -0
- package/assets/toolkit/toolkit/templates/handoffs/PM_TO_BA.md +26 -0
- package/assets/toolkit/toolkit/templates/handoffs/QA_RELEASE_DECISION.md +21 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,6 +4,10 @@ SDTK CLI -- deterministic documentation toolkit for software teams.
|
|
|
4
4
|
|
|
5
5
|
Wraps the SDTK PowerShell toolkit for portable, reproducible feature documentation scaffolding.
|
|
6
6
|
|
|
7
|
+
Canonical install/runtime source in the source repo: `governance/ai/cli/SDTK_RUNTIME_AND_FEATURE_STATUS.md`
|
|
8
|
+
|
|
9
|
+
Generated skills include verification gates and two-stage review hard gates. The current source baseline also ships a canonical skill catalog, handoff templates, public example packs, and a runtime readiness audit. See `toolkit/SDTK_TOOLKIT.md` for workflow quality contracts.
|
|
10
|
+
|
|
7
11
|
## Install
|
|
8
12
|
|
|
9
13
|
```bash
|
|
@@ -22,13 +26,15 @@ sdtk init --runtime claude
|
|
|
22
26
|
sdtk auth --token ghp_xxxxxxxxxxxx
|
|
23
27
|
sdtk auth --verify
|
|
24
28
|
|
|
25
|
-
# 3. Generate feature documentation (17
|
|
29
|
+
# 3. Generate feature documentation (17-file scaffold)
|
|
26
30
|
sdtk generate --feature-key USER_PROFILE --feature-name "User Profile"
|
|
27
31
|
# Codex runtime remains available:
|
|
28
32
|
# sdtk init --runtime codex
|
|
29
33
|
|
|
30
34
|
```
|
|
31
35
|
|
|
36
|
+
The CLI generates the scaffold contract only. Full content enrichment still runs phase-by-phase through PM, BA, ARCH, DEV, and QA using the installed runtime guidance plus the toolkit docs.
|
|
37
|
+
|
|
32
38
|
## Commands
|
|
33
39
|
|
|
34
40
|
### `sdtk init`
|
|
@@ -166,3 +172,6 @@ npm run verify:payload
|
|
|
166
172
|
# Smoke test npm pack
|
|
167
173
|
npm run pack:smoke
|
|
168
174
|
```
|
|
175
|
+
|
|
176
|
+
Run `tests/skill_triggering/` to validate skill routing behavior.
|
|
177
|
+
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
{
|
|
2
|
-
"version": "0.3.
|
|
3
|
-
"sourceCommit": "
|
|
4
|
-
"buildTimestamp": "2026-03-
|
|
5
|
-
"fileCount":
|
|
2
|
+
"version": "0.3.8",
|
|
3
|
+
"sourceCommit": "9753d286b48644a330683e5570ffd1b2dbe18ffe",
|
|
4
|
+
"buildTimestamp": "2026-03-19T02:33:04Z",
|
|
5
|
+
"fileCount": 93,
|
|
6
6
|
"files": [
|
|
7
7
|
{
|
|
8
8
|
"path": "toolkit/AGENTS.md",
|
|
9
|
-
"sha256": "
|
|
10
|
-
"size":
|
|
9
|
+
"sha256": "f13f557e79ead09d5f57452d5ea7cbe192d12ac0a3de138a7a1a2514e44df505",
|
|
10
|
+
"size": 6406
|
|
11
11
|
},
|
|
12
12
|
{
|
|
13
13
|
"path": "toolkit/install.ps1",
|
|
@@ -61,13 +61,13 @@
|
|
|
61
61
|
},
|
|
62
62
|
{
|
|
63
63
|
"path": "toolkit/skills/sdtk-api-design-spec/references/API_DESIGN_CREATION_RULES.md",
|
|
64
|
-
"sha256": "
|
|
65
|
-
"size":
|
|
64
|
+
"sha256": "e169500521e556036ea550d7ea61031e27646eb7f65fd4a75a6a5c03f53eabc5",
|
|
65
|
+
"size": 949
|
|
66
66
|
},
|
|
67
67
|
{
|
|
68
68
|
"path": "toolkit/skills/sdtk-api-design-spec/references/API_DESIGN_FLOWCHART_CREATION_RULES.md",
|
|
69
|
-
"sha256": "
|
|
70
|
-
"size":
|
|
69
|
+
"sha256": "d77095777dc689b545337fcdb8f61384936ed53ea9a0ca6bc8589975e284204b",
|
|
70
|
+
"size": 13406
|
|
71
71
|
},
|
|
72
72
|
{
|
|
73
73
|
"path": "toolkit/skills/sdtk-api-design-spec/references/FLOWCHART_CREATION_RULES.md",
|
|
@@ -81,13 +81,13 @@
|
|
|
81
81
|
},
|
|
82
82
|
{
|
|
83
83
|
"path": "toolkit/skills/sdtk-api-design-spec/SKILL.md",
|
|
84
|
-
"sha256": "
|
|
85
|
-
"size":
|
|
84
|
+
"sha256": "6b653f9858f5daa8ae4f2d425f28332676a60053d210aaf8ebccdadc3de9f026",
|
|
85
|
+
"size": 3857
|
|
86
86
|
},
|
|
87
87
|
{
|
|
88
88
|
"path": "toolkit/skills/sdtk-api-doc/references/API_DESIGN_FLOWCHART_CREATION_RULES.md",
|
|
89
|
-
"sha256": "
|
|
90
|
-
"size":
|
|
89
|
+
"sha256": "d77095777dc689b545337fcdb8f61384936ed53ea9a0ca6bc8589975e284204b",
|
|
90
|
+
"size": 13406
|
|
91
91
|
},
|
|
92
92
|
{
|
|
93
93
|
"path": "toolkit/skills/sdtk-api-doc/references/FLOWCHART_CREATION_RULES.md",
|
|
@@ -101,23 +101,23 @@
|
|
|
101
101
|
},
|
|
102
102
|
{
|
|
103
103
|
"path": "toolkit/skills/sdtk-api-doc/SKILL.md",
|
|
104
|
-
"sha256": "
|
|
105
|
-
"size":
|
|
104
|
+
"sha256": "dd23e42dbdbedf6d0f9f88788957ff8f7d3e6849b533c9d1a18326944dcdeda2",
|
|
105
|
+
"size": 2441
|
|
106
106
|
},
|
|
107
107
|
{
|
|
108
108
|
"path": "toolkit/skills/sdtk-arch/references/API_DESIGN_CREATION_RULES.md",
|
|
109
|
-
"sha256": "
|
|
110
|
-
"size":
|
|
109
|
+
"sha256": "e169500521e556036ea550d7ea61031e27646eb7f65fd4a75a6a5c03f53eabc5",
|
|
110
|
+
"size": 949
|
|
111
111
|
},
|
|
112
112
|
{
|
|
113
113
|
"path": "toolkit/skills/sdtk-arch/references/API_DESIGN_FLOWCHART_CREATION_RULES.md",
|
|
114
|
-
"sha256": "
|
|
115
|
-
"size":
|
|
114
|
+
"sha256": "d77095777dc689b545337fcdb8f61384936ed53ea9a0ca6bc8589975e284204b",
|
|
115
|
+
"size": 13406
|
|
116
116
|
},
|
|
117
117
|
{
|
|
118
118
|
"path": "toolkit/skills/sdtk-arch/references/FLOW_ACTION_SPEC_CREATION_RULES.md",
|
|
119
|
-
"sha256": "
|
|
120
|
-
"size":
|
|
119
|
+
"sha256": "e007db18ad55333a371be739f6ef7928316a5f6f55a9fbffcf6de9a821a02ff0",
|
|
120
|
+
"size": 10052
|
|
121
121
|
},
|
|
122
122
|
{
|
|
123
123
|
"path": "toolkit/skills/sdtk-arch/references/FLOWCHART_CREATION_RULES.md",
|
|
@@ -131,48 +131,68 @@
|
|
|
131
131
|
},
|
|
132
132
|
{
|
|
133
133
|
"path": "toolkit/skills/sdtk-arch/SKILL.md",
|
|
134
|
-
"sha256": "
|
|
135
|
-
"size":
|
|
134
|
+
"sha256": "469a274eca3ac8a353f67a6159feed430b6f14dee6f5a090248e202b51e8a5cd",
|
|
135
|
+
"size": 5078
|
|
136
136
|
},
|
|
137
137
|
{
|
|
138
138
|
"path": "toolkit/skills/sdtk-ba/SKILL.md",
|
|
139
|
-
"sha256": "
|
|
140
|
-
"size":
|
|
139
|
+
"sha256": "2548951bc437bf05066cbedb9adf71a66739eab7e4bbc920650fc9415cea6e8d",
|
|
140
|
+
"size": 1383
|
|
141
|
+
},
|
|
142
|
+
{
|
|
143
|
+
"path": "toolkit/skills/sdtk-design-layout/scripts/render_design_layout_images.py",
|
|
144
|
+
"sha256": "ee01a3daeeb4822429f4dcf530c11f15ac65df6700615beefd6c04c3fb41bbbc",
|
|
145
|
+
"size": 6832
|
|
141
146
|
},
|
|
142
147
|
{
|
|
143
148
|
"path": "toolkit/skills/sdtk-design-layout/SKILL.md",
|
|
144
|
-
"sha256": "
|
|
145
|
-
"size":
|
|
149
|
+
"sha256": "e3d739dd8167b3800075fabb4aa8458a29481b85626d8f6bb5ac2e76dd229527",
|
|
150
|
+
"size": 1928
|
|
151
|
+
},
|
|
152
|
+
{
|
|
153
|
+
"path": "toolkit/skills/sdtk-dev/prompts/code-quality-reviewer.md",
|
|
154
|
+
"sha256": "3d44bc436dab6201beeb4fed52ab3aa94791c51baca7b7b8e2e8a5ecd6c08baf",
|
|
155
|
+
"size": 1125
|
|
156
|
+
},
|
|
157
|
+
{
|
|
158
|
+
"path": "toolkit/skills/sdtk-dev/prompts/implementer.md",
|
|
159
|
+
"sha256": "9bed2859fbeee84257199e63eb471874975d26d57f5a19dcedab0c06980e24ad",
|
|
160
|
+
"size": 1844
|
|
161
|
+
},
|
|
162
|
+
{
|
|
163
|
+
"path": "toolkit/skills/sdtk-dev/prompts/spec-reviewer.md",
|
|
164
|
+
"sha256": "1dc33dd59afe48c4c78564bdb32999b9a4f34958361ad8f5580cef0e77c953ef",
|
|
165
|
+
"size": 1222
|
|
146
166
|
},
|
|
147
167
|
{
|
|
148
168
|
"path": "toolkit/skills/sdtk-dev/SKILL.md",
|
|
149
|
-
"sha256": "
|
|
150
|
-
"size":
|
|
169
|
+
"sha256": "9f30778b6b8a949e56f9d91398cfd386f834e380fa30e7802fc861dde39559a8",
|
|
170
|
+
"size": 5626
|
|
151
171
|
},
|
|
152
172
|
{
|
|
153
173
|
"path": "toolkit/skills/sdtk-dev-backend/SKILL.md",
|
|
154
|
-
"sha256": "
|
|
155
|
-
"size":
|
|
174
|
+
"sha256": "dcb763d46fc49d977a7ef608541c36950ac6958da26729696e07f98082a07552",
|
|
175
|
+
"size": 1009
|
|
156
176
|
},
|
|
157
177
|
{
|
|
158
178
|
"path": "toolkit/skills/sdtk-dev-frontend/SKILL.md",
|
|
159
|
-
"sha256": "
|
|
160
|
-
"size":
|
|
179
|
+
"sha256": "097ea3e4870c855d3635d81ec462c3289e5589f51c5c3308534c4fd5ebe514aa",
|
|
180
|
+
"size": 967
|
|
161
181
|
},
|
|
162
182
|
{
|
|
163
183
|
"path": "toolkit/skills/sdtk-orchestrator/SKILL.md",
|
|
164
|
-
"sha256": "
|
|
165
|
-
"size":
|
|
184
|
+
"sha256": "16eed42e46c7d8a3ebda8887056e0b079cdc07be4699c7811eeb9a9f72a3b629",
|
|
185
|
+
"size": 4525
|
|
166
186
|
},
|
|
167
187
|
{
|
|
168
188
|
"path": "toolkit/skills/sdtk-pm/SKILL.md",
|
|
169
|
-
"sha256": "
|
|
170
|
-
"size":
|
|
189
|
+
"sha256": "25d9335c9a395008f99fa683b44c0eca1ccccf9e66a64628b01c60d31d86e77f",
|
|
190
|
+
"size": 1722
|
|
171
191
|
},
|
|
172
192
|
{
|
|
173
193
|
"path": "toolkit/skills/sdtk-qa/SKILL.md",
|
|
174
|
-
"sha256": "
|
|
175
|
-
"size":
|
|
194
|
+
"sha256": "c6092cb13646afdd6d49ca2766b52b1265a542f0452fadd0b7c716478b0435b5",
|
|
195
|
+
"size": 3221
|
|
176
196
|
},
|
|
177
197
|
{
|
|
178
198
|
"path": "toolkit/skills/sdtk-screen-design-spec/references/excel-image-export.md",
|
|
@@ -186,8 +206,8 @@
|
|
|
186
206
|
},
|
|
187
207
|
{
|
|
188
208
|
"path": "toolkit/skills/sdtk-screen-design-spec/references/FLOW_ACTION_SPEC_CREATION_RULES.md",
|
|
189
|
-
"sha256": "
|
|
190
|
-
"size":
|
|
209
|
+
"sha256": "e007db18ad55333a371be739f6ef7928316a5f6f55a9fbffcf6de9a821a02ff0",
|
|
210
|
+
"size": 10052
|
|
191
211
|
},
|
|
192
212
|
{
|
|
193
213
|
"path": "toolkit/skills/sdtk-screen-design-spec/references/numbering-rules.md",
|
|
@@ -206,8 +226,8 @@
|
|
|
206
226
|
},
|
|
207
227
|
{
|
|
208
228
|
"path": "toolkit/skills/sdtk-screen-design-spec/SKILL.md",
|
|
209
|
-
"sha256": "
|
|
210
|
-
"size":
|
|
229
|
+
"sha256": "36ddb765725ec9cc4b01fe02cac222cf7e621643bc1212bac6e073b942f3eee0",
|
|
230
|
+
"size": 4446
|
|
211
231
|
},
|
|
212
232
|
{
|
|
213
233
|
"path": "toolkit/skills/sdtk-test-case-spec/references/TEST_CASE_CREATION_RULES.md",
|
|
@@ -221,8 +241,13 @@
|
|
|
221
241
|
},
|
|
222
242
|
{
|
|
223
243
|
"path": "toolkit/skills/sdtk-test-case-spec/SKILL.md",
|
|
224
|
-
"sha256": "
|
|
225
|
-
"size":
|
|
244
|
+
"sha256": "c4e9e276b440bbe0822fb0c0ff62d6eb0dea5e8fb25f1a9f342ebcf30a12b754",
|
|
245
|
+
"size": 3414
|
|
246
|
+
},
|
|
247
|
+
{
|
|
248
|
+
"path": "toolkit/skills/skills.catalog.yaml",
|
|
249
|
+
"sha256": "9b1a4917cd1cccbacd11d3922319b2abdbc763f0b6906b1875f840ed967e4975",
|
|
250
|
+
"size": 11782
|
|
226
251
|
},
|
|
227
252
|
{
|
|
228
253
|
"path": "toolkit/skills-claude/api-design-spec/SKILL.md",
|
|
@@ -291,18 +316,18 @@
|
|
|
291
316
|
},
|
|
292
317
|
{
|
|
293
318
|
"path": "toolkit/templates/docs/api/API_DESIGN_CREATION_RULES.md",
|
|
294
|
-
"sha256": "
|
|
295
|
-
"size":
|
|
319
|
+
"sha256": "e169500521e556036ea550d7ea61031e27646eb7f65fd4a75a6a5c03f53eabc5",
|
|
320
|
+
"size": 949
|
|
296
321
|
},
|
|
297
322
|
{
|
|
298
323
|
"path": "toolkit/templates/docs/api/API_DESIGN_DETAIL_TEMPLATE.md",
|
|
299
|
-
"sha256": "
|
|
300
|
-
"size":
|
|
324
|
+
"sha256": "7a13ed21baa2f8ccf2dc3a4ecdd2e30c90f0cbcbbcff06db2a64df6a8945b727",
|
|
325
|
+
"size": 1300
|
|
301
326
|
},
|
|
302
327
|
{
|
|
303
328
|
"path": "toolkit/templates/docs/api/API_DESIGN_FLOWCHART_CREATION_RULES.md",
|
|
304
|
-
"sha256": "
|
|
305
|
-
"size":
|
|
329
|
+
"sha256": "d77095777dc689b545337fcdb8f61384936ed53ea9a0ca6bc8589975e284204b",
|
|
330
|
+
"size": 13406
|
|
306
331
|
},
|
|
307
332
|
{
|
|
308
333
|
"path": "toolkit/templates/docs/api/API_ENDPOINTS_TEMPLATE.md",
|
|
@@ -386,13 +411,48 @@
|
|
|
386
411
|
},
|
|
387
412
|
{
|
|
388
413
|
"path": "toolkit/templates/docs/specs/FLOW_ACTION_SPEC_CREATION_RULES.md",
|
|
389
|
-
"sha256": "
|
|
390
|
-
"size":
|
|
414
|
+
"sha256": "e007db18ad55333a371be739f6ef7928316a5f6f55a9fbffcf6de9a821a02ff0",
|
|
415
|
+
"size": 10052
|
|
391
416
|
},
|
|
392
417
|
{
|
|
393
418
|
"path": "toolkit/templates/docs/specs/FLOW_ACTION_SPEC_TEMPLATE.md",
|
|
394
|
-
"sha256": "
|
|
395
|
-
"size":
|
|
419
|
+
"sha256": "97367b222dbe970c5b1f08fd72533d778a422cd209bc82f32dd67b9b98827f0f",
|
|
420
|
+
"size": 4879
|
|
421
|
+
},
|
|
422
|
+
{
|
|
423
|
+
"path": "toolkit/templates/handoffs/ARCH_TO_DEV.md",
|
|
424
|
+
"sha256": "8af30132cee4a0e9740e56e678f292649b096a22a97d03d5c099480bcd19ad0a",
|
|
425
|
+
"size": 1201
|
|
426
|
+
},
|
|
427
|
+
{
|
|
428
|
+
"path": "toolkit/templates/handoffs/BA_TO_ARCH.md",
|
|
429
|
+
"sha256": "e0195c1815bc14852d02e9ee57ebc1845df80c02a6d052a12f8ed12b82941cc3",
|
|
430
|
+
"size": 919
|
|
431
|
+
},
|
|
432
|
+
{
|
|
433
|
+
"path": "toolkit/templates/handoffs/DEV_STAGE1_SPEC_REVIEW.md",
|
|
434
|
+
"sha256": "4450703248fa18c9d9a2c030cfe253c95fc812bc45a427c3b30b4312734b6684",
|
|
435
|
+
"size": 1090
|
|
436
|
+
},
|
|
437
|
+
{
|
|
438
|
+
"path": "toolkit/templates/handoffs/DEV_STAGE2_CODE_QUALITY_REVIEW.md",
|
|
439
|
+
"sha256": "81a093320b911a27fdabfded87131135f63e4aeef3241e254147b33f68030d50",
|
|
440
|
+
"size": 695
|
|
441
|
+
},
|
|
442
|
+
{
|
|
443
|
+
"path": "toolkit/templates/handoffs/DEV_TO_QA.md",
|
|
444
|
+
"sha256": "947751b720f7711c9ef6090a06a8d073988ea13d22b12712b4f192fb07fa338d",
|
|
445
|
+
"size": 709
|
|
446
|
+
},
|
|
447
|
+
{
|
|
448
|
+
"path": "toolkit/templates/handoffs/PM_TO_BA.md",
|
|
449
|
+
"sha256": "98b927fe381984a229ff69ad294686595eb3ecc90129b461b8a33fb5cca61531",
|
|
450
|
+
"size": 839
|
|
451
|
+
},
|
|
452
|
+
{
|
|
453
|
+
"path": "toolkit/templates/handoffs/QA_RELEASE_DECISION.md",
|
|
454
|
+
"sha256": "002ab3c8cc5f686de73060e1927675fa2a762d2ba62353eebd08bb7eb616c097",
|
|
455
|
+
"size": 725
|
|
396
456
|
},
|
|
397
457
|
{
|
|
398
458
|
"path": "toolkit/templates/QUALITY_CHECKLIST.md",
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
|
|
1
|
+
f13f557e79ead09d5f57452d5ea7cbe192d12ac0a3de138a7a1a2514e44df505 toolkit/AGENTS.md
|
|
2
2
|
e717a2791fb597d7a21f57f4c4790dbc545e954f0af3ca0c47f160f78c8a2474 toolkit/install.ps1
|
|
3
3
|
0f3e0bfe1b5165250f0da4da5790a9e6220023752713088a0076eb7f17fd6397 toolkit/runtimes/claude/CLAUDE_TEMPLATE.md
|
|
4
4
|
4154c15c71f44d2f2caf07fb41722fa65d4f9ec7e78f798ee084effd12345c62 toolkit/runtimes/codex/CODEX_TEMPLATE.md
|
|
@@ -9,39 +9,44 @@ ca64e0c2a0f13137bc6b780a57442de46a3e0551778bbcbadd4eb779c21cb203 toolkit/script
|
|
|
9
9
|
e0d462bd6dcdb17cc003d459063ff341bd2e4f60b245cda9b7e9b9e94b3cf01f toolkit/scripts/uninstall-codex-skills.ps1
|
|
10
10
|
de2921da9ce504487d9c7d97bf862b65d0ba00b9f1593a4fbfadf41ac36adb49 toolkit/sdtk.config.json
|
|
11
11
|
21b1b0212f85c76dc6a89ae5936b39c4c1df7837a333f7a3db337f3039babb7b toolkit/sdtk.config.profiles.example.json
|
|
12
|
-
|
|
13
|
-
|
|
12
|
+
e169500521e556036ea550d7ea61031e27646eb7f65fd4a75a6a5c03f53eabc5 toolkit/skills/sdtk-api-design-spec/references/API_DESIGN_CREATION_RULES.md
|
|
13
|
+
d77095777dc689b545337fcdb8f61384936ed53ea9a0ca6bc8589975e284204b toolkit/skills/sdtk-api-design-spec/references/API_DESIGN_FLOWCHART_CREATION_RULES.md
|
|
14
14
|
decffe52425e22b3dd82e9c8f3768aefbb209ec58237107d84f583fee876ea8f toolkit/skills/sdtk-api-design-spec/references/FLOWCHART_CREATION_RULES.md
|
|
15
15
|
c6147e7b01632cb6ffa017af43e4e5c9e1f98d160ed812ade1d087b1f3ca5490 toolkit/skills/sdtk-api-design-spec/scripts/generate_api_design_detail.py
|
|
16
|
-
|
|
17
|
-
|
|
16
|
+
6b653f9858f5daa8ae4f2d425f28332676a60053d210aaf8ebccdadc3de9f026 toolkit/skills/sdtk-api-design-spec/SKILL.md
|
|
17
|
+
d77095777dc689b545337fcdb8f61384936ed53ea9a0ca6bc8589975e284204b toolkit/skills/sdtk-api-doc/references/API_DESIGN_FLOWCHART_CREATION_RULES.md
|
|
18
18
|
decffe52425e22b3dd82e9c8f3768aefbb209ec58237107d84f583fee876ea8f toolkit/skills/sdtk-api-doc/references/FLOWCHART_CREATION_RULES.md
|
|
19
19
|
f29c6774019ef0789dfb88678e1ab31d4d8eb7b3ab69b2115368ef5d879e5276 toolkit/skills/sdtk-api-doc/references/YAML_CREATION_RULES.md
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
20
|
+
dd23e42dbdbedf6d0f9f88788957ff8f7d3e6849b533c9d1a18326944dcdeda2 toolkit/skills/sdtk-api-doc/SKILL.md
|
|
21
|
+
e169500521e556036ea550d7ea61031e27646eb7f65fd4a75a6a5c03f53eabc5 toolkit/skills/sdtk-arch/references/API_DESIGN_CREATION_RULES.md
|
|
22
|
+
d77095777dc689b545337fcdb8f61384936ed53ea9a0ca6bc8589975e284204b toolkit/skills/sdtk-arch/references/API_DESIGN_FLOWCHART_CREATION_RULES.md
|
|
23
|
+
e007db18ad55333a371be739f6ef7928316a5f6f55a9fbffcf6de9a821a02ff0 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
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
26
|
+
469a274eca3ac8a353f67a6159feed430b6f14dee6f5a090248e202b51e8a5cd toolkit/skills/sdtk-arch/SKILL.md
|
|
27
|
+
2548951bc437bf05066cbedb9adf71a66739eab7e4bbc920650fc9415cea6e8d toolkit/skills/sdtk-ba/SKILL.md
|
|
28
|
+
ee01a3daeeb4822429f4dcf530c11f15ac65df6700615beefd6c04c3fb41bbbc toolkit/skills/sdtk-design-layout/scripts/render_design_layout_images.py
|
|
29
|
+
e3d739dd8167b3800075fabb4aa8458a29481b85626d8f6bb5ac2e76dd229527 toolkit/skills/sdtk-design-layout/SKILL.md
|
|
30
|
+
3d44bc436dab6201beeb4fed52ab3aa94791c51baca7b7b8e2e8a5ecd6c08baf toolkit/skills/sdtk-dev/prompts/code-quality-reviewer.md
|
|
31
|
+
9bed2859fbeee84257199e63eb471874975d26d57f5a19dcedab0c06980e24ad toolkit/skills/sdtk-dev/prompts/implementer.md
|
|
32
|
+
1dc33dd59afe48c4c78564bdb32999b9a4f34958361ad8f5580cef0e77c953ef toolkit/skills/sdtk-dev/prompts/spec-reviewer.md
|
|
33
|
+
9f30778b6b8a949e56f9d91398cfd386f834e380fa30e7802fc861dde39559a8 toolkit/skills/sdtk-dev/SKILL.md
|
|
34
|
+
dcb763d46fc49d977a7ef608541c36950ac6958da26729696e07f98082a07552 toolkit/skills/sdtk-dev-backend/SKILL.md
|
|
35
|
+
097ea3e4870c855d3635d81ec462c3289e5589f51c5c3308534c4fd5ebe514aa toolkit/skills/sdtk-dev-frontend/SKILL.md
|
|
36
|
+
16eed42e46c7d8a3ebda8887056e0b079cdc07be4699c7811eeb9a9f72a3b629 toolkit/skills/sdtk-orchestrator/SKILL.md
|
|
37
|
+
25d9335c9a395008f99fa683b44c0eca1ccccf9e66a64628b01c60d31d86e77f toolkit/skills/sdtk-pm/SKILL.md
|
|
38
|
+
c6092cb13646afdd6d49ca2766b52b1265a542f0452fadd0b7c716478b0435b5 toolkit/skills/sdtk-qa/SKILL.md
|
|
35
39
|
97f65fd84c80e4836c9bbb82d8b7fc81527336c55dbbd82ea5e69672e21b22e4 toolkit/skills/sdtk-screen-design-spec/references/excel-image-export.md
|
|
36
40
|
a9b414a07d76e63331ffc832dea2381357f9a99e2cd82ea74f713b3a9d7acee7 toolkit/skills/sdtk-screen-design-spec/references/figma-mcp.md
|
|
37
|
-
|
|
41
|
+
e007db18ad55333a371be739f6ef7928316a5f6f55a9fbffcf6de9a821a02ff0 toolkit/skills/sdtk-screen-design-spec/references/FLOW_ACTION_SPEC_CREATION_RULES.md
|
|
38
42
|
4edd3318634fbc142f1ce3161fc3ac93d901a6bb7f0add1d1bed7fc25293c4d9 toolkit/skills/sdtk-screen-design-spec/references/numbering-rules.md
|
|
39
43
|
b54b14cc75c02c3fe9f89547b3f09baf1d7d036ef5f3d9f40487516e22351c45 toolkit/skills/sdtk-screen-design-spec/scripts/renumber_flow_action_spec_global.py
|
|
40
44
|
ae0bc9b120c19a142f10cc79168a8f7d6bf8a37e48341fc16cbc74bbdc2e692c toolkit/skills/sdtk-screen-design-spec/scripts/validate_flow_action_spec_numbering.py
|
|
41
|
-
|
|
45
|
+
36ddb765725ec9cc4b01fe02cac222cf7e621643bc1212bac6e073b942f3eee0 toolkit/skills/sdtk-screen-design-spec/SKILL.md
|
|
42
46
|
7c21e74f5eee712c6b65665b4f10483ed008113186a92dc0a4673ce1fcd3ef5c toolkit/skills/sdtk-test-case-spec/references/TEST_CASE_CREATION_RULES.md
|
|
43
47
|
4d1e813908114f2be68007fb7373973e2c6e0aebc5a6305b8b19443d5ae477d0 toolkit/skills/sdtk-test-case-spec/scripts/validate_test_case_spec.py
|
|
44
|
-
|
|
48
|
+
c4e9e276b440bbe0822fb0c0ff62d6eb0dea5e8fb25f1a9f342ebcf30a12b754 toolkit/skills/sdtk-test-case-spec/SKILL.md
|
|
49
|
+
9b1a4917cd1cccbacd11d3922319b2abdbc763f0b6906b1875f840ed967e4975 toolkit/skills/skills.catalog.yaml
|
|
45
50
|
123873681ff65792a9a269b264155c65a5feb68b23e4eeb1e68cb7da1a137d54 toolkit/skills-claude/api-design-spec/SKILL.md
|
|
46
51
|
6f6ddb470bc61d286b84418e299b360d5f148e6bed75fa50b6c8f2929e6fe49c toolkit/skills-claude/api-doc/SKILL.md
|
|
47
52
|
e293fd71f9fc71ac63e5e53bf55fbfe9c71e186e298b2fd3429c71a4e972a8b1 toolkit/skills-claude/arch/SKILL.md
|
|
@@ -55,9 +60,9 @@ b34621fe61957e573c616ad816d591a60a6c8d1333d0bfb71f39f45b93331cb0 toolkit/skills
|
|
|
55
60
|
3ab5af1b27aa0947052ef7b76abca132d89b78b74516b8668474c08c344289aa toolkit/skills-claude/qa/SKILL.md
|
|
56
61
|
5686da60872f1a3c6791e9a740897d4a564f40d53d54902a47fbc3165e68a1ec toolkit/skills-claude/screen-design-spec/SKILL.md
|
|
57
62
|
c397431a7752fcdee1dbb7720472703d262bfcc8fb543c4562fbc24a79064769 toolkit/skills-claude/test-case-spec/SKILL.md
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
63
|
+
e169500521e556036ea550d7ea61031e27646eb7f65fd4a75a6a5c03f53eabc5 toolkit/templates/docs/api/API_DESIGN_CREATION_RULES.md
|
|
64
|
+
7a13ed21baa2f8ccf2dc3a4ecdd2e30c90f0cbcbbcff06db2a64df6a8945b727 toolkit/templates/docs/api/API_DESIGN_DETAIL_TEMPLATE.md
|
|
65
|
+
d77095777dc689b545337fcdb8f61384936ed53ea9a0ca6bc8589975e284204b toolkit/templates/docs/api/API_DESIGN_FLOWCHART_CREATION_RULES.md
|
|
61
66
|
7dd9840e7a9c268fd7671791c0e80cfbcf54c3c2ff8bbacd85e44662f238ac9c toolkit/templates/docs/api/API_ENDPOINTS_TEMPLATE.md
|
|
62
67
|
56e2b2a150ff737b856bb75e58fea603d09fe5c26d9fe5d5ea0516b4eb4703e8 toolkit/templates/docs/api/feature_api_flow_list_TEMPLATE.txt
|
|
63
68
|
7a86c642f2d5826b2ce76fddb8ed0bcb300af4eb654e70e16576057927654d7a toolkit/templates/docs/api/FEATURE_API_TEMPLATE.yaml
|
|
@@ -74,8 +79,15 @@ e8d3554fc4893a8a57fbf006e58f37f21347de5f31ce02f0717e97d29b387eea toolkit/templa
|
|
|
74
79
|
7c21e74f5eee712c6b65665b4f10483ed008113186a92dc0a4673ce1fcd3ef5c toolkit/templates/docs/qa/TEST_CASE_CREATION_RULES.md
|
|
75
80
|
4b64a123d6e22edefa17a23a1eff766cf612ec5fa2f78b34bf50eecb39abf06a toolkit/templates/docs/qa/TEST_CASE_TEMPLATE.md
|
|
76
81
|
3b5f911d5e0eb042efc388ef3a441285a57d2dc02ae032d080934495e2d06f4d toolkit/templates/docs/specs/BA_SPEC_TEMPLATE.md
|
|
77
|
-
|
|
78
|
-
|
|
82
|
+
e007db18ad55333a371be739f6ef7928316a5f6f55a9fbffcf6de9a821a02ff0 toolkit/templates/docs/specs/FLOW_ACTION_SPEC_CREATION_RULES.md
|
|
83
|
+
97367b222dbe970c5b1f08fd72533d778a422cd209bc82f32dd67b9b98827f0f toolkit/templates/docs/specs/FLOW_ACTION_SPEC_TEMPLATE.md
|
|
84
|
+
8af30132cee4a0e9740e56e678f292649b096a22a97d03d5c099480bcd19ad0a toolkit/templates/handoffs/ARCH_TO_DEV.md
|
|
85
|
+
e0195c1815bc14852d02e9ee57ebc1845df80c02a6d052a12f8ed12b82941cc3 toolkit/templates/handoffs/BA_TO_ARCH.md
|
|
86
|
+
4450703248fa18c9d9a2c030cfe253c95fc812bc45a427c3b30b4312734b6684 toolkit/templates/handoffs/DEV_STAGE1_SPEC_REVIEW.md
|
|
87
|
+
81a093320b911a27fdabfded87131135f63e4aeef3241e254147b33f68030d50 toolkit/templates/handoffs/DEV_STAGE2_CODE_QUALITY_REVIEW.md
|
|
88
|
+
947751b720f7711c9ef6090a06a8d073988ea13d22b12712b4f192fb07fa338d toolkit/templates/handoffs/DEV_TO_QA.md
|
|
89
|
+
98b927fe381984a229ff69ad294686595eb3ecc90129b461b8a33fb5cca61531 toolkit/templates/handoffs/PM_TO_BA.md
|
|
90
|
+
002ab3c8cc5f686de73060e1927675fa2a762d2ba62353eebd08bb7eb616c097 toolkit/templates/handoffs/QA_RELEASE_DECISION.md
|
|
79
91
|
f9dc0d49ceeeb8814d77670e43f09b5221f46d406fb1e89eb575c1ab39bc022a toolkit/templates/QUALITY_CHECKLIST.md
|
|
80
92
|
0ccb7a0509cf92aa91ebea95996dfffd5b52edd6ab4bbefbb827e4ed495abc31 toolkit/templates/README.md
|
|
81
93
|
2b5d4d10019e3c9b3219d92b8123acc85872d9c76230107206e7a270a5ece5a2 toolkit/templates/SHARED_PLANNING.md
|
|
@@ -12,6 +12,8 @@ Goal: use SDTK as a virtual PM/BA/ARCH/DEV/QA operating model to deliver one fea
|
|
|
12
12
|
- Read stack and command configuration from `sdtk.config.json` in the project root.
|
|
13
13
|
- For VI/JP source requirements, keep original text in an appendix and add literal English translation for traceability.
|
|
14
14
|
- Code review must be complete before QA starts.
|
|
15
|
+
- Verification-before-completion: no phase may declare done, pass, or handoff-ready without fresh command evidence per `governance/ai/core/SDTK_VERIFICATION_BEFORE_COMPLETION_POLICY.md`.
|
|
16
|
+
- `toolkit/skills/skills.catalog.yaml` is the inventory source of truth for the 13 core SDTK skills.
|
|
15
17
|
|
|
16
18
|
## 0.1) Clarification Protocol
|
|
17
19
|
Apply for all roles (`/pm`, `/ba`, `/arch`, `/dev`, `/qa`):
|
|
@@ -44,6 +46,16 @@ Notes:
|
|
|
44
46
|
5. DEV Implementation + Code Review -> `docs/dev/FEATURE_IMPL_PLAN_[FEATURE_KEY].md` + code + tests
|
|
45
47
|
6. QA Testing -> `docs/qa/[FEATURE_KEY]_TEST_CASE.md` + `docs/qa/QA_RELEASE_REPORT_[FEATURE_KEY].md`
|
|
46
48
|
|
|
49
|
+
## 2.1) DEV Review Gates
|
|
50
|
+
DEV Review Gates (mandatory, in order):
|
|
51
|
+
1. Artifact/spec compliance review -- verify code matches BA spec, API YAML, FLOW_ACTION_SPEC, and DB spec line by line.
|
|
52
|
+
2. Code quality review -- verify structure, naming, test coverage, and maintainability. Runs ONLY after Stage 1 PASS.
|
|
53
|
+
|
|
54
|
+
QA handoff is blocked until both gates PASS.
|
|
55
|
+
|
|
56
|
+
Stage 1 and QA validation must quote exact specification text when recording a match or mismatch.
|
|
57
|
+
Use: `Spec says: "[exact quote]" -> Evidence: [match/mismatch + file reference]`
|
|
58
|
+
|
|
47
59
|
## 3) Shared State And Quality Gates
|
|
48
60
|
- `SHARED_PLANNING.md`: phase status, owners, artifacts, blockers, handoff notes.
|
|
49
61
|
- `QUALITY_CHECKLIST.md`: gate checklist by phase.
|
|
@@ -89,21 +101,31 @@ In addition to `ARCH_DESIGN`, ARCH may generate:
|
|
|
89
101
|
- `on`: always generate in QA phase.
|
|
90
102
|
- `off`: skip unless explicitly requested.
|
|
91
103
|
|
|
104
|
+
## 6.3) Maintainer Assets
|
|
105
|
+
- Skill inventory: `toolkit/skills/skills.catalog.yaml`
|
|
106
|
+
- Handoff templates: `toolkit/templates/handoffs/`
|
|
107
|
+
- Example scenarios: `examples/`
|
|
108
|
+
- Readiness audit: `toolkit/scripts/check-runtime-readiness.ps1`
|
|
109
|
+
|
|
92
110
|
## 7) Mandatory Rule References
|
|
93
111
|
Rule files are installed locally by the runtime. Skills resolve these at:
|
|
94
112
|
- Claude Code: `.claude/skills/references/`
|
|
95
113
|
- Codex: `$CODEX_HOME/skills/<skill>/references/`
|
|
96
114
|
|
|
115
|
+
Workflow governance docs:
|
|
116
|
+
- `governance/ai/core/SDTK_VERIFICATION_BEFORE_COMPLETION_POLICY.md` -- verification-before-completion gate
|
|
117
|
+
- `governance/ai/core/SDTK_SKILL_AUTHORING_AND_TESTING.md` -- maintainer authoring/test guide
|
|
118
|
+
|
|
97
119
|
Available rule files:
|
|
98
|
-
- `YAML_CREATION_RULES.md`
|
|
99
|
-
- `API_DESIGN_FLOWCHART_CREATION_RULES.md`
|
|
100
|
-
- `FLOWCHART_CREATION_RULES.md`
|
|
101
|
-
- `API_DESIGN_CREATION_RULES.md`
|
|
102
|
-
- `FLOW_ACTION_SPEC_CREATION_RULES.md`
|
|
103
|
-
- `TEST_CASE_CREATION_RULES.md`
|
|
104
|
-
- `numbering-rules.md`
|
|
105
|
-
- `figma-mcp.md`
|
|
106
|
-
- `excel-image-export.md`
|
|
120
|
+
- `YAML_CREATION_RULES.md` -- API YAML docs
|
|
121
|
+
- `API_DESIGN_FLOWCHART_CREATION_RULES.md` -- API design detail + flow docs
|
|
122
|
+
- `FLOWCHART_CREATION_RULES.md` -- Flowchart (legacy compat)
|
|
123
|
+
- `API_DESIGN_CREATION_RULES.md` -- API design (legacy compat)
|
|
124
|
+
- `FLOW_ACTION_SPEC_CREATION_RULES.md` -- Screen flow-action specs
|
|
125
|
+
- `TEST_CASE_CREATION_RULES.md` -- QA test-case specs
|
|
126
|
+
- `numbering-rules.md` -- Flow-action numbering policy
|
|
127
|
+
- `figma-mcp.md` -- Figma MCP integration
|
|
128
|
+
- `excel-image-export.md` -- Excel image export
|
|
107
129
|
|
|
108
130
|
Flow-action numbering policy:
|
|
109
131
|
- Use one global numbering mode for the whole document (no per-screen reset).
|
|
@@ -5,6 +5,10 @@ description: Generate detailed API design markdown (`[FEATURE_KEY]_API_DESIGN_DE
|
|
|
5
5
|
|
|
6
6
|
# SDTK API Design Detail Spec
|
|
7
7
|
|
|
8
|
+
## Critical Constraints
|
|
9
|
+
- I do not drift from the source YAML or flow list.
|
|
10
|
+
- I do not leave broken flow image embeds or missing assumptions in the API design detail.
|
|
11
|
+
|
|
8
12
|
## Outputs
|
|
9
13
|
- `docs/api/[FEATURE_KEY]_API_DESIGN_DETAIL.md`
|
|
10
14
|
- Supporting generated assets:
|
package/assets/toolkit/toolkit/skills/sdtk-api-design-spec/references/API_DESIGN_CREATION_RULES.md
CHANGED
|
@@ -7,10 +7,16 @@ The active rule source for API design detail and API flowchart behavior is now:
|
|
|
7
7
|
- `API_DESIGN_FLOWCHART_CREATION_RULES_FINAL.md` (root)
|
|
8
8
|
- `templates/docs/api/API_DESIGN_FLOWCHART_CREATION_RULES.md` (toolkit)
|
|
9
9
|
|
|
10
|
-
|
|
10
|
+
Even in compatibility mode, generated API design detail docs must still include:
|
|
11
|
+
- a top-level `## Assumptions` section
|
|
12
|
+
- this table format: `| # | Assumption | Verified | Risk if wrong |`
|
|
13
|
+
- explicit unresolved assumptions when downstream review depends on them
|
|
14
|
+
|
|
15
|
+
Use the active rule file for:
|
|
11
16
|
- API design detail markdown structure
|
|
12
17
|
- flowchart integration and synchronization rules
|
|
13
18
|
- error section rules
|
|
14
19
|
- flow summary / notes / login rules
|
|
20
|
+
- assumptions-section requirements
|
|
15
21
|
|
|
16
22
|
This compatibility note should remain only until all references are migrated.
|
|
@@ -38,6 +38,23 @@ Primary sample references:
|
|
|
38
38
|
- `GET /bukken/info/{company_uuid}/{bukken_uuid}` style
|
|
39
39
|
- search API query-builder style shown in the Bukken sample helper flow
|
|
40
40
|
|
|
41
|
+
## 2.1 API Design Detail Markdown Requirements
|
|
42
|
+
|
|
43
|
+
Generated `*_API_DESIGN_DETAIL.md` files must keep this minimum structure:
|
|
44
|
+
- `## 0. Abbreviations`
|
|
45
|
+
- `## 1. Document Scope`
|
|
46
|
+
- `## Assumptions`
|
|
47
|
+
- per-endpoint `## <n>. API Detail ...` sections
|
|
48
|
+
- `## 3. Generation Notes` or the current equivalent final notes section
|
|
49
|
+
|
|
50
|
+
`## Assumptions` must use this table shape:
|
|
51
|
+
|
|
52
|
+
```text
|
|
53
|
+
| # | Assumption | Verified | Risk if wrong |
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
If an assumption is not verified yet, keep it explicit and treat it as a downstream review risk instead of silently collapsing it into a fact.
|
|
57
|
+
|
|
41
58
|
## 3. Core Flowchart Writing Rules
|
|
42
59
|
|
|
43
60
|
### Rule A. Add a visible API header for every block
|
|
@@ -5,6 +5,10 @@ description: Generate OpenAPI 3.x YAML and PlantUML flow diagrams for a feature
|
|
|
5
5
|
|
|
6
6
|
# SDTK API Documentation
|
|
7
7
|
|
|
8
|
+
## Critical Constraints
|
|
9
|
+
- I do not invent API paths or payload contracts that contradict BA or ARCH artifacts.
|
|
10
|
+
- I do not leave YAML, endpoint markdown, and flow-list outputs out of sync.
|
|
11
|
+
|
|
8
12
|
## Outputs
|
|
9
13
|
- `docs/api/[FeaturePascal]_API.yaml`
|
|
10
14
|
- `docs/api/[FEATURE_KEY]_ENDPOINTS.md`
|
package/assets/toolkit/toolkit/skills/sdtk-api-doc/references/API_DESIGN_FLOWCHART_CREATION_RULES.md
CHANGED
|
@@ -38,6 +38,23 @@ Primary sample references:
|
|
|
38
38
|
- `GET /bukken/info/{company_uuid}/{bukken_uuid}` style
|
|
39
39
|
- search API query-builder style shown in the Bukken sample helper flow
|
|
40
40
|
|
|
41
|
+
## 2.1 API Design Detail Markdown Requirements
|
|
42
|
+
|
|
43
|
+
Generated `*_API_DESIGN_DETAIL.md` files must keep this minimum structure:
|
|
44
|
+
- `## 0. Abbreviations`
|
|
45
|
+
- `## 1. Document Scope`
|
|
46
|
+
- `## Assumptions`
|
|
47
|
+
- per-endpoint `## <n>. API Detail ...` sections
|
|
48
|
+
- `## 3. Generation Notes` or the current equivalent final notes section
|
|
49
|
+
|
|
50
|
+
`## Assumptions` must use this table shape:
|
|
51
|
+
|
|
52
|
+
```text
|
|
53
|
+
| # | Assumption | Verified | Risk if wrong |
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
If an assumption is not verified yet, keep it explicit and treat it as a downstream review risk instead of silently collapsing it into a fact.
|
|
57
|
+
|
|
41
58
|
## 3. Core Flowchart Writing Rules
|
|
42
59
|
|
|
43
60
|
### Rule A. Add a visible API header for every block
|