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.
Files changed (113) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +123 -177
  3. package/package.json +52 -46
  4. package/scripts/postinstall.js +40 -0
  5. package/assets/manifest/toolkit-bundle.manifest.json +0 -473
  6. package/assets/manifest/toolkit-bundle.sha256.txt +0 -93
  7. package/assets/toolkit/toolkit/AGENTS.md +0 -131
  8. package/assets/toolkit/toolkit/install.ps1 +0 -310
  9. package/assets/toolkit/toolkit/runtimes/claude/CLAUDE_TEMPLATE.md +0 -54
  10. package/assets/toolkit/toolkit/runtimes/codex/CODEX_TEMPLATE.md +0 -32
  11. package/assets/toolkit/toolkit/scripts/init-feature.ps1 +0 -261
  12. package/assets/toolkit/toolkit/scripts/install-claude-skills.ps1 +0 -169
  13. package/assets/toolkit/toolkit/scripts/install-codex-skills.ps1 +0 -189
  14. package/assets/toolkit/toolkit/scripts/uninstall-claude-skills.ps1 +0 -139
  15. package/assets/toolkit/toolkit/scripts/uninstall-codex-skills.ps1 +0 -116
  16. package/assets/toolkit/toolkit/sdtk.config.json +0 -28
  17. package/assets/toolkit/toolkit/sdtk.config.profiles.example.json +0 -50
  18. package/assets/toolkit/toolkit/skills/sdtk-api-design-spec/SKILL.md +0 -84
  19. package/assets/toolkit/toolkit/skills/sdtk-api-design-spec/references/API_DESIGN_CREATION_RULES.md +0 -22
  20. package/assets/toolkit/toolkit/skills/sdtk-api-design-spec/references/API_DESIGN_FLOWCHART_CREATION_RULES.md +0 -468
  21. package/assets/toolkit/toolkit/skills/sdtk-api-design-spec/references/FLOWCHART_CREATION_RULES.md +0 -20
  22. package/assets/toolkit/toolkit/skills/sdtk-api-design-spec/scripts/generate_api_design_detail.py +0 -732
  23. package/assets/toolkit/toolkit/skills/sdtk-api-doc/SKILL.md +0 -43
  24. package/assets/toolkit/toolkit/skills/sdtk-api-doc/references/API_DESIGN_FLOWCHART_CREATION_RULES.md +0 -468
  25. package/assets/toolkit/toolkit/skills/sdtk-api-doc/references/FLOWCHART_CREATION_RULES.md +0 -20
  26. package/assets/toolkit/toolkit/skills/sdtk-api-doc/references/YAML_CREATION_RULES.md +0 -128
  27. package/assets/toolkit/toolkit/skills/sdtk-arch/SKILL.md +0 -83
  28. package/assets/toolkit/toolkit/skills/sdtk-arch/references/API_DESIGN_CREATION_RULES.md +0 -22
  29. package/assets/toolkit/toolkit/skills/sdtk-arch/references/API_DESIGN_FLOWCHART_CREATION_RULES.md +0 -468
  30. package/assets/toolkit/toolkit/skills/sdtk-arch/references/FLOWCHART_CREATION_RULES.md +0 -20
  31. package/assets/toolkit/toolkit/skills/sdtk-arch/references/FLOW_ACTION_SPEC_CREATION_RULES.md +0 -220
  32. package/assets/toolkit/toolkit/skills/sdtk-arch/references/YAML_CREATION_RULES.md +0 -128
  33. package/assets/toolkit/toolkit/skills/sdtk-ba/SKILL.md +0 -29
  34. package/assets/toolkit/toolkit/skills/sdtk-design-layout/SKILL.md +0 -52
  35. package/assets/toolkit/toolkit/skills/sdtk-design-layout/scripts/render_design_layout_images.py +0 -246
  36. package/assets/toolkit/toolkit/skills/sdtk-dev/SKILL.md +0 -90
  37. package/assets/toolkit/toolkit/skills/sdtk-dev/prompts/code-quality-reviewer.md +0 -35
  38. package/assets/toolkit/toolkit/skills/sdtk-dev/prompts/implementer.md +0 -61
  39. package/assets/toolkit/toolkit/skills/sdtk-dev/prompts/spec-reviewer.md +0 -42
  40. package/assets/toolkit/toolkit/skills/sdtk-dev-backend/SKILL.md +0 -21
  41. package/assets/toolkit/toolkit/skills/sdtk-dev-frontend/SKILL.md +0 -19
  42. package/assets/toolkit/toolkit/skills/sdtk-orchestrator/SKILL.md +0 -80
  43. package/assets/toolkit/toolkit/skills/sdtk-pm/SKILL.md +0 -30
  44. package/assets/toolkit/toolkit/skills/sdtk-qa/SKILL.md +0 -53
  45. package/assets/toolkit/toolkit/skills/sdtk-screen-design-spec/SKILL.md +0 -86
  46. package/assets/toolkit/toolkit/skills/sdtk-screen-design-spec/references/FLOW_ACTION_SPEC_CREATION_RULES.md +0 -220
  47. package/assets/toolkit/toolkit/skills/sdtk-screen-design-spec/references/excel-image-export.md +0 -51
  48. package/assets/toolkit/toolkit/skills/sdtk-screen-design-spec/references/figma-mcp.md +0 -54
  49. package/assets/toolkit/toolkit/skills/sdtk-screen-design-spec/references/numbering-rules.md +0 -28
  50. package/assets/toolkit/toolkit/skills/sdtk-screen-design-spec/scripts/renumber_flow_action_spec_global.py +0 -136
  51. package/assets/toolkit/toolkit/skills/sdtk-screen-design-spec/scripts/validate_flow_action_spec_numbering.py +0 -414
  52. package/assets/toolkit/toolkit/skills/sdtk-test-case-spec/SKILL.md +0 -74
  53. package/assets/toolkit/toolkit/skills/sdtk-test-case-spec/references/TEST_CASE_CREATION_RULES.md +0 -129
  54. package/assets/toolkit/toolkit/skills/sdtk-test-case-spec/scripts/validate_test_case_spec.py +0 -97
  55. package/assets/toolkit/toolkit/skills/skills.catalog.yaml +0 -302
  56. package/assets/toolkit/toolkit/skills-claude/api-design-spec/SKILL.md +0 -90
  57. package/assets/toolkit/toolkit/skills-claude/api-doc/SKILL.md +0 -47
  58. package/assets/toolkit/toolkit/skills-claude/arch/SKILL.md +0 -59
  59. package/assets/toolkit/toolkit/skills-claude/ba/SKILL.md +0 -50
  60. package/assets/toolkit/toolkit/skills-claude/design-layout/SKILL.md +0 -57
  61. package/assets/toolkit/toolkit/skills-claude/dev/SKILL.md +0 -45
  62. package/assets/toolkit/toolkit/skills-claude/dev-backend/SKILL.md +0 -20
  63. package/assets/toolkit/toolkit/skills-claude/dev-frontend/SKILL.md +0 -18
  64. package/assets/toolkit/toolkit/skills-claude/orchestrator/SKILL.md +0 -63
  65. package/assets/toolkit/toolkit/skills-claude/pm/SKILL.md +0 -52
  66. package/assets/toolkit/toolkit/skills-claude/qa/SKILL.md +0 -48
  67. package/assets/toolkit/toolkit/skills-claude/screen-design-spec/SKILL.md +0 -90
  68. package/assets/toolkit/toolkit/skills-claude/test-case-spec/SKILL.md +0 -61
  69. package/assets/toolkit/toolkit/templates/QUALITY_CHECKLIST.md +0 -124
  70. package/assets/toolkit/toolkit/templates/README.md +0 -63
  71. package/assets/toolkit/toolkit/templates/SHARED_PLANNING.md +0 -80
  72. package/assets/toolkit/toolkit/templates/docs/api/API_DESIGN_CREATION_RULES.md +0 -22
  73. package/assets/toolkit/toolkit/templates/docs/api/API_DESIGN_DETAIL_TEMPLATE.md +0 -67
  74. package/assets/toolkit/toolkit/templates/docs/api/API_DESIGN_FLOWCHART_CREATION_RULES.md +0 -468
  75. package/assets/toolkit/toolkit/templates/docs/api/API_ENDPOINTS_TEMPLATE.md +0 -229
  76. package/assets/toolkit/toolkit/templates/docs/api/FEATURE_API_TEMPLATE.yaml +0 -20
  77. package/assets/toolkit/toolkit/templates/docs/api/FLOWCHART_CREATION_RULES.md +0 -20
  78. package/assets/toolkit/toolkit/templates/docs/api/YAML_CREATION_RULES.md +0 -128
  79. package/assets/toolkit/toolkit/templates/docs/api/feature_api_flow_list_TEMPLATE.txt +0 -12
  80. package/assets/toolkit/toolkit/templates/docs/architecture/ARCH_DESIGN_TEMPLATE.md +0 -109
  81. package/assets/toolkit/toolkit/templates/docs/database/DATABASE_SPEC_TEMPLATE.md +0 -175
  82. package/assets/toolkit/toolkit/templates/docs/design/DESIGN_LAYOUT_TEMPLATE.md +0 -60
  83. package/assets/toolkit/toolkit/templates/docs/dev/FEATURE_IMPL_PLAN_TEMPLATE.md +0 -73
  84. package/assets/toolkit/toolkit/templates/docs/product/BACKLOG_TEMPLATE.md +0 -50
  85. package/assets/toolkit/toolkit/templates/docs/product/PRD_TEMPLATE.md +0 -66
  86. package/assets/toolkit/toolkit/templates/docs/product/PROJECT_INITIATION_TEMPLATE.md +0 -98
  87. package/assets/toolkit/toolkit/templates/docs/qa/QA_RELEASE_REPORT_TEMPLATE.md +0 -61
  88. package/assets/toolkit/toolkit/templates/docs/qa/TEST_CASE_CREATION_RULES.md +0 -129
  89. package/assets/toolkit/toolkit/templates/docs/qa/TEST_CASE_TEMPLATE.md +0 -104
  90. package/assets/toolkit/toolkit/templates/docs/specs/BA_SPEC_TEMPLATE.md +0 -139
  91. package/assets/toolkit/toolkit/templates/docs/specs/FLOW_ACTION_SPEC_CREATION_RULES.md +0 -220
  92. package/assets/toolkit/toolkit/templates/docs/specs/FLOW_ACTION_SPEC_TEMPLATE.md +0 -197
  93. package/assets/toolkit/toolkit/templates/handoffs/ARCH_TO_DEV.md +0 -31
  94. package/assets/toolkit/toolkit/templates/handoffs/BA_TO_ARCH.md +0 -28
  95. package/assets/toolkit/toolkit/templates/handoffs/DEV_STAGE1_SPEC_REVIEW.md +0 -26
  96. package/assets/toolkit/toolkit/templates/handoffs/DEV_STAGE2_CODE_QUALITY_REVIEW.md +0 -20
  97. package/assets/toolkit/toolkit/templates/handoffs/DEV_TO_QA.md +0 -23
  98. package/assets/toolkit/toolkit/templates/handoffs/PM_TO_BA.md +0 -26
  99. package/assets/toolkit/toolkit/templates/handoffs/QA_RELEASE_DECISION.md +0 -21
  100. package/bin/sdtk.js +0 -15
  101. package/src/commands/auth.js +0 -85
  102. package/src/commands/generate.js +0 -177
  103. package/src/commands/help.js +0 -101
  104. package/src/commands/init.js +0 -97
  105. package/src/commands/runtime.js +0 -217
  106. package/src/index.js +0 -59
  107. package/src/lib/args.js +0 -116
  108. package/src/lib/errors.js +0 -41
  109. package/src/lib/github-access.js +0 -68
  110. package/src/lib/powershell.js +0 -85
  111. package/src/lib/scope.js +0 -68
  112. package/src/lib/state.js +0 -83
  113. package/src/lib/toolkit-payload.js +0 -99
