solmate-skills 2.0.10 → 2.0.12
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 +12 -4
- package/CLAUDE.md +1 -1
- package/README.md +61 -274
- package/USAGE.md +787 -0
- package/bin/cli.js +27 -2
- package/docs-dev/SKILL.md +22 -5
- package/manage-skills/SKILL.md +1 -1
- package/package.json +1 -1
- package/rules-product/SKILL.md +46 -6
- package/rules-react/SKILL.md +9 -6
- package/rules-workflow/SKILL.md +15 -6
- package/tools-shadcn/README.md +7 -4
- package/tools-shadcn/SKILL.md +27 -1
- package/tools-shadcn/resources/setup-guide.md +12 -4
- package/tools-shadcn/scripts/verify-setup.sh +2 -1
- package/verify-code/SKILL.md +5 -6
- package/verify-docs/SKILL.md +24 -6
- package/verify-implementation/SKILL.md +9 -2
- package/verify-skills/SKILL.md +7 -1
package/AGENTS.md
CHANGED
|
@@ -73,8 +73,14 @@
|
|
|
73
73
|
- **사용자 커뮤니케이션 필수**: 구현 전 HTML Preview를 사용자에게 보여주고 피드백을 받아야 하며, 확인 결과와 보완 사항을 UI 문서 또는 `docs/04_Logic_Progress/00_BACKLOG.md`에 기록한다.
|
|
74
74
|
- **구현 차단 조건**: HTML Preview가 없거나 문서에 링크되지 않았거나 사용자의 화면 확인 기록이 없으면 UI-First Gate를 통과할 수 없고, 구현을 시작할 수 없다.
|
|
75
75
|
|
|
76
|
+
### 2.9. Component & Library Planning Gate (필수)
|
|
77
|
+
- **컴포넌트·라이브러리 계획 필수화**: React 구현 전 사용할 shadcn/ui 컴포넌트, 직접 만들 커스텀 컴포넌트, 재사용할 기존 컴포넌트, 새로 설치할 라이브러리, 설치하지 않을 라이브러리를 정리한다.
|
|
78
|
+
- **shadcn 적용 방식 기록**: 신규 Next.js 모노레포는 `init --preset`, 기존 프로젝트는 `apply --preset` 또는 `apply --only theme` 적용 여부를 기록한다. 해당 없으면 `N/A - 사유`를 적는다.
|
|
79
|
+
- **저장 위치**: Component & Library Plan은 `docs/03_Technical_Specs/` 문서, `docs/04_Logic_Progress/00_BACKLOG.md`, 또는 Pre-Code Technical Brief에 기록한다.
|
|
80
|
+
- **구현 차단 조건**: Component & Library Plan이 없으면 React 컴포넌트 구현을 시작할 수 없다.
|
|
81
|
+
|
|
76
82
|
## 3. 개발 표준 및 품질
|
|
77
|
-
- **UI 중심 개발 전략 (UI-First)**: Concept_Design -> UI_Screens ->
|
|
83
|
+
- **UI 중심 개발 전략 (UI-First)**: Concept_Design -> UI_Screens -> HTML Preview -> Pre-Code Technical Brief -> Component & Library Plan -> React 구현 -> Technical_Specs/Logic_Progress 순서를 따른다.
|
|
78
84
|
- **git commit 필수**: 중요 작업 전 반드시 git commit을 수행한다.
|
|
79
85
|
- **커밋 메시지 형식**: `type(scope): subject` 포맷을 따른다.
|
|
80
86
|
- **Type**: `feat`(기능), `fix`(버그), `docs`(문서), `style`(포맷), `refactor`(리팩토링), `test`(테스트), `chore`(기타)
|
|
@@ -110,7 +116,7 @@ AI 에이전트는 본 프로젝트에 설치된 다음 **26개 스킬**을 활
|
|
|
110
116
|
| | `docs-pitch` | 피치덱 작성 (Markdown / Reveal.js HTML) |
|
|
111
117
|
| | `docs-business` | 사업계획서 작성 (정부 지원, 투자 심사, 파트너십 목적별 구성) |
|
|
112
118
|
| **품질 검증 (QA)** | `verify-implementation` | 모든 `verify-*` 스킬의 통합 순차 실행 및 YAGNI/KISS/DRY Gate 보고 |
|
|
113
|
-
| | `verify-docs` | 문서 레이어 정합성 및 네이밍/메타데이터, UI-First Gate 검증 |
|
|
119
|
+
| | `verify-docs` | 문서 레이어 정합성 및 네이밍/메타데이터, UI-First Gate, Component & Library Planning Gate 검증 |
|
|
114
120
|
| | `verify-ui` | 구현 UI와 화면 문서·HTML Preview·사용자 동선·상태별 UI 정합성 검증 |
|
|
115
121
|
| | `verify-code` | PR 전 코드 품질 종합 리뷰 (로직, 타입, 중복, 과잉 구현, 사이드 이펙트) |
|
|
116
122
|
| | `verify-security` | OWASP Top 10 기준 보안 취약점 점검 (인증, 인젝션, 시크릿 노출 등) |
|
|
@@ -119,8 +125,8 @@ AI 에이전트는 본 프로젝트에 설치된 다음 **26개 스킬**을 활
|
|
|
119
125
|
| | `verify-skills` | 스킬 패키지 메타데이터·CLI·README/AGENTS·패키징 검증 |
|
|
120
126
|
| **개발 및 설계** | `rules-dev` | 코딩 표준, 프로젝트 컨벤션, YAGNI/KISS/DRY Gate 준수 여부 확인 |
|
|
121
127
|
| | `rules-react` | UI 컴포넌트 설계 및 구현 표준 가이드 |
|
|
122
|
-
| | `rules-product` | 기획→UI
|
|
123
|
-
| **특수 도구(Tools)** | `tools-shadcn` | shadcn/ui
|
|
128
|
+
| | `rules-product` | 기획→UI→컴포넌트·라이브러리 계획→React→개발문서 전체 파이프라인 오케스트레이션 |
|
|
129
|
+
| **특수 도구(Tools)** | `tools-shadcn` | shadcn/ui 컴포넌트·프리셋·라이브러리 활용 및 커스텀 가이드 |
|
|
124
130
|
| | `tools-obsidian` | 지식 베이스(Obsidian)와의 동기화 및 관리 |
|
|
125
131
|
| **외부 확장(External)** | `ext-awesome-design` | 프리미엄 디자인 시스템 및 마크다운 템플릿 라이브러리 |
|
|
126
132
|
| | `ext-k-skill` | 한국 특화 전문 스킬 모음 (법률, 배송, 교통 등) |
|
|
@@ -154,3 +160,5 @@ AI 에이전트는 사용자가 스킬을 호출하지 않아도, 아래 상황
|
|
|
154
160
|
|
|
155
161
|
## 6. 최종 약속
|
|
156
162
|
AI 에이전트는 본 **AGENTS.md**를 모든 판단의 최우선 근거로 삼는다. 문서에 정의되지 않은 작업을 수행할 경우 반드시 사용자에게 구현 전 문서 업데이트 필요성을 먼저 확인한다.
|
|
163
|
+
|
|
164
|
+
**사람용 스킬 사용법** (상황별 선택, 26개 카탈로그, Gate 상세): 프로젝트 루트 `USAGE.md` — 영문 기본, 하단 한국어 (`npx solmate-skills install` 시 복사).
|
package/CLAUDE.md
CHANGED
|
@@ -23,7 +23,7 @@ There are no build, test, or lint scripts in this repo (`"test": "echo \"Error:
|
|
|
23
23
|
|
|
24
24
|
## Installing Skills via Symlink (Dev)
|
|
25
25
|
|
|
26
|
-
`init-skills.sh` creates symlinks from a target project's `.agent/skills/` to this repo, and links `AGENTS.md` to the project root. Run it from inside the target project:
|
|
26
|
+
`init-skills.sh` creates symlinks from a target project's `.agent/skills/` to this repo, and links `AGENTS.md` and `USAGE.md` to the project root. Run it from inside the target project:
|
|
27
27
|
|
|
28
28
|
```bash
|
|
29
29
|
bash /Users/namhyeongseog/Documents/solmate-skills/init-skills.sh
|
package/README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Reusable AI-agent skills for disciplined product work.
|
|
4
4
|
|
|
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 YAGNI/KISS/DRY approval gates, and verify the result before release.
|
|
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, plan components and libraries before coding, implement with YAGNI/KISS/DRY 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
|
|
|
@@ -24,7 +24,9 @@ npx solmate-skills@latest install rules-product
|
|
|
24
24
|
npx solmate-skills@latest install hooks
|
|
25
25
|
```
|
|
26
26
|
|
|
27
|
-
The installer copies each selected skill folder into `.agent/skills/<skill-name>` in your current project.
|
|
27
|
+
The installer copies each selected skill folder into `.agent/skills/<skill-name>` in your current project and copies [USAGE.md](./USAGE.md) to the project root.
|
|
28
|
+
|
|
29
|
+
**Detailed usage:** see `USAGE.md` at the project root (English default, Korean below) for the situation-to-skill cheat sheet, orchestrator map, full skill catalog (26 skills), gate details, and recommended prompts.
|
|
28
30
|
|
|
29
31
|
## What You Get
|
|
30
32
|
|
|
@@ -32,10 +34,30 @@ The installer copies each selected skill folder into `.agent/skills/<skill-name>
|
|
|
32
34
|
- **UI-first planning**: `/docs-plan` creates concept and screen documents before implementation starts.
|
|
33
35
|
- **HTML UI Preview Gate**: major screens and flows must have browser-viewable HTML previews under `docs/02_UI_Screens/previews/`.
|
|
34
36
|
- **Backlog Context Lock**: every backlog item must link the Concept, UI, HTML Preview, Technical Spec, and QA documents needed for implementation.
|
|
37
|
+
- **Component & Library Planning Gate**: React work must name the shadcn/ui components, custom components, reused components, libraries to add, libraries to avoid, and preset action before coding.
|
|
35
38
|
- **YAGNI/KISS/DRY Gate**: `rules-dev` is the canonical source for avoiding future-only features, preferring the simplest existing/native path, and removing only true duplicate knowledge.
|
|
36
39
|
- **Implementation workflow**: `/rules-workflow` keeps coding work tied to approved documents, preconditions, and acceptance criteria.
|
|
37
40
|
- **Release verification**: `/verify-implementation` runs the verification family for docs, UI, code, security, performance, DB schema, and skill package readiness.
|
|
38
41
|
|
|
42
|
+
## What's New in 2.0.12
|
|
43
|
+
|
|
44
|
+
`solmate-skills@2.0.12` adds a bilingual usage guide and copies it into every target project on install.
|
|
45
|
+
|
|
46
|
+
- [USAGE.md](./USAGE.md) documents all 26 skills in English (default) with Korean below: cheat sheet, orchestrator map, gates, and prompts.
|
|
47
|
+
- `npx solmate-skills install` (single skill, `all`, or `hooks`) now copies `USAGE.md` to the project root.
|
|
48
|
+
- [README.md](./README.md) is trimmed to a 5-minute start; detailed usage lives in `USAGE.md`.
|
|
49
|
+
- `init-skills.sh` symlinks `USAGE.md` alongside `AGENTS.md` for local development.
|
|
50
|
+
|
|
51
|
+
## What's New in 2.0.11
|
|
52
|
+
|
|
53
|
+
`solmate-skills@2.0.11` adds a Component & Library Planning Gate so React implementation starts from approved UI context and an explicit component/library plan.
|
|
54
|
+
|
|
55
|
+
- `/rules-product` and `/rules-workflow` now connect concept docs, HTML UI preview, component planning, and implementation in a clearer sequence.
|
|
56
|
+
- `/rules-react` requires agents to name shadcn/ui components, custom components, reused components, libraries to add, libraries to avoid, and preset action before coding.
|
|
57
|
+
- `/tools-shadcn` documents the default new-project preset command and existing-project apply command.
|
|
58
|
+
- `/verify-docs` and `/verify-implementation` now check that UI docs, backlog references, and implementation plans preserve the UI-first flow.
|
|
59
|
+
- `README.md` and `AGENTS.md` surface the planning gate as part of the recommended Solmate workflow.
|
|
60
|
+
|
|
39
61
|
## What's New in 2.0.10
|
|
40
62
|
|
|
41
63
|
`solmate-skills@2.0.10` fixes Claude Code hook false positives so read-only tool use no longer triggers edit-oriented skill suggestions.
|
|
@@ -70,24 +92,33 @@ Recent workflow guardrails:
|
|
|
70
92
|
|
|
71
93
|
## Quick Start
|
|
72
94
|
|
|
73
|
-
|
|
95
|
+
Install skills, then invoke one command based on your situation.
|
|
74
96
|
|
|
75
|
-
|
|
|
97
|
+
| Situation | Start with | Notes |
|
|
76
98
|
|:---|:---|:---|
|
|
77
|
-
|
|
|
78
|
-
|
|
|
79
|
-
|
|
|
80
|
-
| PR 전 최종 점검 | `/verify-implementation` | 모든 `verify-*` 스킬을 순차 실행하여 통합 보고 |
|
|
99
|
+
| New project or "where do I start?" | `/rules-product` | Diagnoses phase and delegates to the right skill |
|
|
100
|
+
| Implement one feature | `/rules-product` then `/rules-workflow` | Gates must pass before coding |
|
|
101
|
+
| Pre-PR / pre-release check | `/verify-implementation` | Runs the verify-* family in order |
|
|
81
102
|
|
|
82
|
-
|
|
103
|
+
**Recommended first line:**
|
|
83
104
|
|
|
84
|
-
```
|
|
105
|
+
```text
|
|
85
106
|
/rules-product
|
|
86
107
|
```
|
|
87
108
|
|
|
88
|
-
|
|
109
|
+
### Orchestrator map
|
|
110
|
+
|
|
111
|
+
```text
|
|
112
|
+
rules-product → diagnose phase, check gates, delegate
|
|
113
|
+
rules-workflow → plan → implement → verify → PR (18 steps)
|
|
114
|
+
verify-implementation → run verify-* skills and report
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
Full pipeline, gates, backlog template, and all 26 skill entries: **[USAGE.md](./USAGE.md)**
|
|
118
|
+
|
|
119
|
+
### Flow Status Block
|
|
89
120
|
|
|
90
|
-
`rules-product` and `rules-workflow`
|
|
121
|
+
`rules-product` and `rules-workflow` report progress in this format:
|
|
91
122
|
|
|
92
123
|
```text
|
|
93
124
|
[Flow]
|
|
@@ -99,288 +130,44 @@ Gate: UI-First Gate 진행 중
|
|
|
99
130
|
권장 스킬: /docs-plan
|
|
100
131
|
```
|
|
101
132
|
|
|
102
|
-
###
|
|
133
|
+
### Existing projects
|
|
103
134
|
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
**Update or reinstall skills from the project root:**
|
|
135
|
+
Reinstall from the project root, then diagnose — do not restart from Phase 1 by default.
|
|
107
136
|
|
|
108
137
|
```bash
|
|
109
138
|
npx solmate-skills@latest install all
|
|
110
139
|
npx solmate-skills@latest install hooks
|
|
111
140
|
```
|
|
112
141
|
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
```text
|
|
116
|
-
/rules-product를 사용해서 이 프로젝트의 현재 진행 상태를 진단하고, 다음 작업을 Flow Status Block 기준으로 안내해줘.
|
|
117
|
-
```
|
|
118
|
-
|
|
119
|
-
**When starting implementation work:**
|
|
120
|
-
|
|
121
|
-
```text
|
|
122
|
-
/rules-workflow를 사용해서 현재 기능 작업을 진행해줘. 먼저 Flow Status Block으로 현재 위치를 알려주고, UI-First 흐름에 맞춰 진행해줘.
|
|
123
|
-
```
|
|
124
|
-
|
|
125
|
-
**When verifying finished work:**
|
|
126
|
-
|
|
127
|
-
```text
|
|
128
|
-
/verify-implementation으로 현재 변경사항을 전체 검증해줘. Flow Status Block을 포함해서 보고해줘.
|
|
129
|
-
```
|
|
130
|
-
|
|
131
|
-
진행 중인 프로젝트에서는 Phase 1부터 강제로 다시 시작하지 않습니다. `/rules-product`가 기존 문서, 코드, 백로그, 변경사항을 보고 현재 위치를 진단한 뒤, 이어서 진행할 Phase와 필요한 Gate를 제안해야 합니다.
|
|
142
|
+
Example prompts: [USAGE.md §9 Recommended Prompts](./USAGE.md#9-recommended-prompts) (EN) · [§9 권장 프롬프트](./USAGE.md#9-권장-프롬프트-모음) (KO)
|
|
132
143
|
|
|
133
144
|
---
|
|
134
145
|
|
|
135
|
-
##
|
|
136
|
-
|
|
137
|
-
Skills are organized into five categories.
|
|
146
|
+
## Skills at a Glance
|
|
138
147
|
|
|
139
|
-
|
|
148
|
+
26 installable skills plus `hooks`. Category summary:
|
|
140
149
|
|
|
141
|
-
|
|
|
150
|
+
| Category | Skills |
|
|
142
151
|
|:---|:---|
|
|
143
|
-
| `
|
|
144
|
-
|
|
|
152
|
+
| Orchestration | `rules-product`, `rules-workflow` |
|
|
153
|
+
| Rules | `rules-docs`, `rules-dev`, `rules-react`, `manage-collaboration`, `manage-decisions`, `manage-skills` |
|
|
154
|
+
| Documentation | `docs-plan`, `docs-dev`, `docs-pitch`, `docs-business` |
|
|
155
|
+
| Verification | `verify-implementation`, `verify-docs`, `verify-ui`, `verify-code`, `verify-security`, `verify-performance`, `verify-drizzle-schema`, `verify-skills` |
|
|
156
|
+
| Roles | `role-team-lead`, `role-team-member` |
|
|
157
|
+
| Tools | `tools-shadcn`, `tools-obsidian` |
|
|
158
|
+
| External | `ext-awesome-design`, `ext-k-skill` |
|
|
145
159
|
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
| Skill | Description |
|
|
149
|
-
|:---|:---|
|
|
150
|
-
| `rules-docs` | Master documentation rules and 365 Principle governance. |
|
|
151
|
-
| `rules-dev` | Enforce development setup, coding conventions, and quality rules. |
|
|
152
|
-
| `rules-react` | Create modular, premium React components and pages. |
|
|
153
|
-
| `rules-workflow` | Full 18-step implementation and execution lifecycle. |
|
|
154
|
-
| `rules-product` | Orchestrate the full product development pipeline. |
|
|
155
|
-
| `manage-collaboration` | Enforce AI-Human collaboration standards. |
|
|
156
|
-
| `manage-decisions` | Question-driven decision making for tech, DB, API, UX, and architecture choices. |
|
|
157
|
-
| `manage-skills` | Detect and fix drift between verify skills and changed code. |
|
|
158
|
-
|
|
159
|
-
### Documentation
|
|
160
|
-
|
|
161
|
-
| Skill | Description |
|
|
162
|
-
|:---|:---|
|
|
163
|
-
| `docs-plan` | Create and manage **planning documents** (Layer 1-2: vision, UI screens). |
|
|
164
|
-
| `docs-dev` | Create and manage **development documents** (Layer 3-5: specs, logic, QA). |
|
|
165
|
-
| `docs-pitch` | Create pitch decks for investors, hackathons, and demo days. |
|
|
166
|
-
| `docs-business` | Generate professional business plans for funding or partnerships. |
|
|
167
|
-
| `verify-docs` | Audit documentation structure and metadata standards. |
|
|
168
|
-
|
|
169
|
-
### Special Tools
|
|
170
|
-
|
|
171
|
-
| Skill | Description |
|
|
172
|
-
|:---|:---|
|
|
173
|
-
| `tools-shadcn` | Expert guidance for shadcn/ui components. |
|
|
174
|
-
| `tools-obsidian` | Sync documentation with an Obsidian vault. |
|
|
175
|
-
|
|
176
|
-
### External Extensions
|
|
177
|
-
|
|
178
|
-
| Skill | Description |
|
|
179
|
-
|:---|:---|
|
|
180
|
-
| `ext-awesome-design` | Premium design system and markdown templates. |
|
|
181
|
-
| `ext-k-skill` | Collection of specialized Korean tools and services. |
|
|
182
|
-
|
|
183
|
-
### Quality & Automation
|
|
184
|
-
|
|
185
|
-
| Skill | Description |
|
|
186
|
-
|:---|:---|
|
|
187
|
-
| `verify-implementation` | Dynamically discover and run all `verify-*` skills. |
|
|
188
|
-
| `verify-drizzle-schema` | Verify Drizzle ORM schema matches architecture specs. |
|
|
189
|
-
| `verify-security` | Check for security vulnerabilities based on OWASP Top 10. |
|
|
190
|
-
| `verify-performance` | Lighthouse & Core Web Vitals check. |
|
|
191
|
-
| `verify-code` | Comprehensive pre-PR code quality review. |
|
|
192
|
-
| `verify-ui` | Verify implemented UI against screen docs, HTML previews, and user flows. |
|
|
193
|
-
| `verify-skills` | Verify skill package metadata, CLI output, and release readiness. |
|
|
160
|
+
**Situation cheat sheet, per-skill when/prerequisites/outputs/next:** [USAGE.md](./USAGE.md)
|
|
194
161
|
|
|
195
162
|
---
|
|
196
163
|
|
|
197
|
-
##
|
|
198
|
-
|
|
199
|
-
### Documentation System
|
|
200
|
-
|
|
201
|
-
The documentation system follows the **365 Principle** (3 Investor Lenses, 6 Rubrics, 5 Documentation Layers) and is split across two skills based on the type of document.
|
|
202
|
-
|
|
203
|
-
**Which skill to use:**
|
|
204
|
-
|
|
205
|
-
```
|
|
206
|
-
Product vision, Lean Canvas, UI design → docs-plan
|
|
207
|
-
DB schema, API specs, roadmap, QA → docs-dev
|
|
208
|
-
Unsure which layer? → rules-docs
|
|
209
|
-
```
|
|
210
|
-
|
|
211
|
-
**5-Layer structure:**
|
|
212
|
-
|
|
213
|
-
```
|
|
214
|
-
docs/
|
|
215
|
-
├── 01_Concept_Design/ ← docs-plan
|
|
216
|
-
├── 02_UI_Screens/ ← docs-plan
|
|
217
|
-
├── 03_Technical_Specs/ ← docs-dev
|
|
218
|
-
├── 04_Logic_Progress/ ← docs-dev
|
|
219
|
-
└── 05_QA_Validation/ ← docs-dev
|
|
220
|
-
```
|
|
221
|
-
|
|
222
|
-
**Typical workflow:**
|
|
223
|
-
|
|
224
|
-
```
|
|
225
|
-
1. /docs-plan → Write VISION_CORE.md, LEAN_CANVAS.md, PRODUCT_SPECS.md
|
|
226
|
-
2. /docs-plan → Write SCREEN_FLOW.md, UI_DESIGN.md, and HTML UI previews
|
|
227
|
-
3. HTML UI Preview Gate → Show browser-viewable HTML screens and capture user feedback
|
|
228
|
-
4. UI-First Gate → Confirm screens, user paths, data flow, and UI states before coding
|
|
229
|
-
5. Pre-Code Technical Brief → Confirm data sources, API shape, state strategy, and acceptance criteria
|
|
230
|
-
6. /docs-dev → Write DEVELOPMENT_PRINCIPLES.md, DB_SCHEMA.md, API_SPECS.md
|
|
231
|
-
7. /docs-dev → Write ROADMAP.md, BACKLOG.md with mandatory related document links
|
|
232
|
-
8. /rules-workflow → Implement each backlog item only after reading linked docs and passing UI-First Gate
|
|
233
|
-
9. /verify-implementation → Audit docs, UI, code, security, performance, DB, and skill package changes
|
|
234
|
-
```
|
|
235
|
-
|
|
236
|
-
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.
|
|
164
|
+
## Hooks (optional)
|
|
237
165
|
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
Backlog Context Lock makes `docs/04_Logic_Progress/00_BACKLOG.md` act as a bridge between planning documents and implementation. A backlog item is not considered ready for coding until it names the documents that define why the task exists, how the UI should behave, what technical constraints apply, and how the work will be verified.
|
|
241
|
-
|
|
242
|
-
### UI-First Gate
|
|
243
|
-
|
|
244
|
-
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.
|
|
245
|
-
|
|
246
|
-
### HTML UI Preview Gate
|
|
247
|
-
|
|
248
|
-
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:
|
|
249
|
-
|
|
250
|
-
```text
|
|
251
|
-
docs/02_UI_Screens/previews/
|
|
252
|
-
```
|
|
253
|
-
|
|
254
|
-
Recommended naming:
|
|
255
|
-
|
|
256
|
-
```text
|
|
257
|
-
docs/02_UI_Screens/previews/01_main_flow_preview.html
|
|
258
|
-
docs/02_UI_Screens/previews/02_dashboard_preview.html
|
|
259
|
-
```
|
|
260
|
-
|
|
261
|
-
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.
|
|
262
|
-
|
|
263
|
-
Required fields for every backlog item:
|
|
264
|
-
|
|
265
|
-
- `Related Concept Docs`
|
|
266
|
-
- `Related UI Docs`
|
|
267
|
-
- `Related HTML Preview`
|
|
268
|
-
- `Related Technical Docs`
|
|
269
|
-
- `Related QA Docs`
|
|
270
|
-
- `Implementation Preconditions`
|
|
271
|
-
- `Acceptance Criteria`
|
|
272
|
-
- `Document Sync Check`
|
|
273
|
-
|
|
274
|
-
If a related document does not exist, write `N/A - 사유`. Do not leave the field blank. If the missing document is required to make a safe implementation decision, pause implementation and write or update the document first.
|
|
275
|
-
|
|
276
|
-
**Backlog item template:**
|
|
277
|
-
|
|
278
|
-
```markdown
|
|
279
|
-
### [ ] TASK-000: Implement feature name
|
|
280
|
-
|
|
281
|
-
- Status: ToDo
|
|
282
|
-
- Related Concept Docs:
|
|
283
|
-
- [Product Specs](../01_Concept_Design/03_PRODUCT_SPECS.md) - feature purpose and user value
|
|
284
|
-
- Related UI Docs:
|
|
285
|
-
- [Screen Flow](../02_UI_Screens/00_SCREEN_FLOW.md) - target screen and interaction flow
|
|
286
|
-
- Related HTML Preview:
|
|
287
|
-
- [Main Flow Preview](../02_UI_Screens/previews/01_main_flow_preview.html) - browser-viewable UI for user review
|
|
288
|
-
- Related Technical Docs:
|
|
289
|
-
- [API Specs](../03_Technical_Specs/02_API_SPECS.md) - endpoint and data contract
|
|
290
|
-
- Related QA Docs:
|
|
291
|
-
- [QA Checklist](../05_QA_Validation/02_QA_CHECKLIST.md) - acceptance and release criteria
|
|
292
|
-
- Implementation Preconditions:
|
|
293
|
-
- [ ] Read all related documents before coding
|
|
294
|
-
- [ ] Confirm screen/UI before coding
|
|
295
|
-
- [ ] Show the HTML UI preview to the user and capture feedback
|
|
296
|
-
- [ ] Confirm user path and screen-by-screen data flow
|
|
297
|
-
- [ ] Confirm loading, empty, and error states
|
|
298
|
-
- [ ] Confirm implementation scope does not conflict with documented intent
|
|
299
|
-
- Acceptance Criteria:
|
|
300
|
-
- [ ] Feature follows the confirmed screen structure and user path
|
|
301
|
-
- [ ] Feature behavior matches linked Concept/UI/Technical docs
|
|
302
|
-
- [ ] QA criteria are testable and satisfied
|
|
303
|
-
- Document Sync Check:
|
|
304
|
-
- [ ] No mismatch between implementation and linked documents
|
|
305
|
-
- [ ] Update related documents if implementation changes the agreed behavior
|
|
306
|
-
```
|
|
307
|
-
|
|
308
|
-
---
|
|
309
|
-
|
|
310
|
-
### Pitch Deck
|
|
311
|
-
|
|
312
|
-
Create a pitch deck from existing `docs-plan` documents.
|
|
313
|
-
|
|
314
|
-
**Prerequisites:** `docs-plan` Layer 1 documents (VISION_CORE, LEAN_CANVAS, PRODUCT_SPECS) should exist first.
|
|
315
|
-
|
|
316
|
-
**Output modes:**
|
|
317
|
-
|
|
318
|
-
| Mode | When to use | Output |
|
|
319
|
-
|:---|:---|:---|
|
|
320
|
-
| Markdown | Content-first, will export to Notion/Slides | `docs/01_Concept_Design/XX_PITCH_DECK.md` |
|
|
321
|
-
| Reveal.js HTML | Present directly in browser, deploy to GitHub Pages | `pitch/index.html` |
|
|
322
|
-
|
|
323
|
-
**Typical workflow:**
|
|
324
|
-
|
|
325
|
-
```
|
|
326
|
-
1. /docs-plan → Ensure VISION_CORE, LEAN_CANVAS, PRODUCT_SPECS exist
|
|
327
|
-
2. /docs-pitch → Select output mode → Answer Phase 0-2 questions → Generate deck
|
|
328
|
-
```
|
|
329
|
-
|
|
330
|
-
---
|
|
331
|
-
|
|
332
|
-
### Development Workflow
|
|
333
|
-
|
|
334
|
-
**Typical workflow:**
|
|
335
|
-
|
|
336
|
-
```
|
|
337
|
-
1. /rules-dev → Review conventions before writing code
|
|
338
|
-
2. /rules-product → Orchestrate the development pipeline
|
|
339
|
-
3. /verify-implementation → Run all verify-* skills before PR
|
|
340
|
-
4. /manage-collaboration → Check branch naming, PR format, and workflow status
|
|
341
|
-
```
|
|
342
|
-
|
|
343
|
-
---
|
|
344
|
-
|
|
345
|
-
### Governance
|
|
346
|
-
|
|
347
|
-
**Role-based skills** define protocols for team lead and team member roles:
|
|
348
|
-
|
|
349
|
-
```
|
|
350
|
-
/role-team-lead → Branch protection, PR review, DB migration, deployment
|
|
351
|
-
/role-team-member → Branching, commits (Conventional Commits in Korean), PR creation
|
|
352
|
-
```
|
|
353
|
-
|
|
354
|
-
---
|
|
355
|
-
|
|
356
|
-
### Proactive Skill Suggestions (Hooks)
|
|
357
|
-
|
|
358
|
-
Install hook scripts so Claude **automatically suggests** the right skill as you work — without needing to invoke them manually.
|
|
359
|
-
|
|
360
|
-
**Two layers work together:**
|
|
361
|
-
|
|
362
|
-
| Layer | Mechanism | Trigger |
|
|
363
|
-
|:---|:---|:---|
|
|
364
|
-
| Method 1 | AGENTS.md rules | Claude judges context and suggests skills by reasoning |
|
|
365
|
-
| Method 2 | Hook scripts | Keyword/file-pattern matching fires on every prompt or file edit |
|
|
366
|
-
|
|
367
|
-
**Install hooks into your project:**
|
|
166
|
+
For Claude Code, install hooks to get keyword and file-pattern skill suggestions:
|
|
368
167
|
|
|
369
168
|
```bash
|
|
370
|
-
|
|
371
|
-
npx solmate-skills install hooks
|
|
372
|
-
|
|
373
|
-
# 2. Run the installer from your project root
|
|
169
|
+
npx solmate-skills@latest install hooks
|
|
374
170
|
bash .agent/skills/hooks/install.sh
|
|
375
171
|
```
|
|
376
172
|
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
| Script | Event | What it detects |
|
|
380
|
-
|:---|:---|:---|
|
|
381
|
-
| `solmate-suggest.sh` | UserPromptSubmit | Keywords: 결정/설계, 보안, 성능, PR, 코드리뷰, 문서, 기능구현, 피치덱, 새 프로젝트 |
|
|
382
|
-
| `solmate-watch.sh` | PreToolUse | File patterns: `schema.ts`, `.env*`, `SKILL.md`, `page.tsx`, `api/route.ts`, `auth.ts`, `AGENTS.md` |
|
|
383
|
-
|
|
384
|
-
**To review or disable hooks:** open `/hooks` in Claude Code.
|
|
385
|
-
|
|
386
|
-
**To uninstall:** remove `.claude/hooks/` and the `hooks` section from `.claude/settings.json`.
|
|
173
|
+
Details: [USAGE.md §8 Hooks](./USAGE.md#8-hooks-claude-code-suggestions) (EN) · [§8 Hooks 한국어](./USAGE.md#8-hooks-claude-code-자동-제안) (KO)
|