sdtk-kit 0.3.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/README.md +131 -0
- package/assets/manifest/toolkit-bundle.manifest.json +303 -0
- package/assets/manifest/toolkit-bundle.sha256.txt +59 -0
- package/assets/toolkit/toolkit/AGENTS.md +103 -0
- package/assets/toolkit/toolkit/install.ps1 +155 -0
- package/assets/toolkit/toolkit/runtimes/claude/CLAUDE_TEMPLATE.md +32 -0
- package/assets/toolkit/toolkit/runtimes/codex/CODEX_TEMPLATE.md +32 -0
- package/assets/toolkit/toolkit/scripts/init-feature.ps1 +253 -0
- package/assets/toolkit/toolkit/scripts/install-codex-skills.ps1 +181 -0
- package/assets/toolkit/toolkit/scripts/uninstall-codex-skills.ps1 +116 -0
- package/assets/toolkit/toolkit/sdtk.config.json +28 -0
- package/assets/toolkit/toolkit/sdtk.config.profiles.example.json +50 -0
- package/assets/toolkit/toolkit/skills/sdtk-api-design-spec/SKILL.md +78 -0
- package/assets/toolkit/toolkit/skills/sdtk-api-design-spec/references/API_DESIGN_CREATION_RULES.md +212 -0
- package/assets/toolkit/toolkit/skills/sdtk-api-design-spec/references/FLOWCHART_CREATION_RULES.md +397 -0
- package/assets/toolkit/toolkit/skills/sdtk-api-design-spec/scripts/generate_api_design_detail.py +565 -0
- package/assets/toolkit/toolkit/skills/sdtk-api-doc/SKILL.md +36 -0
- package/assets/toolkit/toolkit/skills/sdtk-api-doc/references/FLOWCHART_CREATION_RULES.md +397 -0
- package/assets/toolkit/toolkit/skills/sdtk-arch/SKILL.md +43 -0
- package/assets/toolkit/toolkit/skills/sdtk-arch/references/API_DESIGN_CREATION_RULES.md +212 -0
- package/assets/toolkit/toolkit/skills/sdtk-arch/references/FLOWCHART_CREATION_RULES.md +397 -0
- package/assets/toolkit/toolkit/skills/sdtk-arch/references/FLOW_ACTION_SPEC_CREATION_RULES.md +136 -0
- package/assets/toolkit/toolkit/skills/sdtk-ba/SKILL.md +24 -0
- package/assets/toolkit/toolkit/skills/sdtk-design-layout/SKILL.md +21 -0
- package/assets/toolkit/toolkit/skills/sdtk-dev/SKILL.md +20 -0
- package/assets/toolkit/toolkit/skills/sdtk-dev-backend/SKILL.md +17 -0
- package/assets/toolkit/toolkit/skills/sdtk-dev-frontend/SKILL.md +15 -0
- package/assets/toolkit/toolkit/skills/sdtk-orchestrator/SKILL.md +44 -0
- package/assets/toolkit/toolkit/skills/sdtk-pm/SKILL.md +26 -0
- package/assets/toolkit/toolkit/skills/sdtk-qa/SKILL.md +22 -0
- package/assets/toolkit/toolkit/skills/sdtk-screen-design-spec/SKILL.md +59 -0
- package/assets/toolkit/toolkit/skills/sdtk-screen-design-spec/references/FLOW_ACTION_SPEC_CREATION_RULES.md +136 -0
- package/assets/toolkit/toolkit/skills/sdtk-screen-design-spec/references/excel-image-export.md +51 -0
- package/assets/toolkit/toolkit/skills/sdtk-screen-design-spec/references/figma-mcp.md +54 -0
- package/assets/toolkit/toolkit/skills/sdtk-screen-design-spec/references/numbering-rules.md +76 -0
- package/assets/toolkit/toolkit/skills/sdtk-screen-design-spec/scripts/renumber_flow_action_spec_global.py +136 -0
- package/assets/toolkit/toolkit/skills/sdtk-screen-design-spec/scripts/validate_flow_action_spec_numbering.py +249 -0
- package/assets/toolkit/toolkit/skills/sdtk-test-case-spec/SKILL.md +65 -0
- package/assets/toolkit/toolkit/skills/sdtk-test-case-spec/references/TEST_CASE_CREATION_RULES.md +129 -0
- package/assets/toolkit/toolkit/skills/sdtk-test-case-spec/scripts/validate_test_case_spec.py +97 -0
- package/assets/toolkit/toolkit/templates/QUALITY_CHECKLIST.md +124 -0
- package/assets/toolkit/toolkit/templates/README.md +56 -0
- package/assets/toolkit/toolkit/templates/SHARED_PLANNING.md +80 -0
- package/assets/toolkit/toolkit/templates/docs/api/API_DESIGN_CREATION_RULES.md +212 -0
- package/assets/toolkit/toolkit/templates/docs/api/API_DESIGN_DETAIL_TEMPLATE.md +62 -0
- package/assets/toolkit/toolkit/templates/docs/api/API_ENDPOINTS_TEMPLATE.md +229 -0
- package/assets/toolkit/toolkit/templates/docs/api/FEATURE_API_TEMPLATE.yaml +20 -0
- package/assets/toolkit/toolkit/templates/docs/api/FLOWCHART_CREATION_RULES.md +397 -0
- package/assets/toolkit/toolkit/templates/docs/api/feature_api_flow_list_TEMPLATE.txt +12 -0
- package/assets/toolkit/toolkit/templates/docs/architecture/ARCH_DESIGN_TEMPLATE.md +109 -0
- package/assets/toolkit/toolkit/templates/docs/database/DATABASE_SPEC_TEMPLATE.md +175 -0
- package/assets/toolkit/toolkit/templates/docs/design/DESIGN_LAYOUT_TEMPLATE.md +49 -0
- package/assets/toolkit/toolkit/templates/docs/dev/FEATURE_IMPL_PLAN_TEMPLATE.md +73 -0
- package/assets/toolkit/toolkit/templates/docs/product/BACKLOG_TEMPLATE.md +50 -0
- package/assets/toolkit/toolkit/templates/docs/product/PRD_TEMPLATE.md +66 -0
- package/assets/toolkit/toolkit/templates/docs/product/PROJECT_INITIATION_TEMPLATE.md +98 -0
- package/assets/toolkit/toolkit/templates/docs/qa/QA_RELEASE_REPORT_TEMPLATE.md +61 -0
- package/assets/toolkit/toolkit/templates/docs/qa/TEST_CASE_CREATION_RULES.md +129 -0
- package/assets/toolkit/toolkit/templates/docs/qa/TEST_CASE_TEMPLATE.md +104 -0
- package/assets/toolkit/toolkit/templates/docs/specs/BA_SPEC_TEMPLATE.md +139 -0
- package/assets/toolkit/toolkit/templates/docs/specs/FLOW_ACTION_SPEC_CREATION_RULES.md +136 -0
- package/assets/toolkit/toolkit/templates/docs/specs/FLOW_ACTION_SPEC_TEMPLATE.md +160 -0
- package/bin/sdtk.js +15 -0
- package/package.json +47 -0
- package/src/commands/auth.js +85 -0
- package/src/commands/generate.js +177 -0
- package/src/commands/help.js +69 -0
- package/src/commands/init.js +73 -0
- package/src/index.js +56 -0
- package/src/lib/args.js +116 -0
- package/src/lib/errors.js +41 -0
- package/src/lib/github-access.js +68 -0
- package/src/lib/powershell.js +85 -0
- package/src/lib/state.js +83 -0
- package/src/lib/toolkit-payload.js +99 -0
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
# Screen Layout Design: {{FEATURE_KEY}} ({{FEATURE_NAME}})
|
|
2
|
+
|
|
3
|
+
**Document ID:** DESIGN_LAYOUT_{{FEATURE_KEY}}
|
|
4
|
+
**Version:** 1.0.0
|
|
5
|
+
**Date:** {{DATE}}
|
|
6
|
+
**Author:** ARCH Agent
|
|
7
|
+
**Status:** DRAFT - Ready for DEV Review
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## Abbreviations
|
|
12
|
+
|
|
13
|
+
| No | Abbreviation | Meaning |
|
|
14
|
+
| ---: | --- | --- |
|
|
15
|
+
| 1 | UI | User Interface |
|
|
16
|
+
| 2 | API | Application Programming Interface |
|
|
17
|
+
| 3 | OQ | Open Question |
|
|
18
|
+
|
|
19
|
+
---
|
|
20
|
+
|
|
21
|
+
## Screen List
|
|
22
|
+
|
|
23
|
+
| No | Screen ID | Screen Name | Description |
|
|
24
|
+
| ---: | --- | --- | --- |
|
|
25
|
+
| 1 | A-1 | TBD | TBD |
|
|
26
|
+
|
|
27
|
+
---
|
|
28
|
+
|
|
29
|
+
## A-1. TBD
|
|
30
|
+
|
|
31
|
+
```plantuml
|
|
32
|
+
@startsalt
|
|
33
|
+
{
|
|
34
|
+
{ "① TBD" | [② Action] }
|
|
35
|
+
}
|
|
36
|
+
@endsalt
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
### API List
|
|
40
|
+
|
|
41
|
+
| No | API ID | Endpoint |
|
|
42
|
+
| ---: | --- | --- |
|
|
43
|
+
| 1 | API-1 | TBD |
|
|
44
|
+
|
|
45
|
+
### Items
|
|
46
|
+
|
|
47
|
+
| No | Item | Type | Required | Notes |
|
|
48
|
+
| ---: | --- | --- | --- | --- |
|
|
49
|
+
| 1 | TBD | text | - | TBD |
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
# Feature Implementation Plan: {{FEATURE_KEY}} ({{FEATURE_NAME}})
|
|
2
|
+
|
|
3
|
+
**Document ID:** FEATURE_IMPL_PLAN_{{FEATURE_KEY}}
|
|
4
|
+
**Version:** 1.0.0
|
|
5
|
+
**Date:** {{DATE}}
|
|
6
|
+
**Author:** DEV Agent
|
|
7
|
+
**Status:** DRAFT
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## 1. OVERVIEW
|
|
12
|
+
|
|
13
|
+
### 1.1 Source Documents
|
|
14
|
+
- `docs/architecture/ARCH_DESIGN_{{FEATURE_KEY}}.md`
|
|
15
|
+
- `docs/product/BACKLOG_{{FEATURE_KEY}}.md`
|
|
16
|
+
- (optional) `docs/api/{{FEATURE_PASCAL}}_API.yaml`
|
|
17
|
+
- (optional) `docs/design/DESIGN_LAYOUT_{{FEATURE_KEY}}.md`
|
|
18
|
+
|
|
19
|
+
### 1.2 Tech Stack (project-level)
|
|
20
|
+
- Backend: {{STACK_BACKEND}}
|
|
21
|
+
- Frontend: {{STACK_FRONTEND}}
|
|
22
|
+
- Mobile: {{STACK_MOBILE}}
|
|
23
|
+
- Database: {{STACK_DATABASE}}
|
|
24
|
+
- Auth: {{STACK_AUTH}}
|
|
25
|
+
|
|
26
|
+
### 1.3 Local Commands (project-level)
|
|
27
|
+
- Backend tests: `{{CMD_BACKEND_TESTS}}`
|
|
28
|
+
- Backend typecheck: `{{CMD_BACKEND_TYPECHECK}}`
|
|
29
|
+
- Backend lint: `{{CMD_BACKEND_LINT}}`
|
|
30
|
+
- Frontend tests: `{{CMD_FRONTEND_TESTS}}`
|
|
31
|
+
- Frontend lint: `{{CMD_FRONTEND_LINT}}`
|
|
32
|
+
- E2E tests: `{{CMD_E2E_TESTS}}`
|
|
33
|
+
|
|
34
|
+
---
|
|
35
|
+
|
|
36
|
+
## 2. IMPLEMENTATION SCOPE
|
|
37
|
+
|
|
38
|
+
### 2.1 Backend
|
|
39
|
+
- TBD
|
|
40
|
+
|
|
41
|
+
### 2.2 Frontend
|
|
42
|
+
- TBD
|
|
43
|
+
|
|
44
|
+
---
|
|
45
|
+
|
|
46
|
+
## 3. OPEN QUESTIONS / CLARIFICATIONS
|
|
47
|
+
|
|
48
|
+
| Q-ID | Question | Decision Owner (PM/User) | Status (OPEN/RESOLVED) | Notes/Options | Resolution |
|
|
49
|
+
|------|----------|---------------------------|------------------------|---------------|------------|
|
|
50
|
+
| OQ-01 | TBD | PM | OPEN | TBD | TBD |
|
|
51
|
+
|
|
52
|
+
---
|
|
53
|
+
|
|
54
|
+
## 4. TEST PLAN
|
|
55
|
+
|
|
56
|
+
- Unit tests: target TBD
|
|
57
|
+
- Integration tests: target TBD
|
|
58
|
+
- E2E tests (if applicable): target TBD
|
|
59
|
+
|
|
60
|
+
---
|
|
61
|
+
|
|
62
|
+
## 5. CODE REVIEW (MANDATORY)
|
|
63
|
+
|
|
64
|
+
- [ ] Self review complete
|
|
65
|
+
- [ ] Peer review requested (AI peer review allowed)
|
|
66
|
+
- [ ] Peer comments addressed
|
|
67
|
+
- [ ] Approved
|
|
68
|
+
|
|
69
|
+
---
|
|
70
|
+
|
|
71
|
+
## 6. HANDOFF TO QA
|
|
72
|
+
|
|
73
|
+
`@qa please test {{FEATURE_KEY}} (after Code Review PASS)`
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# BACKLOG: {{FEATURE_KEY}} ({{FEATURE_NAME}})
|
|
2
|
+
|
|
3
|
+
**Document ID:** BACKLOG_{{FEATURE_KEY}}
|
|
4
|
+
**Version:** 1.0.0
|
|
5
|
+
**Date:** {{DATE}}
|
|
6
|
+
**Author:** PM Agent
|
|
7
|
+
**Status:** DRAFT - Ready for ARCH Review
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## BACKLOG SUMMARY
|
|
12
|
+
|
|
13
|
+
| Priority | Count | Stories |
|
|
14
|
+
|----------|-------|---------|
|
|
15
|
+
| **Must Have** | TBD | US-01... |
|
|
16
|
+
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
## EPIC-01: TBD
|
|
20
|
+
|
|
21
|
+
### US-01: TBD
|
|
22
|
+
|
|
23
|
+
**Priority:** Must Have | **Effort:** TBD | **Sprint:** TBD
|
|
24
|
+
|
|
25
|
+
**Story:**
|
|
26
|
+
As a <role>, I want <capability>, so that <benefit>.
|
|
27
|
+
|
|
28
|
+
**Acceptance Criteria:**
|
|
29
|
+
- [ ] AC-01.1: TBD
|
|
30
|
+
|
|
31
|
+
**Dependencies:** TBD
|
|
32
|
+
|
|
33
|
+
**Traceability:** UC-01, BR-01
|
|
34
|
+
|
|
35
|
+
---
|
|
36
|
+
|
|
37
|
+
## DEFINITION OF DONE
|
|
38
|
+
|
|
39
|
+
- [ ] All acceptance criteria verified
|
|
40
|
+
- [ ] Tests added and passing
|
|
41
|
+
- [ ] Code review complete
|
|
42
|
+
- [ ] Docs updated
|
|
43
|
+
|
|
44
|
+
---
|
|
45
|
+
|
|
46
|
+
## OPEN QUESTIONS (Backlog Clarifications)
|
|
47
|
+
|
|
48
|
+
| Q-ID | Question | Related Epic/Story | Decision Owner (PM/User) | Status (OPEN/RESOLVED) | Resolution |
|
|
49
|
+
|------|----------|--------------------|---------------------------|------------------------|------------|
|
|
50
|
+
| OQ-01 | TBD | EPIC-01 / US-01 | PM | OPEN | TBD |
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
# PRD: {{FEATURE_KEY}} ({{FEATURE_NAME}})
|
|
2
|
+
|
|
3
|
+
**Document ID:** PRD_{{FEATURE_KEY}}
|
|
4
|
+
**Version:** 1.0.0
|
|
5
|
+
**Date:** {{DATE}}
|
|
6
|
+
**Author:** PM Agent
|
|
7
|
+
**Status:** DRAFT - Ready for ARCH Review
|
|
8
|
+
**Source:** BA_SPEC_{{FEATURE_KEY}}.md
|
|
9
|
+
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
## 1. EXECUTIVE SUMMARY
|
|
13
|
+
|
|
14
|
+
## 2. GOALS & SUCCESS METRICS
|
|
15
|
+
|
|
16
|
+
| Goal ID | Goal | Success Metric | Target |
|
|
17
|
+
|---------|------|----------------|--------|
|
|
18
|
+
| G-01 | TBD | TBD | TBD |
|
|
19
|
+
|
|
20
|
+
---
|
|
21
|
+
|
|
22
|
+
## 3. PERSONAS / USER ROLES
|
|
23
|
+
|
|
24
|
+
## 4. FEATURE OVERVIEW
|
|
25
|
+
|
|
26
|
+
### 4.1 Feature Map (by Use Case)
|
|
27
|
+
| Use Case | Feature | Priority | Epic |
|
|
28
|
+
|----------|---------|----------|------|
|
|
29
|
+
| UC-01 | TBD | Must | EPIC-01 |
|
|
30
|
+
|
|
31
|
+
---
|
|
32
|
+
|
|
33
|
+
## 5. RELEASE CRITERIA
|
|
34
|
+
|
|
35
|
+
| RC ID | Criterion | Verification |
|
|
36
|
+
|-------|----------|--------------|
|
|
37
|
+
| RC-01 | TBD | QA report |
|
|
38
|
+
|
|
39
|
+
---
|
|
40
|
+
|
|
41
|
+
## 6. RISKS & OPEN QUESTIONS
|
|
42
|
+
|
|
43
|
+
### 6.1 Risks
|
|
44
|
+
|
|
45
|
+
| Risk ID | Risk | Probability | Impact | Mitigation |
|
|
46
|
+
|---------|------|-------------|--------|------------|
|
|
47
|
+
| R-01 | TBD | Medium | Medium | TBD |
|
|
48
|
+
|
|
49
|
+
### 6.2 Open Questions (Clarifications Needed)
|
|
50
|
+
|
|
51
|
+
| Q-ID | Question | Decision Owner (PM/User) | Needed By (Phase) | Status (OPEN/RESOLVED) | Notes/Options | Resolution |
|
|
52
|
+
|------|----------|---------------------------|-------------------|------------------------|---------------|------------|
|
|
53
|
+
| OQ-01 | TBD | User | Phase 3 (ARCH) | OPEN | TBD | TBD |
|
|
54
|
+
|
|
55
|
+
### 6.3 Decision Log (PM)
|
|
56
|
+
|
|
57
|
+
| D-ID | Decision | Rationale | Decided By (PM/User) | Date | Related Q-ID |
|
|
58
|
+
|------|----------|-----------|----------------------|------|--------------|
|
|
59
|
+
| D-01 | TBD | TBD | PM | {{DATE}} | OQ-01 |
|
|
60
|
+
|
|
61
|
+
---
|
|
62
|
+
|
|
63
|
+
## 7. NEXT ACTION
|
|
64
|
+
|
|
65
|
+
HANDOFF TO ARCH:
|
|
66
|
+
`@arch please design technical solution for {{FEATURE_KEY}} based on BA_SPEC + PRD + BACKLOG`
|
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
# PROJECT INITIATION: {{FEATURE_KEY}}
|
|
2
|
+
|
|
3
|
+
**Document ID:** PROJECT_INITIATION_{{FEATURE_KEY}}
|
|
4
|
+
**Version:** 1.0.0
|
|
5
|
+
**Date:** {{DATE}}
|
|
6
|
+
**Author:** PM Agent
|
|
7
|
+
**Status:** DRAFT - Ready for BA Analysis
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## 1. EXECUTIVE SUMMARY
|
|
12
|
+
|
|
13
|
+
**Feature Name:** {{FEATURE_NAME}}
|
|
14
|
+
|
|
15
|
+
## 2. BUSINESS PROBLEM
|
|
16
|
+
|
|
17
|
+
### 2.1 Current State
|
|
18
|
+
|
|
19
|
+
### 2.2 Pain Points
|
|
20
|
+
|
|
21
|
+
### 2.3 Business Impact
|
|
22
|
+
|
|
23
|
+
---
|
|
24
|
+
|
|
25
|
+
## 3. HIGH-LEVEL REQUIREMENTS
|
|
26
|
+
|
|
27
|
+
| Req ID | Requirement | Priority (MUST/SHOULD/COULD) |
|
|
28
|
+
|--------|------------|------------------------------|
|
|
29
|
+
| REQ-01 | TBD | MUST |
|
|
30
|
+
|
|
31
|
+
### 3.1 User Roles
|
|
32
|
+
|
|
33
|
+
| Role | Description | Key Capabilities |
|
|
34
|
+
|------|-------------|------------------|
|
|
35
|
+
| Administrator | TBD | TBD |
|
|
36
|
+
|
|
37
|
+
### 3.2 Key Screens (if UI involved)
|
|
38
|
+
- TBD
|
|
39
|
+
|
|
40
|
+
---
|
|
41
|
+
|
|
42
|
+
## 4. SUCCESS CRITERIA (Measurable)
|
|
43
|
+
|
|
44
|
+
| Metric ID | Metric | Target | Measurement Method |
|
|
45
|
+
|-----------|--------|--------|-------------------|
|
|
46
|
+
| SM-01 | TBD | TBD | TBD |
|
|
47
|
+
|
|
48
|
+
---
|
|
49
|
+
|
|
50
|
+
## 5. RISKS AND DEPENDENCIES
|
|
51
|
+
|
|
52
|
+
### 5.1 Risks
|
|
53
|
+
| Risk ID | Risk Description | Impact | Probability | Mitigation |
|
|
54
|
+
|---------|------------------|--------|-------------|------------|
|
|
55
|
+
| R-01 | TBD | Medium | Medium | TBD |
|
|
56
|
+
|
|
57
|
+
### 5.2 Dependencies
|
|
58
|
+
| Dep ID | Dependency | Type | Owner | Status |
|
|
59
|
+
|--------|------------|------|-------|--------|
|
|
60
|
+
| D-01 | TBD | Technical | TBD | TBD |
|
|
61
|
+
|
|
62
|
+
### 5.3 Open Questions (Clarifications Needed)
|
|
63
|
+
|
|
64
|
+
| Q-ID | Question | Decision Owner (PM/User) | Needed By (Phase) | Status (OPEN/RESOLVED) | Notes/Options | Resolution |
|
|
65
|
+
|------|----------|---------------------------|-------------------|------------------------|---------------|------------|
|
|
66
|
+
| OQ-01 | TBD | PM | Phase 2 (BA) | OPEN | TBD | TBD |
|
|
67
|
+
|
|
68
|
+
---
|
|
69
|
+
|
|
70
|
+
## 6. CONSTRAINTS
|
|
71
|
+
|
|
72
|
+
| Constraint | Description |
|
|
73
|
+
|------------|-------------|
|
|
74
|
+
| Stack | Backend: {{STACK_BACKEND}}; Frontend: {{STACK_FRONTEND}}; DB: {{STACK_DATABASE}} |
|
|
75
|
+
| Auth | {{STACK_AUTH}} |
|
|
76
|
+
|
|
77
|
+
---
|
|
78
|
+
|
|
79
|
+
## 7. NEXT STEPS
|
|
80
|
+
|
|
81
|
+
HANDOFF TO BA:
|
|
82
|
+
`@ba please analyze requirements for {{FEATURE_KEY}} and create BA_SPEC_{{FEATURE_KEY}}.md`
|
|
83
|
+
|
|
84
|
+
---
|
|
85
|
+
|
|
86
|
+
## 8. SOURCE REFERENCES
|
|
87
|
+
|
|
88
|
+
- Source requirements: `Requirements/...` (if available)
|
|
89
|
+
|
|
90
|
+
---
|
|
91
|
+
|
|
92
|
+
## APPENDIX A: Original Input (VI/JP) - keep as-is
|
|
93
|
+
|
|
94
|
+
Paste the original requirement text here without rewriting.
|
|
95
|
+
|
|
96
|
+
## APPENDIX B: English Translation (of Appendix A)
|
|
97
|
+
|
|
98
|
+
Provide an English translation of Appendix A (literal, for traceability).
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
# QA Release Report: {{FEATURE_KEY}} ({{FEATURE_NAME}})
|
|
2
|
+
|
|
3
|
+
**Document ID:** QA_RELEASE_REPORT_{{FEATURE_KEY}}
|
|
4
|
+
**Version:** 1.0.0
|
|
5
|
+
**Date:** {{DATE}}
|
|
6
|
+
**Author:** QA Agent
|
|
7
|
+
**Status:** DRAFT
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## 1. SUMMARY
|
|
12
|
+
|
|
13
|
+
| Item | Value |
|
|
14
|
+
|------|-------|
|
|
15
|
+
| Release Decision | TBD (APPROVED / REJECTED) |
|
|
16
|
+
| Build/Commit | TBD |
|
|
17
|
+
| Environment | TBD |
|
|
18
|
+
| Test Case Spec | `docs/qa/{{FEATURE_KEY}}_TEST_CASE.md` (if used) |
|
|
19
|
+
|
|
20
|
+
---
|
|
21
|
+
|
|
22
|
+
## 2. TEST EXECUTION
|
|
23
|
+
|
|
24
|
+
| Test Type | Result | Notes |
|
|
25
|
+
|-----------|--------|------|
|
|
26
|
+
| Unit | TBD | |
|
|
27
|
+
| Integration | TBD | |
|
|
28
|
+
| E2E | TBD | |
|
|
29
|
+
|
|
30
|
+
---
|
|
31
|
+
|
|
32
|
+
## 3. DEFECTS
|
|
33
|
+
|
|
34
|
+
| ID | Severity | Description | Status |
|
|
35
|
+
|----|----------|-------------|--------|
|
|
36
|
+
| BUG-01 | MEDIUM | TBD | OPEN |
|
|
37
|
+
|
|
38
|
+
---
|
|
39
|
+
|
|
40
|
+
## 4. OPEN QUESTIONS / CLARIFICATIONS
|
|
41
|
+
|
|
42
|
+
Use this section when acceptance criteria, expected behavior, or scope is unclear. Escalate to PM; if PM cannot resolve from docs, PM must confirm with the user.
|
|
43
|
+
|
|
44
|
+
| Q-ID | Question | Decision Owner (PM/User) | Status (OPEN/RESOLVED) | Notes/Options | Resolution |
|
|
45
|
+
|------|----------|---------------------------|------------------------|---------------|------------|
|
|
46
|
+
| OQ-01 | TBD | PM | OPEN | TBD | TBD |
|
|
47
|
+
|
|
48
|
+
---
|
|
49
|
+
|
|
50
|
+
## 5. RELEASE GATE
|
|
51
|
+
|
|
52
|
+
- [ ] 0 HIGH severity open
|
|
53
|
+
- [ ] Coverage meets targets
|
|
54
|
+
- [ ] NFRs met (performance/security)
|
|
55
|
+
|
|
56
|
+
---
|
|
57
|
+
|
|
58
|
+
## 6. HANDOFF
|
|
59
|
+
|
|
60
|
+
If APPROVED:
|
|
61
|
+
`@pm please finalize release status for {{FEATURE_KEY}}`
|
|
@@ -0,0 +1,129 @@
|
|
|
1
|
+
# TEST CASE CREATION RULES
|
|
2
|
+
## Canonical rules for `[FEATURE_KEY]_TEST_CASE.md`
|
|
3
|
+
|
|
4
|
+
**Version:** 1.0.0
|
|
5
|
+
**Last Updated:** 2026-02-25
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## 1. Purpose
|
|
10
|
+
- Standardize creation of feature test-case documents in markdown.
|
|
11
|
+
- Mirror Excel-style worksheet layout while keeping output reviewable in `.md`.
|
|
12
|
+
- Keep QA artifacts reusable across projects, domains, and screen sets.
|
|
13
|
+
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
## 2. Output Contract
|
|
17
|
+
- Primary output file:
|
|
18
|
+
- `docs/qa/[FEATURE_KEY]_TEST_CASE.md`
|
|
19
|
+
- Optional language/project variant:
|
|
20
|
+
- `docs/en/qa/[FEATURE_KEY]_TEST_CASE.md` (only when the project explicitly uses `docs/en/**`).
|
|
21
|
+
|
|
22
|
+
---
|
|
23
|
+
|
|
24
|
+
## 3. Required Section Order
|
|
25
|
+
1. Document metadata (`Document ID`, `Version`, `Date`, `Author`, `Status`)
|
|
26
|
+
2. `Statistic Summary (Excel-aligned)`
|
|
27
|
+
3. `Abbreviations`
|
|
28
|
+
4. `1. Scope`
|
|
29
|
+
5. `2. References`
|
|
30
|
+
6. `3. Test Environment and Common Data`
|
|
31
|
+
7. `4. Feature Coverage Matrix`
|
|
32
|
+
8. `5. Screen-based Test Cases (Excel-aligned)`
|
|
33
|
+
9. `6. Open Questions (for final freeze)`
|
|
34
|
+
10. `7. STC/UAT Note`
|
|
35
|
+
|
|
36
|
+
Do not reorder these sections unless the user requests a different contract.
|
|
37
|
+
|
|
38
|
+
---
|
|
39
|
+
|
|
40
|
+
## 4. Statistic Summary Rules
|
|
41
|
+
- Place summary near the top of the file (before detailed UTC/ITC tables).
|
|
42
|
+
- Keep columns aligned with Excel `Statistic` logic:
|
|
43
|
+
- `Num of Case`
|
|
44
|
+
- `OK`
|
|
45
|
+
- `NG`
|
|
46
|
+
- `Not tested yet`
|
|
47
|
+
- `Done (%)`
|
|
48
|
+
- `Updated Date`
|
|
49
|
+
- Compute:
|
|
50
|
+
- `Not tested yet = Num of Case - (OK + NG)`
|
|
51
|
+
- `Done (%) = (OK + NG) / Num of Case`
|
|
52
|
+
- Include subtotal rows at minimum:
|
|
53
|
+
- `Unit Test Total`
|
|
54
|
+
- `Integration Test Total`
|
|
55
|
+
- `Grand Total`
|
|
56
|
+
|
|
57
|
+
---
|
|
58
|
+
|
|
59
|
+
## 5. Screen-Based Worksheet Mapping
|
|
60
|
+
- Use `screen-first` layout to mirror Excel tabs:
|
|
61
|
+
- Each functional screen has a section (for example `SCH01`, `SCH02`, ...).
|
|
62
|
+
- Each screen section can have 2 sub-sections:
|
|
63
|
+
- `UTC` worksheet (name pattern: `[SCREEN_KEY]_UTC`)
|
|
64
|
+
- `ITC` worksheet (name pattern: `[SCREEN_KEY]_ITC`)
|
|
65
|
+
- Add one mapping table in section 5 that lists:
|
|
66
|
+
- `Screen`
|
|
67
|
+
- `Suggested Worksheet Pair`
|
|
68
|
+
- `UTC Cases`
|
|
69
|
+
- `ITC Cases`
|
|
70
|
+
- `Notes`
|
|
71
|
+
|
|
72
|
+
---
|
|
73
|
+
|
|
74
|
+
## 6. Test Case Table Schema (Mandatory)
|
|
75
|
+
- Use one unified 18-column schema for both UTC and ITC tables:
|
|
76
|
+
- `No`
|
|
77
|
+
- `Test Type`
|
|
78
|
+
- `Test Perspective`
|
|
79
|
+
- `Test Item`
|
|
80
|
+
- `Precondition`
|
|
81
|
+
- `Test Steps`
|
|
82
|
+
- `Expected Result`
|
|
83
|
+
- `Browser`
|
|
84
|
+
- `Test Execution Result`
|
|
85
|
+
- `Remarks`
|
|
86
|
+
- `Reviewer`
|
|
87
|
+
- `Review Date`
|
|
88
|
+
- `OK/NG`
|
|
89
|
+
- `Cause`
|
|
90
|
+
- `Countermeasure`
|
|
91
|
+
- `Owner`
|
|
92
|
+
- `Completion Date`
|
|
93
|
+
- `Confirmation`
|
|
94
|
+
|
|
95
|
+
---
|
|
96
|
+
|
|
97
|
+
## 7. Numbering and ID Policy
|
|
98
|
+
- Keep a stable `No` for each test case row.
|
|
99
|
+
- Do not renumber existing case IDs only for visual regrouping.
|
|
100
|
+
- In screen-split sections, case IDs may be non-contiguous; this is allowed.
|
|
101
|
+
- Summary/helper tables must keep contiguous `No` (`1,2,3,...`).
|
|
102
|
+
|
|
103
|
+
---
|
|
104
|
+
|
|
105
|
+
## 8. Open Questions (OQ) Policy
|
|
106
|
+
- If expected behavior is unclear, create `OQ-xx` entries in section 6.
|
|
107
|
+
- Do not assume behavior for:
|
|
108
|
+
- permission matrix
|
|
109
|
+
- conflict dialog/action semantics
|
|
110
|
+
- API contract ambiguities
|
|
111
|
+
- release-scope boundary
|
|
112
|
+
- When resolved, keep question row and set status/remarks to resolved.
|
|
113
|
+
|
|
114
|
+
---
|
|
115
|
+
|
|
116
|
+
## 9. Language and Encoding
|
|
117
|
+
- Default artifact language: English.
|
|
118
|
+
- Keep original JP/VI labels when required by business/UI traceability (for example button labels).
|
|
119
|
+
- File encoding must be UTF-8.
|
|
120
|
+
- Avoid mojibake and placeholder tokens (`??`, `?????`) in final output.
|
|
121
|
+
|
|
122
|
+
---
|
|
123
|
+
|
|
124
|
+
## 10. Final Validation Checklist
|
|
125
|
+
- Required sections exist and are in correct order.
|
|
126
|
+
- Statistic totals equal sum of UTC/ITC rows.
|
|
127
|
+
- Screen mapping table case counts match actual UTC/ITC table counts.
|
|
128
|
+
- Scope explicitly states in-scope and out-of-scope boundaries.
|
|
129
|
+
- Open questions are explicitly tracked with owner and impact.
|
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
# {{FEATURE_KEY}} TEST CASE
|
|
2
|
+
|
|
3
|
+
**Document ID:** TEST_CASE_{{FEATURE_KEY}}
|
|
4
|
+
**Version:** 1.0.0
|
|
5
|
+
**Date:** {{DATE}}
|
|
6
|
+
**Author:** QA Agent
|
|
7
|
+
**Status:** DRAFT
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## Statistic Summary (Excel-aligned)
|
|
12
|
+
|
|
13
|
+
| No | Test Group | Worksheet Mapping (Markdown) | Num of Case | OK | NG | Not tested yet | Done (%) | Updated Date |
|
|
14
|
+
| ---: | --- | --- | ---: | ---: | ---: | ---: | ---: | --- |
|
|
15
|
+
| 1 | Unit Test Total | `UT Total` | 0 | 0 | 0 | 0 | 0.00% | {{DATE}} |
|
|
16
|
+
| 2 | Integration Test Total | `IT Total` | 0 | 0 | 0 | 0 | 0.00% | {{DATE}} |
|
|
17
|
+
| 3 | Grand Total | `Total` | 0 | 0 | 0 | 0 | 0.00% | {{DATE}} |
|
|
18
|
+
|
|
19
|
+
---
|
|
20
|
+
|
|
21
|
+
## Abbreviations
|
|
22
|
+
|
|
23
|
+
| No | Abbreviation | Meaning |
|
|
24
|
+
| ---: | --- | --- |
|
|
25
|
+
| 1 | UTC | Unit Test Case |
|
|
26
|
+
| 2 | ITC | Integration Test Case |
|
|
27
|
+
| 3 | STC | System Test Case |
|
|
28
|
+
| 4 | UAT | User Acceptance Test |
|
|
29
|
+
| 5 | OQ | Open Question |
|
|
30
|
+
|
|
31
|
+
---
|
|
32
|
+
|
|
33
|
+
## 1. Scope
|
|
34
|
+
|
|
35
|
+
- In scope: `TBD`
|
|
36
|
+
- Out of scope: `TBD`
|
|
37
|
+
- Notes: `TBD`
|
|
38
|
+
|
|
39
|
+
---
|
|
40
|
+
|
|
41
|
+
## 2. References
|
|
42
|
+
|
|
43
|
+
| No | Document | Usage |
|
|
44
|
+
| ---: | --- | --- |
|
|
45
|
+
| 1 | `docs/specs/BA_SPEC_{{FEATURE_KEY}}.md` | Business rules and acceptance criteria |
|
|
46
|
+
| 2 | `docs/architecture/ARCH_DESIGN_{{FEATURE_KEY}}.md` | Architecture scope and constraints |
|
|
47
|
+
| 3 | `docs/api/{{FEATURE_KEY}}_ENDPOINTS.md` | API contracts and status/error policy |
|
|
48
|
+
| 4 | `docs/specs/{{FEATURE_KEY}}_FLOW_ACTION_SPEC.md` | Screen behavior and flow actions |
|
|
49
|
+
|
|
50
|
+
---
|
|
51
|
+
|
|
52
|
+
## 3. Test Environment and Common Data
|
|
53
|
+
|
|
54
|
+
| No | Item | Value |
|
|
55
|
+
| ---: | --- | --- |
|
|
56
|
+
| 1 | Browser | Chrome (latest stable) |
|
|
57
|
+
| 2 | Auth | TBD |
|
|
58
|
+
| 3 | Environment | TBD |
|
|
59
|
+
| 4 | Seed data | TBD |
|
|
60
|
+
| 5 | Error policy | TBD |
|
|
61
|
+
|
|
62
|
+
---
|
|
63
|
+
|
|
64
|
+
## 4. Feature Coverage Matrix
|
|
65
|
+
|
|
66
|
+
| No | Feature Block | Screens | Primary APIs |
|
|
67
|
+
| ---: | --- | --- | --- |
|
|
68
|
+
| 1 | TBD | TBD | TBD |
|
|
69
|
+
|
|
70
|
+
---
|
|
71
|
+
|
|
72
|
+
## 5. Screen-based Test Cases (Excel-aligned)
|
|
73
|
+
|
|
74
|
+
| No | Screen | Suggested Worksheet Pair | UTC Cases | ITC Cases | Notes |
|
|
75
|
+
| ---: | --- | --- | ---: | ---: | --- |
|
|
76
|
+
| 1 | SCREEN-001 | `SCREEN001_UTC`, `SCREEN001_ITC` | 0 | 0 | TBD |
|
|
77
|
+
|
|
78
|
+
### 5.1 SCREEN-001
|
|
79
|
+
|
|
80
|
+
#### 5.1.1 UTC (`SCREEN001_UTC`)
|
|
81
|
+
|
|
82
|
+
| No | Test Type | Test Perspective | Test Item | Precondition | Test Steps | Expected Result | Browser | Test Execution Result | Remarks | Reviewer | Review Date | OK/NG | Cause | Countermeasure | Owner | Completion Date | Confirmation |
|
|
83
|
+
| ---: | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
|
|
84
|
+
| 1 | Normal | TBD | TBD | TBD | TBD | TBD | Chrome | TBD | | | | | | | | | |
|
|
85
|
+
|
|
86
|
+
#### 5.1.2 ITC (`SCREEN001_ITC`)
|
|
87
|
+
|
|
88
|
+
| No | Test Type | Test Perspective | Test Item | Precondition | Test Steps | Expected Result | Browser | Test Execution Result | Remarks | Reviewer | Review Date | OK/NG | Cause | Countermeasure | Owner | Completion Date | Confirmation |
|
|
89
|
+
| ---: | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
|
|
90
|
+
| 1 | Normal | TBD | TBD | TBD | TBD | TBD | Chrome | TBD | | | | | | | | | |
|
|
91
|
+
|
|
92
|
+
---
|
|
93
|
+
|
|
94
|
+
## 6. Open Questions (for final freeze)
|
|
95
|
+
|
|
96
|
+
| No | Q-ID | Question | Impact | Owner |
|
|
97
|
+
| ---: | --- | --- | --- | --- |
|
|
98
|
+
| 1 | OQ-01 | TBD | TBD | PM / Customer |
|
|
99
|
+
|
|
100
|
+
---
|
|
101
|
+
|
|
102
|
+
## 7. STC/UAT Note
|
|
103
|
+
|
|
104
|
+
If STC/UAT template is unavailable, keep STC/UAT as tracked backlog items and map to future release gates.
|