solmate-skills 2.0.11 → 2.0.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (36) hide show
  1. package/AGENTS.md +11 -0
  2. package/CLAUDE.md +13 -3
  3. package/README.md +135 -286
  4. package/USAGE.md +893 -0
  5. package/bin/cli.js +198 -3
  6. package/bin/harness-artifact.js +621 -0
  7. package/bin/harness-artifact.test.js +520 -0
  8. package/bin/harness-check.js +373 -0
  9. package/bin/harness-check.test.js +159 -0
  10. package/bin/test.js +2 -0
  11. package/docs/01_Concept_Design/01_AGENT_HARNESS_REQUIREMENTS_ANALYSIS.md +162 -0
  12. package/docs/03_Technical_Specs/01_AGENT_HARNESS_ARCHITECTURE.md +376 -0
  13. package/docs/03_Technical_Specs/assets/01_agent_harness_data_flow.svg +94 -0
  14. package/docs/04_Logic_Progress/00_BACKLOG.md +339 -0
  15. package/docs/04_Logic_Progress/01_EXECUTION_PLAN.md +160 -0
  16. package/docs/04_Logic_Progress/03_DECISION_LOG.md +98 -0
  17. package/docs/05_QA_Validation/01_TEST_SCENARIOS.md +313 -0
  18. package/docs/05_QA_Validation/02_AGENT_HARNESS_DESIGN_REVIEW.md +100 -0
  19. package/docs/05_QA_Validation/03_AGENT_HARNESS_CONTRACT_QA.md +96 -0
  20. package/manage-collaboration/SKILL.md +2 -0
  21. package/package.json +6 -4
  22. package/rules-docs/SKILL.md +15 -1
  23. package/rules-product/SKILL.md +37 -6
  24. package/rules-product/agents/openai.yaml +2 -2
  25. package/rules-workflow/SKILL.md +38 -6
  26. package/rules-workflow/adapters/claude/solmate-context-reader.md +17 -0
  27. package/rules-workflow/adapters/claude/solmate-implementer.md +20 -0
  28. package/rules-workflow/adapters/claude/solmate-verifier.md +21 -0
  29. package/rules-workflow/agents/openai.yaml +2 -2
  30. package/rules-workflow/resources/agent-harness-contract.md +187 -0
  31. package/rules-workflow/resources/agent-harness-v1.schema.json +432 -0
  32. package/verify-docs/SKILL.md +33 -6
  33. package/verify-docs/agents/openai.yaml +2 -2
  34. package/verify-implementation/SKILL.md +21 -2
  35. package/verify-implementation/agents/openai.yaml +2 -2
  36. package/verify-skills/SKILL.md +34 -1