@@ -1,139 +0,0 @@
1
- # BA SPEC: {{FEATURE_KEY}} ({{FEATURE_NAME}})
2
-
3
- **Document ID:** BA_SPEC_{{FEATURE_KEY}}
4
- **Version:** 1.0.0
5
- **Date:** {{DATE}}
6
- **Author:** BA Agent
7
- **Status:** DRAFT - Ready for PM Review
8
-
9
- ---
10
-
11
- ## Abbreviations
12
-
13
- | No | Abbreviation | Meaning |
14
- | ---: | --- | --- |
15
- | 1 | API | Application Programming Interface |
16
- | 2 | DB | Database |
17
- | 3 | UI | User Interface |
18
- | 4 | UX | User Experience |
19
- | 5 | BR | Business Rule |
20
- | 6 | UC | Use Case |
21
- | 7 | AC | Acceptance Criteria |
22
- | 8 | NFR | Non-Functional Requirement |
23
- | 9 | OQ | Open Question |
24
- | 10 | REQ | Requirement |
25
-
26
- ---
27
-
28
- ## 1. DOMAIN ANALYSIS
29
-
30
- ### 1.1 Domain Glossary
31
-
32
- | No | Term | Definition | Example |
33
- | ---: | --- | --- | --- |
34
- | 1 | TBD | TBD | TBD |
35
-
36
- ### 1.2 Business Rules
37
-
38
- | No | Rule ID | Rule Description | Type | Related REQ |
39
- | ---: | --- | --- | --- | --- |
40
- | 1 | BR-01 | TBD | Mandatory | REQ-01 |
41
-
42
- ### 1.3 Non-Functional Requirements
43
-
44
- | No | NFR ID | Category | Requirement | Target |
45
- | ---: | --- | --- | --- | --- |
46
- | 1 | NFR-01 | Performance | TBD | TBD |
47
-
48
- ---
49
-
50
- ## 2. USE CASES
51
-
52
- | No | UC ID | Use Case Name | Primary Actor | Related REQ |
53
- | ---: | --- | --- | --- | --- |
54
- | 1 | UC-01 | TBD | TBD | REQ-01 |
55
-
56
- ---
57
-
58
- ## 3. DATA MODEL (Logical)
59
-
60
- | No | Entity | Description | Key Fields |
61
- | ---: | --- | --- | --- |
62
- | 1 | TBD | TBD | TBD |
63
-
64
- ---
65
-
66
- ## 4. CONTRACTS SUMMARY
67
-
68
- ### 4.1 API Endpoints (High-level)
69
-
70
- | No | Endpoint | Method | Purpose | Related UC |
71
- | ---: | --- | --- | --- | --- |
72
- | 1 | `/api/v1/...` | GET | TBD | UC-01 |
73
-
74
- ### 4.2 UI Screens (if applicable)
75
-
76
- | No | Screen ID | Screen Name | Purpose | Related UC |
77
- | ---: | --- | --- | --- | --- |
78
- | 1 | SCR-01 | TBD | TBD | UC-01 |
79
-
80
- ### 4.3 Acceptance Criteria (high-level)
81
-
82
- | No | AC ID | Acceptance Criteria | Related UC | Related BR |
83
- | ---: | --- | --- | --- | --- |
84
- | 1 | AC-01-01 | TBD | UC-01 | BR-01 |
85
-
86
- ---
87
-
88
- ## 5. RISKS & OPEN QUESTIONS
89
-
90
- ### 5.1 Risks
91
-
92
- | No | Risk ID | Risk | Probability | Impact | Mitigation |
93
- | ---: | --- | --- | --- | --- | --- |
94
- | 1 | R-01 | TBD | Medium | Medium | TBD |
95
-
96
- ### 5.2 Open Questions
97
-
98
- | No | Q-ID | Question | Type | Priority | Decision Owner (PM/User) | Status (OPEN/RESOLVED) | Notes/Options | Resolution |
99
- | ---: | --- | --- | --- | --- | --- | --- | --- | --- |
100
- | 1 | OQ-01 | TBD | Business | High | PM | OPEN | TBD | TBD |
101
-
102
- ---
103
-
104
- ## 6. TRACEABILITY SUMMARY
105
-
106
- | No | REQ ID | Use Cases | Business Rules | Acceptance Criteria | Status |
107
- | ---: | --- | --- | --- | --- | --- |
108
- | 1 | REQ-01 | UC-01 | BR-01 | AC-01-01 | COVERED |
109
-
110
- ---
111
-
112
- ## 7. HANDOFF
113
-
114
- HANDOFF TO PM:
115
- `@pm BA_SPEC_{{FEATURE_KEY}} is ready. Please create PRD_{{FEATURE_KEY}}.md + BACKLOG_{{FEATURE_KEY}}.md`
116
-
117
- Next:
118
- `@arch please design architecture for {{FEATURE_KEY}} after PM review`
119
-
120
- NOTE:
121
- `@pm please resolve Open Questions (OQ-xx) above; if any cannot be resolved from existing docs, please confirm with the user (final stakeholder).`
122
-
123
- ---
124
-
125
- ## APPENDIX A: Source Requirements (Original VI/JP) - keep as-is
126
-
127
- If the input requirements were provided in Vietnamese/Japanese, paste them here unchanged.
128
-
129
- ## APPENDIX B: English Translation (of Appendix A)
130
-
131
- Provide an English translation of Appendix A (literal, for traceability).
132
-
133
- ---
134
-
135
- ## Document History
136
-
137
- | No | Version | Date | Author | Changes |
138
- | ---: | --- | --- | --- | --- |
139
- | 1 | 1.0.0 | {{DATE}} | BA Agent | Initial template-based version |
@@ -1,220 +0,0 @@
1
- # Flow Action Spec Creation Rules for AI Agents
2
-
3
- This document defines reusable rules for creating and updating screen flow-action specifications
4
- (for example `docs/specs/*_FLOW_ACTION_SPEC.md`).
5
-
6
- ## 1. Scope and Goal
7
-
8
- - Produce a screen-level specification that is traceable from BA/ARCH to FE/BE implementation.
9
- - Keep one source of truth for:
10
- - screen flow
11
- - UI items and actions
12
- - API calls per action
13
- - screen-to-API mapping
14
- - Keep documentation implementation-aware and review-friendly.
15
-
16
- ## 2. Mandatory Document Structure
17
-
18
- A flow-action spec should include, at minimum:
19
-
20
- 1. `Abbreviations`
21
- 2. `Feature overview`
22
- 3. `Assumptions`
23
- 4. `Screen flow action` (with PlantUML)
24
- 5. `Screen layout spec by flow action`
25
- 6. `System processing flow`
26
- 7. `Open questions`
27
- 8. `Screen - API mapping`
28
- 9. `Document history`
29
-
30
- If a section is not in scope, keep the section and mark explicitly as `N/A` with reason.
31
-
32
- ## 3. Table Standards
33
-
34
- - Every table must include a `No` column (sequential numbering).
35
- - Use stable headers for action tables:
36
- - `No | Item Name | Item Type | Attribute | DB Column | Size | Default Value | Action | Description | Note`
37
- - Use stable headers for API mapping tables:
38
- - `No | Trigger/When | UI item (No / Item Name) | API to call | Data usage / Notes`
39
- - Use stable headers for screen mapping:
40
- - `No | Screen (section) | Screen ID | Read/Search APIs | Write APIs | Notes / Q&A refs`
41
- - Table rows must keep column count consistent with the header (no broken or merged rows).
42
- - Avoid single-line merged content that collapses multiple logical items into one table row.
43
-
44
- ### 3.1 Action Table Mapping Completion Rules
45
-
46
- - After API endpoint spec and database spec are available, the action-table columns `Attribute`, `DB Column`, `Size`, and `Default Value` must not be left blank when the mapping can be derived from current source-of-truth inputs.
47
- - Fill these four columns only after the relevant API contract and DB schema are stable enough to be treated as the current source of truth for the active phase.
48
- - Source priority for filling the four columns:
49
- 1. `docs/api/*_ENDPOINTS.md` and OpenAPI YAML for request/response contract
50
- 2. `docs/database/DATABASE_SPEC_*.md` for physical column names, nullability, storage shape, and query-source aliases
51
- 3. confirmed flow/business rules for default state and behavior
52
- 4. design source (Figma/Excel) for screen label and control type only
53
- - `Attribute` rules:
54
- - input item: use the canonical request payload path
55
- - display item: use the canonical response path
56
- - UI-only item: use `ui.*` namespace
57
- - `DB Column` rules:
58
- - use physical DB column names or query-source aliases from the API/database spec
59
- - if multiple columns participate, list them explicitly
60
- - if the control is UI-only, write `N/A`
61
- - `Size` rules:
62
- - document data format/type, not pixel width
63
- - prefer canonical forms such as `uuid`, `DATE (YYYY-MM-DD)`, `DATETIME`, `TIME (HH:mm)`, `boolean`, `array[uuid]`, `enum(...)`, `JSON string`
64
- - prefer DB storage type first; if not available, fall back to API schema type/format
65
- - `Default Value` rules:
66
- - use confirmed business, UI, or runtime defaults
67
- - if the default comes from settings or environment, state that clearly
68
- - if not finalized, use `TBD` and keep or raise an open-question reference in `Note`
69
- - If screen labels conflict with canonical API/DB naming, preserve the original screen label in the visible screen columns, but keep `Attribute` and `DB Column` aligned to API/DB source of truth and explain the mismatch in `Note`.
70
-
71
- ### 3.2 Language and Encoding Standards (EN Artifacts)
72
-
73
- - For EN artifacts (`docs/en/**` or explicitly requested EN version), narrative text must be English.
74
- - JP labels, if provided by the input, should be kept in a clearly marked appendix or note column, not in the default item table columns.
75
- - Do not leave mixed-language fragments in one sentence/cell (for example VI+EN mixed text).
76
- - If original VI/JP text is required for traceability, keep it in a clearly marked appendix block (`Original Text`), then provide EN translation.
77
- - Save files as UTF-8 and avoid mojibake/broken glyphs (`�`, `ↁE`, garbled sequences).
78
- - Keep canonical terminology stable across documents (for example: `bukken`, `sagyo`, `customer employee`).
79
-
80
- ### 3.3 Markdown Structure Hygiene
81
-
82
- - Keep each heading on its own line; do not concatenate multiple headings/sections on one line.
83
- - Keep metadata blocks (`Information`, `Note`, `Behavior notes`) as structured bullet blocks, not single compressed lines.
84
- - Keep image, table, and separator (`---`) boundaries explicit to preserve parser/render stability.
85
-
86
- ### 3.4 Assumptions Section
87
-
88
- - Every flow-action spec must include a top-level `## Assumptions` section.
89
- - Use this table format exactly: `# | Assumption | Verified | Risk if wrong`.
90
- - Keep assumptions explicit when downstream mapping or behavior depends on an unresolved decision.
91
- - If an assumption affects UI behavior, API mapping, or DB mapping, reflect the risk in `Note` and keep or raise the related `OQ-xx` item.
92
-
93
- ## 4. Item Numbering and Duplication Rules
94
-
95
- - Use one numbering mode only: `global across document`.
96
- - Number values must increase across all action tables in the document.
97
- - DESIGN_LAYOUT wireframe markers are a separate screen-local visual system. They may reset per screen and do not need to numerically equal the global action-table `No`.
98
- - Avoid duplicate item descriptions for the same UI control across screens unless behavior differs.
99
- - If duplicate number is intentional (rare), annotate reason in `Note`.
100
-
101
- ## 5. Screen Section Rules
102
-
103
- For each screen section:
104
-
105
- - Provide metadata:
106
- - official screen name
107
- - Screen ID
108
- - Design Source Type
109
- - Design Source Reference
110
- - Embed one representative image per screen (from Figma, screenshot, or generated layout).
111
- - Provide one action table.
112
- - Provide one API mapping table.
113
- - If a screen has dialogs, create explicit dialog sub-sections with their own tables and API mapping.
114
-
115
- ## 5.1 Design Source Modes
116
-
117
- Each screen section must declare a design source using one of these modes:
118
-
119
- | Mode | When | Design Source Reference |
120
- |------|------|----------------------|
121
- | `source-backed` | Figma URL or screenshot is available | Figma URL or screenshot path |
122
- | `generated-draft` | No Figma/screenshot, but feature has UI scope | Section reference in `docs/design/DESIGN_LAYOUT_[FEATURE_KEY].md` |
123
- | `none` | Feature has no UI scope for this screen | State `N/A - no UI scope` |
124
-
125
- Rules:
126
- - For UI-scope features, `none` is only valid when the specific screen truly has no visual layout.
127
- - When using `generated-draft`, the `DESIGN_LAYOUT_[FEATURE_KEY].md` must exist before the flow-action spec is finalized.
128
- - The flow-action spec and the design-layout doc must remain separate documents.
129
- - When Figma becomes available later, update the source mode from `generated-draft` to `source-backed`.
130
-
131
- ## 5.2 Wireframe Marker Mapping for Generated-Draft Screens
132
-
133
- For generated-draft screens with rendered design-layout images:
134
-
135
- - Treat wireframe markers as screen-local visual references only.
136
- - Keep action-table `No` global across the document per section 4.
137
- - Add a wireframe marker mapping table directly under the screen image.
138
- - Use this stable header:
139
- - `No | Wireframe Marker | Action Table No | Item Name | Notes`
140
- - Map only the items visibly present on the wireframe image.
141
- - If an action-table row is not visible on the wireframe, state `Not shown on wireframe` in `Notes` instead of inventing a marker.
142
- - If the wireframe label and the action-table label differ slightly, keep the action-table item name and explain the label difference in `Notes`.
143
-
144
- ## 6. API Traceability Rules
145
-
146
- - Every actionable UI event that changes state must map to a write API.
147
- - Every data-loading UI event must map to a read/search API.
148
- - If one endpoint serves multiple actions (initial load, search, refresh), state this explicitly.
149
- - If no API is called for an action, state `No API` and explain why.
150
-
151
- ## 7. PlantUML Rules for Screen Flow
152
-
153
- - Use new-style PlantUML activity diagram syntax only for screen-flow diagrams.
154
- - Allowed activity constructs include: `start`, `stop`, `partition "..." {}`, `:Activity;`, `->`, `if/then/else/endif`, `fork`, `fork again`, `end fork`, and `note right/left`.
155
- - Do not mix legacy activity syntax such as `(*)`, `-->`, or `[edge label]` with new-style activity actions like `:Activity;`.
156
- - Validate renderability before handoff. If a renderer is unavailable in the current environment, at minimum keep the block internally consistent with new-style activity syntax only.
157
- - Use `\\n` for multi-line labels in activity nodes and notes.
158
- - Keep diagram at navigation/action level (not low-level SQL or backend internals).
159
- - Ensure screen names in PlantUML match section names in layout spec.
160
-
161
- ## 8. Data Source and Asset Rules
162
-
163
- - Prioritize source order:
164
- 1. Confirmed design source (for example Figma)
165
- 2. Confirmed requirement files (Excel/spec)
166
- 3. User-provided screenshots
167
- - Store images in repository-relative filesystem paths.
168
- - Reference images in markdown using file-relative paths from the spec file's directory.
169
- - Do not keep temporary local absolute paths in markdown.
170
-
171
- ### 8.1 Rendered Screen Images for Generated-Draft Screens
172
-
173
- When `Design Source Type` is `generated-draft`:
174
- - Screen preview images may be rendered from `DESIGN_LAYOUT_[FEATURE_KEY].md` PlantUML SALT wireframes.
175
- - Renderer: `toolkit/skills/sdtk-design-layout/scripts/render_design_layout_images.py`
176
- - Expected output path (filesystem): `docs/specs/assets/<feature_snake>/screens/<screen_id>.svg`
177
- - Markdown image path (file-relative from `docs/specs/*_FLOW_ACTION_SPEC.md`): `assets/<feature_snake>/screens/<screen_id>.svg`
178
- - DESIGN_LAYOUT markers inside the image are screen-local visual references and may reset per screen; use the wireframe mapping table to bridge them to the global action-table `No`.
179
- - If the rendered `.svg` file exists, use the file-relative markdown path in the `Screen image:` reference.
180
- - If rendering is unavailable or the `.svg` does not exist, replace the image line with:
181
- `> Screen image not rendered in this environment. See Design Source Reference for layout.`
182
- - Do not leave a broken image reference pointing to a non-existent file.
183
-
184
- ## 9. Consistency with Other Specs
185
-
186
- - Align terms with:
187
- - BA spec glossary
188
- - API endpoints spec
189
- - Database spec
190
- - If terminology differs across docs, raise an open question and add a temporary mapping note.
191
- - Keep endpoint paths in flow-action spec consistent with API endpoint spec.
192
-
193
- ## 10. Open Questions and Uncertainty Handling
194
-
195
- - Capture unresolved items in `Open questions` table.
196
- - Do not invent UI behavior or API contracts when source is ambiguous.
197
- - Mark uncertain mappings as `Draft` and include impacted files/sections.
198
-
199
- ## 11. Change Management
200
-
201
- - On each update:
202
- - update impacted screen sections
203
- - update API mapping tables
204
- - update screen-to-API mapping summary
205
- - append one row in document history
206
- - Never overwrite past history rows.
207
-
208
- ## 12. Final Checklist Before Handoff
209
-
210
- - PlantUML renders successfully.
211
- - All mandatory sections exist.
212
- - All tables include `No`.
213
- - Numbering is global across the document (no resets).
214
- - No broken image links (for `generated-draft` screens: `.svg` exists or render-skipped note is present).
215
- - Screen/API mappings are consistent with `*_ENDPOINTS.md`.
216
- - Assumptions section exists and unresolved assumptions are traceable.
217
- - Open questions are explicit and traceable.
218
- - For EN artifact: no leftover VI text outside allowed `Original Text` appendix blocks.
219
- - No mojibake/encoding corruption markers.
220
- - Headings/tables are structurally clean (no merged lines that break readability/traceability).
@@ -1,197 +0,0 @@
1
- # {{FEATURE_NAME}} - Screen Flow Action Specification
2
-
3
- **Document ID:** {{FEATURE_KEY}}_FLOW_ACTION_SPEC
4
- **Version:** 1.0.0
5
- **Date:** {{DATE}}
6
- **Author:** ARCH Agent
7
- **Status:** DRAFT
8
- **Related Specs:** `docs/specs/BA_SPEC_{{FEATURE_KEY}}.md`, `docs/api/{{FEATURE_KEY}}_ENDPOINTS.md`, `docs/database/DATABASE_SPEC_{{FEATURE_KEY}}.md`
9
-
10
- ---
11
-
12
- ## Abbreviations
13
-
14
- | No | Abbreviation | Meaning |
15
- | ---: | --- | --- |
16
- | 1 | UI | User Interface |
17
- | 2 | UX | User Experience |
18
- | 3 | API | Application Programming Interface |
19
- | 4 | FE | Frontend |
20
- | 5 | BE | Backend |
21
- | 6 | OQ | Open Question |
22
-
23
- ---
24
-
25
- ## 1) Feature overview
26
-
27
- ### 1.1 Background and user needs
28
- - TBD
29
-
30
- ### 1.2 Target features in scope
31
- - TBD
32
-
33
- ### 1.3 Implementation direction
34
- - TBD
35
-
36
- ## Assumptions
37
-
38
- | # | Assumption | Verified | Risk if wrong |
39
- | ---: | --- | --- | --- |
40
- | 1 | TBD | No | TBD |
41
-
42
- ---
43
-
44
- ## 2) Screen flow action
45
-
46
- ### 2.1 Flow diagram (PlantUML)
47
-
48
- ```plantuml
49
- @startuml
50
- skinparam shadowing false
51
- skinparam activityBackgroundColor #FEFEFE
52
- skinparam activityBorderColor #333333
53
-
54
- title {{FEATURE_NAME}} - Screen Flow Action
55
-
56
- start
57
- partition "Main Flow" {
58
- :SCR-01 Screen A;
59
- note right
60
- User reviews the main list and selects an action.
61
- end note
62
- -> Open detail;
63
- :SCR-02 Screen B;
64
- }
65
- stop
66
- @enduml
67
- ```
68
-
69
- ### 2.2 Mapping to major screens
70
-
71
- | No | Screen Group | Screen Name | Screen ID | Notes |
72
- | ---: | --- | --- | --- | --- |
73
- | 1 | Main | Screen A | SCR-01 | TBD |
74
- | 2 | Main | Screen B | SCR-02 | TBD |
75
-
76
- ---
77
-
78
- ## 3) Screen layout spec by flow action
79
-
80
- > Standard item table format:
81
- > `No | Item Name | Item Type | Attribute | DB Column | Size | Default Value | Action | Description | Note`
82
-
83
- ### 3.1 Screen A
84
-
85
- Information:
86
- - Screen ID: SCR-01
87
- - Design Source Type: source-backed | generated-draft | none
88
- - Design Source Reference: Figma URL | screenshot path | `docs/design/DESIGN_LAYOUT_{{FEATURE_KEY}}.md` section reference | `N/A - no UI scope`
89
-
90
- Screen image:
91
- <!-- Use a file-relative markdown path from docs/specs/, not a project-root docs/specs/assets/... path. -->
92
- ![3.1 Screen A](assets/{{FEATURE_SNAKE}}/screens/scr_01.svg)
93
-
94
- <!-- If the .svg file does not exist (render unavailable), replace the image line above with: -->
95
- <!-- > Screen image not rendered in this environment. See Design Source Reference for layout. -->
96
-
97
- #### Wireframe Marker Mapping (Draft)
98
-
99
- > Generated-draft wireframe markers are screen-local visual references. Map each visible marker to the global action-table `No` used below.
100
-
101
- | No | Wireframe Marker | Action Table No | Item Name | Notes |
102
- | ---: | --- | ---: | --- | --- |
103
- | 1 | marker-1 | 1 | Item A | Visible on wireframe |
104
- | 2 | marker-2 | 2 | Item B | Visible on wireframe |
105
-
106
- | No | Item Name | Item Type | Attribute | DB Column | Size | Default Value | Action | Description | Note |
107
- | ---: | --- | --- | --- | --- | --- | --- | --- | --- | --- |
108
- | 1 | Item A | Button | - | - | - | - | Click | TBD | TBD |
109
- | 2 | Item B | Input | string | column_a | 100 | empty | Input | TBD | TBD |
110
-
111
- #### API Mapping (Draft)
112
-
113
- | No | Trigger/When | UI item (No / Item Name) | API to call | Data usage / Notes |
114
- | ---: | --- | --- | --- | --- |
115
- | 1 | Initial load | Main area | `GET /api/...` | Load initial dataset |
116
- | 2 | Click search | No 1 | `POST /api/.../search` | Refresh grid |
117
-
118
- ---
119
-
120
- ### 3.2 Screen B
121
-
122
- Information:
123
- - Screen ID: SCR-02
124
- - Design Source Type: source-backed | generated-draft | none
125
- - Design Source Reference: Figma URL | screenshot path | `docs/design/DESIGN_LAYOUT_{{FEATURE_KEY}}.md` section reference | `N/A - no UI scope`
126
-
127
- Screen image:
128
- <!-- Use a file-relative markdown path from docs/specs/, not a project-root docs/specs/assets/... path. -->
129
- ![3.2 Screen B](assets/{{FEATURE_SNAKE}}/screens/scr_02.svg)
130
-
131
- <!-- If the .svg file does not exist (render unavailable), replace the image line above with: -->
132
- <!-- > Screen image not rendered in this environment. See Design Source Reference for layout. -->
133
-
134
- #### Wireframe Marker Mapping (Draft)
135
-
136
- > Generated-draft wireframe markers are screen-local visual references. Map each visible marker to the global action-table `No` used below.
137
-
138
- | No | Wireframe Marker | Action Table No | Item Name | Notes |
139
- | ---: | --- | ---: | --- | --- |
140
- | 1 | marker-1 | 3 | Item C | Visible on wireframe |
141
-
142
- | No | Item Name | Item Type | Attribute | DB Column | Size | Default Value | Action | Description | Note |
143
- | ---: | --- | --- | --- | --- | --- | --- | --- | --- | --- |
144
- | 3 | Item C | Toggle | boolean | flag_a | - | false | Toggle | TBD | TBD |
145
-
146
- #### API Mapping (Draft)
147
-
148
- | No | Trigger/When | UI item (No / Item Name) | API to call | Data usage / Notes |
149
- | ---: | --- | --- | --- | --- |
150
- | 1 | Change mode | No 3 | `POST /api/.../edit/{uuid}` | Persist mode |
151
-
152
- ---
153
-
154
- ## 4) System processing flow
155
-
156
- ### 4.1 Initial load
157
- 1. Validate screen permissions.
158
- 2. Load settings/profile context.
159
- 3. Load main dataset.
160
-
161
- ### 4.2 Create/Update/Delete flow
162
- 1. Validate request.
163
- 2. Execute write API.
164
- 3. Refresh read dataset.
165
-
166
- ---
167
-
168
- ## 5) Notes
169
-
170
- - Keep item numbering strategy explicit (`global` or `per-screen`).
171
- - Do not duplicate item descriptions across screens unless behavior differs.
172
-
173
- ---
174
-
175
- ## 6) Open questions
176
-
177
- | No | Scope | Question | Impact |
178
- | ---: | --- | --- | --- |
179
- | 1 | UI | TBD | TBD |
180
- | 2 | API | TBD | TBD |
181
-
182
- ---
183
-
184
- ## 7) Screen - API Mapping
185
-
186
- | No | Screen (section) | Screen ID | Read/Search APIs | Write APIs | Notes / Q&A refs |
187
- | ---: | --- | --- | --- | --- | --- |
188
- | 1 | 3.1 Screen A | SCR-01 | `GET /api/...` | `POST /api/...` | TBD |
189
- | 2 | 3.2 Screen B | SCR-02 | `POST /api/.../search` | `POST /api/.../edit/{uuid}` | TBD |
190
-
191
- ---
192
-
193
- ## Document History
194
-
195
- | No | Version | Date | Author | Changes |
196
- | ---: | --- | --- | --- | --- |
197
- | 1 | 1.0.0 | {{DATE}} | ARCH Agent | Initial template-based version |
@@ -1,31 +0,0 @@
1
- # ARCH to DEV Handoff
2
-
3
- ## Required Inputs
4
- - `docs/architecture/ARCH_DESIGN_[FEATURE_KEY].md`
5
- - `docs/product/BACKLOG_[FEATURE_KEY].md`
6
- - when applicable:
7
- - `docs/api/[FeaturePascal]_API.yaml`
8
- - `docs/api/[FEATURE_KEY]_ENDPOINTS.md`
9
- - `docs/database/DATABASE_SPEC_[FEATURE_KEY].md`
10
- - `docs/design/DESIGN_LAYOUT_[FEATURE_KEY].md`
11
- - `docs/specs/[FEATURE_KEY]_FLOW_ACTION_SPEC.md`
12
-
13
- ## Required Outputs
14
- - `docs/dev/FEATURE_IMPL_PLAN_[FEATURE_KEY].md`
15
- - code and tests
16
- - Stage 1 and Stage 2 review evidence before QA handoff
17
-
18
- ## Mandatory Checks
19
- - ARCH outputs are current and reference the same feature scope.
20
- - UI scope includes `DESIGN_LAYOUT` before `FLOW_ACTION_SPEC`.
21
- - API and DB source-of-truth files are available when implementation depends on them.
22
-
23
- ## Forbidden Shortcuts
24
- - Do not start implementation before `FEATURE_IMPL_PLAN` is written and approved.
25
- - Do not treat architecture assumptions as verified facts without citing the source.
26
-
27
- ## Handoff Message Shape
28
- - Feature: `[FEATURE_KEY]`
29
- - Required implementation slice: file or module scope
30
- - Required proving checks: test or lint or build commands
31
- - Upstream blockers or assumptions: explicit list
@@ -1,28 +0,0 @@
1
- # BA to ARCH Handoff
2
-
3
- ## Required Inputs
4
- - `docs/specs/BA_SPEC_[FEATURE_KEY].md`
5
- - `docs/product/PRD_[FEATURE_KEY].md`
6
- - `docs/product/BACKLOG_[FEATURE_KEY].md`
7
- - current `SHARED_PLANNING.md`
8
-
9
- ## Required Outputs
10
- - `docs/architecture/ARCH_DESIGN_[FEATURE_KEY].md`
11
- - API, DB, and UI design artifacts when in scope
12
- - updated `SHARED_PLANNING.md`
13
- - updated `QUALITY_CHECKLIST.md`
14
-
15
- ## Mandatory Checks
16
- - `REQ -> UC/BR/AC` traceability exists in BA output.
17
- - unresolved `OQ-xx` items are visible to ARCH.
18
- - ARCH knows whether API, DB, and UI scope are required.
19
-
20
- ## Forbidden Shortcuts
21
- - Do not jump into implementation details before architecture scope is mapped.
22
- - Do not hide unresolved business rules inside architecture assumptions.
23
-
24
- ## Handoff Message Shape
25
- - Feature: `[FEATURE_KEY]`
26
- - In-scope use cases: `UC-xx`
27
- - Key business rules: `BR-xx`
28
- - Blocking open questions: `OQ-xx` or `None`
@@ -1,26 +0,0 @@
1
- # DEV Stage 1 Spec Review
2
-
3
- ## Required Inputs
4
- - implementation diff or changed files
5
- - `docs/specs/BA_SPEC_[FEATURE_KEY].md`
6
- - `docs/api/[FeaturePascal]_API.yaml` and `docs/api/[FEATURE_KEY]_ENDPOINTS.md` when API scope exists
7
- - `docs/specs/[FEATURE_KEY]_FLOW_ACTION_SPEC.md` when UI scope exists
8
- - `docs/database/DATABASE_SPEC_[FEATURE_KEY].md` when data scope exists
9
-
10
- ## Required Outputs
11
- - PASS or FAIL verdict
12
- - mismatch table with exact file references
13
- - explicit handoff decision to Stage 2 or back to DEV
14
-
15
- ## Mandatory Checks
16
- - code matches BA, API, DB, and flow-action requirements line by line
17
- - missing mappings and drift are called out explicitly
18
- - unresolved assumptions that affect behavior are treated as blockers
19
-
20
- ## Verification Evidence
21
- - quote the exact specification text before declaring a match or mismatch
22
- - use: `Spec says: "[exact quote]" -> Evidence: [match/mismatch + file reference]`
23
-
24
- ## Forbidden Shortcuts
25
- - Do not start with style or maintainability feedback.
26
- - Do not trust the implementer report without checking artifacts directly.
@@ -1,20 +0,0 @@
1
- # DEV Stage 2 Code Quality Review
2
-
3
- ## Required Inputs
4
- - Stage 1 review result marked PASS
5
- - implementation diff or changed files
6
- - relevant test or lint outputs
7
-
8
- ## Required Outputs
9
- - PASS or FAIL verdict
10
- - quality findings with file references
11
- - recommendation for QA handoff readiness
12
-
13
- ## Mandatory Checks
14
- - Stage 1 spec review already passed
15
- - naming, structure, tests, and maintainability are reviewed
16
- - verification commands cited are fresh and relevant to the current diff
17
-
18
- ## Forbidden Shortcuts
19
- - Do not reopen Stage 1 requirement matching as a substitute for quality review.
20
- - Do not declare QA-ready without confirming Stage 1 PASS and fresh verification evidence.
@@ -1,23 +0,0 @@
1
- # DEV to QA Handoff
2
-
3
- ## Required Inputs
4
- - `docs/dev/FEATURE_IMPL_PLAN_[FEATURE_KEY].md`
5
- - implementation diff summary
6
- - Stage 1 spec review PASS evidence
7
- - Stage 2 code-quality review PASS evidence
8
- - fresh test or lint outputs used for QA handoff
9
-
10
- ## Required Outputs
11
- - QA test scope
12
- - explicit release-risk notes
13
- - updated `SHARED_PLANNING.md`
14
- - updated `QUALITY_CHECKLIST.md`
15
-
16
- ## Mandatory Checks
17
- - both DEV review gates are PASS
18
- - verification evidence is fresh
19
- - known limitations or assumptions are recorded, not hidden
20
-
21
- ## Forbidden Shortcuts
22
- - Do not hand off to QA with only one review gate complete.
23
- - Do not describe expected behavior as if it were verified runtime evidence.