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
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: arch
|
|
3
|
+
description: Solution Architect workflow for SDTK. Use when you need to convert BA_SPEC + PM backlog into technical architecture, API contracts (OpenAPI), and UI layout docs; update SHARED_PLANNING.md / QUALITY_CHECKLIST.md and handoff to DEV.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
## SDTK Pipeline Rules (always apply)
|
|
7
|
+
1. Pipeline: PM Initiation → BA Analysis → PM Planning → Architecture Design → Development + Review → QA Validation
|
|
8
|
+
2. After completing phase work: update SHARED_PLANNING.md + QUALITY_CHECKLIST.md
|
|
9
|
+
3. If unclear: log OQ-xx in artifact, escalate to PM (PM asks user if needed)
|
|
10
|
+
4. Traceability: REQ → BR/UC/AC → design → backlog → code/tests → QA
|
|
11
|
+
5. Code review must be COMPLETE before QA phase can start
|
|
12
|
+
6. Do not skip phases. If inputs missing, ask focused questions.
|
|
13
|
+
|
|
14
|
+
## Prerequisites (verify before proceeding)
|
|
15
|
+
Read QUALITY_CHECKLIST.md and verify:
|
|
16
|
+
- Phase 2 BA Analysis gate must show all items [x] Done.
|
|
17
|
+
- Phase 2+ PM Planning gate must show all items [x] Done.
|
|
18
|
+
|
|
19
|
+
If prerequisites NOT met: report which gate is missing, suggest user run the prerequisite phase first.
|
|
20
|
+
|
|
21
|
+
## Current Context
|
|
22
|
+
- Config: !`node -e "try{process.stdout.write(require('fs').readFileSync('sdtk.config.json','utf8'))}catch{process.stdout.write('{}')}"`
|
|
23
|
+
- Pipeline: !`node -e "try{process.stdout.write(require('fs').readFileSync('SHARED_PLANNING.md','utf8'))}catch{process.stdout.write('Not initialized')}"`
|
|
24
|
+
- Gates: !`node -e "try{process.stdout.write(require('fs').readFileSync('QUALITY_CHECKLIST.md','utf8'))}catch{process.stdout.write('Not initialized')}"`
|
|
25
|
+
- State: !`node -e "try{process.stdout.write(require('fs').readFileSync('.sdtk/orchestration-state.json','utf8'))}catch{process.stdout.write('{}')}"`
|
|
26
|
+
|
|
27
|
+
## Input
|
|
28
|
+
$ARGUMENTS
|
|
29
|
+
|
|
30
|
+
If no arguments provided, read current feature context from SHARED_PLANNING.md.
|
|
31
|
+
|
|
32
|
+
# SDTK ARCH (Solution Architecture)
|
|
33
|
+
|
|
34
|
+
## Outputs
|
|
35
|
+
- `docs/architecture/ARCH_DESIGN_[FEATURE_KEY].md`
|
|
36
|
+
- If applicable:
|
|
37
|
+
- `docs/api/[FeaturePascal]_API.yaml`
|
|
38
|
+
- `docs/api/[FEATURE_KEY]_ENDPOINTS.md`
|
|
39
|
+
- `docs/api/[FEATURE_KEY]_API_DESIGN_DETAIL.md`
|
|
40
|
+
- `docs/api/[feature_snake]_api_flow_list.txt`
|
|
41
|
+
- `docs/database/DATABASE_SPEC_[FEATURE_KEY].md`
|
|
42
|
+
- `docs/design/DESIGN_LAYOUT_[FEATURE_KEY].md`
|
|
43
|
+
- `docs/specs/[FEATURE_KEY]_FLOW_ACTION_SPEC.md`
|
|
44
|
+
|
|
45
|
+
## Process
|
|
46
|
+
1. Read BA spec + PRD/backlog.
|
|
47
|
+
2. Read `sdtk.config.json` for project stack assumptions (backend/frontend/db/auth).
|
|
48
|
+
3. If architecture output includes API contracts/flows, read and apply the split API rule sources before defining endpoints/flows:
|
|
49
|
+
- `.claude/skills/references/YAML_CREATION_RULES.md`
|
|
50
|
+
- `.claude/skills/references/API_DESIGN_FLOWCHART_CREATION_RULES.md`
|
|
51
|
+
4. If architecture output includes screen flow-action specs, read and apply rules from `.claude/skills/references/FLOW_ACTION_SPEC_CREATION_RULES.md` (global numbering policy).
|
|
52
|
+
5. If API detail spec is required, use skill `/api-design-spec` to build/update `docs/api/[FEATURE_KEY]_API_DESIGN_DETAIL.md` using YAML + flow list.
|
|
53
|
+
6. For complex UI flow-action specs, use skill `/screen-design-spec` to build/update `docs/specs/[FEATURE_KEY]_FLOW_ACTION_SPEC.md`.
|
|
54
|
+
7. Define:
|
|
55
|
+
- System components + data model
|
|
56
|
+
- API endpoints and flows (if backend changes)
|
|
57
|
+
- Screen layouts (if UI changes)
|
|
58
|
+
- Security/authz decisions
|
|
59
|
+
8. Create/update:
|
|
60
|
+
- OpenAPI YAML + API endpoint markdown
|
|
61
|
+
- API flow list
|
|
62
|
+
- API design detail spec (when `orchestration.apiDesignDetailMode` is `auto/on`)
|
|
63
|
+
- Database spec (if DB impact exists)
|
|
64
|
+
- Flow-action spec and design layout (if UI impact exists)
|
|
65
|
+
9. Ensure mapping UC/BR -> DB/API/screens and run output hygiene checks:
|
|
66
|
+
- EN artifacts use English narrative text (except clearly marked original-language appendix blocks).
|
|
67
|
+
- No mojibake/encoding corruption in markdown/yaml/txt outputs.
|
|
68
|
+
10. If anything is unclear: record OQ-xx in ARCH_DESIGN "Open Questions" and escalate to PM (suggest user run `/pm` for a decision if still missing info).
|
|
69
|
+
11. Update shared state + Phase 3 checklist.
|
|
70
|
+
12. Handoff: suggest user run `/dev` to implement the design.
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: ba
|
|
3
|
+
description: Business Analyst workflow for SDTK. Use when you need to turn PM initiation into BA_SPEC with glossary, business rules (BR-xx), use cases (UC-xx), acceptance criteria (AC-xx), NFRs, risks, open questions, and a traceability matrix.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
## SDTK Pipeline Rules (always apply)
|
|
7
|
+
1. Pipeline: PM Initiation → BA Analysis → PM Planning → Architecture Design → Development + Review → QA Validation
|
|
8
|
+
2. After completing phase work: update SHARED_PLANNING.md + QUALITY_CHECKLIST.md
|
|
9
|
+
3. If unclear: log OQ-xx in artifact, escalate to PM (PM asks user if needed)
|
|
10
|
+
4. Traceability: REQ → BR/UC/AC → design → backlog → code/tests → QA
|
|
11
|
+
5. Code review must be COMPLETE before QA phase can start
|
|
12
|
+
6. Do not skip phases. If inputs missing, ask focused questions.
|
|
13
|
+
|
|
14
|
+
## Prerequisites (verify before proceeding)
|
|
15
|
+
Read QUALITY_CHECKLIST.md and verify:
|
|
16
|
+
- Phase 1 PM Init gate must show all items [x] Done.
|
|
17
|
+
|
|
18
|
+
If prerequisites NOT met: report which gate is missing, suggest user run `/pm` first.
|
|
19
|
+
|
|
20
|
+
## Current Context
|
|
21
|
+
- Config: !`node -e "try{process.stdout.write(require('fs').readFileSync('sdtk.config.json','utf8'))}catch{process.stdout.write('{}')}"`
|
|
22
|
+
- Pipeline: !`node -e "try{process.stdout.write(require('fs').readFileSync('SHARED_PLANNING.md','utf8'))}catch{process.stdout.write('Not initialized')}"`
|
|
23
|
+
- Gates: !`node -e "try{process.stdout.write(require('fs').readFileSync('QUALITY_CHECKLIST.md','utf8'))}catch{process.stdout.write('Not initialized')}"`
|
|
24
|
+
- State: !`node -e "try{process.stdout.write(require('fs').readFileSync('.sdtk/orchestration-state.json','utf8'))}catch{process.stdout.write('{}')}"`
|
|
25
|
+
|
|
26
|
+
## Input
|
|
27
|
+
$ARGUMENTS
|
|
28
|
+
|
|
29
|
+
If no arguments provided, read current feature context from SHARED_PLANNING.md.
|
|
30
|
+
|
|
31
|
+
# SDTK BA (Business Analysis)
|
|
32
|
+
|
|
33
|
+
## Output
|
|
34
|
+
- `docs/specs/BA_SPEC_[FEATURE_KEY].md`
|
|
35
|
+
|
|
36
|
+
## Process
|
|
37
|
+
1. Read `docs/product/PROJECT_INITIATION_[FEATURE_KEY].md` (and any source requirements).
|
|
38
|
+
2. Produce:
|
|
39
|
+
- Glossary
|
|
40
|
+
- BR-xx (numbered)
|
|
41
|
+
- UC-xx (cover 100% REQ-xx)
|
|
42
|
+
- AC-xx (mapped to UC/BR)
|
|
43
|
+
- NFR-xx
|
|
44
|
+
- Risks + Open Questions
|
|
45
|
+
- Traceability summary table (REQ → UC/BR/AC)
|
|
46
|
+
3. If source requirements are VI/JP: preserve the original text and add a literal EN translation in appendices.
|
|
47
|
+
4. If anything is unclear: record OQ-xx in BA_SPEC "Open Questions" and escalate to PM (suggest user run `/pm` for a decision if still missing info).
|
|
48
|
+
5. Update `SHARED_PLANNING.md` + `QUALITY_CHECKLIST.md` Phase 2.
|
|
49
|
+
6. Handoff: suggest user run `/pm` to proceed with PRD planning.
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: design-layout
|
|
3
|
+
description: Generate UI screen layout documentation for a feature, including PlantUML @startsalt wireframes and item tables. Use when a feature includes frontend/admin screens and you need docs/design/* deliverables.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
## Required Inputs (read before proceeding)
|
|
7
|
+
Read the following artifacts for the current feature:
|
|
8
|
+
1. `docs/specs/BA_SPEC_*.md` — screens + fields
|
|
9
|
+
2. `docs/api/[FEATURE_KEY]_ENDPOINTS.md` — API list
|
|
10
|
+
|
|
11
|
+
## Input
|
|
12
|
+
$ARGUMENTS
|
|
13
|
+
|
|
14
|
+
# SDTK Screen Layout Design
|
|
15
|
+
|
|
16
|
+
## Output
|
|
17
|
+
- `docs/design/DESIGN_LAYOUT_[FEATURE_KEY].md`
|
|
18
|
+
|
|
19
|
+
## Process
|
|
20
|
+
1. Read BA spec (screens + fields) and API list.
|
|
21
|
+
2. For each screen, include:
|
|
22
|
+
- PlantUML `@startsalt` wireframe first
|
|
23
|
+
- API list table
|
|
24
|
+
- Item table with numbering that matches the wireframe
|
|
25
|
+
3. Keep screen IDs consistent (A-*, B-*, C-*).
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: dev
|
|
3
|
+
description: Developer workflow for SDTK. Use when you need to implement a feature from ARCH_DESIGN + BACKLOG: create an implementation plan, write code + tests, complete mandatory code review gate, and prepare a QA handoff.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
## SDTK Pipeline Rules (always apply)
|
|
7
|
+
1. Pipeline: PM Initiation → BA Analysis → PM Planning → Architecture Design → Development + Review → QA Validation
|
|
8
|
+
2. After completing phase work: update SHARED_PLANNING.md + QUALITY_CHECKLIST.md
|
|
9
|
+
3. If unclear: log OQ-xx in artifact, escalate to PM (PM asks user if needed)
|
|
10
|
+
4. Traceability: REQ → BR/UC/AC → design → backlog → code/tests → QA
|
|
11
|
+
5. Code review must be COMPLETE before QA phase can start
|
|
12
|
+
6. Do not skip phases. If inputs missing, ask focused questions.
|
|
13
|
+
|
|
14
|
+
## Prerequisites (verify before proceeding)
|
|
15
|
+
Read QUALITY_CHECKLIST.md and verify:
|
|
16
|
+
- Phase 3 ARCH Design gate must show all items [x] Done.
|
|
17
|
+
|
|
18
|
+
If prerequisites NOT met: report which gate is missing, suggest user run `/arch` first.
|
|
19
|
+
|
|
20
|
+
## Current Context
|
|
21
|
+
- Config: !`node -e "try{process.stdout.write(require('fs').readFileSync('sdtk.config.json','utf8'))}catch{process.stdout.write('{}')}"`
|
|
22
|
+
- Pipeline: !`node -e "try{process.stdout.write(require('fs').readFileSync('SHARED_PLANNING.md','utf8'))}catch{process.stdout.write('Not initialized')}"`
|
|
23
|
+
- Gates: !`node -e "try{process.stdout.write(require('fs').readFileSync('QUALITY_CHECKLIST.md','utf8'))}catch{process.stdout.write('Not initialized')}"`
|
|
24
|
+
- State: !`node -e "try{process.stdout.write(require('fs').readFileSync('.sdtk/orchestration-state.json','utf8'))}catch{process.stdout.write('{}')}"`
|
|
25
|
+
|
|
26
|
+
## Input
|
|
27
|
+
$ARGUMENTS
|
|
28
|
+
|
|
29
|
+
If no arguments provided, read current feature context from SHARED_PLANNING.md.
|
|
30
|
+
|
|
31
|
+
# SDTK DEV (Implementation + Code Review)
|
|
32
|
+
|
|
33
|
+
## Outputs
|
|
34
|
+
- `docs/dev/FEATURE_IMPL_PLAN_[FEATURE_KEY].md`
|
|
35
|
+
- Code + tests (follow repo conventions)
|
|
36
|
+
|
|
37
|
+
## Process
|
|
38
|
+
1. Read `ARCH_DESIGN_*` + backlog.
|
|
39
|
+
2. Read `sdtk.config.json` for project stack + test/lint commands.
|
|
40
|
+
3. Write `FEATURE_IMPL_PLAN_*` (scope, file list, test plan).
|
|
41
|
+
4. If anything is unclear: record OQ-xx in FEATURE_IMPL_PLAN "Open Questions" and escalate to PM (suggest user run `/pm` for a decision if still missing info).
|
|
42
|
+
5. Implement incrementally with tests.
|
|
43
|
+
6. Complete mandatory code review gate (self + peer checklist; AI peer review allowed).
|
|
44
|
+
7. Update `SHARED_PLANNING.md` + `QUALITY_CHECKLIST.md` Phase 4.
|
|
45
|
+
8. Handoff: suggest user run `/qa` to test (only after code review PASS).
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: dev-backend
|
|
3
|
+
description: Generate/modify Python Django REST Framework backend code following the toolkit conventions (models/views/services/serializers/validation/urls/enums). Use when implementing backend features in that project style.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
## Input
|
|
7
|
+
$ARGUMENTS
|
|
8
|
+
|
|
9
|
+
# SDTK Backend (Toolkit conventions)
|
|
10
|
+
|
|
11
|
+
## Process
|
|
12
|
+
1. Check whether this repository already has a backend reference module and follow its patterns.
|
|
13
|
+
2. Follow module structure: `src/backend/<module>/{models,view,service,serializers,validation,enum,urls.py}`.
|
|
14
|
+
3. Apply conventions:
|
|
15
|
+
- Soft delete via `del_flg`
|
|
16
|
+
- Audit fields (creator/updater/del timestamps)
|
|
17
|
+
- Permission checks before operations
|
|
18
|
+
- `transaction.atomic()` for writes
|
|
19
|
+
- Logging decorator on public endpoints
|
|
20
|
+
4. Add tests for critical business rules and state transitions.
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: dev-frontend
|
|
3
|
+
description: Generate/modify React frontend code following the toolkit conventions (list/register/edit/detail pages, components, services, React Query hooks, permission checks). Use when implementing frontend features in that project style.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
## Input
|
|
7
|
+
$ARGUMENTS
|
|
8
|
+
|
|
9
|
+
# SDTK Frontend (Toolkit conventions)
|
|
10
|
+
|
|
11
|
+
## Process
|
|
12
|
+
1. Check whether this repository already has a frontend reference module and follow its patterns.
|
|
13
|
+
2. Follow structure:
|
|
14
|
+
- `src/frontend/features/{feature}/...`
|
|
15
|
+
- `src/frontend/services/{feature}/{feature}Service.js`
|
|
16
|
+
- `src/frontend/services/apiHook/{feature}.js`
|
|
17
|
+
3. Implement screens based on `docs/design/DESIGN_LAYOUT_[FEATURE_KEY].md`.
|
|
18
|
+
4. Preserve patterns: React Query hooks, loading states, permission checks, consistent labels.
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: orchestrator
|
|
3
|
+
description: Orchestrate a full 6-phase SDLC multi-agent workflow (PM/BA/ARCH/DEV/QA) using this repo's conventions: SHARED_PLANNING.md + QUALITY_CHECKLIST.md + docs/* artifacts + phase handoffs.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
## SDTK Pipeline Rules (always apply)
|
|
7
|
+
1. Pipeline: PM Initiation → BA Analysis → PM Planning → Architecture Design → Development + Review → QA Validation
|
|
8
|
+
2. After completing phase work: update SHARED_PLANNING.md + QUALITY_CHECKLIST.md
|
|
9
|
+
3. If unclear: log OQ-xx in artifact, escalate to PM (PM asks user if needed)
|
|
10
|
+
4. Traceability: REQ → BR/UC/AC → design → backlog → code/tests → QA
|
|
11
|
+
5. Code review must be COMPLETE before QA phase can start
|
|
12
|
+
6. Do not skip phases. If inputs missing, ask focused questions.
|
|
13
|
+
|
|
14
|
+
## Current Context
|
|
15
|
+
- Config: !`node -e "try{process.stdout.write(require('fs').readFileSync('sdtk.config.json','utf8'))}catch{process.stdout.write('{}')}"`
|
|
16
|
+
- Pipeline: !`node -e "try{process.stdout.write(require('fs').readFileSync('SHARED_PLANNING.md','utf8'))}catch{process.stdout.write('Not initialized')}"`
|
|
17
|
+
- Gates: !`node -e "try{process.stdout.write(require('fs').readFileSync('QUALITY_CHECKLIST.md','utf8'))}catch{process.stdout.write('Not initialized')}"`
|
|
18
|
+
- State: !`node -e "try{process.stdout.write(require('fs').readFileSync('.sdtk/orchestration-state.json','utf8'))}catch{process.stdout.write('{}')}"`
|
|
19
|
+
|
|
20
|
+
## Input
|
|
21
|
+
$ARGUMENTS
|
|
22
|
+
|
|
23
|
+
If no arguments provided, read current feature context from SHARED_PLANNING.md.
|
|
24
|
+
|
|
25
|
+
# SDTK Orchestrator (multi-agent workflow)
|
|
26
|
+
|
|
27
|
+
## Initialize
|
|
28
|
+
- Ensure feature key + feature name exist (ask if missing).
|
|
29
|
+
- Read `sdtk.config.json` (project stack + commands) if present.
|
|
30
|
+
- Run `sdtk generate --feature-key <KEY> --feature-name "<NAME>"` to create skeleton artifacts.
|
|
31
|
+
|
|
32
|
+
## Execute pipeline (one phase per turn)
|
|
33
|
+
- Default role: PM (entry point) if user did not specify.
|
|
34
|
+
- Respect role tags: `/pm`, `/ba`, `/arch`, `/dev`, `/qa`.
|
|
35
|
+
- For each phase:
|
|
36
|
+
- Create/update the phase artifact(s) in `docs/`.
|
|
37
|
+
- If phase is ARCH and API contract/flow is in scope, invoke `/api-doc` to produce/update `docs/api/[FeaturePascal]_API.yaml`, `docs/api/[FEATURE_KEY]_ENDPOINTS.md`, and `docs/api/[feature_snake]_api_flow_list.txt`.
|
|
38
|
+
- If phase is ARCH and API detail spec is in scope, invoke `/api-design-spec` to produce/update `docs/api/[FEATURE_KEY]_API_DESIGN_DETAIL.md`.
|
|
39
|
+
- If phase is ARCH and UI flow behavior is in scope, invoke `/screen-design-spec` to produce/update `docs/specs/[FEATURE_KEY]_FLOW_ACTION_SPEC.md`.
|
|
40
|
+
- If phase is QA and test-case specification is in scope, invoke `/test-case-spec` to produce/update `docs/qa/[FEATURE_KEY]_TEST_CASE.md`.
|
|
41
|
+
- Update `SHARED_PLANNING.md` (phase row + activity log).
|
|
42
|
+
- Update `QUALITY_CHECKLIST.md` (mark items PASS/Pending).
|
|
43
|
+
- Produce one clear handoff message to the next role.
|
|
44
|
+
|
|
45
|
+
## API design detail mode (Hybrid)
|
|
46
|
+
- Read `sdtk.config.json` key: `orchestration.apiDesignDetailMode`.
|
|
47
|
+
- Supported values:
|
|
48
|
+
- `auto` (default): run `/api-design-spec` when ARCH has API scope and YAML + flow list are available.
|
|
49
|
+
- `on`: always run `/api-design-spec` for API scope (fail fast if required inputs are missing).
|
|
50
|
+
- `off`: skip API design detail generation unless user explicitly requests it.
|
|
51
|
+
|
|
52
|
+
## Test-case spec mode (Hybrid)
|
|
53
|
+
- Read `sdtk.config.json` key: `orchestration.testCaseSpecMode`.
|
|
54
|
+
- Supported values:
|
|
55
|
+
- `auto` (default): run `/test-case-spec` when QA phase requires reusable test-case artifact.
|
|
56
|
+
- `on`: always run `/test-case-spec` for QA phase (fail fast if required inputs are missing).
|
|
57
|
+
- `off`: skip test-case spec generation unless user explicitly requests it.
|
|
58
|
+
|
|
59
|
+
## Guardrails
|
|
60
|
+
- Do not skip phases; if prerequisites are missing, ask focused questions.
|
|
61
|
+
- Keep traceability: REQ -> BR/UC/AC -> design -> backlog -> code/tests -> QA report.
|
|
62
|
+
- Require code review completion before QA handoff.
|
|
63
|
+
- If input requirements are VI/JP: preserve original text + add EN translation in appendix for traceability (at least in Project Initiation and BA spec).
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: pm
|
|
3
|
+
description: Product Manager + meta-orchestrator workflow for SDTK. Use when you need to start a new feature (Phase 1) or produce PM planning artifacts (PRD + BACKLOG) and update SHARED_PLANNING.md / QUALITY_CHECKLIST.md with correct phase handoffs.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
## SDTK Pipeline Rules (always apply)
|
|
7
|
+
1. Pipeline: PM Initiation → BA Analysis → PM Planning → Architecture Design → Development + Review → QA Validation
|
|
8
|
+
2. After completing phase work: update SHARED_PLANNING.md + QUALITY_CHECKLIST.md
|
|
9
|
+
3. If unclear: log OQ-xx in artifact, escalate to PM (PM asks user if needed)
|
|
10
|
+
4. Traceability: REQ → BR/UC/AC → design → backlog → code/tests → QA
|
|
11
|
+
5. Code review must be COMPLETE before QA phase can start
|
|
12
|
+
6. Do not skip phases. If inputs missing, ask focused questions.
|
|
13
|
+
|
|
14
|
+
## Prerequisites (verify before proceeding)
|
|
15
|
+
Read QUALITY_CHECKLIST.md and verify:
|
|
16
|
+
- Phase 1 (PM Init): No prerequisites required.
|
|
17
|
+
- Phase 2+ (PM Planning): BA Analysis gate must show all items [x] Done.
|
|
18
|
+
|
|
19
|
+
If prerequisites NOT met: report which gate is missing, suggest user run the prerequisite phase first.
|
|
20
|
+
|
|
21
|
+
## Current Context
|
|
22
|
+
- Config: !`node -e "try{process.stdout.write(require('fs').readFileSync('sdtk.config.json','utf8'))}catch{process.stdout.write('{}')}"`
|
|
23
|
+
- Pipeline: !`node -e "try{process.stdout.write(require('fs').readFileSync('SHARED_PLANNING.md','utf8'))}catch{process.stdout.write('Not initialized')}"`
|
|
24
|
+
- Gates: !`node -e "try{process.stdout.write(require('fs').readFileSync('QUALITY_CHECKLIST.md','utf8'))}catch{process.stdout.write('Not initialized')}"`
|
|
25
|
+
- State: !`node -e "try{process.stdout.write(require('fs').readFileSync('.sdtk/orchestration-state.json','utf8'))}catch{process.stdout.write('{}')}"`
|
|
26
|
+
|
|
27
|
+
## Input
|
|
28
|
+
$ARGUMENTS
|
|
29
|
+
|
|
30
|
+
If no arguments provided, read current feature context from SHARED_PLANNING.md.
|
|
31
|
+
|
|
32
|
+
# SDTK PM (Entry Point + Planning)
|
|
33
|
+
|
|
34
|
+
## Outputs
|
|
35
|
+
- Phase 1: `docs/product/PROJECT_INITIATION_[FEATURE_KEY].md`
|
|
36
|
+
- Phase 2+ (after BA spec): `docs/product/PRD_[FEATURE_KEY].md` + `docs/product/BACKLOG_[FEATURE_KEY].md`
|
|
37
|
+
|
|
38
|
+
## Process
|
|
39
|
+
1. Confirm `FEATURE_KEY` + `FEATURE_NAME` + Phase-1 scope in/out.
|
|
40
|
+
2. Create/update PM artifact(s).
|
|
41
|
+
3. Ensure REQ-xx list is clear and testable.
|
|
42
|
+
4. If requirements are provided in VI/JP: keep the original text in an appendix and add an EN translation (literal) for traceability.
|
|
43
|
+
5. Update `SHARED_PLANNING.md` + `QUALITY_CHECKLIST.md`.
|
|
44
|
+
6. Handoff:
|
|
45
|
+
- After Project Initiation -> suggest user run `/ba` to analyze requirements
|
|
46
|
+
- After PRD/Backlog -> suggest user run `/arch` to design architecture
|
|
47
|
+
|
|
48
|
+
## Clarification And Decisions (PM responsibility)
|
|
49
|
+
- Collect OQ-xx items raised by BA/ARCH/DEV/QA in their respective artifacts.
|
|
50
|
+
- Try to resolve OQ-xx using existing docs and reasonable product/tech decisions.
|
|
51
|
+
- If still missing information from the original input: ask the user (final stakeholder) and record the answer as the resolution.
|
|
52
|
+
- Record decisions in PRD `Decision Log` and update OQ-xx `Resolution` fields in the originating docs.
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: qa
|
|
3
|
+
description: QA workflow for SDTK. Use when you need to validate an implemented feature against BA/PRD/Backlog, run quality gates, document defects, and produce a QA_RELEASE_REPORT with a release decision.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
## SDTK Pipeline Rules (always apply)
|
|
7
|
+
1. Pipeline: PM Initiation → BA Analysis → PM Planning → Architecture Design → Development + Review → QA Validation
|
|
8
|
+
2. After completing phase work: update SHARED_PLANNING.md + QUALITY_CHECKLIST.md
|
|
9
|
+
3. If unclear: log OQ-xx in artifact, escalate to PM (PM asks user if needed)
|
|
10
|
+
4. Traceability: REQ → BR/UC/AC → design → backlog → code/tests → QA
|
|
11
|
+
5. Code review must be COMPLETE before QA phase can start
|
|
12
|
+
6. Do not skip phases. If inputs missing, ask focused questions.
|
|
13
|
+
|
|
14
|
+
## Prerequisites (verify before proceeding)
|
|
15
|
+
Read QUALITY_CHECKLIST.md and verify:
|
|
16
|
+
- Phase 4 DEV gate must show all items [x] Done (including code review completion).
|
|
17
|
+
|
|
18
|
+
If prerequisites NOT met: report which gate is missing, suggest user run `/dev` first to complete code review.
|
|
19
|
+
|
|
20
|
+
## Current Context
|
|
21
|
+
- Config: !`node -e "try{process.stdout.write(require('fs').readFileSync('sdtk.config.json','utf8'))}catch{process.stdout.write('{}')}"`
|
|
22
|
+
- Pipeline: !`node -e "try{process.stdout.write(require('fs').readFileSync('SHARED_PLANNING.md','utf8'))}catch{process.stdout.write('Not initialized')}"`
|
|
23
|
+
- Gates: !`node -e "try{process.stdout.write(require('fs').readFileSync('QUALITY_CHECKLIST.md','utf8'))}catch{process.stdout.write('Not initialized')}"`
|
|
24
|
+
- State: !`node -e "try{process.stdout.write(require('fs').readFileSync('.sdtk/orchestration-state.json','utf8'))}catch{process.stdout.write('{}')}"`
|
|
25
|
+
|
|
26
|
+
## Input
|
|
27
|
+
$ARGUMENTS
|
|
28
|
+
|
|
29
|
+
If no arguments provided, read current feature context from SHARED_PLANNING.md.
|
|
30
|
+
|
|
31
|
+
# SDTK QA (Testing + Release Decision)
|
|
32
|
+
|
|
33
|
+
## Output
|
|
34
|
+
- `docs/qa/QA_RELEASE_REPORT_[FEATURE_KEY].md`
|
|
35
|
+
- Optional (when detailed test design spec is requested):
|
|
36
|
+
- `docs/qa/[FEATURE_KEY]_TEST_CASE.md` via `/test-case-spec`
|
|
37
|
+
|
|
38
|
+
## Process
|
|
39
|
+
1. Validate prerequisites: DEV phase completed + code review PASS.
|
|
40
|
+
2. Create test strategy mapped to UC/AC.
|
|
41
|
+
3. If test-case specification artifact is required, invoke `/test-case-spec` and align counts/coverage with release testing scope.
|
|
42
|
+
4. If acceptance criteria / expected behavior is unclear: record OQ-xx in QA report and escalate to PM (suggest user run `/pm` if still missing info).
|
|
43
|
+
5. Execute/record results (unit/integration/e2e as applicable).
|
|
44
|
+
6. Record defects with severity and status.
|
|
45
|
+
7. Decide: APPROVED vs REJECTED (with reasons).
|
|
46
|
+
8. Update shared state + Phase 5 checklist.
|
|
47
|
+
9. Handoff: suggest user run `/pm` to finalize release status if approved.
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: screen-design-spec
|
|
3
|
+
description: Create/update screen flow-action specifications from requirement sources (Excel/Figma/spec docs), including screen flow PlantUML, UI item/action tables, API mapping tables, and screen-to-API traceability.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
## Required Inputs (read before proceeding)
|
|
7
|
+
Read the following artifacts for the current feature:
|
|
8
|
+
1. `docs/specs/BA_SPEC_*.md` — business rules, use cases
|
|
9
|
+
2. `docs/architecture/ARCH_DESIGN_*.md` — system components
|
|
10
|
+
3. `docs/api/[FEATURE_KEY]_ENDPOINTS.md` — API endpoints (when available)
|
|
11
|
+
|
|
12
|
+
## Input
|
|
13
|
+
$ARGUMENTS
|
|
14
|
+
|
|
15
|
+
# SDTK Screen Flow Action Spec
|
|
16
|
+
|
|
17
|
+
## Outputs
|
|
18
|
+
- `docs/specs/[FEATURE_KEY]_FLOW_ACTION_SPEC.md`
|
|
19
|
+
- Optional supporting docs:
|
|
20
|
+
- `docs/specs/[FEATURE_KEY]_FIGMA_LAYOUT.md`
|
|
21
|
+
- `docs/specs/[FEATURE_KEY]_DESIGN_SPEC_FROM_EXCEL.md`
|
|
22
|
+
- `docs/specs/assets/[feature_snake]/screens/*`
|
|
23
|
+
|
|
24
|
+
## Required Inputs
|
|
25
|
+
- Feature key/name
|
|
26
|
+
- Primary requirement sources (BA spec, architecture, customer design docs)
|
|
27
|
+
- Screen source references (Figma URLs and/or requirement screenshots)
|
|
28
|
+
- API endpoint source (`docs/api/[FEATURE_KEY]_ENDPOINTS.md`) when available
|
|
29
|
+
|
|
30
|
+
## Process
|
|
31
|
+
1. Read requirement sources and identify in-scope screens, dialogs, and transitions.
|
|
32
|
+
2. Read and apply rules from `.claude/skills/references/FLOW_ACTION_SPEC_CREATION_RULES.md`.
|
|
33
|
+
3. Build/update section `Feature overview` and `Screen flow action` (PlantUML).
|
|
34
|
+
4. For each screen/dialog:
|
|
35
|
+
- Add metadata (screen ID, source link)
|
|
36
|
+
- Add screen image reference
|
|
37
|
+
- Add UI item/action table with `No` column
|
|
38
|
+
- Add API mapping table (trigger -> API -> data usage)
|
|
39
|
+
5. Build/update `System processing flow` from use-case and process sources.
|
|
40
|
+
6. Build/update `Open questions` for unresolved behavior/API/data points.
|
|
41
|
+
7. Build/update `Screen - API Mapping` summary section.
|
|
42
|
+
8. Validate:
|
|
43
|
+
- global numbering consistency (no screen-level reset)
|
|
44
|
+
- no broken image paths
|
|
45
|
+
- PlantUML renderability
|
|
46
|
+
- consistency with API endpoints spec
|
|
47
|
+
- EN artifact hygiene (no VI leftovers, no mojibake, no merged heading lines)
|
|
48
|
+
- for legacy specs with per-screen reset numbering: run renumber migration first
|
|
49
|
+
9. Update document history and handoff to ARCH/DEV.
|
|
50
|
+
|
|
51
|
+
## Rule References
|
|
52
|
+
- Core rules: `.claude/skills/references/FLOW_ACTION_SPEC_CREATION_RULES.md`
|
|
53
|
+
- Numbering reference: `.claude/skills/references/numbering-rules.md`
|
|
54
|
+
- Figma reference: `.claude/skills/references/figma-mcp.md`
|
|
55
|
+
- Excel image export reference: `.claude/skills/references/excel-image-export.md`
|
|
56
|
+
|
|
57
|
+
## Validation Script
|
|
58
|
+
- `scripts/validate_flow_action_spec_numbering.py`
|
|
59
|
+
- Checks duplicate/resetted numbering in action tables.
|
|
60
|
+
- Checks encoding/markdown hygiene.
|
|
61
|
+
- For EN artifacts, run with `--en-check`:
|
|
62
|
+
- `python scripts/validate_flow_action_spec_numbering.py --spec "docs/specs/[FEATURE_KEY]_FLOW_ACTION_SPEC.md" --en-check`
|
|
63
|
+
- `scripts/renumber_flow_action_spec_global.py`
|
|
64
|
+
- Auto-migrates action table `No` fields to global numbering.
|
|
65
|
+
- Dry-run:
|
|
66
|
+
- `python scripts/renumber_flow_action_spec_global.py --spec "docs/specs/[FEATURE_KEY]_FLOW_ACTION_SPEC.md"`
|
|
67
|
+
- Apply:
|
|
68
|
+
- `python scripts/renumber_flow_action_spec_global.py --spec "docs/specs/[FEATURE_KEY]_FLOW_ACTION_SPEC.md" --write`
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: test-case-spec
|
|
3
|
+
description: Generate screen-based QA test-case markdown in Excel-aligned layout (Statistic + per-screen UTC/ITC worksheets). Use when QA needs reusable test design artifacts before or during execution.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
## Required Inputs (read before proceeding)
|
|
7
|
+
Read the following artifacts for the current feature:
|
|
8
|
+
1. `docs/specs/[FEATURE_KEY]_FLOW_ACTION_SPEC.md` — screen/flow references
|
|
9
|
+
2. `docs/specs/BA_SPEC_[FEATURE_KEY].md` — business rules, use cases
|
|
10
|
+
3. `docs/api/[FEATURE_KEY]_ENDPOINTS.md` — API reference
|
|
11
|
+
4. `docs/specs/Q&A.md` or `docs/en/specs/Q&A.md` — clarification source (when available)
|
|
12
|
+
|
|
13
|
+
## Input
|
|
14
|
+
$ARGUMENTS
|
|
15
|
+
|
|
16
|
+
# SDTK Test Case Spec
|
|
17
|
+
|
|
18
|
+
## Outputs
|
|
19
|
+
- `docs/qa/[FEATURE_KEY]_TEST_CASE.md`
|
|
20
|
+
- Optional project variant:
|
|
21
|
+
- `docs/en/qa/[FEATURE_KEY]_TEST_CASE.md` (only when project uses `docs/en/**`)
|
|
22
|
+
|
|
23
|
+
## Core Rules
|
|
24
|
+
1. Apply `.claude/skills/references/TEST_CASE_CREATION_RULES.md` first.
|
|
25
|
+
2. Keep section order fixed (Statistic -> Abbreviations -> Scope -> References -> Environment -> Coverage -> Screen-based UTC/ITC -> OQ -> STC/UAT note).
|
|
26
|
+
3. Use screen-first layout to mirror worksheet structure:
|
|
27
|
+
- each screen can have `[SCREEN_KEY]_UTC` and `[SCREEN_KEY]_ITC`.
|
|
28
|
+
4. Keep one unified 18-column schema for UTC/ITC rows.
|
|
29
|
+
5. Keep stable case IDs; do not renumber only because of regrouping.
|
|
30
|
+
6. Track unresolved decisions via `OQ-xx`.
|
|
31
|
+
|
|
32
|
+
## Procedure
|
|
33
|
+
1. Resolve output path:
|
|
34
|
+
- default `docs/qa/[FEATURE_KEY]_TEST_CASE.md`
|
|
35
|
+
- use `docs/en/qa/...` only if the repo already follows `docs/en/**`.
|
|
36
|
+
2. Build/refresh `Statistic Summary (Excel-aligned)`:
|
|
37
|
+
- include UT total, IT total, grand total.
|
|
38
|
+
3. Build `Feature Coverage Matrix` from flow/action and API docs.
|
|
39
|
+
4. Split UTC/ITC by screen sections (`screen-first`), not by test type only.
|
|
40
|
+
5. Fill conflict/permission/error-path cases from Q&A decisions and API contracts.
|
|
41
|
+
6. Record unresolved items in section `Open Questions`.
|
|
42
|
+
7. Validate:
|
|
43
|
+
- counts in summary match table rows
|
|
44
|
+
- no placeholder tokens like `??`
|
|
45
|
+
- out-of-scope boundaries are explicit
|
|
46
|
+
|
|
47
|
+
## Role Integration
|
|
48
|
+
- Primary owner: `/qa`.
|
|
49
|
+
- `/qa` uses this skill to design/update reusable test-case specs.
|
|
50
|
+
- `/qa` still owns release decision artifact (`QA_RELEASE_REPORT_*`).
|
|
51
|
+
|
|
52
|
+
## Notes
|
|
53
|
+
- This skill is for test-case specification artifacts, not test execution logs.
|
|
54
|
+
- For release approval and defect triage, continue with `/qa`.
|
|
55
|
+
|
|
56
|
+
## Validator Script
|
|
57
|
+
- `scripts/validate_test_case_spec.py`
|
|
58
|
+
|
|
59
|
+
### Typical command
|
|
60
|
+
```bash
|
|
61
|
+
python scripts/validate_test_case_spec.py \
|
|
62
|
+
--file "docs/qa/[FEATURE_KEY]_TEST_CASE.md"
|
|
63
|
+
```
|
|
@@ -51,6 +51,9 @@ The script renders templates into `docs/**` and updates:
|
|
|
51
51
|
|
|
52
52
|
## Rules Used by Toolkit
|
|
53
53
|
- API design/flowchart rules:
|
|
54
|
+
- `templates/docs/api/YAML_CREATION_RULES.md`
|
|
55
|
+
- `templates/docs/api/API_DESIGN_FLOWCHART_CREATION_RULES.md`
|
|
56
|
+
- Compatibility notes kept for legacy references:
|
|
54
57
|
- `templates/docs/api/FLOWCHART_CREATION_RULES.md`
|
|
55
58
|
- `templates/docs/api/API_DESIGN_CREATION_RULES.md`
|
|
56
59
|
- Screen flow-action spec rules:
|
|
@@ -58,5 +61,3 @@ The script renders templates into `docs/**` and updates:
|
|
|
58
61
|
- Numbering mode is fixed: global numbering across full document (no screen-level reset).
|
|
59
62
|
- QA test-case spec rules:
|
|
60
63
|
- `templates/docs/qa/TEST_CASE_CREATION_RULES.md`
|
|
61
|
-
|
|
62
|
-
|