solmate-skills 2.0.11 → 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 +2 -0
- package/CLAUDE.md +1 -1
- package/README.md +49 -286
- package/USAGE.md +787 -0
- package/bin/cli.js +27 -2
- package/package.json +1 -1
- package/rules-product/SKILL.md +7 -0
- package/rules-workflow/SKILL.md +7 -0
- package/verify-implementation/SKILL.md +7 -0
- package/verify-skills/SKILL.md +7 -1
package/AGENTS.md
CHANGED
|
@@ -160,3 +160,5 @@ AI 에이전트는 사용자가 스킬을 호출하지 않아도, 아래 상황
|
|
|
160
160
|
|
|
161
161
|
## 6. 최종 약속
|
|
162
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
|
@@ -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
|
|
|
@@ -37,6 +39,15 @@ The installer copies each selected skill folder into `.agent/skills/<skill-name>
|
|
|
37
39
|
- **Implementation workflow**: `/rules-workflow` keeps coding work tied to approved documents, preconditions, and acceptance criteria.
|
|
38
40
|
- **Release verification**: `/verify-implementation` runs the verification family for docs, UI, code, security, performance, DB schema, and skill package readiness.
|
|
39
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
|
+
|
|
40
51
|
## What's New in 2.0.11
|
|
41
52
|
|
|
42
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.
|
|
@@ -81,24 +92,33 @@ Recent workflow guardrails:
|
|
|
81
92
|
|
|
82
93
|
## Quick Start
|
|
83
94
|
|
|
84
|
-
|
|
95
|
+
Install skills, then invoke one command based on your situation.
|
|
85
96
|
|
|
86
|
-
|
|
|
97
|
+
| Situation | Start with | Notes |
|
|
87
98
|
|:---|:---|:---|
|
|
88
|
-
|
|
|
89
|
-
|
|
|
90
|
-
|
|
|
91
|
-
| 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 |
|
|
92
102
|
|
|
93
|
-
|
|
103
|
+
**Recommended first line:**
|
|
94
104
|
|
|
95
|
-
```
|
|
105
|
+
```text
|
|
96
106
|
/rules-product
|
|
97
107
|
```
|
|
98
108
|
|
|
99
|
-
|
|
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
|
|
100
120
|
|
|
101
|
-
`rules-product` and `rules-workflow`
|
|
121
|
+
`rules-product` and `rules-workflow` report progress in this format:
|
|
102
122
|
|
|
103
123
|
```text
|
|
104
124
|
[Flow]
|
|
@@ -110,301 +130,44 @@ Gate: UI-First Gate 진행 중
|
|
|
110
130
|
권장 스킬: /docs-plan
|
|
111
131
|
```
|
|
112
132
|
|
|
113
|
-
###
|
|
133
|
+
### Existing projects
|
|
114
134
|
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
**Update or reinstall skills from the project root:**
|
|
135
|
+
Reinstall from the project root, then diagnose — do not restart from Phase 1 by default.
|
|
118
136
|
|
|
119
137
|
```bash
|
|
120
138
|
npx solmate-skills@latest install all
|
|
121
139
|
npx solmate-skills@latest install hooks
|
|
122
140
|
```
|
|
123
141
|
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
```text
|
|
127
|
-
/rules-product를 사용해서 이 프로젝트의 현재 진행 상태를 진단하고, 다음 작업을 Flow Status Block 기준으로 안내해줘.
|
|
128
|
-
```
|
|
129
|
-
|
|
130
|
-
**When starting implementation work:**
|
|
131
|
-
|
|
132
|
-
```text
|
|
133
|
-
/rules-workflow를 사용해서 현재 기능 작업을 진행해줘. 먼저 Flow Status Block으로 현재 위치를 알려주고, UI-First 흐름에 맞춰 진행해줘.
|
|
134
|
-
```
|
|
135
|
-
|
|
136
|
-
**When verifying finished work:**
|
|
137
|
-
|
|
138
|
-
```text
|
|
139
|
-
/verify-implementation으로 현재 변경사항을 전체 검증해줘. Flow Status Block을 포함해서 보고해줘.
|
|
140
|
-
```
|
|
141
|
-
|
|
142
|
-
진행 중인 프로젝트에서는 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)
|
|
143
143
|
|
|
144
144
|
---
|
|
145
145
|
|
|
146
|
-
##
|
|
146
|
+
## Skills at a Glance
|
|
147
147
|
|
|
148
|
-
|
|
148
|
+
26 installable skills plus `hooks`. Category summary:
|
|
149
149
|
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
| Skill | Description |
|
|
150
|
+
| Category | Skills |
|
|
153
151
|
|:---|:---|
|
|
154
|
-
| `
|
|
155
|
-
|
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
|
160
|
-
|
|
161
|
-
| `rules-docs` | Master documentation rules and 365 Principle governance. |
|
|
162
|
-
| `rules-dev` | Enforce development setup, coding conventions, and quality rules. |
|
|
163
|
-
| `rules-react` | Create modular, premium React components and pages. |
|
|
164
|
-
| `rules-workflow` | Full 18-step implementation and execution lifecycle. |
|
|
165
|
-
| `rules-product` | Orchestrate the full product development pipeline. |
|
|
166
|
-
| `manage-collaboration` | Enforce AI-Human collaboration standards. |
|
|
167
|
-
| `manage-decisions` | Question-driven decision making for tech, DB, API, UX, and architecture choices. |
|
|
168
|
-
| `manage-skills` | Detect and fix drift between verify skills and changed code. |
|
|
169
|
-
|
|
170
|
-
### Documentation
|
|
171
|
-
|
|
172
|
-
| Skill | Description |
|
|
173
|
-
|:---|:---|
|
|
174
|
-
| `docs-plan` | Create and manage **planning documents** (Layer 1-2: vision, UI screens). |
|
|
175
|
-
| `docs-dev` | Create and manage **development documents** (Layer 3-5: specs, logic, QA). |
|
|
176
|
-
| `docs-pitch` | Create pitch decks for investors, hackathons, and demo days. |
|
|
177
|
-
| `docs-business` | Generate professional business plans for funding or partnerships. |
|
|
178
|
-
| `verify-docs` | Audit documentation structure and metadata standards. |
|
|
179
|
-
|
|
180
|
-
### Special Tools
|
|
181
|
-
|
|
182
|
-
| Skill | Description |
|
|
183
|
-
|:---|:---|
|
|
184
|
-
| `tools-shadcn` | Expert guidance for shadcn/ui components. |
|
|
185
|
-
| `tools-obsidian` | Sync documentation with an Obsidian vault. |
|
|
186
|
-
|
|
187
|
-
### External Extensions
|
|
188
|
-
|
|
189
|
-
| Skill | Description |
|
|
190
|
-
|:---|:---|
|
|
191
|
-
| `ext-awesome-design` | Premium design system and markdown templates. |
|
|
192
|
-
| `ext-k-skill` | Collection of specialized Korean tools and services. |
|
|
193
|
-
|
|
194
|
-
### Quality & Automation
|
|
195
|
-
|
|
196
|
-
| Skill | Description |
|
|
197
|
-
|:---|:---|
|
|
198
|
-
| `verify-implementation` | Dynamically discover and run all `verify-*` skills. |
|
|
199
|
-
| `verify-drizzle-schema` | Verify Drizzle ORM schema matches architecture specs. |
|
|
200
|
-
| `verify-security` | Check for security vulnerabilities based on OWASP Top 10. |
|
|
201
|
-
| `verify-performance` | Lighthouse & Core Web Vitals check. |
|
|
202
|
-
| `verify-code` | Comprehensive pre-PR code quality review. |
|
|
203
|
-
| `verify-ui` | Verify implemented UI against screen docs, HTML previews, and user flows. |
|
|
204
|
-
| `verify-skills` | Verify skill package metadata, CLI output, and release readiness. |
|
|
205
|
-
|
|
206
|
-
---
|
|
207
|
-
|
|
208
|
-
## Usage Guide
|
|
209
|
-
|
|
210
|
-
### Documentation System
|
|
211
|
-
|
|
212
|
-
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.
|
|
213
|
-
|
|
214
|
-
**Which skill to use:**
|
|
215
|
-
|
|
216
|
-
```
|
|
217
|
-
Product vision, Lean Canvas, UI design → docs-plan
|
|
218
|
-
DB schema, API specs, roadmap, QA → docs-dev
|
|
219
|
-
Unsure which layer? → rules-docs
|
|
220
|
-
```
|
|
221
|
-
|
|
222
|
-
**5-Layer structure:**
|
|
223
|
-
|
|
224
|
-
```
|
|
225
|
-
docs/
|
|
226
|
-
├── 01_Concept_Design/ ← docs-plan
|
|
227
|
-
├── 02_UI_Screens/ ← docs-plan
|
|
228
|
-
├── 03_Technical_Specs/ ← docs-dev
|
|
229
|
-
├── 04_Logic_Progress/ ← docs-dev
|
|
230
|
-
└── 05_QA_Validation/ ← docs-dev
|
|
231
|
-
```
|
|
232
|
-
|
|
233
|
-
**Typical workflow:**
|
|
234
|
-
|
|
235
|
-
```
|
|
236
|
-
1. /docs-plan → Write VISION_CORE.md, LEAN_CANVAS.md, PRODUCT_SPECS.md
|
|
237
|
-
2. /docs-plan → Write SCREEN_FLOW.md, UI_DESIGN.md, and HTML UI previews
|
|
238
|
-
3. HTML UI Preview Gate → Show browser-viewable HTML screens and capture user feedback
|
|
239
|
-
4. UI-First Gate → Confirm screens, user paths, data flow, and UI states before coding
|
|
240
|
-
5. Pre-Code Technical Brief → Confirm data sources, API shape, state strategy, and acceptance criteria
|
|
241
|
-
6. Component & Library Planning Gate → Confirm shadcn components, custom components, reused components, and libraries
|
|
242
|
-
7. /docs-dev → Write DEVELOPMENT_PRINCIPLES.md, DB_SCHEMA.md, API_SPECS.md
|
|
243
|
-
8. /docs-dev → Write ROADMAP.md, BACKLOG.md with mandatory related document links
|
|
244
|
-
9. /rules-workflow → Implement each backlog item only after reading linked docs and passing UI-First and Component & Library gates
|
|
245
|
-
10. /verify-implementation → Audit docs, UI, code, security, performance, DB, and skill package changes
|
|
246
|
-
```
|
|
247
|
-
|
|
248
|
-
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.
|
|
249
|
-
|
|
250
|
-
### Backlog Context Lock
|
|
251
|
-
|
|
252
|
-
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.
|
|
253
|
-
|
|
254
|
-
### UI-First Gate
|
|
255
|
-
|
|
256
|
-
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.
|
|
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` |
|
|
257
159
|
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
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:
|
|
261
|
-
|
|
262
|
-
```text
|
|
263
|
-
docs/02_UI_Screens/previews/
|
|
264
|
-
```
|
|
265
|
-
|
|
266
|
-
Recommended naming:
|
|
267
|
-
|
|
268
|
-
```text
|
|
269
|
-
docs/02_UI_Screens/previews/01_main_flow_preview.html
|
|
270
|
-
docs/02_UI_Screens/previews/02_dashboard_preview.html
|
|
271
|
-
```
|
|
272
|
-
|
|
273
|
-
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.
|
|
274
|
-
|
|
275
|
-
### Component & Library Planning Gate
|
|
276
|
-
|
|
277
|
-
React implementation should not begin until the team has listed the UI building blocks and library choices. Record the shadcn/ui components to add, custom components to create, existing components to reuse, libraries to install, libraries intentionally not added, and whether the project needs `init --preset`, `apply --preset`, `apply --only theme`, or `N/A - reason`.
|
|
278
|
-
|
|
279
|
-
Required fields for every backlog item:
|
|
280
|
-
|
|
281
|
-
- `Related Concept Docs`
|
|
282
|
-
- `Related UI Docs`
|
|
283
|
-
- `Related HTML Preview`
|
|
284
|
-
- `Related Technical Docs`
|
|
285
|
-
- `Related QA Docs`
|
|
286
|
-
- `Implementation Preconditions`
|
|
287
|
-
- `Component & Library Plan`
|
|
288
|
-
- `Acceptance Criteria`
|
|
289
|
-
- `Document Sync Check`
|
|
290
|
-
|
|
291
|
-
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.
|
|
292
|
-
|
|
293
|
-
**Backlog item template:**
|
|
294
|
-
|
|
295
|
-
```markdown
|
|
296
|
-
### [ ] TASK-000: Implement feature name
|
|
297
|
-
|
|
298
|
-
- Status: ToDo
|
|
299
|
-
- Related Concept Docs:
|
|
300
|
-
- [Product Specs](../01_Concept_Design/03_PRODUCT_SPECS.md) - feature purpose and user value
|
|
301
|
-
- Related UI Docs:
|
|
302
|
-
- [Screen Flow](../02_UI_Screens/00_SCREEN_FLOW.md) - target screen and interaction flow
|
|
303
|
-
- Related HTML Preview:
|
|
304
|
-
- [Main Flow Preview](../02_UI_Screens/previews/01_main_flow_preview.html) - browser-viewable UI for user review
|
|
305
|
-
- Related Technical Docs:
|
|
306
|
-
- [API Specs](../03_Technical_Specs/02_API_SPECS.md) - endpoint and data contract
|
|
307
|
-
- Related QA Docs:
|
|
308
|
-
- [QA Checklist](../05_QA_Validation/02_QA_CHECKLIST.md) - acceptance and release criteria
|
|
309
|
-
- Implementation Preconditions:
|
|
310
|
-
- [ ] Read all related documents before coding
|
|
311
|
-
- [ ] Confirm screen/UI before coding
|
|
312
|
-
- [ ] Show the HTML UI preview to the user and capture feedback
|
|
313
|
-
- [ ] Confirm user path and screen-by-screen data flow
|
|
314
|
-
- [ ] Confirm loading, empty, and error states
|
|
315
|
-
- [ ] Confirm implementation scope does not conflict with documented intent
|
|
316
|
-
- Component & Library Plan:
|
|
317
|
-
- shadcn/ui components: button, card, form, or `N/A - reason`
|
|
318
|
-
- Custom components: feature-specific components or `N/A - reason`
|
|
319
|
-
- Reused components: existing paths or `N/A - reason`
|
|
320
|
-
- New libraries: package names and reasons or `N/A - reason`
|
|
321
|
-
- Libraries intentionally not added: rejected options and reasons or `N/A - reason`
|
|
322
|
-
- shadcn preset action: init --preset / apply --preset / apply --only theme / N/A - reason
|
|
323
|
-
- Acceptance Criteria:
|
|
324
|
-
- [ ] Feature follows the confirmed screen structure and user path
|
|
325
|
-
- [ ] Feature behavior matches linked Concept/UI/Technical docs
|
|
326
|
-
- [ ] QA criteria are testable and satisfied
|
|
327
|
-
- Document Sync Check:
|
|
328
|
-
- [ ] No mismatch between implementation and linked documents
|
|
329
|
-
- [ ] Update related documents if implementation changes the agreed behavior
|
|
330
|
-
```
|
|
160
|
+
**Situation cheat sheet, per-skill when/prerequisites/outputs/next:** [USAGE.md](./USAGE.md)
|
|
331
161
|
|
|
332
162
|
---
|
|
333
163
|
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
Create a pitch deck from existing `docs-plan` documents.
|
|
164
|
+
## Hooks (optional)
|
|
337
165
|
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
**Output modes:**
|
|
341
|
-
|
|
342
|
-
| Mode | When to use | Output |
|
|
343
|
-
|:---|:---|:---|
|
|
344
|
-
| Markdown | Content-first, will export to Notion/Slides | `docs/01_Concept_Design/XX_PITCH_DECK.md` |
|
|
345
|
-
| Reveal.js HTML | Present directly in browser, deploy to GitHub Pages | `pitch/index.html` |
|
|
346
|
-
|
|
347
|
-
**Typical workflow:**
|
|
348
|
-
|
|
349
|
-
```
|
|
350
|
-
1. /docs-plan → Ensure VISION_CORE, LEAN_CANVAS, PRODUCT_SPECS exist
|
|
351
|
-
2. /docs-pitch → Select output mode → Answer Phase 0-2 questions → Generate deck
|
|
352
|
-
```
|
|
353
|
-
|
|
354
|
-
---
|
|
355
|
-
|
|
356
|
-
### Development Workflow
|
|
357
|
-
|
|
358
|
-
**Typical workflow:**
|
|
359
|
-
|
|
360
|
-
```
|
|
361
|
-
1. /rules-dev → Review conventions before writing code
|
|
362
|
-
2. /rules-product → Orchestrate the development pipeline
|
|
363
|
-
3. /verify-implementation → Run all verify-* skills before PR
|
|
364
|
-
4. /manage-collaboration → Check branch naming, PR format, and workflow status
|
|
365
|
-
```
|
|
366
|
-
|
|
367
|
-
---
|
|
368
|
-
|
|
369
|
-
### Governance
|
|
370
|
-
|
|
371
|
-
**Role-based skills** define protocols for team lead and team member roles:
|
|
372
|
-
|
|
373
|
-
```
|
|
374
|
-
/role-team-lead → Branch protection, PR review, DB migration, deployment
|
|
375
|
-
/role-team-member → Branching, commits (Conventional Commits in Korean), PR creation
|
|
376
|
-
```
|
|
377
|
-
|
|
378
|
-
---
|
|
379
|
-
|
|
380
|
-
### Proactive Skill Suggestions (Hooks)
|
|
381
|
-
|
|
382
|
-
Install hook scripts so Claude **automatically suggests** the right skill as you work — without needing to invoke them manually.
|
|
383
|
-
|
|
384
|
-
**Two layers work together:**
|
|
385
|
-
|
|
386
|
-
| Layer | Mechanism | Trigger |
|
|
387
|
-
|:---|:---|:---|
|
|
388
|
-
| Method 1 | AGENTS.md rules | Claude judges context and suggests skills by reasoning |
|
|
389
|
-
| Method 2 | Hook scripts | Keyword/file-pattern matching fires on every prompt or file edit |
|
|
390
|
-
|
|
391
|
-
**Install hooks into your project:**
|
|
166
|
+
For Claude Code, install hooks to get keyword and file-pattern skill suggestions:
|
|
392
167
|
|
|
393
168
|
```bash
|
|
394
|
-
|
|
395
|
-
npx solmate-skills install hooks
|
|
396
|
-
|
|
397
|
-
# 2. Run the installer from your project root
|
|
169
|
+
npx solmate-skills@latest install hooks
|
|
398
170
|
bash .agent/skills/hooks/install.sh
|
|
399
171
|
```
|
|
400
172
|
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
| Script | Event | What it detects |
|
|
404
|
-
|:---|:---|:---|
|
|
405
|
-
| `solmate-suggest.sh` | UserPromptSubmit | Keywords: 결정/설계, 보안, 성능, PR, 코드리뷰, 문서, 기능구현, 피치덱, 새 프로젝트 |
|
|
406
|
-
| `solmate-watch.sh` | PreToolUse | File patterns: `schema.ts`, `.env*`, `SKILL.md`, `page.tsx`, `api/route.ts`, `auth.ts`, `AGENTS.md` |
|
|
407
|
-
|
|
408
|
-
**To review or disable hooks:** open `/hooks` in Claude Code.
|
|
409
|
-
|
|
410
|
-
**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)
|
package/USAGE.md
ADDED
|
@@ -0,0 +1,787 @@
|
|
|
1
|
+
# solmate-skills Usage Guide
|
|
2
|
+
|
|
3
|
+
<a id="solmate-skills-usage-guide"></a>
|
|
4
|
+
|
|
5
|
+
Created Date: 2026-06-25 03:00
|
|
6
|
+
Last Updated Date: 2026-06-29 15:20
|
|
7
|
+
|
|
8
|
+
**Language:** English (default) · [Korean version below](#solmate-skills-usage-guide-korean)
|
|
9
|
+
|
|
10
|
+
This is a **human-readable** guide for choosing and invoking skills.
|
|
11
|
+
Agent execution rules live in each `SKILL.md` and the installed `AGENTS.md`.
|
|
12
|
+
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
## 1. How to Invoke Skills
|
|
16
|
+
|
|
17
|
+
### Cursor / Claude Code (recommended)
|
|
18
|
+
|
|
19
|
+
Use slash commands or natural language in chat:
|
|
20
|
+
|
|
21
|
+
```text
|
|
22
|
+
/rules-product
|
|
23
|
+
Use /rules-workflow to implement this feature
|
|
24
|
+
Run /verify-implementation on the current changes
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
### Install locations
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
npx solmate-skills@latest install all # .agent/skills/<skill-name>/ + ./USAGE.md
|
|
31
|
+
npx solmate-skills@latest install hooks # Claude Code suggestions (optional) + ./USAGE.md
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
Every `install` command (single skill, `all`, or `hooks`) copies `USAGE.md` to the **project root**.
|
|
35
|
+
|
|
36
|
+
### Local development (symlink)
|
|
37
|
+
|
|
38
|
+
When hacking on the `solmate-skills` repo itself:
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
# Run from the target project root
|
|
42
|
+
bash /path/to/solmate-skills/init-skills.sh
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
This symlinks `.agent/skills/` to the repo and links `AGENTS.md` and `USAGE.md` at the project root.
|
|
46
|
+
|
|
47
|
+
---
|
|
48
|
+
|
|
49
|
+
## 2. Situation Cheat Sheet
|
|
50
|
+
|
|
51
|
+
| You say / situation | Skill | Notes |
|
|
52
|
+
|:---|:---|:---|
|
|
53
|
+
| "Where do I start?" / new project | `rules-product` | **Recommended entry point** |
|
|
54
|
+
| "Where are we?" / resume work | `rules-product` | Phase diagnosis, then delegate |
|
|
55
|
+
| Vision, Lean Canvas, UI docs | `docs-plan` | Layers 1–2 |
|
|
56
|
+
| DB, API, backlog, QA docs | `docs-dev` | Layers 3–5 |
|
|
57
|
+
| Unsure which doc layer | `rules-docs` | 5-layer and gate rules |
|
|
58
|
+
| Implement a feature / pre-commit·PR | `rules-workflow` | 18-step workflow |
|
|
59
|
+
| React screens / components | `rules-react` | Component & Library Plan first |
|
|
60
|
+
| shadcn/ui setup / customization | `tools-shadcn` | preset init/apply |
|
|
61
|
+
| Coding conventions / overengineering | `rules-dev` | YAGNI/KISS/DRY **canonical source** |
|
|
62
|
+
| "Which tech should we use?" | `manage-decisions` | 6 decision-type templates |
|
|
63
|
+
| Full check before PR | `verify-implementation` | Runs verify-* in order |
|
|
64
|
+
| Docs only | `verify-docs` | Backlog, gates, metadata |
|
|
65
|
+
| UI vs docs | `verify-ui` | HTML Preview, flows, states |
|
|
66
|
+
| Code quality only | `verify-code` | Pre-PR review |
|
|
67
|
+
| Security | `verify-security` | OWASP Top 10 |
|
|
68
|
+
| Performance / Lighthouse | `verify-performance` | Core Web Vitals |
|
|
69
|
+
| Drizzle schema | `verify-drizzle-schema` | After schema changes |
|
|
70
|
+
| solmate-skills package changes | `verify-skills` | Pre-publish metadata |
|
|
71
|
+
| Pitch deck | `docs-pitch` | Layer 1 docs first |
|
|
72
|
+
| Business plan | `docs-business` | Grants, investment, partnerships |
|
|
73
|
+
| Branch / commit / PR (member) | `role-team-member` | |
|
|
74
|
+
| Deploy / DB / PR review (lead) | `role-team-lead` | |
|
|
75
|
+
| AI–human collaboration | `manage-collaboration` | |
|
|
76
|
+
| Skill package maintenance | `manage-skills` | Detect missing verify skills |
|
|
77
|
+
| Obsidian sync | `tools-obsidian` | |
|
|
78
|
+
| Premium design reference | `ext-awesome-design` | DESIGN.md templates |
|
|
79
|
+
| Korea-specific services | `ext-k-skill` | Law, delivery, transit, etc. |
|
|
80
|
+
|
|
81
|
+
---
|
|
82
|
+
|
|
83
|
+
## 3. Core Orchestrators
|
|
84
|
+
|
|
85
|
+
```text
|
|
86
|
+
┌─────────────────────┐
|
|
87
|
+
│ rules-product │
|
|
88
|
+
│ (entry · phase diag)│
|
|
89
|
+
└──────────┬──────────┘
|
|
90
|
+
│ delegates
|
|
91
|
+
┌───────────────────┼───────────────────┐
|
|
92
|
+
▼ ▼ ▼
|
|
93
|
+
┌─────────────┐ ┌─────────────┐ ┌─────────────┐
|
|
94
|
+
│ docs-plan │ │rules-workflow│ │ verify-impl │
|
|
95
|
+
│ docs-dev │ │ (18 steps) │ │ (master QA) │
|
|
96
|
+
│ rules-react │ └──────┬──────┘ └──────┬──────┘
|
|
97
|
+
└─────────────┘ │ │
|
|
98
|
+
│ ▼
|
|
99
|
+
│ verify-docs … verify-skills
|
|
100
|
+
▼
|
|
101
|
+
commit / PR
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
| Skill | Role | When to use alone |
|
|
105
|
+
|:---|:---|:---|
|
|
106
|
+
| `rules-product` | Diagnose phase, check gates, delegate | **Default first step** |
|
|
107
|
+
| `rules-workflow` | Plan → implement → cleanup → PR (18 steps) | Feature work, commit/PR prep |
|
|
108
|
+
| `verify-implementation` | Run verify-* by changed files, unified report | Pre-PR / pre-release |
|
|
109
|
+
|
|
110
|
+
### Individual verify-* vs master
|
|
111
|
+
|
|
112
|
+
| Situation | Use |
|
|
113
|
+
|:---|:---|
|
|
114
|
+
| Full pre-PR / pre-release | `verify-implementation` |
|
|
115
|
+
| Docs only changed | `verify-docs` |
|
|
116
|
+
| TSX screens only | `verify-ui` |
|
|
117
|
+
| API / auth / env changed | `verify-security` (+ `verify-code` if needed) |
|
|
118
|
+
| Schema only | `verify-drizzle-schema` |
|
|
119
|
+
| solmate-skills repo itself | `verify-skills` |
|
|
120
|
+
|
|
121
|
+
---
|
|
122
|
+
|
|
123
|
+
## 4. Full Pipeline (with Gates)
|
|
124
|
+
|
|
125
|
+
```text
|
|
126
|
+
Phase 1 Planning docs → docs-plan (01_Concept_Design)
|
|
127
|
+
Phase 2 UI design docs → docs-plan (02_UI_Screens)
|
|
128
|
+
HTML UI Preview Gate → previews/ HTML + user feedback
|
|
129
|
+
UI-First Gate → screens, flows, data, states
|
|
130
|
+
Pre-Code Technical Brief → API, state, acceptance criteria
|
|
131
|
+
Component & Library Planning Gate → shadcn, custom, reuse, libraries
|
|
132
|
+
Phase 3 React implementation → rules-react (+ tools-shadcn)
|
|
133
|
+
Phase 4 Dev docs → docs-dev (03–05)
|
|
134
|
+
Phase 5 Quality verification → verify-implementation
|
|
135
|
+
Phase 6 Deliverables (opt.) → docs-pitch / docs-business
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
Implementation detail: `rules-workflow` (18 steps).
|
|
139
|
+
YAGNI/KISS/DRY canonical rules: `rules-dev`.
|
|
140
|
+
|
|
141
|
+
### Flow Status Block
|
|
142
|
+
|
|
143
|
+
Agents report progress in this format (field labels may appear in Korean in project docs):
|
|
144
|
+
|
|
145
|
+
```text
|
|
146
|
+
[Flow]
|
|
147
|
+
현재: Phase 2 — UI 설계
|
|
148
|
+
Gate: UI-First Gate 진행 중
|
|
149
|
+
완료: Phase 1 — Concept
|
|
150
|
+
다음: Pre-Code Technical Brief
|
|
151
|
+
필요 확인: 화면별 오류 상태
|
|
152
|
+
권장 스킬: /docs-plan
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
---
|
|
156
|
+
|
|
157
|
+
## 5. Skill Catalog (26 skills)
|
|
158
|
+
|
|
159
|
+
Each entry: **When** / **Prerequisites** / **Invoke** / **Outputs** / **Next**
|
|
160
|
+
|
|
161
|
+
### 5.1. Governance & operations
|
|
162
|
+
|
|
163
|
+
#### `rules-product`
|
|
164
|
+
|
|
165
|
+
- **When:** New project, resume, "what should I do next?"
|
|
166
|
+
- **Prerequisites:** None
|
|
167
|
+
- **Invoke:** `/rules-product` — diagnose current progress
|
|
168
|
+
- **Outputs:** Flow Status Block, next skill, gate pass/fail
|
|
169
|
+
- **Next:** `docs-plan`, `docs-dev`, `rules-react`, `rules-workflow`, or `verify-implementation` by phase
|
|
170
|
+
|
|
171
|
+
#### `rules-workflow`
|
|
172
|
+
|
|
173
|
+
- **When:** Feature implementation, planning, commit/PR (18 steps)
|
|
174
|
+
- **Prerequisites:** HTML UI Preview Gate, UI-First Gate, Backlog Context Lock, Component & Library Plan (non-prototype)
|
|
175
|
+
- **Invoke:** `/rules-workflow` — implement this backlog item
|
|
176
|
+
- **Outputs:** Plan review, implementation, self-check, PR readiness
|
|
177
|
+
- **Next:** `verify-implementation`
|
|
178
|
+
|
|
179
|
+
#### `rules-dev`
|
|
180
|
+
|
|
181
|
+
- **When:** Conventions, env setup, avoid overengineering
|
|
182
|
+
- **Prerequisites:** Project `AGENTS.md` or `DEVELOPMENT_PRINCIPLES.md`
|
|
183
|
+
- **Invoke:** `/rules-dev` — is this minimal implementation?
|
|
184
|
+
- **Outputs:** YAGNI/KISS/DRY gate verdict, coding standards
|
|
185
|
+
- **Next:** `rules-workflow` when coding
|
|
186
|
+
|
|
187
|
+
#### `rules-docs`
|
|
188
|
+
|
|
189
|
+
- **When:** Doc structure, metadata, gates; unsure which layer
|
|
190
|
+
- **Prerequisites:** None
|
|
191
|
+
- **Invoke:** `/rules-docs` — is this doc in the right layer?
|
|
192
|
+
- **Outputs:** 5-layer placement, Related Documents, gate requirements
|
|
193
|
+
- **Next:** `docs-plan` or `docs-dev`
|
|
194
|
+
|
|
195
|
+
#### `manage-collaboration`
|
|
196
|
+
|
|
197
|
+
- **When:** Branch/PR/approval flow, AI–human standards
|
|
198
|
+
- **Prerequisites:** Team role agreed (`role-team-lead` / `role-team-member`)
|
|
199
|
+
- **Invoke:** `/manage-collaboration` — does this PR flow match standards?
|
|
200
|
+
- **Outputs:** Collaboration checklist
|
|
201
|
+
- **Next:** `role-team-member` or `role-team-lead`
|
|
202
|
+
|
|
203
|
+
#### `manage-decisions`
|
|
204
|
+
|
|
205
|
+
- **When:** Stack, DB, API, UX, architecture decisions
|
|
206
|
+
- **Prerequisites:** None (conversation-driven)
|
|
207
|
+
- **Invoke:** `/manage-decisions` — guide DB design decision
|
|
208
|
+
- **Outputs:** Typed questions, decision record
|
|
209
|
+
- **Next:** `docs-dev` or `rules-workflow`
|
|
210
|
+
|
|
211
|
+
#### `manage-skills`
|
|
212
|
+
|
|
213
|
+
- **When:** After adding/editing skills in solmate-skills repo
|
|
214
|
+
- **Prerequisites:** Skill file changes in session
|
|
215
|
+
- **Invoke:** `/manage-skills` — any missing verify skills?
|
|
216
|
+
- **Outputs:** Gap list, update suggestions
|
|
217
|
+
- **Next:** `verify-skills`
|
|
218
|
+
|
|
219
|
+
#### `role-team-lead`
|
|
220
|
+
|
|
221
|
+
- **When:** Lead — onboarding, branch protection, PR review, DB, deploy
|
|
222
|
+
- **Prerequisites:** Lead role agreed
|
|
223
|
+
- **Invoke:** `/role-team-lead` — pre-deploy checklist
|
|
224
|
+
- **Outputs:** Lead responsibility checklist
|
|
225
|
+
- **Next:** `verify-implementation`, `manage-collaboration`
|
|
226
|
+
|
|
227
|
+
#### `role-team-member`
|
|
228
|
+
|
|
229
|
+
- **When:** Member — branch, Conventional Commits (Korean), PR
|
|
230
|
+
- **Prerequisites:** Member role agreed
|
|
231
|
+
- **Invoke:** `/role-team-member` — review commit message
|
|
232
|
+
- **Outputs:** Branch/commit/PR guide
|
|
233
|
+
- **Next:** `rules-workflow`, `verify-code`
|
|
234
|
+
|
|
235
|
+
### 5.2. Documentation
|
|
236
|
+
|
|
237
|
+
#### `docs-plan`
|
|
238
|
+
|
|
239
|
+
- **When:** Vision, Lean Canvas, specs, UI design, HTML previews
|
|
240
|
+
- **Prerequisites:** Ask before Write
|
|
241
|
+
- **Invoke:** `/docs-plan` — draft Layer 1 planning docs
|
|
242
|
+
- **Outputs:** `docs/01_*`, `docs/02_*`, `previews/*.html`
|
|
243
|
+
- **Next:** `verify-docs`, then `docs-dev` or `rules-react`
|
|
244
|
+
|
|
245
|
+
#### `docs-dev`
|
|
246
|
+
|
|
247
|
+
- **When:** DB schema, API, backlog, roadmap, QA, component/library plans
|
|
248
|
+
- **Prerequisites:** Related Concept/UI docs; backlog needs Related Docs
|
|
249
|
+
- **Invoke:** `/docs-dev` — write API spec and backlog
|
|
250
|
+
- **Outputs:** `docs/03_*`, `docs/04_*`, `docs/05_*`
|
|
251
|
+
- **Next:** `rules-workflow`, `verify-docs`
|
|
252
|
+
|
|
253
|
+
#### `docs-pitch`
|
|
254
|
+
|
|
255
|
+
- **When:** Investor, hackathon, demo day deck
|
|
256
|
+
- **Prerequisites:** Layer 1 (`VISION_CORE`, `LEAN_CANVAS`, `PRODUCT_SPECS`)
|
|
257
|
+
- **Invoke:** `/docs-pitch` — Reveal.js HTML deck
|
|
258
|
+
- **Outputs:** Markdown or `pitch/index.html`
|
|
259
|
+
- **Next:** `verify-docs` (optional)
|
|
260
|
+
|
|
261
|
+
#### `docs-business`
|
|
262
|
+
|
|
263
|
+
- **When:** Grants, investment, partnership business plan
|
|
264
|
+
- **Prerequisites:** Layer 1 planning docs
|
|
265
|
+
- **Invoke:** `/docs-business` — draft business plan
|
|
266
|
+
- **Outputs:** Structured business plan Markdown
|
|
267
|
+
- **Next:** Standalone deliverable
|
|
268
|
+
|
|
269
|
+
### 5.3. Development & UI
|
|
270
|
+
|
|
271
|
+
#### `rules-react`
|
|
272
|
+
|
|
273
|
+
- **When:** React pages, components, refactor
|
|
274
|
+
- **Prerequisites:** UI docs, HTML Preview confirmed, Component & Library Plan
|
|
275
|
+
- **Invoke:** `/rules-react` — implement this screen
|
|
276
|
+
- **Outputs:** React code under `src/`
|
|
277
|
+
- **Next:** `verify-ui`, `verify-code`
|
|
278
|
+
|
|
279
|
+
#### `tools-shadcn`
|
|
280
|
+
|
|
281
|
+
- **When:** shadcn/ui init, add components, theme/preset
|
|
282
|
+
- **Prerequisites:** Component & Library Plan preset action
|
|
283
|
+
- **Invoke:** `/tools-shadcn` — add button, form to project
|
|
284
|
+
- **Outputs:** shadcn components, preset commands
|
|
285
|
+
- **Next:** `rules-react`
|
|
286
|
+
|
|
287
|
+
#### `tools-obsidian`
|
|
288
|
+
|
|
289
|
+
- **When:** Sync project docs with Obsidian vault
|
|
290
|
+
- **Prerequisites:** Vault path
|
|
291
|
+
- **Invoke:** `/tools-obsidian` — check sync status
|
|
292
|
+
- **Outputs:** Link status, metadata compatibility
|
|
293
|
+
- **Next:** None
|
|
294
|
+
|
|
295
|
+
### 5.4. Verification (verify-*)
|
|
296
|
+
|
|
297
|
+
#### `verify-implementation`
|
|
298
|
+
|
|
299
|
+
- **When:** Pre-PR unified check (**default**)
|
|
300
|
+
- **Prerequisites:** Changes to verify
|
|
301
|
+
- **Invoke:** `/verify-implementation` — full verification
|
|
302
|
+
- **Outputs:** Pass/Fail report incl. YAGNI/KISS/DRY Gate
|
|
303
|
+
- **Next:** Fix and re-run, or scoped verify-* skills
|
|
304
|
+
|
|
305
|
+
#### `verify-docs`
|
|
306
|
+
|
|
307
|
+
- **When:** After doc edits; backlog/gate alignment
|
|
308
|
+
- **Prerequisites:** `docs/` changes
|
|
309
|
+
- **Invoke:** `/verify-docs` — validate backlog Related Docs
|
|
310
|
+
- **Outputs:** Layer/metadata/gate violations
|
|
311
|
+
- **Next:** `docs-plan` / `docs-dev`
|
|
312
|
+
|
|
313
|
+
#### `verify-ui`
|
|
314
|
+
|
|
315
|
+
- **When:** After React/TSX UI work
|
|
316
|
+
- **Prerequisites:** `docs/02_UI_Screens/`, HTML Preview
|
|
317
|
+
- **Invoke:** `/verify-ui` — does UI match docs?
|
|
318
|
+
- **Outputs:** Screen/flow/state mismatches
|
|
319
|
+
- **Next:** `rules-react`
|
|
320
|
+
|
|
321
|
+
#### `verify-code`
|
|
322
|
+
|
|
323
|
+
- **When:** Pre-PR code quality, overengineering
|
|
324
|
+
- **Prerequisites:** Code changes
|
|
325
|
+
- **Invoke:** `/verify-code` — pre-PR review
|
|
326
|
+
- **Outputs:** Issue table (YAGNI/KISS/DRY tags)
|
|
327
|
+
- **Next:** Fix or `verify-implementation`
|
|
328
|
+
|
|
329
|
+
#### `verify-security`
|
|
330
|
+
|
|
331
|
+
- **When:** auth, API, middleware, env, DB changes
|
|
332
|
+
- **Prerequisites:** Security-sensitive changes
|
|
333
|
+
- **Invoke:** `/verify-security` — OWASP check
|
|
334
|
+
- **Outputs:** Vulnerabilities, auth, secrets
|
|
335
|
+
- **Next:** Fix and re-run
|
|
336
|
+
|
|
337
|
+
#### `verify-performance`
|
|
338
|
+
|
|
339
|
+
- **When:** Page, layout, images, bundle; pre-deploy
|
|
340
|
+
- **Prerequisites:** Frontend performance impact
|
|
341
|
+
- **Invoke:** `/verify-performance` — Lighthouse check
|
|
342
|
+
- **Outputs:** LCP, CLS, bundle, image issues
|
|
343
|
+
- **Next:** Fix and re-run
|
|
344
|
+
|
|
345
|
+
#### `verify-drizzle-schema`
|
|
346
|
+
|
|
347
|
+
- **When:** Drizzle schema/migration changes
|
|
348
|
+
- **Prerequisites:** `DB_SCHEMA.md` or equivalent
|
|
349
|
+
- **Invoke:** `/verify-drizzle-schema` — schema alignment
|
|
350
|
+
- **Outputs:** Schema/doc mismatches
|
|
351
|
+
- **Next:** `docs-dev`
|
|
352
|
+
|
|
353
|
+
#### `verify-skills`
|
|
354
|
+
|
|
355
|
+
- **When:** solmate-skills package edit, pre-publish
|
|
356
|
+
- **Prerequisites:** `SKILL.md`, `package.json`, `README.md`, `AGENTS.md` changes
|
|
357
|
+
- **Invoke:** `/verify-skills` — release readiness
|
|
358
|
+
- **Outputs:** CLI, frontmatter, version sync, npm pack
|
|
359
|
+
- **Next:** `npm publish`
|
|
360
|
+
|
|
361
|
+
### 5.5. External extensions
|
|
362
|
+
|
|
363
|
+
#### `ext-awesome-design`
|
|
364
|
+
|
|
365
|
+
- **When:** Premium design tokens, DESIGN.md, brand UI styles
|
|
366
|
+
- **Prerequisites:** None (reference library)
|
|
367
|
+
- **Invoke:** Reference stripe DESIGN.md from ext-awesome-design
|
|
368
|
+
- **Outputs:** Design reference, DESIGN.md draft
|
|
369
|
+
- **Next:** `docs-plan`, `rules-react`
|
|
370
|
+
|
|
371
|
+
#### `ext-k-skill`
|
|
372
|
+
|
|
373
|
+
- **When:** Korea-specific data (law, delivery, KTX, fine dust, etc.)
|
|
374
|
+
- **Prerequisites:** Per-feature setup in ext-k-skill package
|
|
375
|
+
- **Invoke:** See ext-k-skill README and feature guides
|
|
376
|
+
- **Outputs:** Feature-specific API results
|
|
377
|
+
- **Next:** None (tooling)
|
|
378
|
+
|
|
379
|
+
> `ext-k-skill` is separate from the core Solmate workflow. Run `k-skill-setup` and per-feature docs after install.
|
|
380
|
+
|
|
381
|
+
---
|
|
382
|
+
|
|
383
|
+
## 6. Documentation System
|
|
384
|
+
|
|
385
|
+
### Which skill writes which docs
|
|
386
|
+
|
|
387
|
+
```text
|
|
388
|
+
Product vision, Lean Canvas, UI design → docs-plan
|
|
389
|
+
DB schema, API specs, roadmap, QA → docs-dev
|
|
390
|
+
Unsure which layer? → rules-docs
|
|
391
|
+
```
|
|
392
|
+
|
|
393
|
+
### 5-Layer structure
|
|
394
|
+
|
|
395
|
+
```text
|
|
396
|
+
docs/
|
|
397
|
+
├── 01_Concept_Design/ ← docs-plan
|
|
398
|
+
├── 02_UI_Screens/ ← docs-plan (+ previews/)
|
|
399
|
+
├── 03_Technical_Specs/ ← docs-dev
|
|
400
|
+
├── 04_Logic_Progress/ ← docs-dev
|
|
401
|
+
└── 05_QA_Validation/ ← docs-dev
|
|
402
|
+
```
|
|
403
|
+
|
|
404
|
+
---
|
|
405
|
+
|
|
406
|
+
## 7. Gates (detail)
|
|
407
|
+
|
|
408
|
+
### HTML UI Preview Gate
|
|
409
|
+
|
|
410
|
+
- Path: `docs/02_UI_Screens/previews/`
|
|
411
|
+
- Link from UI docs with relative paths
|
|
412
|
+
- Show HTML to user before implementation; record feedback
|
|
413
|
+
|
|
414
|
+
### UI-First Gate
|
|
415
|
+
|
|
416
|
+
- Screen structure, user paths, CTAs, data flow
|
|
417
|
+
- Loading, empty, error states before coding
|
|
418
|
+
|
|
419
|
+
### Component & Library Planning Gate
|
|
420
|
+
|
|
421
|
+
- shadcn/ui, custom, reused components
|
|
422
|
+
- Libraries to add/avoid, preset action (`init --preset`, `apply --preset`, etc.)
|
|
423
|
+
- Record in backlog `Component & Library Plan`
|
|
424
|
+
|
|
425
|
+
### Backlog Context Lock
|
|
426
|
+
|
|
427
|
+
Required fields per item in `docs/04_Logic_Progress/00_BACKLOG.md`:
|
|
428
|
+
|
|
429
|
+
- `Related Concept Docs`, `Related UI Docs`, `Related HTML Preview`
|
|
430
|
+
- `Related Technical Docs`, `Related QA Docs`
|
|
431
|
+
- `Implementation Preconditions`, `Component & Library Plan`
|
|
432
|
+
- `Acceptance Criteria`, `Document Sync Check`
|
|
433
|
+
|
|
434
|
+
Use `N/A - reason` when a doc does not exist. Pause implementation if a missing doc blocks a safe decision.
|
|
435
|
+
|
|
436
|
+
### YAGNI/KISS/DRY Gate
|
|
437
|
+
|
|
438
|
+
- **Canonical:** `rules-dev` § Minimal Implementation Gate
|
|
439
|
+
- Referenced by `rules-workflow`, `verify-code` Area 3, `verify-implementation` report
|
|
440
|
+
- Prototype/spike: advisory only; do not drop security, validation, or error handling for "simplicity"
|
|
441
|
+
|
|
442
|
+
### Backlog item template
|
|
443
|
+
|
|
444
|
+
<a id="backlog-item-template"></a>
|
|
445
|
+
|
|
446
|
+
```markdown
|
|
447
|
+
### [ ] TASK-000: Implement feature name
|
|
448
|
+
|
|
449
|
+
- Status: ToDo
|
|
450
|
+
- Related Concept Docs:
|
|
451
|
+
- [Product Specs](../01_Concept_Design/03_PRODUCT_SPECS.md) - feature purpose and user value
|
|
452
|
+
- Related UI Docs:
|
|
453
|
+
- [Screen Flow](../02_UI_Screens/00_SCREEN_FLOW.md) - target screen and interaction flow
|
|
454
|
+
- Related HTML Preview:
|
|
455
|
+
- [Main Flow Preview](../02_UI_Screens/previews/01_main_flow_preview.html) - browser-viewable UI for user review
|
|
456
|
+
- Related Technical Docs:
|
|
457
|
+
- [API Specs](../03_Technical_Specs/02_API_SPECS.md) - endpoint and data contract
|
|
458
|
+
- Related QA Docs:
|
|
459
|
+
- [QA Checklist](../05_QA_Validation/02_QA_CHECKLIST.md) - acceptance and release criteria
|
|
460
|
+
- Implementation Preconditions:
|
|
461
|
+
- [ ] Read all related documents before coding
|
|
462
|
+
- [ ] Confirm screen/UI before coding
|
|
463
|
+
- [ ] Show the HTML UI preview to the user and capture feedback
|
|
464
|
+
- [ ] Confirm user path and screen-by-screen data flow
|
|
465
|
+
- [ ] Confirm loading, empty, and error states
|
|
466
|
+
- [ ] Confirm implementation scope does not conflict with documented intent
|
|
467
|
+
- Component & Library Plan:
|
|
468
|
+
- shadcn/ui components: button, card, form, or `N/A - reason`
|
|
469
|
+
- Custom components: feature-specific components or `N/A - reason`
|
|
470
|
+
- Reused components: existing paths or `N/A - reason`
|
|
471
|
+
- New libraries: package names and reasons or `N/A - reason`
|
|
472
|
+
- Libraries intentionally not added: rejected options and reasons or `N/A - reason`
|
|
473
|
+
- shadcn preset action: init --preset / apply --preset / apply --only theme / N/A - reason
|
|
474
|
+
- Acceptance Criteria:
|
|
475
|
+
- [ ] Feature follows the confirmed screen structure and user path
|
|
476
|
+
- [ ] Feature behavior matches linked Concept/UI/Technical docs
|
|
477
|
+
- [ ] QA criteria are testable and satisfied
|
|
478
|
+
- Document Sync Check:
|
|
479
|
+
- [ ] No mismatch between implementation and linked documents
|
|
480
|
+
- [ ] Update related documents if implementation changes the agreed behavior
|
|
481
|
+
```
|
|
482
|
+
|
|
483
|
+
---
|
|
484
|
+
|
|
485
|
+
## 8. Hooks (Claude Code suggestions)
|
|
486
|
+
|
|
487
|
+
Keyword and file-pattern **suggestions** (not forced runs):
|
|
488
|
+
|
|
489
|
+
```bash
|
|
490
|
+
npx solmate-skills@latest install hooks
|
|
491
|
+
bash .agent/skills/hooks/install.sh
|
|
492
|
+
```
|
|
493
|
+
|
|
494
|
+
| Script | Event | Examples |
|
|
495
|
+
|:---|:---|:---|
|
|
496
|
+
| `solmate-suggest.sh` | UserPromptSubmit | decisions, security, performance, PR, docs |
|
|
497
|
+
| `solmate-watch.sh` | PreToolUse (Write/Edit) | `schema.ts`, `page.tsx`, `SKILL.md`, `AGENTS.md` |
|
|
498
|
+
|
|
499
|
+
Re-run `install hooks` to pick up 2.0.10 false-positive fixes on existing projects.
|
|
500
|
+
|
|
501
|
+
---
|
|
502
|
+
|
|
503
|
+
## 9. Recommended Prompts
|
|
504
|
+
|
|
505
|
+
**Project diagnosis (new or resume)**
|
|
506
|
+
|
|
507
|
+
```text
|
|
508
|
+
Use /rules-product to diagnose this project's current progress and recommend next steps with a Flow Status Block.
|
|
509
|
+
```
|
|
510
|
+
|
|
511
|
+
**Feature implementation**
|
|
512
|
+
|
|
513
|
+
```text
|
|
514
|
+
Use /rules-workflow for this feature. Start with a Flow Status Block and follow the UI-First flow.
|
|
515
|
+
```
|
|
516
|
+
|
|
517
|
+
**Pre-PR verification**
|
|
518
|
+
|
|
519
|
+
```text
|
|
520
|
+
Run /verify-implementation on current changes. Include a Flow Status Block in the report.
|
|
521
|
+
```
|
|
522
|
+
|
|
523
|
+
---
|
|
524
|
+
|
|
525
|
+
## 10. Related Documents
|
|
526
|
+
|
|
527
|
+
| Document | Audience | Content |
|
|
528
|
+
|:---|:---|:---|
|
|
529
|
+
| [README.md](./README.md) | First-time installers | Install, 5-minute start, changelog |
|
|
530
|
+
| [USAGE.md](./USAGE.md) (this file) | Daily users | Cheat sheet, catalog, gates (EN + KO) |
|
|
531
|
+
| `AGENTS.md` | Installed project AI | Global rules, skill table, suggestions |
|
|
532
|
+
| `<skill>/SKILL.md` | AI agents | Per-skill execution spec |
|
|
533
|
+
|
|
534
|
+
---
|
|
535
|
+
|
|
536
|
+
# solmate-skills Usage Guide (Korean)
|
|
537
|
+
|
|
538
|
+
<a id="solmate-skills-usage-guide-korean"></a>
|
|
539
|
+
|
|
540
|
+
**언어:** [English (default)](#solmate-skills-usage-guide) · 한국어 (아래)
|
|
541
|
+
|
|
542
|
+
사람이 읽기 위한 스킬 사용법 가이드입니다.
|
|
543
|
+
에이전트 실행 규칙의 정본은 각 `SKILL.md`와 프로젝트에 설치된 `AGENTS.md`입니다.
|
|
544
|
+
|
|
545
|
+
---
|
|
546
|
+
|
|
547
|
+
## 1. 스킬 호출 방법
|
|
548
|
+
|
|
549
|
+
### Cursor / Claude Code (권장)
|
|
550
|
+
|
|
551
|
+
채팅에서 슬래시 명령 또는 자연어로 호출합니다.
|
|
552
|
+
|
|
553
|
+
```text
|
|
554
|
+
/rules-product
|
|
555
|
+
/rules-workflow를 사용해서 이 기능 구현을 진행해줘
|
|
556
|
+
/verify-implementation으로 현재 변경사항을 검증해줘
|
|
557
|
+
```
|
|
558
|
+
|
|
559
|
+
### 설치 위치
|
|
560
|
+
|
|
561
|
+
```bash
|
|
562
|
+
npx solmate-skills@latest install all # .agent/skills/<skill-name>/ + ./USAGE.md
|
|
563
|
+
npx solmate-skills@latest install hooks # Claude Code 자동 제안 (별도) + ./USAGE.md
|
|
564
|
+
```
|
|
565
|
+
|
|
566
|
+
모든 `install` 명령(단일 스킬, `all`, `hooks`)은 `USAGE.md`를 **프로젝트 루트**에 복사합니다.
|
|
567
|
+
|
|
568
|
+
### 로컬 개발 (symlink)
|
|
569
|
+
|
|
570
|
+
`solmate-skills` 저장소를 직접 수정하며 테스트할 때:
|
|
571
|
+
|
|
572
|
+
```bash
|
|
573
|
+
# 대상 프로젝트 루트에서 실행
|
|
574
|
+
bash /path/to/solmate-skills/init-skills.sh
|
|
575
|
+
```
|
|
576
|
+
|
|
577
|
+
`.agent/skills/`가 저장소로 symlink되고, `AGENTS.md`와 `USAGE.md`가 루트에 링크됩니다.
|
|
578
|
+
|
|
579
|
+
---
|
|
580
|
+
|
|
581
|
+
## 2. 상황별 스킬 선택 (치트시트)
|
|
582
|
+
|
|
583
|
+
| 사용자가 말하는 것 | 추천 스킬 | 비고 |
|
|
584
|
+
|:---|:---|:---|
|
|
585
|
+
| "뭐부터 해야 해?" / 신규 프로젝트 | `rules-product` | **가장 권장하는 시작점** |
|
|
586
|
+
| "지금 어디까지 왔지?" / 작업 재개 | `rules-product` | Phase 진단 후 다음 스킬 위임 |
|
|
587
|
+
| 비전·린캔버스·화면 설계 문서 | `docs-plan` | Layer 1-2 |
|
|
588
|
+
| DB·API·백로그·QA 문서 | `docs-dev` | Layer 3-5 |
|
|
589
|
+
| 문서 구조가 맞는지 모르겠음 | `rules-docs` | 5레이어·게이트 규칙 정본 |
|
|
590
|
+
| 기능 하나 구현 / 커밋·PR 전 | `rules-workflow` | 18단계 구현 워크플로 |
|
|
591
|
+
| React 화면·컴포넌트 구현 | `rules-react` | Component & Library Plan 선행 |
|
|
592
|
+
| shadcn/ui 설치·커스터마이징 | `tools-shadcn` | preset init/apply 포함 |
|
|
593
|
+
| 코딩 컨벤션·과잉 구현 방지 | `rules-dev` | YAGNI/KISS/DRY **정본** |
|
|
594
|
+
| "이거 어떤 기술 쓸까?" / 설계 결정 | `manage-decisions` | 6개 결정 유형 질문 템플릿 |
|
|
595
|
+
| PR 전 **전체** 점검 | `verify-implementation` | verify-* 통합 실행 |
|
|
596
|
+
| 문서만 점검 | `verify-docs` | 백로그·게이트·메타데이터 |
|
|
597
|
+
| UI가 문서와 맞는지 | `verify-ui` | HTML Preview·동선·상태 |
|
|
598
|
+
| 코드 품질·과잉 구현만 | `verify-code` | PR 전 코드 리뷰 |
|
|
599
|
+
| 보안 점검 | `verify-security` | OWASP Top 10 |
|
|
600
|
+
| 성능·Lighthouse | `verify-performance` | Core Web Vitals |
|
|
601
|
+
| Drizzle 스키마 | `verify-drizzle-schema` | 스키마 변경 시 |
|
|
602
|
+
| solmate-skills 패키지 수정 후 | `verify-skills` | 배포 전 메타데이터 검증 |
|
|
603
|
+
| 피치덱 | `docs-pitch` | Layer 1 문서 선행 |
|
|
604
|
+
| 사업계획서 | `docs-business` | 정부 지원·투자 심사용 |
|
|
605
|
+
| 브랜치·커밋·PR 규칙 (팀원) | `role-team-member` | |
|
|
606
|
+
| 배포·DB·PR 리뷰 (팀장) | `role-team-lead` | |
|
|
607
|
+
| AI-인간 협업 표준 | `manage-collaboration` | |
|
|
608
|
+
| 스킬 패키지 유지보수 | `manage-skills` | verify 스킬 누락 탐지 |
|
|
609
|
+
| Obsidian 동기화 | `tools-obsidian` | |
|
|
610
|
+
| 프리미엄 디자인 참고 | `ext-awesome-design` | DESIGN.md 템플릿 |
|
|
611
|
+
| 한국 특화 서비스 조회 | `ext-k-skill` | 법률·배송·교통 등 |
|
|
612
|
+
|
|
613
|
+
---
|
|
614
|
+
|
|
615
|
+
## 3. 핵심 오케스트레이터 관계
|
|
616
|
+
|
|
617
|
+
| 스킬 | 역할 | 단독 사용 시점 |
|
|
618
|
+
|:---|:---|:---|
|
|
619
|
+
| `rules-product` | 프로젝트 Phase 진단, Gate 확인, 하위 스킬 위임 | **항상 첫 진입점**으로 권장 |
|
|
620
|
+
| `rules-workflow` | 승인된 문서 기준으로 계획→구현→정리→PR (18단계) | 기능 구현·커밋·PR 직전 |
|
|
621
|
+
| `verify-implementation` | 변경 파일에 맞춰 verify-* 순차 실행·통합 보고 | PR·배포 전 최종 점검 |
|
|
622
|
+
|
|
623
|
+
### verify-* 개별 vs 통합
|
|
624
|
+
|
|
625
|
+
| 상황 | 사용 |
|
|
626
|
+
|:---|:---|
|
|
627
|
+
| PR·배포 전 전체 점검 | `verify-implementation` |
|
|
628
|
+
| 문서만 수정함 | `verify-docs` |
|
|
629
|
+
| TSX 화면만 수정함 | `verify-ui` |
|
|
630
|
+
| API·auth·env 수정함 | `verify-security` (+ 필요 시 `verify-code`) |
|
|
631
|
+
| 스키마만 수정함 | `verify-drizzle-schema` |
|
|
632
|
+
| solmate-skills 저장소 자체 수정 | `verify-skills` |
|
|
633
|
+
|
|
634
|
+
---
|
|
635
|
+
|
|
636
|
+
## 4. 전체 파이프라인 (Gate 포함)
|
|
637
|
+
|
|
638
|
+
```text
|
|
639
|
+
Phase 1 기획문서 → docs-plan (01_Concept_Design)
|
|
640
|
+
Phase 2 UI 설계 문서 → docs-plan (02_UI_Screens)
|
|
641
|
+
HTML UI Preview Gate → previews/ HTML + 사용자 피드백
|
|
642
|
+
UI-First Gate → 화면·동선·데이터 흐름·상태 확인
|
|
643
|
+
Pre-Code Technical Brief → API·상태·acceptance criteria 합의
|
|
644
|
+
Component & Library Planning Gate → shadcn·커스텀·재사용·라이브러리 계획
|
|
645
|
+
Phase 3 React 구현 → rules-react (+ tools-shadcn)
|
|
646
|
+
Phase 4 개발문서 → docs-dev (03~05)
|
|
647
|
+
Phase 5 품질 검증 → verify-implementation
|
|
648
|
+
Phase 6 전달물 (선택) → docs-pitch / docs-business
|
|
649
|
+
```
|
|
650
|
+
|
|
651
|
+
구현 상세: `rules-workflow` (18단계). YAGNI/KISS/DRY **정본**: `rules-dev`.
|
|
652
|
+
|
|
653
|
+
### Flow Status Block
|
|
654
|
+
|
|
655
|
+
```text
|
|
656
|
+
[Flow]
|
|
657
|
+
현재: Phase 2 — UI 설계
|
|
658
|
+
Gate: UI-First Gate 진행 중
|
|
659
|
+
완료: Phase 1 — Concept
|
|
660
|
+
다음: Pre-Code Technical Brief
|
|
661
|
+
필요 확인: 화면별 오류 상태
|
|
662
|
+
권장 스킬: /docs-plan
|
|
663
|
+
```
|
|
664
|
+
|
|
665
|
+
---
|
|
666
|
+
|
|
667
|
+
## 5. 스킬 카탈로그 (26개)
|
|
668
|
+
|
|
669
|
+
각 항목: **언제** / **선행 조건** / **호출 예** / **산출물** / **다음 스킬**
|
|
670
|
+
(스킬 이름·구조는 영문 섹션 [§5](#5-skill-catalog-26-skills)과 동일합니다.)
|
|
671
|
+
|
|
672
|
+
### 5.1. 운영 및 거버넌스
|
|
673
|
+
|
|
674
|
+
| 스킬 | 언제 | 다음 스킬 |
|
|
675
|
+
|:---|:---|:---|
|
|
676
|
+
| `rules-product` | 신규·재개·"뭘 해야 하지?" | Phase별 위임 |
|
|
677
|
+
| `rules-workflow` | 기능 구현·18단계·PR 전 | `verify-implementation` |
|
|
678
|
+
| `rules-dev` | 컨벤션·과잉 구현 방지 | `rules-workflow` |
|
|
679
|
+
| `rules-docs` | 문서 레이어·게이트 확인 | `docs-plan` / `docs-dev` |
|
|
680
|
+
| `manage-collaboration` | 브랜치·PR·협업 표준 | role 스킬 |
|
|
681
|
+
| `manage-decisions` | 기술·DB·API·UX 결정 | `docs-dev` / `rules-workflow` |
|
|
682
|
+
| `manage-skills` | 스킬 패키지 수정 후 | `verify-skills` |
|
|
683
|
+
| `role-team-lead` | 팀장 책임·배포 | `verify-implementation` |
|
|
684
|
+
| `role-team-member` | 팀원·커밋·PR | `rules-workflow` |
|
|
685
|
+
|
|
686
|
+
### 5.2. 문서 작성
|
|
687
|
+
|
|
688
|
+
| 스킬 | 언제 | 산출물 |
|
|
689
|
+
|:---|:---|:---|
|
|
690
|
+
| `docs-plan` | Layer 1-2, HTML Preview | `01_*`, `02_*`, `previews/` |
|
|
691
|
+
| `docs-dev` | Layer 3-5, 백로그 | `03_*` ~ `05_*` |
|
|
692
|
+
| `docs-pitch` | 피치덱 | MD 또는 Reveal HTML |
|
|
693
|
+
| `docs-business` | 사업계획서 | 사업계획서 MD |
|
|
694
|
+
|
|
695
|
+
### 5.3. 개발 및 UI
|
|
696
|
+
|
|
697
|
+
| 스킬 | 언제 | 선행 조건 |
|
|
698
|
+
|:---|:---|:---|
|
|
699
|
+
| `rules-react` | React 구현 | UI 문서·Preview·Component Plan |
|
|
700
|
+
| `tools-shadcn` | shadcn/ui | preset action |
|
|
701
|
+
| `tools-obsidian` | Obsidian 동기화 | 볼트 경로 |
|
|
702
|
+
|
|
703
|
+
### 5.4. 품질 검증
|
|
704
|
+
|
|
705
|
+
| 스킬 | 언제 |
|
|
706
|
+
|:---|:---|
|
|
707
|
+
| `verify-implementation` | PR 전 통합 (**기본**) |
|
|
708
|
+
| `verify-docs` | 문서·백로그·게이트 |
|
|
709
|
+
| `verify-ui` | UI vs 문서 |
|
|
710
|
+
| `verify-code` | 코드·과잉 구현 |
|
|
711
|
+
| `verify-security` | OWASP |
|
|
712
|
+
| `verify-performance` | Lighthouse·CWV |
|
|
713
|
+
| `verify-drizzle-schema` | Drizzle 스키마 |
|
|
714
|
+
| `verify-skills` | 패키지 배포 전 |
|
|
715
|
+
|
|
716
|
+
### 5.5. 외부 확장
|
|
717
|
+
|
|
718
|
+
| 스킬 | 언제 |
|
|
719
|
+
|:---|:---|
|
|
720
|
+
| `ext-awesome-design` | DESIGN.md·디자인 참고 |
|
|
721
|
+
| `ext-k-skill` | 한국 특화 API (코어 워크플로와 별도) |
|
|
722
|
+
|
|
723
|
+
---
|
|
724
|
+
|
|
725
|
+
## 6. 문서 시스템 요약
|
|
726
|
+
|
|
727
|
+
```text
|
|
728
|
+
기획·UI 문서 → docs-plan (01, 02)
|
|
729
|
+
기술·진행·QA → docs-dev (03, 04, 05)
|
|
730
|
+
레이어 불명 → rules-docs
|
|
731
|
+
```
|
|
732
|
+
|
|
733
|
+
---
|
|
734
|
+
|
|
735
|
+
## 7. Gate 상세
|
|
736
|
+
|
|
737
|
+
- **HTML UI Preview Gate:** `docs/02_UI_Screens/previews/`, UI 문서 링크, 사용자 피드백
|
|
738
|
+
- **UI-First Gate:** 화면·동선·CTA·데이터 흐름·로딩/빈/오류 상태
|
|
739
|
+
- **Component & Library Planning Gate:** shadcn·커스텀·재사용·라이브러리·preset
|
|
740
|
+
- **Backlog Context Lock:** Related Docs, Preconditions, Component Plan, Acceptance, Sync Check
|
|
741
|
+
- **YAGNI/KISS/DRY Gate:** `rules-dev` 정본; 프로토타입은 기록성 체크
|
|
742
|
+
|
|
743
|
+
백로그 템플릿: [영문 §7 Backlog item template](#backlog-item-template) (필드명은 영문 유지)
|
|
744
|
+
|
|
745
|
+
---
|
|
746
|
+
|
|
747
|
+
## 8. Hooks (Claude Code 자동 제안)
|
|
748
|
+
|
|
749
|
+
```bash
|
|
750
|
+
npx solmate-skills@latest install hooks
|
|
751
|
+
bash .agent/skills/hooks/install.sh
|
|
752
|
+
```
|
|
753
|
+
|
|
754
|
+
키워드·파일 패턴에 맞춰 스킬을 **제안**합니다 (강제 실행 아님). 2.0.10 false-positive 수정은 hooks 재설치로 반영.
|
|
755
|
+
|
|
756
|
+
---
|
|
757
|
+
|
|
758
|
+
## 9. 권장 프롬프트 모음
|
|
759
|
+
|
|
760
|
+
**프로젝트 진단**
|
|
761
|
+
|
|
762
|
+
```text
|
|
763
|
+
/rules-product를 사용해서 이 프로젝트의 현재 진행 상태를 진단하고, 다음 작업을 Flow Status Block 기준으로 안내해줘.
|
|
764
|
+
```
|
|
765
|
+
|
|
766
|
+
**기능 구현**
|
|
767
|
+
|
|
768
|
+
```text
|
|
769
|
+
/rules-workflow를 사용해서 현재 기능 작업을 진행해줘. 먼저 Flow Status Block으로 현재 위치를 알려주고, UI-First 흐름에 맞춰 진행해줘.
|
|
770
|
+
```
|
|
771
|
+
|
|
772
|
+
**PR 전 검증**
|
|
773
|
+
|
|
774
|
+
```text
|
|
775
|
+
/verify-implementation으로 현재 변경사항을 전체 검증해줘. Flow Status Block을 포함해서 보고해줘.
|
|
776
|
+
```
|
|
777
|
+
|
|
778
|
+
---
|
|
779
|
+
|
|
780
|
+
## 10. 관련 문서
|
|
781
|
+
|
|
782
|
+
| 문서 | 대상 | 내용 |
|
|
783
|
+
|:---|:---|:---|
|
|
784
|
+
| [README.md](./README.md) | 처음 설치 | 설치, Quick Start |
|
|
785
|
+
| [USAGE.md](./USAGE.md) | 일상 사용자 | 영문(기본) + 한국어 |
|
|
786
|
+
| `AGENTS.md` | AI | 전역 규칙 |
|
|
787
|
+
| `<skill>/SKILL.md` | AI | 스킬별 실행 정본 |
|
package/bin/cli.js
CHANGED
|
@@ -7,6 +7,9 @@ const { execSync } = require('child_process');
|
|
|
7
7
|
const IGNORED_FOLDERS = ['bin', 'node_modules', '.git', '.github', '.gemini', '.agent'];
|
|
8
8
|
const IGNORED_FILES = ['package.json', 'package-lock.json', 'AGENTS.md', 'SKILL.md', 'init-skills.sh', 'README.md', '.DS_Store', 'old_AGENTS.md'];
|
|
9
9
|
|
|
10
|
+
// Root-level docs copied to the target project on every install.
|
|
11
|
+
const PACKAGE_DOC_FILES = ['USAGE.md'];
|
|
12
|
+
|
|
10
13
|
// Skills that require a post-install script to be executed after copying.
|
|
11
14
|
// Key: skill name, Value: path relative to the skill folder.
|
|
12
15
|
const POST_INSTALL_SCRIPTS = {
|
|
@@ -28,6 +31,21 @@ function getAvailableSkills() {
|
|
|
28
31
|
.map(dirent => dirent.name);
|
|
29
32
|
}
|
|
30
33
|
|
|
34
|
+
function installPackageDocs() {
|
|
35
|
+
for (const fileName of PACKAGE_DOC_FILES) {
|
|
36
|
+
const sourcePath = path.join(packageRoot, fileName);
|
|
37
|
+
const destPath = path.join(targetProjectRoot, fileName);
|
|
38
|
+
|
|
39
|
+
if (!fs.existsSync(sourcePath)) {
|
|
40
|
+
console.warn(`Warning: ${fileName} not found in package; skipping.`);
|
|
41
|
+
continue;
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
fs.copyFileSync(sourcePath, destPath);
|
|
45
|
+
console.log(`Installed ${fileName} to project root`);
|
|
46
|
+
}
|
|
47
|
+
}
|
|
48
|
+
|
|
31
49
|
function copyFolderSync(from, to) {
|
|
32
50
|
if (!fs.existsSync(to)) {
|
|
33
51
|
fs.mkdirSync(to, { recursive: true });
|
|
@@ -64,6 +82,7 @@ function installHooks() {
|
|
|
64
82
|
console.log('Installing hooks utility...');
|
|
65
83
|
copyFolderSync(sourcePath, destPath);
|
|
66
84
|
console.log('Successfully installed hooks utility to .agent/skills/hooks');
|
|
85
|
+
installPackageDocs();
|
|
67
86
|
|
|
68
87
|
const scriptPath = path.join(destPath, 'install.sh');
|
|
69
88
|
if (fs.existsSync(scriptPath)) {
|
|
@@ -76,12 +95,14 @@ function installHooks() {
|
|
|
76
95
|
}
|
|
77
96
|
}
|
|
78
97
|
|
|
79
|
-
function installSkill(skillName) {
|
|
98
|
+
function installSkill(skillName, options = {}) {
|
|
99
|
+
const { deferPackageDocs = false } = options;
|
|
80
100
|
const skills = getAvailableSkills();
|
|
81
101
|
|
|
82
102
|
if (skillName === 'install-all') {
|
|
83
103
|
console.log('Installing all skills...');
|
|
84
|
-
skills.forEach(s => installSkill(s));
|
|
104
|
+
skills.forEach(s => installSkill(s, { deferPackageDocs: true }));
|
|
105
|
+
installPackageDocs();
|
|
85
106
|
return;
|
|
86
107
|
}
|
|
87
108
|
|
|
@@ -114,6 +135,10 @@ function installSkill(skillName) {
|
|
|
114
135
|
}
|
|
115
136
|
}
|
|
116
137
|
}
|
|
138
|
+
|
|
139
|
+
if (!deferPackageDocs) {
|
|
140
|
+
installPackageDocs();
|
|
141
|
+
}
|
|
117
142
|
}
|
|
118
143
|
|
|
119
144
|
const args = process.argv.slice(2);
|
package/package.json
CHANGED
package/rules-product/SKILL.md
CHANGED
|
@@ -5,6 +5,13 @@ description: Orchestrates the full product development pipeline from planning to
|
|
|
5
5
|
|
|
6
6
|
# Product Workflow Orchestrator
|
|
7
7
|
|
|
8
|
+
> **Human Quick Reference**
|
|
9
|
+
> - **When**: New project, resume work, or "what should I do next?"
|
|
10
|
+
> - **Invoke**: `/rules-product` or ask for a Flow Status Block diagnosis
|
|
11
|
+
> - **Prerequisites**: None — starts by scanning the repo
|
|
12
|
+
> - **Next**: `docs-plan`, `docs-dev`, `rules-react`, `rules-workflow`, or `verify-implementation` by phase
|
|
13
|
+
> - **Guide**: project root `USAGE.md` (English default, Korean below; copied on install)
|
|
14
|
+
|
|
8
15
|
You are a **workflow lead** who guides the user through the full product development pipeline. You do not do the work yourself — you diagnose the current phase, verify gate conditions, and direct the user to the right sub-skill at each step.
|
|
9
16
|
|
|
10
17
|
## Pipeline Overview
|
package/rules-workflow/SKILL.md
CHANGED
|
@@ -5,6 +5,13 @@ description: Guides the full implementation lifecycle from planning through PR.
|
|
|
5
5
|
|
|
6
6
|
# Implementation & Execution Workflow (18 Steps)
|
|
7
7
|
|
|
8
|
+
> **Human Quick Reference**
|
|
9
|
+
> - **When**: Feature implementation, commit/PR prep, 18-step workflow
|
|
10
|
+
> - **Invoke**: `/rules-workflow` after gates and backlog links are ready
|
|
11
|
+
> - **Prerequisites**: HTML UI Preview Gate, UI-First Gate, Backlog Context Lock, Component & Library Plan
|
|
12
|
+
> - **Next**: `verify-implementation` before PR
|
|
13
|
+
> - **Guide**: project root `USAGE.md` (English default, Korean below; copied on install)
|
|
14
|
+
|
|
8
15
|
Follow this workflow for feature implementation and significant code changes. Complete each phase before advancing; use the checklists to avoid skipping steps.
|
|
9
16
|
|
|
10
17
|
---
|
|
@@ -7,6 +7,13 @@ argument-hint: "[선택사항: 특정 verify 스킬 이름]"
|
|
|
7
7
|
|
|
8
8
|
# 구현 검증 (Master)
|
|
9
9
|
|
|
10
|
+
> **Human Quick Reference**
|
|
11
|
+
> - **When**: Pre-PR or pre-release full check (default verify entry point)
|
|
12
|
+
> - **Invoke**: `/verify-implementation`
|
|
13
|
+
> - **Prerequisites**: Changes to verify; runs verify-* skills based on `git diff`
|
|
14
|
+
> - **Next**: Fix failures, then re-run; use individual verify-* skills for scoped checks
|
|
15
|
+
> - **Guide**: project root `USAGE.md` (English default, Korean below; copied on install)
|
|
16
|
+
|
|
10
17
|
## 목적
|
|
11
18
|
|
|
12
19
|
프로젝트에 존재하는 모든 `verify-*` 스킬을 동적으로 탐색하여 순차적으로 실행하고 통합 검증을 수행합니다. 기본 순서를 따르되, 변경 파일과 프로젝트 특성에 따라 해당 없는 스킬은 `N/A - 사유`로 기록합니다. 코드 변경이 있으면 YAGNI/KISS/DRY Gate 통과 여부를 통합 보고서에 반드시 포함합니다.
|
package/verify-skills/SKILL.md
CHANGED
|
@@ -109,20 +109,26 @@ print("metadata ok" if not bad else "\n".join(bad))'
|
|
|
109
109
|
|
|
110
110
|
---
|
|
111
111
|
|
|
112
|
-
## Check 4: README, AGENTS, package 버전 동기화
|
|
112
|
+
## Check 4: README, AGENTS, USAGE, package 버전 동기화
|
|
113
113
|
|
|
114
114
|
- `package.json` 버전과 README의 최신 버전 문구가 일치하는지 확인한다.
|
|
115
|
+
- README가 `USAGE.md`를 링크하는지 확인한다.
|
|
116
|
+
- `bin/cli.js`가 `USAGE.md`를 프로젝트 루트로 복사하는지 확인한다.
|
|
115
117
|
- README와 AGENTS의 verify 목록이 실제 `verify-*` 디렉터리와 맞는지 확인한다.
|
|
116
118
|
|
|
117
119
|
```bash
|
|
118
120
|
node -p "require('./package.json').version"
|
|
119
121
|
grep -n "What's New in" README.md
|
|
122
|
+
grep -n "USAGE.md" README.md AGENTS.md
|
|
123
|
+
grep -n "PACKAGE_DOC_FILES\\|installPackageDocs" bin/cli.js
|
|
120
124
|
find . -maxdepth 1 -type d -name 'verify-*' -exec basename {} \; | sort
|
|
121
125
|
grep -n "verify-" README.md AGENTS.md
|
|
122
126
|
```
|
|
123
127
|
|
|
124
128
|
- 체크:
|
|
125
129
|
- [ ] README 최신 버전 문구가 `package.json`과 일치하는가?
|
|
130
|
+
- [ ] README·AGENTS가 `USAGE.md`를 참조하는가?
|
|
131
|
+
- [ ] CLI `install`이 `USAGE.md`를 프로젝트 루트로 복사하는가?
|
|
126
132
|
- [ ] README Available Skills에 새 스킬이 반영되었는가?
|
|
127
133
|
- [ ] AGENTS.md 품질 검증 목록에 새 verify 스킬이 반영되었는가?
|
|
128
134
|
|