sdtk-kit 0.3.9 → 1.0.0
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/LICENSE +21 -0
- package/README.md +123 -177
- package/package.json +52 -46
- package/scripts/postinstall.js +40 -0
- package/assets/manifest/toolkit-bundle.manifest.json +0 -473
- package/assets/manifest/toolkit-bundle.sha256.txt +0 -93
- package/assets/toolkit/toolkit/AGENTS.md +0 -131
- package/assets/toolkit/toolkit/install.ps1 +0 -310
- package/assets/toolkit/toolkit/runtimes/claude/CLAUDE_TEMPLATE.md +0 -54
- package/assets/toolkit/toolkit/runtimes/codex/CODEX_TEMPLATE.md +0 -32
- package/assets/toolkit/toolkit/scripts/init-feature.ps1 +0 -261
- package/assets/toolkit/toolkit/scripts/install-claude-skills.ps1 +0 -169
- package/assets/toolkit/toolkit/scripts/install-codex-skills.ps1 +0 -189
- package/assets/toolkit/toolkit/scripts/uninstall-claude-skills.ps1 +0 -139
- package/assets/toolkit/toolkit/scripts/uninstall-codex-skills.ps1 +0 -116
- package/assets/toolkit/toolkit/sdtk.config.json +0 -28
- package/assets/toolkit/toolkit/sdtk.config.profiles.example.json +0 -50
- package/assets/toolkit/toolkit/skills/sdtk-api-design-spec/SKILL.md +0 -84
- package/assets/toolkit/toolkit/skills/sdtk-api-design-spec/references/API_DESIGN_CREATION_RULES.md +0 -22
- package/assets/toolkit/toolkit/skills/sdtk-api-design-spec/references/API_DESIGN_FLOWCHART_CREATION_RULES.md +0 -468
- package/assets/toolkit/toolkit/skills/sdtk-api-design-spec/references/FLOWCHART_CREATION_RULES.md +0 -20
- package/assets/toolkit/toolkit/skills/sdtk-api-design-spec/scripts/generate_api_design_detail.py +0 -732
- package/assets/toolkit/toolkit/skills/sdtk-api-doc/SKILL.md +0 -43
- package/assets/toolkit/toolkit/skills/sdtk-api-doc/references/API_DESIGN_FLOWCHART_CREATION_RULES.md +0 -468
- package/assets/toolkit/toolkit/skills/sdtk-api-doc/references/FLOWCHART_CREATION_RULES.md +0 -20
- package/assets/toolkit/toolkit/skills/sdtk-api-doc/references/YAML_CREATION_RULES.md +0 -128
- package/assets/toolkit/toolkit/skills/sdtk-arch/SKILL.md +0 -83
- package/assets/toolkit/toolkit/skills/sdtk-arch/references/API_DESIGN_CREATION_RULES.md +0 -22
- package/assets/toolkit/toolkit/skills/sdtk-arch/references/API_DESIGN_FLOWCHART_CREATION_RULES.md +0 -468
- package/assets/toolkit/toolkit/skills/sdtk-arch/references/FLOWCHART_CREATION_RULES.md +0 -20
- package/assets/toolkit/toolkit/skills/sdtk-arch/references/FLOW_ACTION_SPEC_CREATION_RULES.md +0 -220
- package/assets/toolkit/toolkit/skills/sdtk-arch/references/YAML_CREATION_RULES.md +0 -128
- package/assets/toolkit/toolkit/skills/sdtk-ba/SKILL.md +0 -29
- package/assets/toolkit/toolkit/skills/sdtk-design-layout/SKILL.md +0 -52
- package/assets/toolkit/toolkit/skills/sdtk-design-layout/scripts/render_design_layout_images.py +0 -246
- package/assets/toolkit/toolkit/skills/sdtk-dev/SKILL.md +0 -90
- package/assets/toolkit/toolkit/skills/sdtk-dev/prompts/code-quality-reviewer.md +0 -35
- package/assets/toolkit/toolkit/skills/sdtk-dev/prompts/implementer.md +0 -61
- package/assets/toolkit/toolkit/skills/sdtk-dev/prompts/spec-reviewer.md +0 -42
- package/assets/toolkit/toolkit/skills/sdtk-dev-backend/SKILL.md +0 -21
- package/assets/toolkit/toolkit/skills/sdtk-dev-frontend/SKILL.md +0 -19
- package/assets/toolkit/toolkit/skills/sdtk-orchestrator/SKILL.md +0 -80
- package/assets/toolkit/toolkit/skills/sdtk-pm/SKILL.md +0 -30
- package/assets/toolkit/toolkit/skills/sdtk-qa/SKILL.md +0 -53
- package/assets/toolkit/toolkit/skills/sdtk-screen-design-spec/SKILL.md +0 -86
- package/assets/toolkit/toolkit/skills/sdtk-screen-design-spec/references/FLOW_ACTION_SPEC_CREATION_RULES.md +0 -220
- package/assets/toolkit/toolkit/skills/sdtk-screen-design-spec/references/excel-image-export.md +0 -51
- package/assets/toolkit/toolkit/skills/sdtk-screen-design-spec/references/figma-mcp.md +0 -54
- package/assets/toolkit/toolkit/skills/sdtk-screen-design-spec/references/numbering-rules.md +0 -28
- package/assets/toolkit/toolkit/skills/sdtk-screen-design-spec/scripts/renumber_flow_action_spec_global.py +0 -136
- package/assets/toolkit/toolkit/skills/sdtk-screen-design-spec/scripts/validate_flow_action_spec_numbering.py +0 -414
- package/assets/toolkit/toolkit/skills/sdtk-test-case-spec/SKILL.md +0 -74
- package/assets/toolkit/toolkit/skills/sdtk-test-case-spec/references/TEST_CASE_CREATION_RULES.md +0 -129
- package/assets/toolkit/toolkit/skills/sdtk-test-case-spec/scripts/validate_test_case_spec.py +0 -97
- package/assets/toolkit/toolkit/skills/skills.catalog.yaml +0 -302
- package/assets/toolkit/toolkit/skills-claude/api-design-spec/SKILL.md +0 -90
- package/assets/toolkit/toolkit/skills-claude/api-doc/SKILL.md +0 -47
- package/assets/toolkit/toolkit/skills-claude/arch/SKILL.md +0 -59
- package/assets/toolkit/toolkit/skills-claude/ba/SKILL.md +0 -50
- package/assets/toolkit/toolkit/skills-claude/design-layout/SKILL.md +0 -57
- package/assets/toolkit/toolkit/skills-claude/dev/SKILL.md +0 -45
- package/assets/toolkit/toolkit/skills-claude/dev-backend/SKILL.md +0 -20
- package/assets/toolkit/toolkit/skills-claude/dev-frontend/SKILL.md +0 -18
- package/assets/toolkit/toolkit/skills-claude/orchestrator/SKILL.md +0 -63
- package/assets/toolkit/toolkit/skills-claude/pm/SKILL.md +0 -52
- package/assets/toolkit/toolkit/skills-claude/qa/SKILL.md +0 -48
- package/assets/toolkit/toolkit/skills-claude/screen-design-spec/SKILL.md +0 -90
- package/assets/toolkit/toolkit/skills-claude/test-case-spec/SKILL.md +0 -61
- package/assets/toolkit/toolkit/templates/QUALITY_CHECKLIST.md +0 -124
- package/assets/toolkit/toolkit/templates/README.md +0 -63
- package/assets/toolkit/toolkit/templates/SHARED_PLANNING.md +0 -80
- package/assets/toolkit/toolkit/templates/docs/api/API_DESIGN_CREATION_RULES.md +0 -22
- package/assets/toolkit/toolkit/templates/docs/api/API_DESIGN_DETAIL_TEMPLATE.md +0 -67
- package/assets/toolkit/toolkit/templates/docs/api/API_DESIGN_FLOWCHART_CREATION_RULES.md +0 -468
- package/assets/toolkit/toolkit/templates/docs/api/API_ENDPOINTS_TEMPLATE.md +0 -229
- package/assets/toolkit/toolkit/templates/docs/api/FEATURE_API_TEMPLATE.yaml +0 -20
- package/assets/toolkit/toolkit/templates/docs/api/FLOWCHART_CREATION_RULES.md +0 -20
- package/assets/toolkit/toolkit/templates/docs/api/YAML_CREATION_RULES.md +0 -128
- package/assets/toolkit/toolkit/templates/docs/api/feature_api_flow_list_TEMPLATE.txt +0 -12
- package/assets/toolkit/toolkit/templates/docs/architecture/ARCH_DESIGN_TEMPLATE.md +0 -109
- package/assets/toolkit/toolkit/templates/docs/database/DATABASE_SPEC_TEMPLATE.md +0 -175
- package/assets/toolkit/toolkit/templates/docs/design/DESIGN_LAYOUT_TEMPLATE.md +0 -60
- package/assets/toolkit/toolkit/templates/docs/dev/FEATURE_IMPL_PLAN_TEMPLATE.md +0 -73
- package/assets/toolkit/toolkit/templates/docs/product/BACKLOG_TEMPLATE.md +0 -50
- package/assets/toolkit/toolkit/templates/docs/product/PRD_TEMPLATE.md +0 -66
- package/assets/toolkit/toolkit/templates/docs/product/PROJECT_INITIATION_TEMPLATE.md +0 -98
- package/assets/toolkit/toolkit/templates/docs/qa/QA_RELEASE_REPORT_TEMPLATE.md +0 -61
- package/assets/toolkit/toolkit/templates/docs/qa/TEST_CASE_CREATION_RULES.md +0 -129
- package/assets/toolkit/toolkit/templates/docs/qa/TEST_CASE_TEMPLATE.md +0 -104
- package/assets/toolkit/toolkit/templates/docs/specs/BA_SPEC_TEMPLATE.md +0 -139
- package/assets/toolkit/toolkit/templates/docs/specs/FLOW_ACTION_SPEC_CREATION_RULES.md +0 -220
- package/assets/toolkit/toolkit/templates/docs/specs/FLOW_ACTION_SPEC_TEMPLATE.md +0 -197
- package/assets/toolkit/toolkit/templates/handoffs/ARCH_TO_DEV.md +0 -31
- package/assets/toolkit/toolkit/templates/handoffs/BA_TO_ARCH.md +0 -28
- package/assets/toolkit/toolkit/templates/handoffs/DEV_STAGE1_SPEC_REVIEW.md +0 -26
- package/assets/toolkit/toolkit/templates/handoffs/DEV_STAGE2_CODE_QUALITY_REVIEW.md +0 -20
- package/assets/toolkit/toolkit/templates/handoffs/DEV_TO_QA.md +0 -23
- package/assets/toolkit/toolkit/templates/handoffs/PM_TO_BA.md +0 -26
- package/assets/toolkit/toolkit/templates/handoffs/QA_RELEASE_DECISION.md +0 -21
- package/bin/sdtk.js +0 -15
- package/src/commands/auth.js +0 -85
- package/src/commands/generate.js +0 -177
- package/src/commands/help.js +0 -101
- package/src/commands/init.js +0 -97
- package/src/commands/runtime.js +0 -217
- package/src/index.js +0 -59
- package/src/lib/args.js +0 -116
- package/src/lib/errors.js +0 -41
- package/src/lib/github-access.js +0 -68
- package/src/lib/powershell.js +0 -85
- package/src/lib/scope.js +0 -68
- package/src/lib/state.js +0 -83
- package/src/lib/toolkit-payload.js +0 -99
|
@@ -1,57 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: design-layout
|
|
3
|
-
description: Generate UI screen layout documentation for a feature, including PlantUML SALT wireframes and item tables. Use when a feature includes frontend or 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 and fields
|
|
9
|
-
2. `docs/api/[FEATURE_KEY]_ENDPOINTS.md` - API list
|
|
10
|
-
|
|
11
|
-
## Input
|
|
12
|
-
$ARGUMENTS
|
|
13
|
-
|
|
14
|
-
# SDTK Screen Layout Design
|
|
15
|
-
|
|
16
|
-
## Critical Constraints
|
|
17
|
-
- I do not skip screen IDs or item numbering alignment with the wireframe.
|
|
18
|
-
- I do not hide render limitations; I record when screen preview rendering is unavailable.
|
|
19
|
-
- I do not leave rendered wireframes without visible local item markers that map back to the `Items` table.
|
|
20
|
-
- I do not pretend wireframe markers are the same thing as `FLOW_ACTION_SPEC` global action-table numbers.
|
|
21
|
-
|
|
22
|
-
## Output
|
|
23
|
-
- `docs/design/DESIGN_LAYOUT_[FEATURE_KEY].md`
|
|
24
|
-
|
|
25
|
-
## Process
|
|
26
|
-
1. Read BA spec (screens + fields) and API list.
|
|
27
|
-
2. For each screen, include:
|
|
28
|
-
- PlantUML `@startsalt` wireframe first, with visible screen-local markers embedded directly in the SALT labels
|
|
29
|
-
- API list table
|
|
30
|
-
- Item table whose `No` values exactly match the local marker sequence used in the wireframe for that screen
|
|
31
|
-
3. Use this wireframe-marker convention so the rendered SVG can be cross-referenced visually:
|
|
32
|
-
- markers are screen-local visual references and reset per screen
|
|
33
|
-
- prefer Unicode circled-number markers in generated docs; avoid parenthetical `(N)` markers because they blend into UI text and can conflict with SALT parsing
|
|
34
|
-
- text label or input prompt: prefix the visible label with the local marker
|
|
35
|
-
- button: place the local marker inside the visible button label
|
|
36
|
-
- table header: prefix the header text with the local marker
|
|
37
|
-
- standalone control, pagination, toggle, or status chip: prefix the visible label with the local marker
|
|
38
|
-
- do not rely on prose, comments, or a separate legend; the marker must be visible inside the rendered wireframe itself
|
|
39
|
-
- the local marker does not need to equal the `FLOW_ACTION_SPEC` global `No`; `screen-design-spec` publishes the mapping table
|
|
40
|
-
4. Keep screen IDs consistent (A-*, B-*, C-*).
|
|
41
|
-
5. After writing `DESIGN_LAYOUT`, attempt to render screen preview images by default:
|
|
42
|
-
- Run `.claude/skills/design-layout/scripts/render_design_layout_images.py` to extract `@startsalt` blocks and render `.svg` files.
|
|
43
|
-
- Output path: `docs/specs/assets/<feature_snake>/screens/<screen_id>.svg`
|
|
44
|
-
- The renderer warns if a screen wireframe has no visible local markers or still uses legacy `(N)` markers.
|
|
45
|
-
- If PlantUML is unavailable, rendering is skipped with a warning and the render-skipped note is used in `FLOW_ACTION_SPEC`.
|
|
46
|
-
|
|
47
|
-
## Screen Image Renderer
|
|
48
|
-
- Script: `.claude/skills/design-layout/scripts/render_design_layout_images.py`
|
|
49
|
-
- Usage:
|
|
50
|
-
```
|
|
51
|
-
python ".claude/skills/design-layout/scripts/render_design_layout_images.py" \
|
|
52
|
-
--design-layout "docs/design/DESIGN_LAYOUT_[FEATURE_KEY].md" \
|
|
53
|
-
--feature-key [FEATURE_KEY]
|
|
54
|
-
```
|
|
55
|
-
- Requires: Java + `plantuml.jar`
|
|
56
|
-
- Output: `.svg` files under `docs/specs/assets/<feature_snake>/screens/`
|
|
57
|
-
- Failure policy: non-blocking. Warns and continues if rendering is unavailable.
|
|
@@ -1,45 +0,0 @@
|
|
|
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).
|
|
@@ -1,20 +0,0 @@
|
|
|
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.
|
|
@@ -1,18 +0,0 @@
|
|
|
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.
|
|
@@ -1,63 +0,0 @@
|
|
|
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).
|
|
@@ -1,52 +0,0 @@
|
|
|
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.
|
|
@@ -1,48 +0,0 @@
|
|
|
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
|
|
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 are 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 are not met, report which gate is missing and 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 are 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. Keep the structured TEST_CASE total consistent with the release-report baseline; track E2E separately if needed.
|
|
42
|
-
4. Apply `governance/ai/core/SDTK_BENCHMARK_QA_MODE_POLICY.md` for benchmark-mode verdict rules when no executable build exists.
|
|
43
|
-
5. If acceptance criteria / expected behavior is unclear, record OQ-xx in QA report and preserve benchmark-expected ambiguity per `governance/ai/core/SDTK_BENCHMARK_OQ_POLICY.md`; escalate to PM.
|
|
44
|
-
6. Execute/record results (unit/integration/e2e as applicable).
|
|
45
|
-
7. Record defects with severity and status.
|
|
46
|
-
8. Decide: APPROVED vs REJECTED (with reasons).
|
|
47
|
-
9. Update shared state + Phase 5 checklist.
|
|
48
|
-
10. Handoff: suggest user run `/pm` to finalize release status if approved.
|
|
@@ -1,90 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: screen-design-spec
|
|
3
|
-
description: Create or update screen flow-action specifications from requirement sources, including screen flow PlantUML, UI item 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 and 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
|
-
## Critical Constraints
|
|
18
|
-
- I do not finalize UI-scope screens without a valid design source type and reference.
|
|
19
|
-
- I do not leave broken image paths or incomplete API mappings in the flow-action spec.
|
|
20
|
-
- I use new-style PlantUML activity diagram syntax only for the screen flow diagram.
|
|
21
|
-
- I do not mix legacy and new-style PlantUML activity syntax in the screen flow diagram.
|
|
22
|
-
- Do not mix legacy activity syntax such as `(*)`, `-->`, or `[edge label]` with new-style activity actions like `:Activity;`.
|
|
23
|
-
- I keep action-table numbering global across the document even when wireframe markers reset per screen.
|
|
24
|
-
|
|
25
|
-
## Outputs
|
|
26
|
-
- `docs/specs/[FEATURE_KEY]_FLOW_ACTION_SPEC.md`
|
|
27
|
-
- Optional supporting docs:
|
|
28
|
-
- `docs/specs/[FEATURE_KEY]_FIGMA_LAYOUT.md`
|
|
29
|
-
- `docs/specs/[FEATURE_KEY]_DESIGN_SPEC_FROM_EXCEL.md`
|
|
30
|
-
- `docs/specs/assets/[feature_snake]/screens/*`
|
|
31
|
-
|
|
32
|
-
## Required Inputs
|
|
33
|
-
- Feature key/name
|
|
34
|
-
- Primary requirement sources (BA spec, architecture, customer design docs)
|
|
35
|
-
- Screen source references, using one of these design source modes:
|
|
36
|
-
- `source-backed`: Figma URLs and/or requirement screenshots
|
|
37
|
-
- `generated-draft`: generated layout from `docs/design/DESIGN_LAYOUT_[FEATURE_KEY].md`
|
|
38
|
-
- API endpoint source (`docs/api/[FEATURE_KEY]_ENDPOINTS.md`) when available
|
|
39
|
-
|
|
40
|
-
## Process
|
|
41
|
-
1. Read requirement sources and identify in-scope screens, dialogs, and transitions.
|
|
42
|
-
2. Read and apply rules from `.claude/skills/references/FLOW_ACTION_SPEC_CREATION_RULES.md`.
|
|
43
|
-
3. Determine design source mode per screen:
|
|
44
|
-
- If Figma URL or screenshot exists: use `source-backed`.
|
|
45
|
-
- If no Figma/screenshot but feature has UI scope: use `generated-draft` and reference the corresponding section in `docs/design/DESIGN_LAYOUT_[FEATURE_KEY].md`.
|
|
46
|
-
- If screen has no UI scope: use `none`.
|
|
47
|
-
4. Build/update section `Feature overview` and `Screen flow action` (PlantUML).
|
|
48
|
-
5. For each screen/dialog:
|
|
49
|
-
- Add metadata (screen ID, Design Source Type, Design Source Reference)
|
|
50
|
-
- Add screen image reference (from Figma, screenshot, or rendered `.svg` from generated layout)
|
|
51
|
-
- For generated-draft wireframes, add a wireframe-marker mapping table from the screen-local wireframe markers to the global action-table `No`
|
|
52
|
-
- Add UI item/action table with `No` column
|
|
53
|
-
- Add API mapping table (trigger -> API -> data usage)
|
|
54
|
-
6. Build/update `System processing flow` from use-case and process sources.
|
|
55
|
-
7. Build/update `Open questions` for unresolved behavior/API/data points.
|
|
56
|
-
8. Build/update `Screen - API Mapping` summary section.
|
|
57
|
-
9. Validate:
|
|
58
|
-
- global numbering consistency (no screen-level reset)
|
|
59
|
-
- no broken image paths (for `generated-draft` screens, verify `.svg` exists or use render-skipped note)
|
|
60
|
-
- PlantUML renderability and new-style activity syntax consistency (no `(*)`, `-->`, or `[edge label]` mixing)
|
|
61
|
-
- consistency with API endpoints spec
|
|
62
|
-
- EN artifact hygiene (no VI leftovers, no mojibake, no merged heading lines)
|
|
63
|
-
- for legacy specs with per-screen reset numbering: run renumber migration first
|
|
64
|
-
- every UI-scope screen declares a Design Source Type (`source-backed` or `generated-draft`)
|
|
65
|
-
- every generated-draft screen with an embedded wireframe image includes a wireframe-marker mapping table to the global action-table `No`
|
|
66
|
-
10. For `generated-draft` screens, set `Screen image:` to the rendered `.svg` path if the file exists:
|
|
67
|
-
- Expected path (filesystem): `docs/specs/assets/<feature_snake>/screens/<screen_id>.svg`
|
|
68
|
-
- Markdown image path (file-relative): `assets/<feature_snake>/screens/<screen_id>.svg`
|
|
69
|
-
- If the `.svg` does not exist, replace the image reference with:
|
|
70
|
-
`> Screen image not rendered in this environment. See Design Source Reference for layout.`
|
|
71
|
-
11. For generated-draft screens, treat wireframe markers as screen-local visual references:
|
|
72
|
-
- the local marker sequence may reset per screen
|
|
73
|
-
- do not renumber the wireframe to fake equality with the global action-table `No`
|
|
74
|
-
- publish the mapping table directly under the screen image so reviewers can cross-reference local markers to global action-table numbers
|
|
75
|
-
12. Update document history and handoff to ARCH/DEV.
|
|
76
|
-
|
|
77
|
-
## Rule References
|
|
78
|
-
- Core rules: `.claude/skills/references/FLOW_ACTION_SPEC_CREATION_RULES.md`
|
|
79
|
-
- Numbering reference: `.claude/skills/references/numbering-rules.md`
|
|
80
|
-
- Figma reference: `.claude/skills/references/figma-mcp.md`
|
|
81
|
-
- Excel image export reference: `.claude/skills/references/excel-image-export.md`
|
|
82
|
-
|
|
83
|
-
## Validation Script
|
|
84
|
-
- `.claude/skills/screen-design-spec/scripts/validate_flow_action_spec_numbering.py`
|
|
85
|
-
- `python ".claude/skills/screen-design-spec/scripts/validate_flow_action_spec_numbering.py" --spec "docs/specs/[FEATURE_KEY]_FLOW_ACTION_SPEC.md" --en-check`
|
|
86
|
-
- `.claude/skills/screen-design-spec/scripts/renumber_flow_action_spec_global.py`
|
|
87
|
-
- Dry-run:
|
|
88
|
-
- `python ".claude/skills/screen-design-spec/scripts/renumber_flow_action_spec_global.py" --spec "docs/specs/[FEATURE_KEY]_FLOW_ACTION_SPEC.md"`
|
|
89
|
-
- Apply:
|
|
90
|
-
- `python ".claude/skills/screen-design-spec/scripts/renumber_flow_action_spec_global.py" --spec "docs/specs/[FEATURE_KEY]_FLOW_ACTION_SPEC.md" --write`
|
|
@@ -1,61 +0,0 @@
|
|
|
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
|
-
4. Keep one unified 18-column schema for UTC/ITC rows.
|
|
28
|
-
5. Keep stable case IDs; do not renumber only because of regrouping.
|
|
29
|
-
6. Track unresolved decisions via `OQ-xx` and keep benchmark-expected OQs explicitly OPEN per `governance/ai/core/SDTK_BENCHMARK_OQ_POLICY.md`.
|
|
30
|
-
|
|
31
|
-
## Procedure
|
|
32
|
-
1. Resolve output path:
|
|
33
|
-
- default `docs/qa/[FEATURE_KEY]_TEST_CASE.md`
|
|
34
|
-
- use `docs/en/qa/...` only if the repo already follows `docs/en/**`.
|
|
35
|
-
2. Build/refresh `Statistic Summary (Excel-aligned)` with UT total, IT total, and grand total.
|
|
36
|
-
3. Build `Feature Coverage Matrix` from flow/action and API docs.
|
|
37
|
-
4. Split UTC/ITC by screen sections (`screen-first`), not by test type only.
|
|
38
|
-
5. Fill conflict/permission/error-path cases from Q&A decisions and API contracts.
|
|
39
|
-
6. Record unresolved items in section `Open Questions`.
|
|
40
|
-
7. Validate:
|
|
41
|
-
- counts in summary match table rows
|
|
42
|
-
- structured TEST_CASE total stays aligned with the QA release-report baseline; if E2E is tracked separately, label it separately instead of inflating grand total
|
|
43
|
-
- no placeholder tokens like `??`
|
|
44
|
-
- out-of-scope boundaries are explicit
|
|
45
|
-
|
|
46
|
-
## Role Integration
|
|
47
|
-
- Primary owner: `/qa`.
|
|
48
|
-
- `/qa` uses this skill to design/update reusable test-case specs.
|
|
49
|
-
- `/qa` still owns release decision artifact (`QA_RELEASE_REPORT_*`).
|
|
50
|
-
|
|
51
|
-
## Notes
|
|
52
|
-
- This skill is for test-case specification artifacts, not test execution logs.
|
|
53
|
-
- For release approval and defect triage, continue with `/qa`.
|
|
54
|
-
|
|
55
|
-
## Validator Script
|
|
56
|
-
- `scripts/validate_test_case_spec.py`
|
|
57
|
-
|
|
58
|
-
### Typical command
|
|
59
|
-
```bash
|
|
60
|
-
python scripts/validate_test_case_spec.py --file "docs/qa/[FEATURE_KEY]_TEST_CASE.md"
|
|
61
|
-
```
|
|
@@ -1,124 +0,0 @@
|
|
|
1
|
-
# QUALITY CHECKLIST
|
|
2
|
-
## Multi-Agent Development Pipeline Gates (v2.1 - 6 Phases)
|
|
3
|
-
|
|
4
|
-
**Current Feature:** `{{FEATURE_KEY}}`
|
|
5
|
-
**Last Updated:** `{{DATETIME}}`
|
|
6
|
-
**Overall Status:** `PHASE 1 PM INITIATION - IN PROGRESS`
|
|
7
|
-
|
|
8
|
-
---
|
|
9
|
-
|
|
10
|
-
## PHASE 1: PM INITIATION (Project Kickoff) CHECKLIST
|
|
11
|
-
|
|
12
|
-
| # | Criteria | Status | Verified By | Notes/Issues | Date |
|
|
13
|
-
|---|----------|--------|-------------|--------------|------|
|
|
14
|
-
| 1 | Requirements received from stakeholders | [ ] Pending | PM Agent | | |
|
|
15
|
-
| 2 | Business problem clearly defined | [ ] Pending | PM Agent | | |
|
|
16
|
-
| 3 | High-level scope documented (REQ-xx) + Open Questions (OQ-xx) captured | [ ] Pending | PM Agent | | |
|
|
17
|
-
| 4 | Stakeholders identified | [ ] Pending | PM Agent | | |
|
|
18
|
-
| 5 | Success criteria defined (measurable) | [ ] Pending | PM Agent | | |
|
|
19
|
-
| **6** | **PM INITIATION COMPLETE** | [ ] Pending | **PM Gate** | **@ba please analyze** | |
|
|
20
|
-
|
|
21
|
-
---
|
|
22
|
-
|
|
23
|
-
## PHASE 2: BA (Business Analysis) CHECKLIST
|
|
24
|
-
|
|
25
|
-
| # | Criteria | Status | Verified By | Notes/Issues | Date |
|
|
26
|
-
|---|----------|--------|-------------|--------------|------|
|
|
27
|
-
| 1 | Domain Glossary complete (all terms defined) | [ ] Pending | BA Agent | | |
|
|
28
|
-
| 2 | Business Rules numbered and complete (BR-01...) | [ ] Pending | BA Agent | | |
|
|
29
|
-
| 3 | Use Cases cover 100% requirements (UC-01...) | [ ] Pending | BA Agent | | |
|
|
30
|
-
| 4 | Data entities and relationships documented | [ ] Pending | BA Agent | | |
|
|
31
|
-
| 5 | Risks identified + prioritized (High/Med/Low) | [ ] Pending | BA Agent | | |
|
|
32
|
-
| 6 | Open questions listed for PM/ARCH review | [ ] Pending | BA Agent | | |
|
|
33
|
-
| **7** | **BA SPECS READY** | [ ] Pending | **BA Gate** | **@pm specs ready for PRD** | |
|
|
34
|
-
|
|
35
|
-
---
|
|
36
|
-
|
|
37
|
-
## PHASE 2+: PM PLANNING CHECKLIST
|
|
38
|
-
|
|
39
|
-
| # | Criteria | Status | Verified By | Notes/Issues | Date |
|
|
40
|
-
|---|----------|--------|-------------|--------------|------|
|
|
41
|
-
| 1 | PRD aligns 100% with BA specs + resolves/records OQ decisions | [ ] Pending | PM Agent | | |
|
|
42
|
-
| 2 | Backlog 100% traceable to BA Use Cases | [ ] Pending | PM Agent | | |
|
|
43
|
-
| 3 | Story priorities reflect business value (MoSCoW) | [ ] Pending | PM Agent | | |
|
|
44
|
-
| 4 | Success metrics defined and measurable | [ ] Pending | PM Agent | | |
|
|
45
|
-
| 5 | Release criteria objective and testable | [ ] Pending | PM Agent | | |
|
|
46
|
-
| 6 | Effort estimates realistic (Fibonacci story points) | [ ] Pending | PM Agent | | |
|
|
47
|
-
| **7** | **PM BACKLOG READY** | [ ] Pending | **PM Gate** | **@arch please design** | |
|
|
48
|
-
|
|
49
|
-
---
|
|
50
|
-
|
|
51
|
-
## PHASE 3: ARCH (Solution Architecture) CHECKLIST
|
|
52
|
-
|
|
53
|
-
| # | Criteria | Status | Verified By | Notes/Issues | Date |
|
|
54
|
-
|---|----------|--------|-------------|--------------|------|
|
|
55
|
-
| 1 | System architecture diagram complete + assumptions/OQ documented | [ ] Pending | ARCH Agent | | |
|
|
56
|
-
| 2 | Database schema/ERD documented + `DATABASE_SPEC_[FEATURE_KEY].md` updated (if DB scope) | [ ] Pending | ARCH Agent | | |
|
|
57
|
-
| 3 | API contract docs updated (`[FeaturePascal]_API.yaml` + `[FEATURE_KEY]_ENDPOINTS.md`) when API scope exists | [ ] Pending | ARCH Agent | | |
|
|
58
|
-
| 4 | API flow list updated (`[feature_snake]_api_flow_list.txt`) when API scope exists | [ ] Pending | ARCH Agent | | |
|
|
59
|
-
| 5 | API design detail updated (`[FEATURE_KEY]_API_DESIGN_DETAIL.md`) when API scope exists and mode is `auto/on` | [ ] Pending | ARCH Agent | Mode from `sdtk.config.json` | |
|
|
60
|
-
| 6 | Flow-action screen spec updated (`[FEATURE_KEY]_FLOW_ACTION_SPEC.md`) when UI flow scope exists | [ ] Pending | ARCH Agent | | |
|
|
61
|
-
| 7 | Screen layout spec updated (`DESIGN_LAYOUT_[FEATURE_KEY].md`) when UI scope exists | [ ] Pending | ARCH Agent | | |
|
|
62
|
-
| 8 | Security model documented (auth/authz) | [ ] Pending | ARCH Agent | | |
|
|
63
|
-
| **9** | **ARCH DESIGN READY** | [ ] Pending | **ARCH Gate** | **@dev please implement** | |
|
|
64
|
-
|
|
65
|
-
---
|
|
66
|
-
|
|
67
|
-
## PHASE 4: DEV (Development + Code Review) CHECKLIST
|
|
68
|
-
|
|
69
|
-
| # | Criteria | Status | Verified By | Notes/Issues | Date |
|
|
70
|
-
|---|----------|--------|-------------|--------------|------|
|
|
71
|
-
| 1 | Implementation Plan matches ARCH design + backlog + clarifications logged (OQ-xx) | [ ] Pending | Dev Agent | | |
|
|
72
|
-
| 2 | **Unit Tests:** coverage meets target | [ ] Pending | Dev Agent | | |
|
|
73
|
-
| 3 | **Integration Tests:** critical flows covered | [ ] Pending | Dev Agent | | |
|
|
74
|
-
| 4 | Linting and type checking passes | [ ] Pending | Dev Agent | | |
|
|
75
|
-
| 5 | Security checklist passed | [ ] Pending | Dev Agent | | |
|
|
76
|
-
| 6 | Performance baseline established | [ ] Pending | Dev Agent | | |
|
|
77
|
-
| 7 | **Self Code Review:** Complete | [ ] Pending | Dev Agent | MANDATORY | |
|
|
78
|
-
| 8 | **Peer Code Review:** Requested | [ ] Pending | Dev Agent | MANDATORY (AI allowed) | |
|
|
79
|
-
| 9 | **Peer Code Review:** All comments addressed | [ ] Pending | Dev Agent | MANDATORY (AI allowed) | |
|
|
80
|
-
| **10** | **DEV READY FOR QA** | [ ] Pending | **Dev Gate** | **Code Review [x] then @qa please test** | |
|
|
81
|
-
|
|
82
|
-
---
|
|
83
|
-
|
|
84
|
-
## PHASE 5: QA (Quality Assurance) CHECKLIST
|
|
85
|
-
|
|
86
|
-
| # | Criteria | Status | Verified By | Notes/Issues | Date |
|
|
87
|
-
|---|----------|--------|-------------|--------------|------|
|
|
88
|
-
| 1 | Test Strategy covers all critical paths + unclear ACs escalated (OQ-xx) | [ ] Pending | QA Agent | | |
|
|
89
|
-
| 2 | Test case specification updated (`[FEATURE_KEY]_TEST_CASE.md`) when detailed test design scope exists | [ ] Pending | QA Agent | | |
|
|
90
|
-
| 3 | **E2E Tests:** P1 flows PASS (if applicable) | [ ] Pending | QA Agent | | |
|
|
91
|
-
| 4 | **Defects:** 0 HIGH severity open | [ ] Pending | QA Agent | | |
|
|
92
|
-
| 5 | **Coverage:** meets targets | [ ] Pending | QA Agent | | |
|
|
93
|
-
| 6 | No flaky tests | [ ] Pending | QA Agent | | |
|
|
94
|
-
| 7 | Performance meets NFRs | [ ] Pending | QA Agent | | |
|
|
95
|
-
| 8 | Release Report complete | [ ] Pending | QA Agent | | |
|
|
96
|
-
| **9** | **QA APPROVED** | [ ] Pending | **QA Gate** | **@pm please finalize release status** | |
|
|
97
|
-
|
|
98
|
-
---
|
|
99
|
-
|
|
100
|
-
## PHASE 6: PM CLOSURE CHECKLIST
|
|
101
|
-
|
|
102
|
-
| # | Criteria | Status | Verified By | Notes/Issues | Date |
|
|
103
|
-
|---|----------|--------|-------------|--------------|------|
|
|
104
|
-
| 1 | QA release decision reviewed by PM | [ ] Pending | PM Agent | | |
|
|
105
|
-
| 2 | Outstanding OQ/risks triaged for next iteration | [ ] Pending | PM Agent | | |
|
|
106
|
-
| 3 | Final status communicated to stakeholders | [ ] Pending | PM Agent | | |
|
|
107
|
-
| **4** | **FEATURE CLOSURE COMPLETE** | [ ] Pending | **PM Gate** | **Pipeline complete** | |
|
|
108
|
-
|
|
109
|
-
---
|
|
110
|
-
|
|
111
|
-
## FINAL RELEASE GATE
|
|
112
|
-
|
|
113
|
-
```
|
|
114
|
-
RELEASE STATUS: IN PROGRESS
|
|
115
|
-
|
|
116
|
-
FINAL VERIFICATION:
|
|
117
|
-
[ ] Phase 1 PM Init
|
|
118
|
-
[ ] Phase 2 BA
|
|
119
|
-
[ ] Phase 2+ PM Plan
|
|
120
|
-
[ ] Phase 3 ARCH
|
|
121
|
-
[ ] Phase 4 DEV + Code Review
|
|
122
|
-
[ ] Phase 5 QA
|
|
123
|
-
[ ] Phase 6 PM Closure
|
|
124
|
-
```
|
|
@@ -1,63 +0,0 @@
|
|
|
1
|
-
# Templates (SDTK)
|
|
2
|
-
|
|
3
|
-
Files in `toolkit/templates/` are skeleton artifacts used by `init-feature.ps1`
|
|
4
|
-
to bootstrap a new feature across the SDLC phases.
|
|
5
|
-
|
|
6
|
-
**Note:** These templates produce *scaffold* files with TBD placeholders.
|
|
7
|
-
The scaffolds define the document structure for each SDLC phase. Content is
|
|
8
|
-
expected to be filled in by human authors or AI agents working through the
|
|
9
|
-
6-phase pipeline (PM Init -> BA -> PM Planning -> ARCH -> DEV -> QA).
|
|
10
|
-
See `SHARED_PLANNING.md` (generated) for the phase pipeline tracker.
|
|
11
|
-
|
|
12
|
-
## Tokens
|
|
13
|
-
- `{{FEATURE_KEY}}` (UPPER_SNAKE_CASE), example: `WORKFLOW_ENGINE`
|
|
14
|
-
- `{{FEATURE_NAME}}`, example: `Workflow Engine`
|
|
15
|
-
- `{{FEATURE_PASCAL}}`, example: `WorkflowEngine`
|
|
16
|
-
- `{{FEATURE_SNAKE}}` (lower_snake_case), example: `workflow_engine`
|
|
17
|
-
- `{{DATE}}` format: `YYYY-MM-DD`
|
|
18
|
-
- `{{DATETIME}}` format: `YYYY-MM-DD HH:mm`
|
|
19
|
-
|
|
20
|
-
## Generate
|
|
21
|
-
Run from project root:
|
|
22
|
-
|
|
23
|
-
`powershell -ExecutionPolicy Bypass -File ".\\toolkit\\\scripts\\init-feature.ps1" -FeatureKey YOUR_FEATURE -FeatureName "Your Feature"`
|
|
24
|
-
|
|
25
|
-
The script renders templates into `docs/**` and updates:
|
|
26
|
-
- `SHARED_PLANNING.md`
|
|
27
|
-
- `QUALITY_CHECKLIST.md`
|
|
28
|
-
|
|
29
|
-
## Stack Configuration
|
|
30
|
-
- Stack and command values come from `sdtk.config.json` (project root).
|
|
31
|
-
- `init-feature.ps1` reads config values and injects them into templates.
|
|
32
|
-
|
|
33
|
-
## Added Architecture Outputs
|
|
34
|
-
- `docs/api/[FEATURE_KEY]_ENDPOINTS.md`
|
|
35
|
-
- `docs/api/[FEATURE_KEY]_API_DESIGN_DETAIL.md`
|
|
36
|
-
- `docs/database/DATABASE_SPEC_[FEATURE_KEY].md`
|
|
37
|
-
- `docs/specs/[FEATURE_KEY]_FLOW_ACTION_SPEC.md`
|
|
38
|
-
|
|
39
|
-
## Added QA Outputs
|
|
40
|
-
- `docs/qa/[FEATURE_KEY]_TEST_CASE.md`
|
|
41
|
-
- `docs/qa/QA_RELEASE_REPORT_[FEATURE_KEY].md`
|
|
42
|
-
|
|
43
|
-
## ARCH Orchestration Mapping
|
|
44
|
-
- API scope: use `sdtk-api-doc`.
|
|
45
|
-
- API detail scope (from YAML + flow list): use `sdtk-api-design-spec` (mode `apiDesignDetailMode: auto|on|off`).
|
|
46
|
-
- UI flow-action scope: use `sdtk-screen-design-spec`.
|
|
47
|
-
|
|
48
|
-
## QA Orchestration Mapping
|
|
49
|
-
- QA release decision/report scope: use `sdtk-qa`.
|
|
50
|
-
- QA detailed test-case spec scope: use `sdtk-test-case-spec` (mode `testCaseSpecMode: auto|on|off`).
|
|
51
|
-
|
|
52
|
-
## Rules Used by Toolkit
|
|
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:
|
|
57
|
-
- `templates/docs/api/FLOWCHART_CREATION_RULES.md`
|
|
58
|
-
- `templates/docs/api/API_DESIGN_CREATION_RULES.md`
|
|
59
|
-
- Screen flow-action spec rules:
|
|
60
|
-
- `templates/docs/specs/FLOW_ACTION_SPEC_CREATION_RULES.md`
|
|
61
|
-
- Numbering mode is fixed: global numbering across full document (no screen-level reset).
|
|
62
|
-
- QA test-case spec rules:
|
|
63
|
-
- `templates/docs/qa/TEST_CASE_CREATION_RULES.md`
|