package/USAGE.md ADDED
@@ -0,0 +1,893 @@
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-07-17 00:33
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 project `AGENTS.md` when it is linked or installed.
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
+ npx solmate-skills@latest install agents # Refresh rules-workflow + native Claude project agents
33
+ ```
34
+
35
+ Every `install` command (single skill, `all`, `hooks`, or `agents`) copies `USAGE.md` to the **project root**. Installing `rules-workflow` or `all` also installs the namespaced Claude agents automatically.
36
+
37
+ ### Local development (symlink)
38
+
39
+ When hacking on the `solmate-skills` repo itself:
40
+
41
+ ```bash
42
+ # Run from the target project root
43
+ bash /path/to/solmate-skills/init-skills.sh
44
+ ```
45
+
46
+ This symlinks `.agent/skills/` to the repo, links `AGENTS.md` and `USAGE.md` at the project root, and links the namespaced Claude agents under `.claude/agents/`.
47
+
48
+ ---
49
+
50
+ ## 2. Situation Cheat Sheet
51
+
52
+ | You say / situation | Skill | Notes |
53
+ |:---|:---|:---|
54
+ | "Where do I start?" / new project | `rules-product` | **Recommended entry point** |
55
+ | "Where are we?" / resume work | `rules-product` | Phase diagnosis, then delegate |
56
+ | Vision, Lean Canvas, UI docs | `docs-plan` | Layers 1–2 |
57
+ | DB, API, backlog, QA docs | `docs-dev` | Layers 3–5 |
58
+ | Unsure which doc layer | `rules-docs` | 5-layer and gate rules |
59
+ | Implement a feature / pre-commit·PR | `rules-workflow` | 18-step workflow |
60
+ | React screens / components | `rules-react` | Component & Library Plan first |
61
+ | shadcn/ui setup / customization | `tools-shadcn` | preset init/apply |
62
+ | Coding conventions / overengineering | `rules-dev` | YAGNI/KISS/DRY **canonical source** |
63
+ | "Which tech should we use?" | `manage-decisions` | 6 decision-type templates |
64
+ | Full check before PR | `verify-implementation` | Runs verify-* in order |
65
+ | Docs only | `verify-docs` | Backlog, gates, metadata |
66
+ | UI vs docs | `verify-ui` | HTML Preview, flows, states |
67
+ | Code quality only | `verify-code` | Pre-PR review |
68
+ | Security | `verify-security` | OWASP Top 10 |
69
+ | Performance / Lighthouse | `verify-performance` | Core Web Vitals |
70
+ | Drizzle schema | `verify-drizzle-schema` | After schema changes |
71
+ | solmate-skills package changes | `verify-skills` | Pre-publish metadata |
72
+ | Pitch deck | `docs-pitch` | Layer 1 docs first |
73
+ | Business plan | `docs-business` | Grants, investment, partnerships |
74
+ | Branch / commit / PR (member) | `role-team-member` | |
75
+ | Deploy / DB / PR review (lead) | `role-team-lead` | |
76
+ | AI–human collaboration | `manage-collaboration` | |
77
+ | Skill package maintenance | `manage-skills` | Detect missing verify skills |
78
+ | Obsidian sync | `tools-obsidian` | |
79
+ | Premium design reference | `ext-awesome-design` | DESIGN.md templates |
80
+ | Korea-specific services | `ext-k-skill` | Law, delivery, transit, etc. |
81
+
82
+ ---
83
+
84
+ ## 3. Core Orchestrators
85
+
86
+ ```text
87
+ ┌─────────────────────┐
88
+ │ rules-product │
89
+ │ (entry · phase diag)│
90
+ └──────────┬──────────┘
91
+ │ delegates
92
+ ┌───────────────────┼───────────────────┐
93
+ ▼ ▼ ▼
94
+ ┌─────────────┐ ┌─────────────┐ ┌─────────────┐
95
+ │ docs-plan │ │rules-workflow│ │ verify-impl │
96
+ │ docs-dev │ │ (18 steps) │ │ (master QA) │
97
+ │ rules-react │ └──────┬──────┘ └──────┬──────┘
98
+ └─────────────┘ │ │
99
+ │ ▼
100
+ │ verify-docs … verify-skills
101
+
102
+ commit / PR
103
+ ```
104
+
105
+ | Skill | Role | When to use alone |
106
+ |:---|:---|:---|
107
+ | `rules-product` | Diagnose phase, check gates, delegate | **Default first step** |
108
+ | `rules-workflow` | Plan → implement → cleanup → PR (18 steps) | Feature work, commit/PR prep |
109
+ | `verify-implementation` | Run verify-* by changed files, unified report | Pre-PR / pre-release |
110
+
111
+ ### Agent harness sequence
112
+
113
+ For backlog tasks with `Work Type: code` or `Work Type: deploy`:
114
+
115
+ ```text
116
+ Coordinator
117
+ -> read-only Context Agent -> Context Receipt
118
+ -> Implementation Agent -> Change Receipt
119
+ -> read-only Verifier -> Verification Receipt
120
+ -> Coordinator completion decision
121
+ ```
122
+
123
+ - Claude Code uses `.claude/agents/solmate-context-reader.md`, `solmate-implementer.md`, and `solmate-verifier.md`.
124
+ - Codex uses available subagents or separate tasks with the same canonical contract from `rules-workflow/resources/agent-harness-contract.md`.
125
+ - The verifier reports findings but does not modify source files.
126
+ - Receipt summaries stay in the backlog; detailed verification links to a QA document or GitHub PR.
127
+ - Use warning mode for the first five real tasks, then switch to blocking checks:
128
+
129
+ ```bash
130
+ npx solmate-skills preflight TASK-000 --strict
131
+ npx solmate-skills verify TASK-000 --strict
132
+ ```
133
+
134
+ Optional v1 structured artifacts use the same warning-to-blocking migration:
135
+
136
+ ```bash
137
+ npx solmate-skills validate-harness manifest _workspace/harness/TASK-000/manifest.json
138
+ npx solmate-skills validate-harness message _workspace/harness/TASK-000/attempt-01/messages/msg-001.json --manifest _workspace/harness/TASK-000/manifest.json
139
+ npx solmate-skills validate-harness events _workspace/harness/TASK-000/events.jsonl --manifest _workspace/harness/TASK-000/manifest.json
140
+ ```
141
+
142
+ Add `--strict` for blocking validation. Contract failures then exit `1`; malformed JSON, missing files, and invalid command input exit `2`. Existing backlog-only projects do not need to create these files.
143
+
144
+ ### Individual verify-* vs master
145
+
146
+ | Situation | Use |
147
+ |:---|:---|
148
+ | Full pre-PR / pre-release | `verify-implementation` |
149
+ | Docs only changed | `verify-docs` |
150
+ | TSX screens only | `verify-ui` |
151
+ | API / auth / env changed | `verify-security` (+ `verify-code` if needed) |
152
+ | Schema only | `verify-drizzle-schema` |
153
+ | solmate-skills repo itself | `verify-skills` |
154
+
155
+ ---
156
+
157
+ ## 4. Full Pipeline (with Gates)
158
+
159
+ ```text
160
+ Phase 1 Planning docs → docs-plan (01_Concept_Design)
161
+ Phase 2 UI design docs → docs-plan (02_UI_Screens)
162
+ HTML UI Preview Gate → previews/ HTML + user feedback
163
+ UI-First Gate → screens, flows, data, states
164
+ Pre-Code Technical Brief → API, state, acceptance criteria
165
+ Component & Library Planning Gate → shadcn, custom, reuse, libraries
166
+ Context Receipt Gate → linked docs read by a read-only agent
167
+ Phase 3 React implementation → rules-react (+ tools-shadcn)
168
+ Phase 4 Dev docs → docs-dev (03–05)
169
+ Phase 5 Independent verification → Verification Receipt + verify-implementation
170
+ Phase 6 Deliverables (opt.) → docs-pitch / docs-business
171
+ ```
172
+
173
+ Implementation detail: `rules-workflow` (18 steps).
174
+ YAGNI/KISS/DRY canonical rules: `rules-dev`.
175
+
176
+ ### Flow Status Block
177
+
178
+ Agents report progress in this format (field labels may appear in Korean in project docs):
179
+
180
+ ```text
181
+ [Flow]
182
+ 현재: Phase 2 — UI 설계
183
+ Gate: UI-First Gate 진행 중
184
+ 완료: Phase 1 — Concept
185
+ 다음: Pre-Code Technical Brief
186
+ 필요 확인: 화면별 오류 상태
187
+ 권장 스킬: /docs-plan
188
+ ```
189
+
190
+ ---
191
+
192
+ ## 5. Skill Catalog (26 skills)
193
+
194
+ Each entry: **When** / **Prerequisites** / **Invoke** / **Outputs** / **Next**
195
+
196
+ ### 5.1. Governance & operations
197
+
198
+ #### `rules-product`
199
+
200
+ - **When:** New project, resume, "what should I do next?"
201
+ - **Prerequisites:** None
202
+ - **Invoke:** `/rules-product` — diagnose current progress
203
+ - **Outputs:** Flow Status Block, next skill, gate pass/fail
204
+ - **Next:** `docs-plan`, `docs-dev`, `rules-react`, `rules-workflow`, or `verify-implementation` by phase
205
+
206
+ #### `rules-workflow`
207
+
208
+ - **When:** Feature implementation, planning, commit/PR (18 steps)
209
+ - **Prerequisites:** HTML UI Preview Gate, UI-First Gate, Backlog Context Lock, Component & Library Plan, Context Receipt (code/deploy)
210
+ - **Invoke:** `/rules-workflow` — implement this backlog item
211
+ - **Outputs:** Context Receipt, plan review, Change Receipt, independent Verification Receipt, PR readiness
212
+ - **Next:** `verify-implementation`
213
+
214
+ #### `rules-dev`
215
+
216
+ - **When:** Conventions, env setup, avoid overengineering
217
+ - **Prerequisites:** Project `AGENTS.md` or `DEVELOPMENT_PRINCIPLES.md`
218
+ - **Invoke:** `/rules-dev` — is this minimal implementation?
219
+ - **Outputs:** YAGNI/KISS/DRY gate verdict, coding standards
220
+ - **Next:** `rules-workflow` when coding
221
+
222
+ #### `rules-docs`
223
+
224
+ - **When:** Doc structure, metadata, gates; unsure which layer
225
+ - **Prerequisites:** None
226
+ - **Invoke:** `/rules-docs` — is this doc in the right layer?
227
+ - **Outputs:** 5-layer placement, Related Documents, gate requirements
228
+ - **Next:** `docs-plan` or `docs-dev`
229
+
230
+ #### `manage-collaboration`
231
+
232
+ - **When:** Branch/PR/approval flow, AI–human standards
233
+ - **Prerequisites:** Team role agreed (`role-team-lead` / `role-team-member`)
234
+ - **Invoke:** `/manage-collaboration` — does this PR flow match standards?
235
+ - **Outputs:** Collaboration checklist
236
+ - **Next:** `role-team-member` or `role-team-lead`
237
+
238
+ #### `manage-decisions`
239
+
240
+ - **When:** Stack, DB, API, UX, architecture decisions
241
+ - **Prerequisites:** None (conversation-driven)
242
+ - **Invoke:** `/manage-decisions` — guide DB design decision
243
+ - **Outputs:** Typed questions, decision record
244
+ - **Next:** `docs-dev` or `rules-workflow`
245
+
246
+ #### `manage-skills`
247
+
248
+ - **When:** After adding/editing skills in solmate-skills repo
249
+ - **Prerequisites:** Skill file changes in session
250
+ - **Invoke:** `/manage-skills` — any missing verify skills?
251
+ - **Outputs:** Gap list, update suggestions
252
+ - **Next:** `verify-skills`
253
+
254
+ #### `role-team-lead`
255
+
256
+ - **When:** Lead — onboarding, branch protection, PR review, DB, deploy
257
+ - **Prerequisites:** Lead role agreed
258
+ - **Invoke:** `/role-team-lead` — pre-deploy checklist
259
+ - **Outputs:** Lead responsibility checklist
260
+ - **Next:** `verify-implementation`, `manage-collaboration`
261
+
262
+ #### `role-team-member`
263
+
264
+ - **When:** Member — branch, Conventional Commits (Korean), PR
265
+ - **Prerequisites:** Member role agreed
266
+ - **Invoke:** `/role-team-member` — review commit message
267
+ - **Outputs:** Branch/commit/PR guide
268
+ - **Next:** `rules-workflow`, `verify-code`
269
+
270
+ ### 5.2. Documentation
271
+
272
+ #### `docs-plan`
273
+
274
+ - **When:** Vision, Lean Canvas, specs, UI design, HTML previews
275
+ - **Prerequisites:** Ask before Write
276
+ - **Invoke:** `/docs-plan` — draft Layer 1 planning docs
277
+ - **Outputs:** `docs/01_*`, `docs/02_*`, `previews/*.html`
278
+ - **Next:** `verify-docs`, then `docs-dev` or `rules-react`
279
+
280
+ #### `docs-dev`
281
+
282
+ - **When:** DB schema, API, backlog, roadmap, QA, component/library plans
283
+ - **Prerequisites:** Related Concept/UI docs; backlog needs Related Docs
284
+ - **Invoke:** `/docs-dev` — write API spec and backlog
285
+ - **Outputs:** `docs/03_*`, `docs/04_*`, `docs/05_*`
286
+ - **Next:** `rules-workflow`, `verify-docs`
287
+
288
+ #### `docs-pitch`
289
+
290
+ - **When:** Investor, hackathon, demo day deck
291
+ - **Prerequisites:** Layer 1 (`VISION_CORE`, `LEAN_CANVAS`, `PRODUCT_SPECS`)
292
+ - **Invoke:** `/docs-pitch` — Reveal.js HTML deck
293
+ - **Outputs:** Markdown or `pitch/index.html`
294
+ - **Next:** `verify-docs` (optional)
295
+
296
+ #### `docs-business`
297
+
298
+ - **When:** Grants, investment, partnership business plan
299
+ - **Prerequisites:** Layer 1 planning docs
300
+ - **Invoke:** `/docs-business` — draft business plan
301
+ - **Outputs:** Structured business plan Markdown
302
+ - **Next:** Standalone deliverable
303
+
304
+ ### 5.3. Development & UI
305
+
306
+ #### `rules-react`
307
+
308
+ - **When:** React pages, components, refactor
309
+ - **Prerequisites:** UI docs, HTML Preview confirmed, Component & Library Plan
310
+ - **Invoke:** `/rules-react` — implement this screen
311
+ - **Outputs:** React code under `src/`
312
+ - **Next:** `verify-ui`, `verify-code`
313
+
314
+ #### `tools-shadcn`
315
+
316
+ - **When:** shadcn/ui init, add components, theme/preset
317
+ - **Prerequisites:** Component & Library Plan preset action
318
+ - **Invoke:** `/tools-shadcn` — add button, form to project
319
+ - **Outputs:** shadcn components, preset commands
320
+ - **Next:** `rules-react`
321
+
322
+ #### `tools-obsidian`
323
+
324
+ - **When:** Sync project docs with Obsidian vault
325
+ - **Prerequisites:** Vault path
326
+ - **Invoke:** `/tools-obsidian` — check sync status
327
+ - **Outputs:** Link status, metadata compatibility
328
+ - **Next:** None
329
+
330
+ ### 5.4. Verification (verify-*)
331
+
332
+ #### `verify-implementation`
333
+
334
+ - **When:** Pre-PR unified check (**default**)
335
+ - **Prerequisites:** Changes to verify
336
+ - **Invoke:** `/verify-implementation` — full verification
337
+ - **Outputs:** Pass/Fail report incl. YAGNI/KISS/DRY Gate
338
+ - **Next:** Fix and re-run, or scoped verify-* skills
339
+
340
+ #### `verify-docs`
341
+
342
+ - **When:** After doc edits; backlog/gate alignment
343
+ - **Prerequisites:** `docs/` changes
344
+ - **Invoke:** `/verify-docs` — validate backlog Related Docs
345
+ - **Outputs:** Layer/metadata/gate violations
346
+ - **Next:** `docs-plan` / `docs-dev`
347
+
348
+ #### `verify-ui`
349
+
350
+ - **When:** After React/TSX UI work
351
+ - **Prerequisites:** `docs/02_UI_Screens/`, HTML Preview
352
+ - **Invoke:** `/verify-ui` — does UI match docs?
353
+ - **Outputs:** Screen/flow/state mismatches
354
+ - **Next:** `rules-react`
355
+
356
+ #### `verify-code`
357
+
358
+ - **When:** Pre-PR code quality, overengineering
359
+ - **Prerequisites:** Code changes
360
+ - **Invoke:** `/verify-code` — pre-PR review
361
+ - **Outputs:** Issue table (YAGNI/KISS/DRY tags)
362
+ - **Next:** Fix or `verify-implementation`
363
+
364
+ #### `verify-security`
365
+
366
+ - **When:** auth, API, middleware, env, DB changes
367
+ - **Prerequisites:** Security-sensitive changes
368
+ - **Invoke:** `/verify-security` — OWASP check
369
+ - **Outputs:** Vulnerabilities, auth, secrets
370
+ - **Next:** Fix and re-run
371
+
372
+ #### `verify-performance`
373
+
374
+ - **When:** Page, layout, images, bundle; pre-deploy
375
+ - **Prerequisites:** Frontend performance impact
376
+ - **Invoke:** `/verify-performance` — Lighthouse check
377
+ - **Outputs:** LCP, CLS, bundle, image issues
378
+ - **Next:** Fix and re-run
379
+
380
+ #### `verify-drizzle-schema`
381
+
382
+ - **When:** Drizzle schema/migration changes
383
+ - **Prerequisites:** `DB_SCHEMA.md` or equivalent
384
+ - **Invoke:** `/verify-drizzle-schema` — schema alignment
385
+ - **Outputs:** Schema/doc mismatches
386
+ - **Next:** `docs-dev`
387
+
388
+ #### `verify-skills`
389
+
390
+ - **When:** solmate-skills package edit, pre-publish
391
+ - **Prerequisites:** `SKILL.md`, `package.json`, `README.md`, `AGENTS.md` changes
392
+ - **Invoke:** `/verify-skills` — release readiness
393
+ - **Outputs:** CLI, frontmatter, version sync, npm pack
394
+ - **Next:** `npm publish`
395
+
396
+ ### 5.5. External extensions
397
+
398
+ #### `ext-awesome-design`
399
+
400
+ - **When:** Premium design tokens, DESIGN.md, brand UI styles
401
+ - **Prerequisites:** None (reference library)
402
+ - **Invoke:** Reference stripe DESIGN.md from ext-awesome-design
403
+ - **Outputs:** Design reference, DESIGN.md draft
404
+ - **Next:** `docs-plan`, `rules-react`
405
+
406
+ #### `ext-k-skill`
407
+
408
+ - **When:** Korea-specific data (law, delivery, KTX, fine dust, etc.)
409
+ - **Prerequisites:** Per-feature setup in ext-k-skill package
410
+ - **Invoke:** See ext-k-skill README and feature guides
411
+ - **Outputs:** Feature-specific API results
412
+ - **Next:** None (tooling)
413
+
414
+ > `ext-k-skill` is separate from the core Solmate workflow. Run `k-skill-setup` and per-feature docs after install.
415
+
416
+ ---
417
+
418
+ ## 6. Documentation System
419
+
420
+ ### Which skill writes which docs
421
+
422
+ ```text
423
+ Product vision, Lean Canvas, UI design → docs-plan
424
+ DB schema, API specs, roadmap, QA → docs-dev
425
+ Unsure which layer? → rules-docs
426
+ ```
427
+
428
+ ### 5-Layer structure
429
+
430
+ ```text
431
+ docs/
432
+ ├── 01_Concept_Design/ ← docs-plan
433
+ ├── 02_UI_Screens/ ← docs-plan (+ previews/)
434
+ ├── 03_Technical_Specs/ ← docs-dev
435
+ ├── 04_Logic_Progress/ ← docs-dev
436
+ └── 05_QA_Validation/ ← docs-dev
437
+ ```
438
+
439
+ ---
440
+
441
+ ## 7. Gates (detail)
442
+
443
+ ### HTML UI Preview Gate
444
+
445
+ - Path: `docs/02_UI_Screens/previews/`
446
+ - Link from UI docs with relative paths
447
+ - Show HTML to user before implementation; record feedback
448
+
449
+ ### UI-First Gate
450
+
451
+ - Screen structure, user paths, CTAs, data flow
452
+ - Loading, empty, error states before coding
453
+
454
+ ### Component & Library Planning Gate
455
+
456
+ - shadcn/ui, custom, reused components
457
+ - Libraries to add/avoid, preset action (`init --preset`, `apply --preset`, etc.)
458
+ - Record in backlog `Component & Library Plan`
459
+
460
+ ### Backlog Context Lock
461
+
462
+ Required fields per item in `docs/04_Logic_Progress/00_BACKLOG.md`:
463
+
464
+ - `Related Concept Docs`, `Related UI Docs`, `Related HTML Preview`
465
+ - `Related Technical Docs`, `Related QA Docs`
466
+ - `Work Type`, `Implementation Preconditions`, `Component & Library Plan`
467
+ - `Context Receipt`, `Change Receipt`, `Verification Receipt`
468
+ - `Acceptance Criteria`, `Document Sync Check`
469
+
470
+ Use `N/A - reason` when a doc does not exist. Pause implementation if a missing doc blocks a safe decision.
471
+
472
+ ### Agent Harness Gate
473
+
474
+ - Canonical contract: `rules-workflow/resources/agent-harness-contract.md`
475
+ - `code` and `deploy`: Context Receipt before implementation; Verification Receipt before Done, PR, merge, publish, or deploy
476
+ - `docs` and `prototype`: advisory receipts
477
+ - Context and Verification agents are read-only
478
+ - Verification details must link to an existing `docs/05_QA_Validation/` document or GitHub PR
479
+ - Default CLI mode is `warning`; `--strict` returns a blocking non-zero exit
480
+
481
+ ### YAGNI/KISS/DRY Gate
482
+
483
+ - **Canonical:** `rules-dev` § Minimal Implementation Gate
484
+ - Referenced by `rules-workflow`, `verify-code` Area 3, `verify-implementation` report
485
+ - Prototype/spike: advisory only; do not drop security, validation, or error handling for "simplicity"
486
+
487
+ ### Backlog item template
488
+
489
+ <a id="backlog-item-template"></a>
490
+
491
+ ```markdown
492
+ ### [ ] TASK-000: Implement feature name
493
+
494
+ - Status: ToDo
495
+ - Work Type: code
496
+ - Related Concept Docs:
497
+ - [Product Specs](../01_Concept_Design/03_PRODUCT_SPECS.md) - feature purpose and user value
498
+ - Related UI Docs:
499
+ - [Screen Flow](../02_UI_Screens/00_SCREEN_FLOW.md) - target screen and interaction flow
500
+ - Related HTML Preview:
501
+ - [Main Flow Preview](../02_UI_Screens/previews/01_main_flow_preview.html) - browser-viewable UI for user review
502
+ - Related Technical Docs:
503
+ - [API Specs](../03_Technical_Specs/02_API_SPECS.md) - endpoint and data contract
504
+ - Related QA Docs:
505
+ - [QA Checklist](../05_QA_Validation/02_QA_CHECKLIST.md) - acceptance and release criteria
506
+ - Implementation Preconditions:
507
+ - [ ] Read all related documents before coding
508
+ - [ ] Confirm screen/UI before coding
509
+ - [ ] Show the HTML UI preview to the user and capture feedback
510
+ - [ ] Confirm user path and screen-by-screen data flow
511
+ - [ ] Confirm loading, empty, and error states
512
+ - [ ] Confirm implementation scope does not conflict with documented intent
513
+ - Context Receipt:
514
+ - Status: PENDING
515
+ - Required References Read:
516
+ - PENDING - repeat every linked Related document after reading it
517
+ - Constraints:
518
+ - PENDING - extracted implementation constraints
519
+ - Conflicts: PENDING - use `None` only after checking
520
+ - Component & Library Plan:
521
+ - shadcn/ui components: button, card, form, or `N/A - reason`
522
+ - Custom components: feature-specific components or `N/A - reason`
523
+ - Reused components: existing paths or `N/A - reason`
524
+ - New libraries: package names and reasons or `N/A - reason`
525
+ - Libraries intentionally not added: rejected options and reasons or `N/A - reason`
526
+ - shadcn preset action: init --preset / apply --preset / apply --only theme / N/A - reason
527
+ - Acceptance Criteria:
528
+ - [ ] Feature follows the confirmed screen structure and user path
529
+ - [ ] Feature behavior matches linked Concept/UI/Technical docs
530
+ - [ ] QA criteria are testable and satisfied
531
+ - Change Receipt:
532
+ - Files Changed:
533
+ - PENDING
534
+ - Requirements Covered:
535
+ - PENDING
536
+ - Excluded Scope: PENDING
537
+ - Basic Checks:
538
+ - PENDING
539
+ - Remaining Risks: PENDING
540
+ - Verification Receipt:
541
+ - Status: PENDING
542
+ - Commands and Results:
543
+ - PENDING - `command` - PASS/FAIL - exact scope and result
544
+ - Unrun Checks:
545
+ - PENDING - skipped checks and reasons
546
+ - Detailed Evidence:
547
+ - PENDING - link an existing QA document or GitHub PR
548
+ - Document Sync Check:
549
+ - [ ] No mismatch between implementation and linked documents
550
+ - [ ] Update related documents if implementation changes the agreed behavior
551
+ ```
552
+
553
+ ---
554
+
555
+ ## 8. Hooks (Claude Code suggestions)
556
+
557
+ Keyword and file-pattern **suggestions** (not forced runs):
558
+
559
+ ```bash
560
+ npx solmate-skills@latest install hooks
561
+ bash .agent/skills/hooks/install.sh
562
+ ```
563
+
564
+ | Script | Event | Examples |
565
+ |:---|:---|:---|
566
+ | `solmate-suggest.sh` | UserPromptSubmit | decisions, security, performance, PR, docs |
567
+ | `solmate-watch.sh` | PreToolUse (Write/Edit) | `schema.ts`, `page.tsx`, `SKILL.md`, `AGENTS.md` |
568
+
569
+ Re-run `install hooks` to pick up 2.0.10 false-positive fixes on existing projects.
570
+
571
+ ---
572
+
573
+ ## 9. Recommended Prompts
574
+
575
+ **Project diagnosis (new or resume)**
576
+
577
+ ```text
578
+ Use /rules-product to diagnose this project's current progress and recommend next steps with a Flow Status Block.
579
+ ```
580
+
581
+ **Feature implementation**
582
+
583
+ ```text
584
+ Use /rules-workflow for this feature. Start with a Flow Status Block and follow the UI-First flow.
585
+ ```
586
+
587
+ **Pre-PR verification**
588
+
589
+ ```text
590
+ Run /verify-implementation on current changes. Include a Flow Status Block in the report.
591
+ ```
592
+
593
+ ---
594
+
595
+ ## 10. Related Documents
596
+
597
+ | Document | Audience | Content |
598
+ |:---|:---|:---|
599
+ | [README.md](./README.md) | First-time installers | Install, 5-minute start, changelog |
600
+ | [USAGE.md](./USAGE.md) (this file) | Daily users | Cheat sheet, catalog, gates (EN + KO) |
601
+ | `AGENTS.md` | Installed project AI | Global rules, skill table, suggestions |
602
+ | `<skill>/SKILL.md` | AI agents | Per-skill execution spec |
603
+
604
+ ---
605
+
606
+ # solmate-skills Usage Guide (Korean)
607
+
608
+ <a id="solmate-skills-usage-guide-korean"></a>
609
+
610
+ **언어:** [English (default)](#solmate-skills-usage-guide) · 한국어 (아래)
611
+
612
+ 사람이 읽기 위한 스킬 사용법 가이드입니다.
613
+ 에이전트 실행 규칙의 정본은 각 `SKILL.md`와 프로젝트에 링크 또는 설치된 `AGENTS.md`입니다.
614
+
615
+ ---
616
+
617
+ ## 1. 스킬 호출 방법
618
+
619
+ ### Cursor / Claude Code (권장)
620
+
621
+ 채팅에서 슬래시 명령 또는 자연어로 호출합니다.
622
+
623
+ ```text
624
+ /rules-product
625
+ /rules-workflow를 사용해서 이 기능 구현을 진행해줘
626
+ /verify-implementation으로 현재 변경사항을 검증해줘
627
+ ```
628
+
629
+ ### 설치 위치
630
+
631
+ ```bash
632
+ npx solmate-skills@latest install all # .agent/skills/<skill-name>/ + ./USAGE.md
633
+ npx solmate-skills@latest install hooks # Claude Code 자동 제안 (별도) + ./USAGE.md
634
+ npx solmate-skills@latest install agents # rules-workflow + Claude 프로젝트 에이전트 갱신
635
+ ```
636
+
637
+ 모든 `install` 명령(단일 스킬, `all`, `hooks`, `agents`)은 `USAGE.md`를 **프로젝트 루트**에 복사합니다. `rules-workflow` 또는 `all` 설치 시 Claude 에이전트도 자동 설치됩니다.
638
+
639
+ ### 로컬 개발 (symlink)
640
+
641
+ `solmate-skills` 저장소를 직접 수정하며 테스트할 때:
642
+
643
+ ```bash
644
+ # 대상 프로젝트 루트에서 실행
645
+ bash /path/to/solmate-skills/init-skills.sh
646
+ ```
647
+
648
+ `.agent/skills/`가 저장소로 symlink되고, `AGENTS.md`와 `USAGE.md`가 루트에 링크되며, `.claude/agents/`에 Solmate 에이전트가 연결됩니다.
649
+
650
+ ---
651
+
652
+ ## 2. 상황별 스킬 선택 (치트시트)
653
+
654
+ | 사용자가 말하는 것 | 추천 스킬 | 비고 |
655
+ |:---|:---|:---|
656
+ | "뭐부터 해야 해?" / 신규 프로젝트 | `rules-product` | **가장 권장하는 시작점** |
657
+ | "지금 어디까지 왔지?" / 작업 재개 | `rules-product` | Phase 진단 후 다음 스킬 위임 |
658
+ | 비전·린캔버스·화면 설계 문서 | `docs-plan` | Layer 1-2 |
659
+ | DB·API·백로그·QA 문서 | `docs-dev` | Layer 3-5 |
660
+ | 문서 구조가 맞는지 모르겠음 | `rules-docs` | 5레이어·게이트 규칙 정본 |
661
+ | 기능 하나 구현 / 커밋·PR 전 | `rules-workflow` | 18단계 구현 워크플로 |
662
+ | React 화면·컴포넌트 구현 | `rules-react` | Component & Library Plan 선행 |
663
+ | shadcn/ui 설치·커스터마이징 | `tools-shadcn` | preset init/apply 포함 |
664
+ | 코딩 컨벤션·과잉 구현 방지 | `rules-dev` | YAGNI/KISS/DRY **정본** |
665
+ | "이거 어떤 기술 쓸까?" / 설계 결정 | `manage-decisions` | 6개 결정 유형 질문 템플릿 |
666
+ | PR 전 **전체** 점검 | `verify-implementation` | verify-* 통합 실행 |
667
+ | 문서만 점검 | `verify-docs` | 백로그·게이트·메타데이터 |
668
+ | UI가 문서와 맞는지 | `verify-ui` | HTML Preview·동선·상태 |
669
+ | 코드 품질·과잉 구현만 | `verify-code` | PR 전 코드 리뷰 |
670
+ | 보안 점검 | `verify-security` | OWASP Top 10 |
671
+ | 성능·Lighthouse | `verify-performance` | Core Web Vitals |
672
+ | Drizzle 스키마 | `verify-drizzle-schema` | 스키마 변경 시 |
673
+ | solmate-skills 패키지 수정 후 | `verify-skills` | 배포 전 메타데이터 검증 |
674
+ | 피치덱 | `docs-pitch` | Layer 1 문서 선행 |
675
+ | 사업계획서 | `docs-business` | 정부 지원·투자 심사용 |
676
+ | 브랜치·커밋·PR 규칙 (팀원) | `role-team-member` | |
677
+ | 배포·DB·PR 리뷰 (팀장) | `role-team-lead` | |
678
+ | AI-인간 협업 표준 | `manage-collaboration` | |
679
+ | 스킬 패키지 유지보수 | `manage-skills` | verify 스킬 누락 탐지 |
680
+ | Obsidian 동기화 | `tools-obsidian` | |
681
+ | 프리미엄 디자인 참고 | `ext-awesome-design` | DESIGN.md 템플릿 |
682
+ | 한국 특화 서비스 조회 | `ext-k-skill` | 법률·배송·교통 등 |
683
+
684
+ ---
685
+
686
+ ## 3. 핵심 오케스트레이터 관계
687
+
688
+ | 스킬 | 역할 | 단독 사용 시점 |
689
+ |:---|:---|:---|
690
+ | `rules-product` | 프로젝트 Phase 진단, Gate 확인, 하위 스킬 위임 | **항상 첫 진입점**으로 권장 |
691
+ | `rules-workflow` | 승인된 문서 기준으로 계획→구현→정리→PR (18단계) | 기능 구현·커밋·PR 직전 |
692
+ | `verify-implementation` | 변경 파일에 맞춰 verify-* 순차 실행·통합 보고 | PR·배포 전 최종 점검 |
693
+
694
+ ### 에이전트 하네스 순서
695
+
696
+ `Work Type`이 `code` 또는 `deploy`인 백로그 작업은 다음 순서로 진행합니다.
697
+
698
+ ```text
699
+ Coordinator
700
+ -> 읽기 전용 Context Agent -> Context Receipt
701
+ -> Implementation Agent -> Change Receipt
702
+ -> 읽기 전용 Verifier -> Verification Receipt
703
+ -> Coordinator 완료 판단
704
+ ```
705
+
706
+ - Claude Code는 `.claude/agents/solmate-*.md`를 사용합니다.
707
+ - Codex는 `rules-workflow/resources/agent-harness-contract.md`의 같은 계약을 subagent 또는 별도 task에 전달합니다.
708
+ - 검증자는 문제를 직접 수정하지 않고 Implementation Agent로 돌려보냅니다.
709
+ - Receipt 요약은 백로그에, 상세 검증 근거는 QA 문서 또는 GitHub PR에 남깁니다.
710
+ - 처음 5개 실제 작업은 warning으로 확인한 뒤 blocking으로 전환합니다.
711
+
712
+ ```bash
713
+ npx solmate-skills preflight TASK-000 --strict
714
+ npx solmate-skills verify TASK-000 --strict
715
+ ```
716
+
717
+ 선택형 v1 구조화 산출물도 같은 warning-to-blocking 마이그레이션을 사용합니다.
718
+
719
+ ```bash
720
+ npx solmate-skills validate-harness manifest _workspace/harness/TASK-000/manifest.json
721
+ npx solmate-skills validate-harness message _workspace/harness/TASK-000/attempt-01/messages/msg-001.json --manifest _workspace/harness/TASK-000/manifest.json
722
+ npx solmate-skills validate-harness events _workspace/harness/TASK-000/events.jsonl --manifest _workspace/harness/TASK-000/manifest.json
723
+ ```
724
+
725
+ 차단 검증에는 `--strict`를 추가합니다. 계약 위반은 종료 코드 `1`, JSON 파싱·파일·명령 입력 오류는 종료 코드 `2`입니다. 기존 백로그 Receipt만 사용하는 프로젝트는 이 파일을 만들 필요가 없습니다.
726
+
727
+ ### verify-* 개별 vs 통합
728
+
729
+ | 상황 | 사용 |
730
+ |:---|:---|
731
+ | PR·배포 전 전체 점검 | `verify-implementation` |
732
+ | 문서만 수정함 | `verify-docs` |
733
+ | TSX 화면만 수정함 | `verify-ui` |
734
+ | API·auth·env 수정함 | `verify-security` (+ 필요 시 `verify-code`) |
735
+ | 스키마만 수정함 | `verify-drizzle-schema` |
736
+ | solmate-skills 저장소 자체 수정 | `verify-skills` |
737
+
738
+ ---
739
+
740
+ ## 4. 전체 파이프라인 (Gate 포함)
741
+
742
+ ```text
743
+ Phase 1 기획문서 → docs-plan (01_Concept_Design)
744
+ Phase 2 UI 설계 문서 → docs-plan (02_UI_Screens)
745
+ HTML UI Preview Gate → previews/ HTML + 사용자 피드백
746
+ UI-First Gate → 화면·동선·데이터 흐름·상태 확인
747
+ Pre-Code Technical Brief → API·상태·acceptance criteria 합의
748
+ Component & Library Planning Gate → shadcn·커스텀·재사용·라이브러리 계획
749
+ Context Receipt Gate → 읽기 전용 에이전트의 관련 문서 확인
750
+ Phase 3 React 구현 → rules-react (+ tools-shadcn)
751
+ Phase 4 개발문서 → docs-dev (03~05)
752
+ Phase 5 독립 품질 검증 → Verification Receipt + verify-implementation
753
+ Phase 6 전달물 (선택) → docs-pitch / docs-business
754
+ ```
755
+
756
+ 구현 상세: `rules-workflow` (18단계). YAGNI/KISS/DRY **정본**: `rules-dev`.
757
+
758
+ ### Flow Status Block
759
+
760
+ ```text
761
+ [Flow]
762
+ 현재: Phase 2 — UI 설계
763
+ Gate: UI-First Gate 진행 중
764
+ 완료: Phase 1 — Concept
765
+ 다음: Pre-Code Technical Brief
766
+ 필요 확인: 화면별 오류 상태
767
+ 권장 스킬: /docs-plan
768
+ ```
769
+
770
+ ---
771
+
772
+ ## 5. 스킬 카탈로그 (26개)
773
+
774
+ 각 항목: **언제** / **선행 조건** / **호출 예** / **산출물** / **다음 스킬**
775
+ (스킬 이름·구조는 영문 섹션 [§5](#5-skill-catalog-26-skills)과 동일합니다.)
776
+
777
+ ### 5.1. 운영 및 거버넌스
778
+
779
+ | 스킬 | 언제 | 다음 스킬 |
780
+ |:---|:---|:---|
781
+ | `rules-product` | 신규·재개·"뭘 해야 하지?" | Phase별 위임 |
782
+ | `rules-workflow` | 기능 구현·18단계·PR 전 | `verify-implementation` |
783
+ | `rules-dev` | 컨벤션·과잉 구현 방지 | `rules-workflow` |
784
+ | `rules-docs` | 문서 레이어·게이트 확인 | `docs-plan` / `docs-dev` |
785
+ | `manage-collaboration` | 브랜치·PR·협업 표준 | role 스킬 |
786
+ | `manage-decisions` | 기술·DB·API·UX 결정 | `docs-dev` / `rules-workflow` |
787
+ | `manage-skills` | 스킬 패키지 수정 후 | `verify-skills` |
788
+ | `role-team-lead` | 팀장 책임·배포 | `verify-implementation` |
789
+ | `role-team-member` | 팀원·커밋·PR | `rules-workflow` |
790
+
791
+ ### 5.2. 문서 작성
792
+
793
+ | 스킬 | 언제 | 산출물 |
794
+ |:---|:---|:---|
795
+ | `docs-plan` | Layer 1-2, HTML Preview | `01_*`, `02_*`, `previews/` |
796
+ | `docs-dev` | Layer 3-5, 백로그 | `03_*` ~ `05_*` |
797
+ | `docs-pitch` | 피치덱 | MD 또는 Reveal HTML |
798
+ | `docs-business` | 사업계획서 | 사업계획서 MD |
799
+
800
+ ### 5.3. 개발 및 UI
801
+
802
+ | 스킬 | 언제 | 선행 조건 |
803
+ |:---|:---|:---|
804
+ | `rules-react` | React 구현 | UI 문서·Preview·Component Plan |
805
+ | `tools-shadcn` | shadcn/ui | preset action |
806
+ | `tools-obsidian` | Obsidian 동기화 | 볼트 경로 |
807
+
808
+ ### 5.4. 품질 검증
809
+
810
+ | 스킬 | 언제 |
811
+ |:---|:---|
812
+ | `verify-implementation` | PR 전 통합 (**기본**) |
813
+ | `verify-docs` | 문서·백로그·게이트 |
814
+ | `verify-ui` | UI vs 문서 |
815
+ | `verify-code` | 코드·과잉 구현 |
816
+ | `verify-security` | OWASP |
817
+ | `verify-performance` | Lighthouse·CWV |
818
+ | `verify-drizzle-schema` | Drizzle 스키마 |
819
+ | `verify-skills` | 패키지 배포 전 |
820
+
821
+ ### 5.5. 외부 확장
822
+
823
+ | 스킬 | 언제 |
824
+ |:---|:---|
825
+ | `ext-awesome-design` | DESIGN.md·디자인 참고 |
826
+ | `ext-k-skill` | 한국 특화 API (코어 워크플로와 별도) |
827
+
828
+ ---
829
+
830
+ ## 6. 문서 시스템 요약
831
+
832
+ ```text
833
+ 기획·UI 문서 → docs-plan (01, 02)
834
+ 기술·진행·QA → docs-dev (03, 04, 05)
835
+ 레이어 불명 → rules-docs
836
+ ```
837
+
838
+ ---
839
+
840
+ ## 7. Gate 상세
841
+
842
+ - **HTML UI Preview Gate:** `docs/02_UI_Screens/previews/`, UI 문서 링크, 사용자 피드백
843
+ - **UI-First Gate:** 화면·동선·CTA·데이터 흐름·로딩/빈/오류 상태
844
+ - **Component & Library Planning Gate:** shadcn·커스텀·재사용·라이브러리·preset
845
+ - **Backlog Context Lock:** Related Docs, Preconditions, Component Plan, Acceptance, Sync Check
846
+ - **Agent Harness Gate:** code/deploy 작업은 Context Receipt와 독립 Verification Receipt 필수
847
+ - **YAGNI/KISS/DRY Gate:** `rules-dev` 정본; 프로토타입은 기록성 체크
848
+
849
+ 백로그 템플릿: [영문 §7 Backlog item template](#backlog-item-template) (필드명은 영문 유지)
850
+
851
+ ---
852
+
853
+ ## 8. Hooks (Claude Code 자동 제안)
854
+
855
+ ```bash
856
+ npx solmate-skills@latest install hooks
857
+ bash .agent/skills/hooks/install.sh
858
+ ```
859
+
860
+ 키워드·파일 패턴에 맞춰 스킬을 **제안**합니다 (강제 실행 아님). 2.0.10 false-positive 수정은 hooks 재설치로 반영.
861
+
862
+ ---
863
+
864
+ ## 9. 권장 프롬프트 모음
865
+
866
+ **프로젝트 진단**
867
+
868
+ ```text
869
+ /rules-product를 사용해서 이 프로젝트의 현재 진행 상태를 진단하고, 다음 작업을 Flow Status Block 기준으로 안내해줘.
870
+ ```
871
+
872
+ **기능 구현**
873
+
874
+ ```text
875
+ /rules-workflow를 사용해서 현재 기능 작업을 진행해줘. 먼저 Flow Status Block으로 현재 위치를 알려주고, UI-First 흐름에 맞춰 진행해줘.
876
+ ```
877
+
878
+ **PR 전 검증**
879
+
880
+ ```text
881
+ /verify-implementation으로 현재 변경사항을 전체 검증해줘. Flow Status Block을 포함해서 보고해줘.
882
+ ```
883
+
884
+ ---
885
+
886
+ ## 10. 관련 문서
887
+
888
+ | 문서 | 대상 | 내용 |
889
+ |:---|:---|:---|
890
+ | [README.md](./README.md) | 처음 설치 | 설치, Quick Start |
891
+ | [USAGE.md](./USAGE.md) | 일상 사용자 | 영문(기본) + 한국어 |
892
+ | `AGENTS.md` | AI | 전역 규칙 |
893
+ | `<skill>/SKILL.md` | AI | 스킬별 실행 정본 |