solmate-skills 2.0.6 → 2.0.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +10 -2
- package/README.md +67 -30
- package/docs-dev/SKILL.md +9 -2
- package/docs-dev/agents/openai.yaml +2 -2
- package/docs-plan/SKILL.md +20 -10
- package/docs-plan/agents/openai.yaml +2 -2
- package/package.json +10 -4
- package/rules-docs/SKILL.md +19 -4
- package/rules-docs/agents/openai.yaml +2 -2
- package/rules-product/SKILL.md +29 -4
- package/rules-product/agents/openai.yaml +2 -2
- package/rules-workflow/SKILL.md +8 -6
- package/verify-docs/SKILL.md +31 -10
- package/verify-docs/agents/openai.yaml +2 -2
- package/verify-ui/SKILL.md +19 -3
- package/verify-ui/agents/openai.yaml +2 -2
package/AGENTS.md
CHANGED
|
@@ -65,6 +65,14 @@
|
|
|
65
65
|
- **검증 위치**: SVG가 최신 UI·API·DB 구조와 일치하는지 여부는 `docs/05_QA_Validation/`의 QA 체크리스트 또는 검증 문서에서 확인한다.
|
|
66
66
|
- **파일 네이밍**: SVG 파일명에도 순번과 목적을 포함한다. (예: `01_user_journey.svg`, `02_auth_data_flow.svg`)
|
|
67
67
|
|
|
68
|
+
### 2.8. HTML UI Preview Gate (필수)
|
|
69
|
+
- **HTML Preview 필수화**: `docs/02_UI_Screens/`의 UI 문서는 Markdown 설명만으로 완료할 수 없다. 주요 화면과 사용자 흐름은 반드시 브라우저에서 열어볼 수 있는 HTML Preview로 제작한다.
|
|
70
|
+
- **저장 위치**: HTML Preview는 `docs/02_UI_Screens/previews/`에 저장한다.
|
|
71
|
+
- **파일 네이밍**: HTML 파일명에도 순번과 목적을 포함한다. (예: `01_main_flow_preview.html`, `02_dashboard_preview.html`)
|
|
72
|
+
- **문서 링크 필수**: `00_SCREEN_FLOW.md`, `01_UI_DESIGN.md`, 관련 `XX_PROTOTYPE_REVIEW.md`는 해당 HTML Preview를 상대 경로로 링크해야 한다.
|
|
73
|
+
- **사용자 커뮤니케이션 필수**: 구현 전 HTML Preview를 사용자에게 보여주고 피드백을 받아야 하며, 확인 결과와 보완 사항을 UI 문서 또는 `docs/04_Logic_Progress/00_BACKLOG.md`에 기록한다.
|
|
74
|
+
- **구현 차단 조건**: HTML Preview가 없거나 문서에 링크되지 않았거나 사용자의 화면 확인 기록이 없으면 UI-First Gate를 통과할 수 없고, 구현을 시작할 수 없다.
|
|
75
|
+
|
|
68
76
|
## 3. 개발 표준 및 품질
|
|
69
77
|
- **UI 중심 개발 전략 (UI-First)**: Concept_Design -> UI_Screens -> Technical_Specs -> Logic_Progress 순서를 따른다.
|
|
70
78
|
- **git commit 필수**: 중요 작업 전 반드시 git commit을 수행한다.
|
|
@@ -96,7 +104,7 @@ AI 에이전트는 본 프로젝트에 설치된 다음 **26개 스킬**을 활
|
|
|
96
104
|
| | `docs-business` | 사업계획서 작성 (정부 지원, 투자 심사, 파트너십 목적별 구성) |
|
|
97
105
|
| **품질 검증 (QA)** | `verify-implementation` | 모든 `verify-*` 스킬의 통합 순차 실행 및 보고 |
|
|
98
106
|
| | `verify-docs` | 문서 레이어 정합성 및 네이밍/메타데이터, UI-First Gate 검증 |
|
|
99
|
-
| | `verify-ui` | 구현 UI와 화면
|
|
107
|
+
| | `verify-ui` | 구현 UI와 화면 문서·HTML Preview·사용자 동선·상태별 UI 정합성 검증 |
|
|
100
108
|
| | `verify-code` | PR 전 코드 품질 종합 리뷰 (로직, 타입, 중복, 사이드 이펙트) |
|
|
101
109
|
| | `verify-security` | OWASP Top 10 기준 보안 취약점 점검 (인증, 인젝션, 시크릿 노출 등) |
|
|
102
110
|
| | `verify-performance` | Lighthouse·Core Web Vitals 기준 성능 점검 (LCP, CLS, 번들, 이미지) |
|
|
@@ -121,7 +129,7 @@ AI 에이전트는 사용자가 스킬을 호출하지 않아도, 아래 상황
|
|
|
121
129
|
| 기술 선택, DB/API/아키텍처 설계 논의 시작 | `manage-decisions` | "결정이 필요한 상황입니다. `/manage-decisions`로 유형별 질문을 진행할까요?" |
|
|
122
130
|
| 보안·인증·인가·환경변수 관련 코드 작성 전후 | `verify-security` | "보안 관련 변경입니다. `/verify-security`로 OWASP 점검을 실행할까요?" |
|
|
123
131
|
| 성능·렌더링·이미지·번들 관련 작업 완료 후 | `verify-performance` | "성능 영향이 있을 수 있습니다. `/verify-performance`로 Lighthouse 점검을 실행할까요?" |
|
|
124
|
-
| UI·화면·컴포넌트 구현 완료 후 | `verify-ui` | "UI 구현 변경입니다. `/verify-ui`로
|
|
132
|
+
| UI·화면·컴포넌트 구현 완료 후 | `verify-ui` | "UI 구현 변경입니다. `/verify-ui`로 HTML Preview·화면 문서·사용자 동선 정합성을 검증할까요?" |
|
|
125
133
|
| PR 생성 전, 코드 변경 완료 후 | `verify-code`, `verify-implementation` | "PR 전 최종 점검입니다. `/verify-implementation`으로 전체 검증을 실행할까요?" |
|
|
126
134
|
| 기획·UI 문서 작성 요청 | `docs-plan` | "Layer 1-2 문서 작성은 `/docs-plan`을 사용하세요." |
|
|
127
135
|
| DB 스키마·API 명세·백로그 작성 요청 | `docs-dev` | "Layer 3-5 문서 작성은 `/docs-dev`를 사용하세요." |
|
package/README.md
CHANGED
|
@@ -1,40 +1,55 @@
|
|
|
1
1
|
# solmate-skills
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Reusable AI-agent skills for disciplined product work.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
`solmate-skills` packages the Solmate workflow as installable skills: plan the product, create browser-viewable UI previews, lock backlog tasks to their source documents, implement with approval gates, and verify the result before release.
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
Use it when you want an AI coding agent to follow a shared workflow instead of improvising project structure, documentation, implementation order, and QA.
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
## Install
|
|
10
10
|
|
|
11
|
-
|
|
12
|
-
- UI, user paths, data flow, loading states, empty states, and error states must be confirmed before coding.
|
|
13
|
-
- User journey SVG files belong in `docs/02_UI_Screens/assets/`.
|
|
14
|
-
- Data flow SVG files belong in `docs/03_Technical_Specs/assets/`.
|
|
15
|
-
- `/rules-workflow` now treats linked backlog documents as implementation inputs before coding starts.
|
|
16
|
-
- `/verify-docs` fails backlog items that omit required related-document fields.
|
|
17
|
-
- Local Codex settings under `.codex/` are excluded from the npm package, while skill-owned shell scripts remain publishable.
|
|
18
|
-
|
|
19
|
-
## Installation
|
|
20
|
-
|
|
21
|
-
You don't need to install this package globally. Simply use `npx`:
|
|
11
|
+
You do not need a global install. Run it with `npx` from the root of the project where you want the skills installed:
|
|
22
12
|
|
|
23
13
|
```bash
|
|
24
14
|
# List available skills
|
|
25
|
-
npx solmate-skills list
|
|
15
|
+
npx solmate-skills@latest list
|
|
26
16
|
|
|
27
|
-
# Install
|
|
17
|
+
# Install every skill
|
|
28
18
|
npx solmate-skills@latest install all
|
|
29
19
|
|
|
20
|
+
# Install one skill
|
|
21
|
+
npx solmate-skills@latest install rules-product
|
|
22
|
+
|
|
30
23
|
# Install proactive hook suggestions for Claude Code projects
|
|
31
24
|
npx solmate-skills@latest install hooks
|
|
32
|
-
|
|
33
|
-
# Install a specific skill
|
|
34
|
-
npx solmate-skills install rules-docs
|
|
35
25
|
```
|
|
36
26
|
|
|
37
|
-
|
|
27
|
+
The installer copies each selected skill folder into `.agent/skills/<skill-name>` in your current project.
|
|
28
|
+
|
|
29
|
+
## What You Get
|
|
30
|
+
|
|
31
|
+
- **Product workflow orchestration**: `/rules-product` diagnoses the current phase and routes the agent to the right next skill.
|
|
32
|
+
- **UI-first planning**: `/docs-plan` creates concept and screen documents before implementation starts.
|
|
33
|
+
- **HTML UI Preview Gate**: major screens and flows must have browser-viewable HTML previews under `docs/02_UI_Screens/previews/`.
|
|
34
|
+
- **Backlog Context Lock**: every backlog item must link the Concept, UI, HTML Preview, Technical Spec, and QA documents needed for implementation.
|
|
35
|
+
- **Implementation workflow**: `/rules-workflow` keeps coding work tied to approved documents, preconditions, and acceptance criteria.
|
|
36
|
+
- **Release verification**: `/verify-implementation` runs the verification family for docs, UI, code, security, performance, DB schema, and skill package readiness.
|
|
37
|
+
|
|
38
|
+
## What's New in 2.0.8
|
|
39
|
+
|
|
40
|
+
`solmate-skills@2.0.8` refreshes the npm README and package metadata so the package purpose, install path, and core workflow gates are clearer on the npm package page.
|
|
41
|
+
|
|
42
|
+
Recent workflow guardrails:
|
|
43
|
+
|
|
44
|
+
- Every backlog task must link to related Concept, UI, HTML Preview, Technical Spec, and QA documents.
|
|
45
|
+
- UI planning must include HTML preview files under `docs/02_UI_Screens/previews/` and link them from the related UI documents.
|
|
46
|
+
- UI, user paths, data flow, loading states, empty states, and error states must be confirmed before coding.
|
|
47
|
+
- User journey SVG files belong in `docs/02_UI_Screens/assets/`.
|
|
48
|
+
- Data flow SVG files belong in `docs/03_Technical_Specs/assets/`.
|
|
49
|
+
- `/rules-workflow` treats linked backlog documents as implementation inputs before coding starts.
|
|
50
|
+
- `/verify-docs` fails backlog items that omit required related-document fields.
|
|
51
|
+
|
|
52
|
+
## Install Details
|
|
38
53
|
|
|
39
54
|
`install all` installs only skill folders that contain `SKILL.md`. Use `install hooks` separately when you want prompt/file-change suggestions that nudge the agent toward `/rules-product`, `/rules-workflow`, and the relevant `verify-*` skills.
|
|
40
55
|
|
|
@@ -161,7 +176,7 @@ Skills are organized into five categories.
|
|
|
161
176
|
| `verify-security` | Check for security vulnerabilities based on OWASP Top 10. |
|
|
162
177
|
| `verify-performance` | Lighthouse & Core Web Vitals check. |
|
|
163
178
|
| `verify-code` | Comprehensive pre-PR code quality review. |
|
|
164
|
-
| `verify-ui` | Verify implemented UI against screen docs and user flows. |
|
|
179
|
+
| `verify-ui` | Verify implemented UI against screen docs, HTML previews, and user flows. |
|
|
165
180
|
| `verify-skills` | Verify skill package metadata, CLI output, and release readiness. |
|
|
166
181
|
|
|
167
182
|
---
|
|
@@ -195,13 +210,14 @@ docs/
|
|
|
195
210
|
|
|
196
211
|
```
|
|
197
212
|
1. /docs-plan → Write VISION_CORE.md, LEAN_CANVAS.md, PRODUCT_SPECS.md
|
|
198
|
-
2. /docs-plan → Write SCREEN_FLOW.md, UI_DESIGN.md
|
|
199
|
-
3. UI
|
|
200
|
-
4.
|
|
201
|
-
5.
|
|
202
|
-
6. /docs-dev → Write
|
|
203
|
-
7. /
|
|
204
|
-
8. /
|
|
213
|
+
2. /docs-plan → Write SCREEN_FLOW.md, UI_DESIGN.md, and HTML UI previews
|
|
214
|
+
3. HTML UI Preview Gate → Show browser-viewable HTML screens and capture user feedback
|
|
215
|
+
4. UI-First Gate → Confirm screens, user paths, data flow, and UI states before coding
|
|
216
|
+
5. Pre-Code Technical Brief → Confirm data sources, API shape, state strategy, and acceptance criteria
|
|
217
|
+
6. /docs-dev → Write DEVELOPMENT_PRINCIPLES.md, DB_SCHEMA.md, API_SPECS.md
|
|
218
|
+
7. /docs-dev → Write ROADMAP.md, BACKLOG.md with mandatory related document links
|
|
219
|
+
8. /rules-workflow → Implement each backlog item only after reading linked docs and passing UI-First Gate
|
|
220
|
+
9. /verify-implementation → Audit docs, UI, code, security, performance, DB, and skill package changes
|
|
205
221
|
```
|
|
206
222
|
|
|
207
223
|
Backlog items are intentionally document-linked. Each task in `docs/04_Logic_Progress/00_BACKLOG.md` must include related Concept, UI, Technical Spec, and QA documents, plus implementation preconditions, acceptance criteria, and a document sync check. If a related document does not exist, the item must say `N/A - 사유`; implementation should pause when the missing document is required for a safe decision.
|
|
@@ -212,12 +228,30 @@ Backlog Context Lock makes `docs/04_Logic_Progress/00_BACKLOG.md` act as a bridg
|
|
|
212
228
|
|
|
213
229
|
### UI-First Gate
|
|
214
230
|
|
|
215
|
-
UI-First Gate prevents implementation from starting before the team has reviewed the actual screens and the user's path through them. Before coding, confirm the core screen structure, user entry and exit paths, CTAs, screen-by-screen data flow, loading states, empty states, and error states. If these are missing, update `docs/02_UI_Screens
|
|
231
|
+
UI-First Gate prevents implementation from starting before the team has reviewed the actual screens and the user's path through them. Before coding, confirm the core screen structure, user entry and exit paths, CTAs, screen-by-screen data flow, loading states, empty states, and error states. If these are missing, update `docs/02_UI_Screens/`, its HTML previews, or the backlog first.
|
|
232
|
+
|
|
233
|
+
### HTML UI Preview Gate
|
|
234
|
+
|
|
235
|
+
UI planning documents are not complete with Markdown alone. For every major screen or user flow, create a browser-viewable HTML preview and store it under:
|
|
236
|
+
|
|
237
|
+
```text
|
|
238
|
+
docs/02_UI_Screens/previews/
|
|
239
|
+
```
|
|
240
|
+
|
|
241
|
+
Recommended naming:
|
|
242
|
+
|
|
243
|
+
```text
|
|
244
|
+
docs/02_UI_Screens/previews/01_main_flow_preview.html
|
|
245
|
+
docs/02_UI_Screens/previews/02_dashboard_preview.html
|
|
246
|
+
```
|
|
247
|
+
|
|
248
|
+
Each related UI document must link to the HTML file with a relative path. The preview must be shown to the user before implementation, and feedback must be captured in `XX_PROTOTYPE_REVIEW.md`, `00_SCREEN_FLOW.md`, `01_UI_DESIGN.md`, or the related backlog item.
|
|
216
249
|
|
|
217
250
|
Required fields for every backlog item:
|
|
218
251
|
|
|
219
252
|
- `Related Concept Docs`
|
|
220
253
|
- `Related UI Docs`
|
|
254
|
+
- `Related HTML Preview`
|
|
221
255
|
- `Related Technical Docs`
|
|
222
256
|
- `Related QA Docs`
|
|
223
257
|
- `Implementation Preconditions`
|
|
@@ -236,6 +270,8 @@ If a related document does not exist, write `N/A - 사유`. Do not leave the fie
|
|
|
236
270
|
- [Product Specs](../01_Concept_Design/03_PRODUCT_SPECS.md) - feature purpose and user value
|
|
237
271
|
- Related UI Docs:
|
|
238
272
|
- [Screen Flow](../02_UI_Screens/00_SCREEN_FLOW.md) - target screen and interaction flow
|
|
273
|
+
- Related HTML Preview:
|
|
274
|
+
- [Main Flow Preview](../02_UI_Screens/previews/01_main_flow_preview.html) - browser-viewable UI for user review
|
|
239
275
|
- Related Technical Docs:
|
|
240
276
|
- [API Specs](../03_Technical_Specs/02_API_SPECS.md) - endpoint and data contract
|
|
241
277
|
- Related QA Docs:
|
|
@@ -243,6 +279,7 @@ If a related document does not exist, write `N/A - 사유`. Do not leave the fie
|
|
|
243
279
|
- Implementation Preconditions:
|
|
244
280
|
- [ ] Read all related documents before coding
|
|
245
281
|
- [ ] Confirm screen/UI before coding
|
|
282
|
+
- [ ] Show the HTML UI preview to the user and capture feedback
|
|
246
283
|
- [ ] Confirm user path and screen-by-screen data flow
|
|
247
284
|
- [ ] Confirm loading, empty, and error states
|
|
248
285
|
- [ ] Confirm implementation scope does not conflict with documented intent
|
package/docs-dev/SKILL.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: docs-dev
|
|
3
|
-
description: Create and manage development documents for Layer 3 (Technical_Specs), Layer 4 (Logic_Progress), and Layer 5 (QA_Validation). Use when writing DB schema docs, API specs, development principles, roadmaps, backlogs, business logic designs, or test scenarios. Always read existing files before editing.
|
|
3
|
+
description: Create and manage development documents for Layer 3 (Technical_Specs), Layer 4 (Logic_Progress), and Layer 5 (QA_Validation). Use when writing DB schema docs, API specs, development principles, roadmaps, backlogs, business logic designs, or test scenarios. Enforces backlog links to Concept/UI/HTML Preview/Technical/QA docs before implementation. Always read existing files before editing.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# Development Documentation Skill
|
|
@@ -60,19 +60,21 @@ This skill manages **Layer 3 (Technical_Specs)**, **Layer 4 (Logic_Progress)**,
|
|
|
60
60
|
|
|
61
61
|
**Backlog 문서 참조 강제 규칙**: `00_BACKLOG.md`의 모든 작업 항목은 관련 문서를 읽은 뒤 작성해야 하며, 구현자는 코드 작성 전에 해당 문서를 다시 확인해야 한다. 백로그는 단순 ToDo 목록이 아니라 Concept, UI, Technical Spec, QA 기준을 구현으로 연결하는 실행 티켓이어야 한다.
|
|
62
62
|
|
|
63
|
-
**UI-First Gate 강제 규칙**: 구현 코드는 화면 확인 이후에만 작성한다. 백로그 항목은 관련 UI
|
|
63
|
+
**UI-First Gate 강제 규칙**: 구현 코드는 화면 확인 이후에만 작성한다. 백로그 항목은 관련 UI 문서와 HTML Preview에서 화면 구조, 사용자 동선, 데이터 흐름, 로딩·빈 상태·오류 상태를 확인했음을 `Implementation Preconditions`에 포함해야 한다. 해당 정보가 없으면 `docs/02_UI_Screens/` 문서와 `docs/02_UI_Screens/previews/` HTML 파일부터 보완한다.
|
|
64
64
|
|
|
65
65
|
**Pre-Code Technical Brief 강제 규칙**: UI 확인 후에도 바로 구현하지 않는다. 데이터 소스, 최소 필드, mutation, 상태 관리 방식, acceptance criteria가 백로그나 기술 문서에 기록되어야 한다. 불명확하면 `docs/03_Technical_Specs/` 문서 또는 백로그 항목을 먼저 보완한다.
|
|
66
66
|
|
|
67
67
|
Backlog 항목 작성 전 필수 확인 대상:
|
|
68
68
|
- `docs/01_Concept_Design/`: 기능 목적, 사용자 가치, 제품 방향
|
|
69
69
|
- `docs/02_UI_Screens/`: 화면 흐름, UI 상태, 인터랙션
|
|
70
|
+
- `docs/02_UI_Screens/previews/`: 사용자에게 보여줄 HTML UI Preview
|
|
70
71
|
- `docs/03_Technical_Specs/`: API, DB, 데이터 구조, 기술 제약
|
|
71
72
|
- `docs/05_QA_Validation/`: 테스트 기준, 수용 조건, 검증 시나리오
|
|
72
73
|
|
|
73
74
|
각 Backlog 항목은 다음 필드를 반드시 포함한다:
|
|
74
75
|
- `Related Concept Docs`: 관련 기획/디자인 문서
|
|
75
76
|
- `Related UI Docs`: 관련 화면/플로우 문서
|
|
77
|
+
- `Related HTML Preview`: 관련 HTML 화면 프로토타입
|
|
76
78
|
- `Related Technical Docs`: 관련 기술 명세 문서
|
|
77
79
|
- `Related QA Docs`: 관련 검증 문서
|
|
78
80
|
- `Implementation Preconditions`: 구현 전 반드시 확인할 조건
|
|
@@ -85,6 +87,7 @@ Backlog 항목 작성 전 필수 확인 대상:
|
|
|
85
87
|
- 관련 문서를 실제로 읽었는가?
|
|
86
88
|
- 문서의 요구사항이 Backlog 항목에 반영되어 있는가?
|
|
87
89
|
- 화면 구조와 사용자 동선을 먼저 확인했는가?
|
|
90
|
+
- HTML UI Preview를 사용자에게 보여주고 피드백을 기록했는가?
|
|
88
91
|
- 화면별 입력·출력 데이터와 상태 변화를 확인했는가?
|
|
89
92
|
- 로딩·빈 상태·오류 상태가 UI 문서나 백로그에 반영되어 있는가?
|
|
90
93
|
- 데이터 소스, 최소 필드, mutation, 상태 관리 방식이 정리되었는가?
|
|
@@ -188,6 +191,8 @@ Backlog 항목 작성 전 필수 확인 대상:
|
|
|
188
191
|
- [문서명](../01_Concept_Design/XX_DOCUMENT.md) - 기능 목적/사용자 가치 근거
|
|
189
192
|
- Related UI Docs:
|
|
190
193
|
- [문서명](../02_UI_Screens/XX_DOCUMENT.md) - 화면 흐름/상태/인터랙션 근거
|
|
194
|
+
- Related HTML Preview:
|
|
195
|
+
- [HTML Preview](../02_UI_Screens/previews/XX_SCREEN_PREVIEW.html) - 사용자 확인용 브라우저 화면
|
|
191
196
|
- Related Technical Docs:
|
|
192
197
|
- [문서명](../03_Technical_Specs/XX_DOCUMENT.md) - API/DB/데이터 구조 근거
|
|
193
198
|
- Related QA Docs:
|
|
@@ -195,6 +200,7 @@ Backlog 항목 작성 전 필수 확인 대상:
|
|
|
195
200
|
- Implementation Preconditions:
|
|
196
201
|
- [ ] 관련 문서 전체 확인 완료
|
|
197
202
|
- [ ] 화면/UI 선확인 완료
|
|
203
|
+
- [ ] HTML UI Preview 사용자 확인 및 피드백 기록 완료
|
|
198
204
|
- [ ] 사용자 진입·전환·이탈 동선 확인 완료
|
|
199
205
|
- [ ] 화면별 입력·출력 데이터 및 상태 변화 확인 완료
|
|
200
206
|
- [ ] 로딩·빈 상태·오류 상태 확인 완료
|
|
@@ -203,6 +209,7 @@ Backlog 항목 작성 전 필수 확인 대상:
|
|
|
203
209
|
- [ ] 구현 범위와 문서 요구사항 충돌 없음
|
|
204
210
|
- Acceptance Criteria:
|
|
205
211
|
- [ ] 구현 결과가 확인된 화면 구조와 사용자 동선을 따른다
|
|
212
|
+
- [ ] 구현 결과가 HTML UI Preview와 의도 없이 불일치하지 않는다
|
|
206
213
|
- [ ] 데이터 흐름과 상태 변화가 Pre-Code Technical Brief와 일치한다
|
|
207
214
|
- [ ] QA 기준이 구현 완료 판단에 반영됨
|
|
208
215
|
- [ ] 핵심 사용자 흐름이 검증됨
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
interface:
|
|
2
2
|
display_name: "Development Docs"
|
|
3
|
-
short_description: "Write
|
|
4
|
-
default_prompt: "Use $docs-dev to create technical specs, implementation plans, and QA validation docs."
|
|
3
|
+
short_description: "Write specs, backlogs, QA, and preview links"
|
|
4
|
+
default_prompt: "Use $docs-dev to create technical specs, implementation plans, preview-linked backlogs, and QA validation docs."
|
package/docs-plan/SKILL.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: docs-plan
|
|
3
|
-
description: Create and manage planning documents for Layer 1 (Concept_Design) and Layer 2 (UI_Screens)
|
|
3
|
+
description: Create and manage planning documents for Layer 1 (Concept_Design) and Layer 2 (UI_Screens), including required HTML UI previews under docs/02_UI_Screens/previews/. Use when documenting product vision, lean canvas, product specs, UI design systems, screen flows, HTML prototypes, or prototype reviews. Ask before writing. Always include Related Documents sections.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# Planning Documentation Skill
|
|
@@ -39,6 +39,7 @@ This skill manages **Layer 1 (Concept_Design)** and **Layer 2 (UI_Screens)** —
|
|
|
39
39
|
**Layer 2 — UI_Screens**
|
|
40
40
|
- `00_SCREEN_FLOW.md` — 전체 사용자 여정, 진입·전환·이탈 흐름, 화면별 데이터 입출력
|
|
41
41
|
- `01_UI_DESIGN.md` — 디자인 시스템, 화면 구조, 상태별 UI, 핵심 CTA
|
|
42
|
+
- `previews/XX_SCREEN_PREVIEW.html` — 브라우저에서 열어볼 수 있는 화면/사용자 흐름 HTML Preview
|
|
42
43
|
- `XX_PROTOTYPE_REVIEW.md` — 페이지별 화면 확인 결과와 구현 전 피드백
|
|
43
44
|
|
|
44
45
|
## 3. Interactive Process (Ask Before Write)
|
|
@@ -77,7 +78,9 @@ This skill manages **Layer 1 (Concept_Design)** and **Layer 2 (UI_Screens)** —
|
|
|
77
78
|
18. **User Path**: 사용자는 어디서 진입하고, 어떤 CTA를 누르며, 어디로 이동하거나 이탈하는가?
|
|
78
79
|
19. **Data Flow**: 각 화면에서 필요한 입력 데이터, 표시 데이터, 저장/전송 데이터는 무엇인가?
|
|
79
80
|
20. **State Coverage**: 로딩, 빈 상태, 오류 상태, 권한 없음 상태는 화면에서 어떻게 보이는가?
|
|
80
|
-
21. **
|
|
81
|
+
21. **HTML UI Preview**: 주요 화면과 사용자 흐름을 `docs/02_UI_Screens/previews/`의 HTML 파일로 제작했는가?
|
|
82
|
+
22. **Preview Links**: `00_SCREEN_FLOW.md`, `01_UI_DESIGN.md`, 관련 `XX_PROTOTYPE_REVIEW.md`에서 HTML Preview를 상대 경로로 링크했는가?
|
|
83
|
+
23. **Prototype Review**: 사용자가 HTML Preview, 실제 화면, 스크린샷, 와이어프레임, 또는 프로토타입 리뷰를 먼저 확인했는가?
|
|
81
84
|
|
|
82
85
|
## 4. Templates
|
|
83
86
|
|
|
@@ -143,37 +146,44 @@ This skill manages **Layer 1 (Concept_Design)** and **Layer 2 (UI_Screens)** —
|
|
|
143
146
|
> Created: YYYY-MM-DD HH:mm
|
|
144
147
|
> Last Updated: YYYY-MM-DD HH:mm
|
|
145
148
|
|
|
146
|
-
## 1.
|
|
147
|
-
|
|
149
|
+
## 1. HTML UI Preview
|
|
150
|
+
- Preview: [HTML Preview](./previews/XX_SCREEN_PREVIEW.html)
|
|
151
|
+
- 확인 방식: 브라우저에서 HTML 파일 열람 / 로컬 서버 / 배포 URL
|
|
152
|
+
- 확인 목적: 화면 구조, 사용자 동선, 상태별 UI 커뮤니케이션
|
|
148
153
|
|
|
149
|
-
## 2.
|
|
154
|
+
## 2. Prototype Link/Screenshot
|
|
155
|
+
(스크린샷, 배포 URL, 또는 추가 작동 프로토타입 링크 첨부)
|
|
156
|
+
|
|
157
|
+
## 3. Key User Flows
|
|
150
158
|
(이 프로토타입에서 시연된 흐름 설명)
|
|
151
159
|
|
|
152
|
-
##
|
|
160
|
+
## 4. Screen States
|
|
153
161
|
- Default:
|
|
154
162
|
- Loading:
|
|
155
163
|
- Empty:
|
|
156
164
|
- Error:
|
|
157
165
|
- Permission denied / unavailable:
|
|
158
166
|
|
|
159
|
-
##
|
|
167
|
+
## 5. Data Flow
|
|
160
168
|
- Inputs:
|
|
161
169
|
- Displayed data:
|
|
162
170
|
- Mutations / saved data:
|
|
163
171
|
- External dependencies:
|
|
164
172
|
|
|
165
|
-
##
|
|
173
|
+
## 6. User Confirmation
|
|
166
174
|
- 화면/UI 선확인 여부:
|
|
175
|
+
- HTML Preview 확인 여부:
|
|
167
176
|
- 확인자:
|
|
168
177
|
- 확인 일시:
|
|
169
178
|
- 보완 필요 사항:
|
|
170
179
|
|
|
171
|
-
##
|
|
180
|
+
## 7. Feedback & Improvements
|
|
172
181
|
(구현 전 변경이 필요한 사항)
|
|
173
182
|
|
|
174
|
-
##
|
|
183
|
+
## 8. Related Documents
|
|
175
184
|
- **Concept_Design**: [Product Specs](../01_Concept_Design/03_PRODUCT_SPECS.md) - 사이트맵 및 사용자 플로우
|
|
176
185
|
- **UI_Screens**: [UI Design](./01_UI_DESIGN.md) - 디자인 시스템 및 컴포넌트 가이드라인
|
|
186
|
+
- **UI_Screens**: [HTML Preview](./previews/XX_SCREEN_PREVIEW.html) - 브라우저 확인용 화면 프로토타입
|
|
177
187
|
- **Technical_Specs**: [Related Spec](../03_Technical_Specs/XX_SPEC.md) - 구현 명세 요구사항
|
|
178
188
|
```
|
|
179
189
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
interface:
|
|
2
2
|
display_name: "Planning Docs"
|
|
3
|
-
short_description: "Write product
|
|
4
|
-
default_prompt: "Use $docs-plan to build
|
|
3
|
+
short_description: "Write product docs and HTML UI previews"
|
|
4
|
+
default_prompt: "Use $docs-plan to build product vision, screen flow, UI docs, and HTML UI previews."
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "solmate-skills",
|
|
3
|
-
"version": "2.0.
|
|
4
|
-
"description": "
|
|
3
|
+
"version": "2.0.8",
|
|
4
|
+
"description": "AI workflow skills for UI-first planning, backlog-linked docs, QA, and Solmate projects",
|
|
5
5
|
"main": "bin/cli.js",
|
|
6
6
|
"bin": {
|
|
7
7
|
"solmate-skills": "bin/cli.js"
|
|
@@ -10,9 +10,15 @@
|
|
|
10
10
|
"test": "echo \"Error: no test specified\" && exit 1"
|
|
11
11
|
},
|
|
12
12
|
"keywords": [
|
|
13
|
-
"skills",
|
|
13
|
+
"ai-skills",
|
|
14
|
+
"codex",
|
|
15
|
+
"claude",
|
|
16
|
+
"workflow",
|
|
17
|
+
"documentation",
|
|
18
|
+
"ui-first",
|
|
19
|
+
"qa",
|
|
14
20
|
"solmate",
|
|
15
|
-
"
|
|
21
|
+
"skills",
|
|
16
22
|
"automation"
|
|
17
23
|
],
|
|
18
24
|
"author": "",
|
package/rules-docs/SKILL.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: rules-docs
|
|
3
|
-
description: Create and manage project documentation according to the 365 Principle
|
|
3
|
+
description: Create and manage project documentation according to the 365 Principle with mandatory cross-layer context linking, Backlog Context Lock, and HTML UI Preview Gate rules. Use when the user asks to document features, update docs, create spec files, manage project docs, or require browser-viewable UI previews linked from docs/02_UI_Screens/.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# Documentation Management Skill
|
|
@@ -66,19 +66,34 @@ description: Create and manage project documentation according to the 365 Princi
|
|
|
66
66
|
- `00_ROADMAP.md`: 마일스톤 및 단계별 일정 (Phase별 큰 줄기와 세부 항목 분할)
|
|
67
67
|
- `01_EXECUTION_PLAN.md`: 기술 실행 전략 및 타임라인 (구체적인 구현 스텝 및 체크박스 필수)
|
|
68
68
|
|
|
69
|
+
### HTML UI Preview Gate (필수)
|
|
70
|
+
|
|
71
|
+
`docs/02_UI_Screens/`의 UI 문서는 Markdown만으로 완료할 수 없다. 주요 화면과 사용자 흐름은 반드시 브라우저에서 열어볼 수 있는 HTML Preview로 제작하고, 다음 위치에 저장한다.
|
|
72
|
+
|
|
73
|
+
```text
|
|
74
|
+
docs/02_UI_Screens/previews/
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
규칙:
|
|
78
|
+
- HTML 파일명은 2자리 순번과 목적을 포함한다. 예: `01_main_flow_preview.html`
|
|
79
|
+
- `00_SCREEN_FLOW.md`, `01_UI_DESIGN.md`, 관련 `XX_PROTOTYPE_REVIEW.md`는 HTML Preview를 상대 경로로 링크한다.
|
|
80
|
+
- HTML Preview는 구현 전 사용자에게 보여주고 피드백을 기록한다.
|
|
81
|
+
- HTML Preview가 없거나 문서에 링크되지 않았거나 사용자 확인 기록이 없으면 UI-First Gate를 통과할 수 없다.
|
|
82
|
+
|
|
69
83
|
### Backlog Context Lock (필수)
|
|
70
84
|
|
|
71
85
|
`docs/04_Logic_Progress/00_BACKLOG.md`의 모든 작업 항목은 다른 레이어의 관련 문서를 구현 입력값으로 연결해야 한다. 백로그는 단독 ToDo가 아니며, 다음 필드를 통해 문서 기반 구현을 강제한다.
|
|
72
86
|
|
|
73
87
|
- `Related Concept Docs`
|
|
74
88
|
- `Related UI Docs`
|
|
89
|
+
- `Related HTML Preview`
|
|
75
90
|
- `Related Technical Docs`
|
|
76
91
|
- `Related QA Docs`
|
|
77
92
|
- `Implementation Preconditions`
|
|
78
93
|
- `Acceptance Criteria`
|
|
79
94
|
- `Document Sync Check`
|
|
80
95
|
|
|
81
|
-
각 Related 필드는 상대 경로 링크와 관계 설명을 포함해야 한다. 관련
|
|
96
|
+
각 Related 필드는 상대 경로 링크와 관계 설명을 포함해야 한다. 관련 문서나 HTML Preview가 없으면 빈칸으로 두지 않고 `N/A - 사유`를 명시한다. 단, 구현 판단에 필요한 Concept, UI, HTML Preview, Technical Spec, QA 기준이 아직 문서화되지 않은 경우에는 백로그만으로 구현을 시작할 수 없으며, 먼저 문서 작성 또는 보완 여부를 사용자에게 확인한다.
|
|
82
97
|
|
|
83
98
|
### 메타데이터 (필수)
|
|
84
99
|
|
|
@@ -112,13 +127,13 @@ description: Create and manage project documentation according to the 365 Princi
|
|
|
112
127
|
|
|
113
128
|
**Concept_Design**: 같은 레이어 문서 + 관련 UI_Screens/Technical_Specs
|
|
114
129
|
|
|
115
|
-
**UI_Screens**: Concept_Design (Product Specs, UI Design) + 이전/다음 UI_Screens + Technical_Specs
|
|
130
|
+
**UI_Screens**: Concept_Design (Product Specs, UI Design) + 이전/다음 UI_Screens + HTML Preview + Technical_Specs
|
|
116
131
|
|
|
117
132
|
**Technical_Specs**: Concept_Design + UI_Screens + 다른 Technical_Specs (DB ↔ API) + Logic_Progress
|
|
118
133
|
|
|
119
134
|
**Logic_Progress**: Concept_Design + UI_Screens + Technical_Specs (DB, API) + QA_Validation
|
|
120
135
|
|
|
121
|
-
**Backlog Items**: 각 항목 단위로 Concept_Design + UI_Screens + Technical_Specs + QA_Validation 링크를 포함한다. 구현자는 항목 착수 전 링크된
|
|
136
|
+
**Backlog Items**: 각 항목 단위로 Concept_Design + UI_Screens + HTML Preview + Technical_Specs + QA_Validation 링크를 포함한다. 구현자는 항목 착수 전 링크된 문서와 HTML Preview를 확인하고 `Implementation Preconditions`를 확인해야 한다.
|
|
122
137
|
|
|
123
138
|
**QA_Validation**: 모든 상위 레이어 참조
|
|
124
139
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
interface:
|
|
2
2
|
display_name: "Documentation Rules"
|
|
3
|
-
short_description: "Apply
|
|
4
|
-
default_prompt: "Use $rules-docs to decide where
|
|
3
|
+
short_description: "Apply docs, links, and HTML preview rules"
|
|
4
|
+
default_prompt: "Use $rules-docs to decide where docs, HTML previews, and related links belong."
|
package/rules-product/SKILL.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: rules-product
|
|
3
|
-
description: Orchestrates the full product development pipeline from planning to development docs. Diagnoses current project phase, checks gate conditions, and delegates to the correct sub-skill at each step. Use this as the entry point for new projects or when resuming work mid-flow.
|
|
3
|
+
description: Orchestrates the full product development pipeline from planning to development docs. Diagnoses current project phase, checks gate conditions including HTML UI Preview Gate and UI-First Gate, and delegates to the correct sub-skill at each step. Use this as the entry point for new projects or when resuming work mid-flow.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# Product Workflow Orchestrator
|
|
@@ -12,6 +12,7 @@ You are a **workflow lead** who guides the user through the full product develop
|
|
|
12
12
|
```
|
|
13
13
|
Phase 1: 기획문서 → docs-plan (Concept_Design)
|
|
14
14
|
Phase 2: UI 설계 문서 → docs-plan (UI_Screens)
|
|
15
|
+
HTML UI Preview Gate: 브라우저 확인용 화면 제작·링크·피드백
|
|
15
16
|
UI-First Gate: 화면·동선·데이터 흐름 확인
|
|
16
17
|
Pre-Code Technical Brief: 데이터·API·상태 최소 합의
|
|
17
18
|
Phase 3: React 변환 → rules-react
|
|
@@ -32,6 +33,7 @@ Run these checks in order:
|
|
|
32
33
|
|-------|--------|---------|
|
|
33
34
|
| `docs/01_Concept_Design/` 존재 여부 | 없으면 Phase 1 미완 | 기획문서 필요 |
|
|
34
35
|
| `docs/02_UI_Screens/` 존재 여부 | 없으면 Phase 2 미완 | UI 설계 필요 |
|
|
36
|
+
| HTML UI Preview 확인 여부 | 없으면 Phase 3 진입 보류 | 브라우저 확인용 화면 필요 |
|
|
35
37
|
| UI-First Gate 확인 여부 | 없으면 Phase 3 진입 보류 | 화면·동선·데이터 흐름 확인 필요 |
|
|
36
38
|
| Pre-Code Technical Brief 여부 | 없으면 Phase 3 진입 보류 | 최소 기술 합의 필요 |
|
|
37
39
|
| `src/components/` 또는 React 코드 존재 여부 | 없으면 Phase 3 미완 | React 개발 필요 |
|
|
@@ -132,6 +134,8 @@ Phase 1이 완료된 후 언제든 작성 가능하다. Phase 2 진입과 독립
|
|
|
132
134
|
- [ ] 사용자 진입·이탈·전환 동선이 정의됨
|
|
133
135
|
- [ ] 화면별 입력 데이터, 출력 데이터, 상태 변화가 정의됨
|
|
134
136
|
- [ ] 로딩·빈 상태·오류 상태가 정의됨
|
|
137
|
+
- [ ] `docs/02_UI_Screens/previews/`에 주요 화면 또는 사용자 흐름 HTML Preview가 존재함
|
|
138
|
+
- [ ] UI 문서가 관련 HTML Preview를 상대 경로로 링크함
|
|
135
139
|
- [ ] 사용자가 화면/UI를 먼저 확인했거나, 확인할 수 있는 프로토타입/스크린샷/리뷰 문서가 있음
|
|
136
140
|
|
|
137
141
|
**위임 지시**:
|
|
@@ -142,10 +146,28 @@ Phase 1이 완료된 후 언제든 작성 가능하다. Phase 2 진입과 독립
|
|
|
142
146
|
참조 문서: docs/01_Concept_Design/ 전체 읽기 후 시작
|
|
143
147
|
```
|
|
144
148
|
|
|
145
|
-
Phase 2 완료 후 곧바로 코딩하지 않는다. 먼저 UI-First Gate를 확인하고 다음을 묻는다:
|
|
146
|
-
> "화면 구조, 사용자 동선, 데이터 흐름, 로딩/빈/오류 상태를 먼저 확인했습니다. 현재 단계에서 더 구체화하거나 보완할 점이 있을까요?"
|
|
149
|
+
Phase 2 완료 후 곧바로 코딩하지 않는다. 먼저 HTML UI Preview Gate와 UI-First Gate를 확인하고 다음을 묻는다:
|
|
150
|
+
> "HTML Preview로 화면 구조, 사용자 동선, 데이터 흐름, 로딩/빈/오류 상태를 먼저 확인했습니다. 현재 단계에서 더 구체화하거나 보완할 점이 있을까요?"
|
|
147
151
|
|
|
148
|
-
Phase 2 완료 보고에는 `Flow Status Block`을 포함하고, 다음 위치가 `UI-First Gate`임을 명시한다.
|
|
152
|
+
Phase 2 완료 보고에는 `Flow Status Block`을 포함하고, 다음 위치가 `HTML UI Preview Gate` 또는 `UI-First Gate`임을 명시한다.
|
|
153
|
+
|
|
154
|
+
---
|
|
155
|
+
|
|
156
|
+
## HTML UI Preview Gate: 브라우저 확인용 화면 제작·링크·피드백
|
|
157
|
+
|
|
158
|
+
**목표**: Markdown UI 문서만으로 소통하지 않고, 사용자가 브라우저에서 직접 볼 수 있는 HTML 화면으로 UI를 확인한다. 이 게이트를 통과하기 전에는 Phase 3 구현을 시작하지 않는다.
|
|
159
|
+
|
|
160
|
+
**필수 확인 항목**:
|
|
161
|
+
- [ ] 주요 화면 또는 핵심 사용자 흐름별 HTML Preview가 존재함
|
|
162
|
+
- [ ] HTML Preview가 `docs/02_UI_Screens/previews/`에 저장됨
|
|
163
|
+
- [ ] `00_SCREEN_FLOW.md`, `01_UI_DESIGN.md`, 관련 `XX_PROTOTYPE_REVIEW.md`가 HTML Preview를 상대 경로로 링크함
|
|
164
|
+
- [ ] HTML Preview를 사용자에게 보여주고 피드백을 받음
|
|
165
|
+
- [ ] 피드백과 보완 사항이 UI 문서 또는 백로그에 기록됨
|
|
166
|
+
|
|
167
|
+
**Gate Out**:
|
|
168
|
+
- [ ] HTML Preview 파일 경로가 문서에 링크됨
|
|
169
|
+
- [ ] 사용자 확인 기록이 `XX_PROTOTYPE_REVIEW.md`, `00_SCREEN_FLOW.md`, `01_UI_DESIGN.md`, 또는 백로그에 남아 있음
|
|
170
|
+
- [ ] 필요한 보완 사항이 반영되었거나 백로그에 태스크로 등록됨
|
|
149
171
|
|
|
150
172
|
---
|
|
151
173
|
|
|
@@ -160,9 +182,11 @@ Phase 2 완료 보고에는 `Flow Status Block`을 포함하고, 다음 위치
|
|
|
160
182
|
- [ ] 화면별 입력 데이터, 출력 데이터, 상태 변화
|
|
161
183
|
- [ ] 로딩, 빈 상태, 오류 상태, 권한 없음 상태
|
|
162
184
|
- [ ] 모바일·데스크톱에서 구조 차이가 큰 구간
|
|
185
|
+
- [ ] HTML Preview가 실제 화면 커뮤니케이션 기준으로 확인됨
|
|
163
186
|
- [ ] 사용자 또는 의사결정권자가 화면/UI를 먼저 확인한 기록
|
|
164
187
|
|
|
165
188
|
**Gate Out**:
|
|
189
|
+
- [ ] HTML UI Preview Gate 통과
|
|
166
190
|
- [ ] `00_SCREEN_FLOW.md`에 사용자 여정과 전환 흐름이 기록됨
|
|
167
191
|
- [ ] `01_UI_DESIGN.md` 또는 `XX_PROTOTYPE_REVIEW.md`에 화면 상태와 피드백이 기록됨
|
|
168
192
|
- [ ] 필요한 경우 `docs/04_Logic_Progress/00_BACKLOG.md`의 작업 항목에 UI 확인 결과가 반영됨
|
|
@@ -198,6 +222,7 @@ Pre-Code Technical Brief 보고에는 `Flow Status Block`을 포함하고, 다
|
|
|
198
222
|
|
|
199
223
|
**Gate In**:
|
|
200
224
|
- Phase 2 문서 (`02_UI_Screens/`) 존재
|
|
225
|
+
- HTML UI Preview Gate 통과
|
|
201
226
|
- UI-First Gate 통과
|
|
202
227
|
- 화면·동선·데이터 흐름 확인 결과가 백로그 또는 UI 문서에 반영됨
|
|
203
228
|
- Pre-Code Technical Brief 통과
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
interface:
|
|
2
2
|
display_name: "Product Workflow"
|
|
3
|
-
short_description: "Orchestrate planning, UI, docs,
|
|
4
|
-
default_prompt: "Use $rules-product to diagnose the current
|
|
3
|
+
short_description: "Orchestrate planning, UI previews, docs, QA"
|
|
4
|
+
default_prompt: "Use $rules-product to diagnose the current phase, gates, HTML previews, and next skill."
|
package/rules-workflow/SKILL.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: rules-workflow
|
|
3
|
-
description: Guides the full implementation lifecycle from planning through PR. Use when implementing a new feature, planning implementation, before committing or creating a PR, or
|
|
3
|
+
description: Guides the full implementation lifecycle from planning through PR. Use when implementing a new feature, planning implementation, before committing or creating a PR, or following the 18-step workflow. Requires product phase preflight, HTML UI Preview Gate, UI-First Gate, Backlog Context Lock, implementation quality checks, and deployment readiness.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# Implementation & Execution Workflow (18 Steps)
|
|
@@ -11,9 +11,9 @@ Follow this workflow for feature implementation and significant code changes. Co
|
|
|
11
11
|
|
|
12
12
|
## Step 0: Product Phase Preflight
|
|
13
13
|
|
|
14
|
-
기능 구현을 시작하기 전, 먼저 `rules-product` 기준으로 현재 프로젝트 Phase를 진단한다. Concept, UI, UI-First Gate, Pre-Code Technical Brief 중 하나라도 누락되어 구현 판단이 불안정하면 코딩을 시작하지 않고 해당 문서 또는 백로그 보완을 제안한다.
|
|
14
|
+
기능 구현을 시작하기 전, 먼저 `rules-product` 기준으로 현재 프로젝트 Phase를 진단한다. Concept, UI, HTML UI Preview Gate, UI-First Gate, Pre-Code Technical Brief 중 하나라도 누락되어 구현 판단이 불안정하면 코딩을 시작하지 않고 해당 문서 또는 백로그 보완을 제안한다.
|
|
15
15
|
|
|
16
|
-
- 체크: [ ] 현재 Phase를 진단했는가? [ ] UI-First Gate가 충족되었는가? [ ] 최소 기술 계약이 확인되었는가?
|
|
16
|
+
- 체크: [ ] 현재 Phase를 진단했는가? [ ] HTML UI Preview Gate가 충족되었는가? [ ] UI-First Gate가 충족되었는가? [ ] 최소 기술 계약이 확인되었는가?
|
|
17
17
|
|
|
18
18
|
진단 결과는 `rules-product`의 `Flow Status Block` 형식으로 먼저 보고한다. 구현 단계 중 사용자가 "지금 어디야?", "다음 뭐야?", "현재 단계가 뭐야?"라고 묻거나 Phase 1-6 경계에 도달하면 같은 형식을 다시 출력한다.
|
|
19
19
|
|
|
@@ -24,10 +24,11 @@ Follow this workflow for feature implementation and significant code changes. Co
|
|
|
24
24
|
### Step 1. 계획 수립
|
|
25
25
|
- 요구사항·목적을 문서 또는 이슈 기준으로 정리한다.
|
|
26
26
|
- 백로그 항목이 있으면 `Related Concept Docs`, `Related UI Docs`, `Related Technical Docs`, `Related QA Docs`를 먼저 읽고 구현 입력값으로 요약한다.
|
|
27
|
-
- 코드 작성보다 먼저 UI
|
|
27
|
+
- 코드 작성보다 먼저 HTML UI Preview Gate를 확인한다. `docs/02_UI_Screens/previews/`의 HTML Preview가 없거나 UI 문서에 링크되지 않았거나 사용자 확인 기록이 없으면 구현 계획을 보류하고 `docs-plan` 문서/HTML 보완을 제안한다.
|
|
28
|
+
- 그 다음 UI-First Gate를 확인한다. 화면 구조, 사용자 동선, 데이터 흐름, 로딩·빈 상태·오류 상태가 문서화되지 않았으면 구현 계획을 보류하고 `docs-plan` 또는 `docs-dev` 문서 보완을 제안한다.
|
|
28
29
|
- Pre-Code Technical Brief를 확인한다. 데이터 소스, 최소 필드, mutation, 상태 관리 방식, acceptance criteria가 불명확하면 구현 전에 사용자와 합의한다.
|
|
29
30
|
- 변경할 파일·추가할 컴포넌트·API·DB 영향 범위를 나열한다.
|
|
30
|
-
- 체크: [ ] 목적이 명확한가? [ ] 관련 문서를 읽었는가? [ ] UI-First Gate가 확인되었는가? [ ] 최소 기술 계약이 확인되었는가? [ ] 영향 범위가 정리되었는가?
|
|
31
|
+
- 체크: [ ] 목적이 명확한가? [ ] 관련 문서를 읽었는가? [ ] HTML UI Preview를 확인했는가? [ ] UI-First Gate가 확인되었는가? [ ] 최소 기술 계약이 확인되었는가? [ ] 영향 범위가 정리되었는가?
|
|
31
32
|
|
|
32
33
|
### Step 2. 계획 검토
|
|
33
34
|
- 계획이 요구사항과 일치하는지, 누락된 시나리오는 없는지 검토한다.
|
|
@@ -48,9 +49,10 @@ Follow this workflow for feature implementation and significant code changes. Co
|
|
|
48
49
|
### Step 5. 구현
|
|
49
50
|
- 승인된 계획대로 구현한다. AGENTS.md·프로젝트 컨벤션(커밋, Zod, Luxon 등)을 따른다.
|
|
50
51
|
- 코드 작성 전 백로그 항목의 `Implementation Preconditions`와 `Acceptance Criteria`를 확인한다. 관련 문서 링크가 비어 있거나 `N/A - 사유`가 부실하면 구현을 보류하고 문서 보완 필요 여부를 사용자에게 확인한다.
|
|
52
|
+
- HTML UI Preview Gate가 통과되지 않았거나 사용자가 HTML Preview를 확인하지 않았다면 구현을 시작하지 않는다.
|
|
51
53
|
- UI-First Gate가 통과되지 않았거나 사용자가 화면/UI를 먼저 확인하지 않았다면 구현을 시작하지 않는다.
|
|
52
54
|
- 구현을 시작하기 직전에 `Flow Status Block`을 출력하고, 현재 위치가 `Phase 3 — React 변환` 또는 해당 기능 구현 단계인지 명시한다.
|
|
53
|
-
- 체크: [ ] 계획 대비 변경 사항이 일치하는가? [ ] 백로그의 관련 문서 기준을 반영했는가? [ ] 화면·동선·데이터 흐름 확인 후 구현했는가?
|
|
55
|
+
- 체크: [ ] 계획 대비 변경 사항이 일치하는가? [ ] 백로그의 관련 문서 기준을 반영했는가? [ ] HTML Preview 확인 후 구현했는가? [ ] 화면·동선·데이터 흐름 확인 후 구현했는가?
|
|
54
56
|
|
|
55
57
|
---
|
|
56
58
|
|
package/verify-docs/SKILL.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: verify-docs
|
|
3
|
-
description: 프로젝트 문서가 5단계 구조(01~05)
|
|
3
|
+
description: 프로젝트 문서가 5단계 구조(01~05), 메타데이터, Related Documents, Backlog Context Lock, HTML UI Preview Gate, UI-First Gate를 준수하는지 검증합니다. 문서 생성/수정 후, PR 전 사용.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# 문서 구조 검증
|
|
@@ -12,10 +12,11 @@ description: 프로젝트 문서가 5단계 구조(01~05)와 메타데이터 표
|
|
|
12
12
|
2. 메타데이터 표준 (Created / Last Updated)
|
|
13
13
|
3. Related Documents 섹션
|
|
14
14
|
4. Backlog Context Lock
|
|
15
|
-
5. UI
|
|
16
|
-
6.
|
|
17
|
-
7.
|
|
18
|
-
8.
|
|
15
|
+
5. HTML UI Preview Gate
|
|
16
|
+
6. UI-First Gate
|
|
17
|
+
7. Pre-Code Technical Brief
|
|
18
|
+
8. Rubric-First Writing
|
|
19
|
+
9. rules-product Gate Out 조건
|
|
19
20
|
|
|
20
21
|
## 실행 시점
|
|
21
22
|
|
|
@@ -64,6 +65,7 @@ AGENTS.md 또는 `docs/01_Concept_Design/00_COLLABORATION_GUIDE.md`를 읽어
|
|
|
64
65
|
- [ ] 모든 Backlog 작업 항목이 체크박스`[ ]` 또는 `[x]`로 시작하는가?
|
|
65
66
|
- [ ] 각 작업 항목에 `Related Concept Docs`가 있는가?
|
|
66
67
|
- [ ] 각 작업 항목에 `Related UI Docs`가 있는가?
|
|
68
|
+
- [ ] 각 작업 항목에 `Related HTML Preview`가 있는가?
|
|
67
69
|
- [ ] 각 작업 항목에 `Related Technical Docs`가 있는가?
|
|
68
70
|
- [ ] 각 작업 항목에 `Related QA Docs`가 있는가?
|
|
69
71
|
- [ ] 각 작업 항목에 `Implementation Preconditions`가 있는가?
|
|
@@ -71,16 +73,32 @@ AGENTS.md 또는 `docs/01_Concept_Design/00_COLLABORATION_GUIDE.md`를 읽어
|
|
|
71
73
|
- [ ] 각 작업 항목에 `Document Sync Check`가 있는가?
|
|
72
74
|
- [ ] Related 필드의 링크가 상대 경로이거나 `N/A - 사유` 형식인가?
|
|
73
75
|
- [ ] `N/A`만 있고 사유가 없는 항목은 없는가?
|
|
76
|
+
- [ ] `Related HTML Preview`가 상대 경로 링크 또는 `N/A - 사유` 형식인가?
|
|
77
|
+
- [ ] `Implementation Preconditions`에 HTML Preview 사용자 확인 및 피드백 기록이 포함되어 있는가?
|
|
74
78
|
- [ ] `Implementation Preconditions`에 화면/UI 선확인, 사용자 동선 확인, 데이터 흐름 확인, 로딩·빈 상태·오류 상태 확인이 포함되어 있는가?
|
|
75
79
|
- [ ] `Implementation Preconditions` 또는 `Acceptance Criteria`에 데이터 소스, 최소 필드, mutation, 상태 관리 방식, 검증 가능한 acceptance criteria가 포함되어 있는가?
|
|
76
80
|
|
|
77
81
|
위 항목 중 하나라도 누락되면 Backlog Context Lock은 Fail로 처리한다.
|
|
78
82
|
|
|
79
|
-
### Step 5: UI
|
|
83
|
+
### Step 5: HTML UI Preview Gate 검사
|
|
84
|
+
|
|
85
|
+
`docs/02_UI_Screens/`와 `docs/02_UI_Screens/previews/`를 함께 확인한다.
|
|
86
|
+
|
|
87
|
+
체크 항목:
|
|
88
|
+
- [ ] `docs/02_UI_Screens/previews/` 폴더가 있는가?
|
|
89
|
+
- [ ] 주요 화면 또는 사용자 흐름에 대응되는 `.html` 파일이 있는가?
|
|
90
|
+
- [ ] HTML 파일명이 2자리 순번과 목적을 포함하는가? (예: `01_main_flow_preview.html`)
|
|
91
|
+
- [ ] `00_SCREEN_FLOW.md`, `01_UI_DESIGN.md`, 관련 `XX_PROTOTYPE_REVIEW.md` 중 하나 이상이 HTML Preview를 상대 경로로 링크하는가?
|
|
92
|
+
- [ ] UI 문서나 백로그에 HTML Preview 사용자 확인 및 피드백 기록이 있는가?
|
|
93
|
+
|
|
94
|
+
HTML Preview가 없거나 링크·사용자 확인 기록이 누락되면 HTML UI Preview Gate는 Fail로 처리한다.
|
|
95
|
+
|
|
96
|
+
### Step 6: UI-First Gate 검사
|
|
80
97
|
|
|
81
98
|
`docs/02_UI_Screens/`와 `docs/04_Logic_Progress/00_BACKLOG.md`를 함께 확인한다.
|
|
82
99
|
|
|
83
100
|
체크 항목:
|
|
101
|
+
- [ ] HTML UI Preview Gate를 통과했는가?
|
|
84
102
|
- [ ] `00_SCREEN_FLOW.md`에 주요 화면, 진입·전환·이탈 동선이 있는가?
|
|
85
103
|
- [ ] `00_SCREEN_FLOW.md` 또는 관련 UI 문서에 화면별 입력·출력 데이터가 있는가?
|
|
86
104
|
- [ ] `01_UI_DESIGN.md` 또는 `XX_PROTOTYPE_REVIEW.md`에 로딩·빈 상태·오류 상태가 있는가?
|
|
@@ -89,7 +107,7 @@ AGENTS.md 또는 `docs/01_Concept_Design/00_COLLABORATION_GUIDE.md`를 읽어
|
|
|
89
107
|
|
|
90
108
|
구현 판단에 필요한 화면·동선·데이터 흐름이 누락되면 UI-First Gate는 Fail로 처리한다.
|
|
91
109
|
|
|
92
|
-
### Step
|
|
110
|
+
### Step 7: Pre-Code Technical Brief 검사
|
|
93
111
|
|
|
94
112
|
`docs/03_Technical_Specs/`와 `docs/04_Logic_Progress/00_BACKLOG.md`를 함께 확인한다.
|
|
95
113
|
|
|
@@ -101,7 +119,7 @@ AGENTS.md 또는 `docs/01_Concept_Design/00_COLLABORATION_GUIDE.md`를 읽어
|
|
|
101
119
|
|
|
102
120
|
데이터·API·상태 계약이 없어 구현자가 임의 구조를 만들 수밖에 없으면 Pre-Code Technical Brief는 Fail로 처리한다.
|
|
103
121
|
|
|
104
|
-
### Step
|
|
122
|
+
### Step 8: Rubric-First Writing 검사
|
|
105
123
|
|
|
106
124
|
| 레이어 | 기준 |
|
|
107
125
|
|:---|:---|
|
|
@@ -111,7 +129,7 @@ AGENTS.md 또는 `docs/01_Concept_Design/00_COLLABORATION_GUIDE.md`를 읽어
|
|
|
111
129
|
| Technical_Specs (Layer 3) | Functionality, UX (latency), Open-source 언급 (권장) |
|
|
112
130
|
| Logic_Progress (Layer 4) | Functionality, UX 언급 (권장) |
|
|
113
131
|
|
|
114
|
-
### Step
|
|
132
|
+
### Step 9: Gate Out 조건 검사
|
|
115
133
|
|
|
116
134
|
rules-product 기준으로 각 Phase의 필수 문서 존재 여부를 확인한다.
|
|
117
135
|
|
|
@@ -123,6 +141,8 @@ rules-product 기준으로 각 Phase의 필수 문서 존재 여부를 확인한
|
|
|
123
141
|
**Phase 2 (UI 설계)**:
|
|
124
142
|
- [ ] `docs/02_UI_Screens/00_SCREEN_FLOW.md`
|
|
125
143
|
- [ ] `docs/02_UI_Screens/01_UI_DESIGN.md`
|
|
144
|
+
- [ ] `docs/02_UI_Screens/previews/` 내 관련 HTML Preview
|
|
145
|
+
- [ ] UI 문서에서 HTML Preview 상대 경로 링크
|
|
126
146
|
- [ ] 화면·동선·데이터 흐름·상태별 UI 확인 기록
|
|
127
147
|
- [ ] Pre-Code Technical Brief 기록
|
|
128
148
|
|
|
@@ -131,7 +151,7 @@ rules-product 기준으로 각 Phase의 필수 문서 존재 여부를 확인한
|
|
|
131
151
|
- [ ] `docs/04_Logic_Progress/00_ROADMAP.md`
|
|
132
152
|
- [ ] `docs/05_QA_Validation/02_QA_CHECKLIST.md`
|
|
133
153
|
|
|
134
|
-
### Step
|
|
154
|
+
### Step 10: 검증 보고서 출력
|
|
135
155
|
|
|
136
156
|
검사 완료 후 아래 형식으로 결과를 출력한다:
|
|
137
157
|
|
|
@@ -145,6 +165,7 @@ rules-product 기준으로 각 Phase의 필수 문서 존재 여부를 확인한
|
|
|
145
165
|
| 메타데이터 | Pass / Fail | 누락 파일 목록 |
|
|
146
166
|
| Related Documents | Pass / Fail | 미연결 파일 목록 |
|
|
147
167
|
| Backlog Context Lock | Pass / Fail | 필수 필드 누락 작업 목록 |
|
|
168
|
+
| HTML UI Preview Gate | Pass / Fail | HTML Preview 파일·링크·확인 기록 누락 목록 |
|
|
148
169
|
| UI-First Gate | Pass / Fail | 화면·동선·데이터 흐름 누락 목록 |
|
|
149
170
|
| Pre-Code Technical Brief | Pass / Fail | 데이터·API·상태 계약 누락 목록 |
|
|
150
171
|
| Rubric-First | Pass / Fail | |
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
interface:
|
|
2
2
|
display_name: "Docs Verification"
|
|
3
|
-
short_description: "Audit
|
|
4
|
-
default_prompt: "Use $verify-docs to audit
|
|
3
|
+
short_description: "Audit docs, metadata, and HTML previews"
|
|
4
|
+
default_prompt: "Use $verify-docs to audit five-layer docs, metadata, links, and HTML UI previews."
|
package/verify-ui/SKILL.md
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: verify-ui
|
|
3
|
-
description: UI 구현이 docs/02_UI_Screens의 화면 설계, 사용자 동선, 데이터 흐름, 로딩·빈 상태·오류 상태와 일치하는지 검증합니다. React/TSX 화면 구현 후, UI-First Gate 확인 후, 또는 "UI 검증", "UX 확인", "화면이 문서와 맞는지 봐줘" 요청 시 사용합니다.
|
|
3
|
+
description: UI 구현이 docs/02_UI_Screens의 화면 설계, HTML UI Preview, 사용자 동선, 데이터 흐름, 로딩·빈 상태·오류 상태와 일치하는지 검증합니다. React/TSX 화면 구현 후, UI-First Gate 확인 후, 또는 "UI 검증", "UX 확인", "화면이 문서와 맞는지 봐줘" 요청 시 사용합니다.
|
|
4
4
|
argument-hint: "[선택사항: 점검할 화면, 라우트, 컴포넌트 경로]"
|
|
5
5
|
---
|
|
6
6
|
|
|
7
7
|
# UI 구현 검증 스킬 (verify-ui)
|
|
8
8
|
|
|
9
|
-
구현된 화면이 UI-First Gate에서 합의한 화면 구조, 사용자 동선, 데이터 흐름, 상태별 UI를 실제로 반영하는지 검증한다.
|
|
9
|
+
구현된 화면이 HTML UI Preview와 UI-First Gate에서 합의한 화면 구조, 사용자 동선, 데이터 흐름, 상태별 UI를 실제로 반영하는지 검증한다.
|
|
10
10
|
|
|
11
11
|
---
|
|
12
12
|
|
|
@@ -14,6 +14,7 @@ argument-hint: "[선택사항: 점검할 화면, 라우트, 컴포넌트 경로]
|
|
|
14
14
|
|
|
15
15
|
- React/TSX 화면 또는 컴포넌트 구현 후
|
|
16
16
|
- `rules-workflow` Step 15 사용자 사용 흐름 확인 시
|
|
17
|
+
- HTML UI Preview와 실제 구현 결과의 일치 여부를 확인할 때
|
|
17
18
|
- `docs/02_UI_Screens/` 문서와 구현 결과의 일치 여부를 확인할 때
|
|
18
19
|
- PR 전 UI/UX 회귀 점검 시
|
|
19
20
|
|
|
@@ -26,10 +27,24 @@ argument-hint: "[선택사항: 점검할 화면, 라우트, 컴포넌트 경로]
|
|
|
26
27
|
```bash
|
|
27
28
|
git diff --name-only HEAD
|
|
28
29
|
find docs/02_UI_Screens -maxdepth 1 -type f -name '*.md' 2>/dev/null
|
|
30
|
+
find docs/02_UI_Screens/previews -maxdepth 1 -type f -name '*.html' 2>/dev/null
|
|
29
31
|
find . -path '*/src/*' \( -name '*.tsx' -o -name '*.jsx' \) 2>/dev/null
|
|
30
32
|
```
|
|
31
33
|
|
|
32
|
-
검증 전 `docs/02_UI_Screens/00_SCREEN_FLOW.md`, `01_UI_DESIGN.md`, 관련 `XX_PROTOTYPE_REVIEW.md`, 백로그 항목의 `Related UI Docs`를 읽는다.
|
|
34
|
+
검증 전 `docs/02_UI_Screens/00_SCREEN_FLOW.md`, `01_UI_DESIGN.md`, 관련 `XX_PROTOTYPE_REVIEW.md`, `docs/02_UI_Screens/previews/*.html`, 백로그 항목의 `Related UI Docs`와 `Related HTML Preview`를 읽는다.
|
|
35
|
+
|
|
36
|
+
---
|
|
37
|
+
|
|
38
|
+
## Check 0: HTML UI Preview 기준 확인
|
|
39
|
+
|
|
40
|
+
- 주요 화면 또는 사용자 흐름에 대응되는 HTML Preview가 있는지 확인한다.
|
|
41
|
+
- UI 문서와 백로그가 HTML Preview를 상대 경로로 링크하는지 확인한다.
|
|
42
|
+
- 구현 결과가 HTML Preview와 의도 없이 크게 달라졌다면 문서 또는 구현 중 어느 쪽이 최신 기준인지 확인한다.
|
|
43
|
+
- 체크:
|
|
44
|
+
- [ ] 관련 HTML Preview가 존재하는가?
|
|
45
|
+
- [ ] HTML Preview가 UI 문서 또는 백로그에 링크되어 있는가?
|
|
46
|
+
- [ ] 사용자 피드백과 보완 사항이 문서 또는 백로그에 반영되어 있는가?
|
|
47
|
+
- [ ] 구현이 HTML Preview의 정보 위계, CTA, 주요 레이아웃을 유지하는가?
|
|
33
48
|
|
|
34
49
|
---
|
|
35
50
|
|
|
@@ -105,6 +120,7 @@ find . -path '*/src/*' \( -name '*.tsx' -o -name '*.jsx' \) 2>/dev/null
|
|
|
105
120
|
|
|
106
121
|
### 문서 동기화 필요
|
|
107
122
|
- 구현이 문서와 다르면 수정할 문서 또는 코드 위치를 명시한다.
|
|
123
|
+
- HTML Preview와 구현이 다르면 최신 기준이 무엇인지 명시하고 문서 또는 코드 수정 대상을 적는다.
|
|
108
124
|
```
|
|
109
125
|
|
|
110
126
|
심각도 기준: **높음** (핵심 동선 차단) / **중** (사용성 또는 문서 불일치) / **낮음** (개선 권장)
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
interface:
|
|
2
2
|
display_name: "UI Verification"
|
|
3
|
-
short_description: "Check UI
|
|
4
|
-
default_prompt: "Use $verify-ui to compare implemented screens with UI docs,
|
|
3
|
+
short_description: "Check UI against docs and HTML previews"
|
|
4
|
+
default_prompt: "Use $verify-ui to compare implemented screens with UI docs, HTML previews, flows, and states."
|