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/AGENTS.md CHANGED
@@ -99,6 +99,15 @@
99
99
  - **프로토타입 예외**: 프로토타입·스파이크·탐색 단계에서는 차단 조건이 아니라 기록성 체크로 적용한다.
100
100
  - **안전 예외**: 검증, 인증·인가, 에러 처리, 접근성, 보안, 데이터 보존, 테스트 가능성은 단순화를 이유로 제거하지 않는다.
101
101
 
102
+ ### 3.3. Agent Harness Gate (Context / Implementation / Verification)
103
+ - **정본 위치**: 역할·권한·인계·Receipt 상세 형식은 `rules-workflow/resources/agent-harness-contract.md`를 따른다.
104
+ - **적용 범위**: `Work Type`이 `code` 또는 `deploy`인 백로그 작업에 필수로 적용한다. `docs`, `prototype`은 기록성 체크로 적용한다.
105
+ - **구현 전 차단**: `blocking` 모드에서는 읽기 전용 Context Agent가 모든 Related 문서를 읽고 PASS Context Receipt를 남기지 않으면 구현을 시작할 수 없다.
106
+ - **완료 전 차단**: `blocking` 모드에서는 읽기 전용 Verification Agent가 명령 결과와 QA 문서 또는 PR 근거를 포함한 PASS Verification Receipt를 남기지 않으면 Done, PR, merge, publish, deploy로 이동할 수 없다.
107
+ - **역할 분리**: Implementation Agent가 작성한 Change Receipt는 독립 검증이 아니다. Verification Agent는 발견 사항을 직접 수정하지 않고 Coordinator를 통해 Implementation Agent로 반환한다.
108
+ - **Claude와 Codex**: Claude Code는 `.claude/agents/solmate-*.md`를 사용한다. Codex는 `rules-workflow` 정본을 사용 가능한 subagent 또는 별도 task에 전달한다.
109
+ - **강제 수준**: 처음 5개 실제 작업은 `warning` 결과를 기록하고 사용자 확인 후 진행한다. 이후 `npx solmate-skills preflight TASK-ID --strict`와 `npx solmate-skills verify TASK-ID --strict`를 차단 게이트로 사용한다.
110
+
102
111
  ## 4. Skills & AI Capabilities
103
112
  AI 에이전트는 본 프로젝트에 설치된 다음 **26개 스킬**을 활용하여 작업을 수행하며, 모든 작업 결과물은 이 스킬들의 검증 가이드를 통과해야 한다.
104
113
 
@@ -160,3 +169,5 @@ AI 에이전트는 사용자가 스킬을 호출하지 않아도, 아래 상황
160
169
 
161
170
  ## 6. 최종 약속
162
171
  AI 에이전트는 본 **AGENTS.md**를 모든 판단의 최우선 근거로 삼는다. 문서에 정의되지 않은 작업을 수행할 경우 반드시 사용자에게 구현 전 문서 업데이트 필요성을 먼저 확인한다.
172
+
173
+ **사람용 스킬 사용법** (상황별 선택, 26개 카탈로그, Gate 상세): 프로젝트 루트 `USAGE.md` — 영문 기본, 하단 한국어 (`npx solmate-skills install` 시 복사).
package/CLAUDE.md CHANGED
@@ -4,7 +4,7 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
4
4
 
5
5
  ## What This Repo Is
6
6
 
7
- `solmate-skills` is an npm package that ships curated AI skill files (SKILL.md) to downstream projects. It is **not** an application — it is a skill library and CLI tool. Each top-level directory (except `bin/`) is a skill that gets copied into `.agent/skills/<skill-name>` of a target project.
7
+ `solmate-skills` is an npm package that ships curated AI skill files (SKILL.md) to downstream projects. It is **not** an application — it is a skill library and CLI tool. Each installable top-level directory contains `SKILL.md` and is copied into `.agent/skills/<skill-name>` of a target project.
8
8
 
9
9
  ## CLI Commands
10
10
 
@@ -17,13 +17,20 @@ npx solmate-skills install <skill-name>
17
17
 
18
18
  # Install all skills
19
19
  npx solmate-skills@latest install all
20
+
21
+ # Refresh native Claude project agents
22
+ npx solmate-skills@latest install agents
23
+
24
+ # Check backlog context and verification receipts
25
+ npx solmate-skills preflight TASK-000 --strict
26
+ npx solmate-skills verify TASK-000 --strict
20
27
  ```
21
28
 
22
- There are no build, test, or lint scripts in this repo (`"test": "echo \"Error: no test specified\" && exit 1"`).
29
+ Run `npm test` to validate the harness receipt parser and blocking behavior. There is no build or lint script.
23
30
 
24
31
  ## Installing Skills via Symlink (Dev)
25
32
 
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:
33
+ `init-skills.sh` creates symlinks from a target project's `.agent/skills/` to this repo, links `AGENTS.md` and `USAGE.md` to the project root, and links the namespaced Claude project agents under `.claude/agents/`. Run it from inside the target project:
27
34
 
28
35
  ```bash
29
36
  bash /Users/namhyeongseog/Documents/solmate-skills/init-skills.sh
@@ -33,6 +40,7 @@ bash /Users/namhyeongseog/Documents/solmate-skills/init-skills.sh
33
40
 
34
41
  ```
35
42
  bin/cli.js — CLI entrypoint; discovers skills as top-level dirs, copies them to .agent/skills/
43
+ bin/harness-check.js — Backlog Context/Verification Receipt parser and blocking checks
36
44
  AGENTS.md — Global AI collaboration rules (linked into target projects)
37
45
  init-skills.sh — Symlink installer for local development
38
46
  <skill-name>/
@@ -40,6 +48,7 @@ init-skills.sh — Symlink installer for local development
40
48
  templates/ — (optional) document templates
41
49
  resources/ — (optional) reference files
42
50
  examples/ — (optional) example outputs
51
+ adapters/ — (optional) runtime-specific thin adapters; canonical policy remains in resources/
43
52
  ```
44
53
 
45
54
  Skills discovered by `bin/cli.js` = any top-level directory not in `IGNORED_FOLDERS` (`bin`, `node_modules`, `.git`, `.github`, `.gemini`, `.agent`).
@@ -61,6 +70,7 @@ Skills discovered by `bin/cli.js` = any top-level directory not in `IGNORED_FOLD
61
70
  - **Conventional Commits in Korean**: `type(scope): 한글 요약` (e.g. `feat(login): 소셜 로그인 API 연동`).
62
71
  - **5-Layer doc structure**: `docs/01_Concept_Design/`, `02_UI_Screens/`, `03_Technical_Specs/`, `04_Logic_Progress/`, `05_QA_Validation/`.
63
72
  - **Backlogs and roadmaps** belong exclusively in `docs/04_Logic_Progress/`.
73
+ - **Agent Harness Gate**: code/deploy work requires a passing Context Receipt before implementation and an independent Verification Receipt before completion or release.
64
74
 
65
75
  ## Skill Categories
66
76
 
package/README.md CHANGED
@@ -1,8 +1,8 @@
1
1
  # solmate-skills
2
2
 
3
- Reusable AI-agent skills for disciplined product work.
3
+ Reusable AI-agent harness and workflow skills for disciplined product work.
4
4
 
5
- `solmate-skills` packages the Solmate workflow as installable skills: plan the product, create browser-viewable UI previews, lock backlog tasks to their source documents, plan components and libraries before coding, implement with YAGNI/KISS/DRY approval gates, and verify the result before release.
5
+ `solmate-skills` packages the Solmate workflow as installable skills: plan the product, create browser-viewable UI previews, lock backlog tasks to their source documents, prove that required context was read, plan components and libraries before coding, implement with YAGNI/KISS/DRY approval gates, and independently verify the result before release.
6
6
 
7
7
  Use it when you want an AI coding agent to follow a shared workflow instead of improvising project structure, documentation, implementation order, and QA.
8
8
 
@@ -22,9 +22,14 @@ npx solmate-skills@latest install rules-product
22
22
 
23
23
  # Install proactive hook suggestions for Claude Code projects
24
24
  npx solmate-skills@latest install hooks
25
+
26
+ # Refresh native Claude agents for the shared harness
27
+ npx solmate-skills@latest install agents
25
28
  ```
26
29
 
27
- The installer copies each selected skill folder into `.agent/skills/<skill-name>` in your current project.
30
+ 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. Installing `rules-workflow` or `all` also installs the namespaced Claude project agents under `.claude/agents/`; Codex uses the same canonical contract through `rules-workflow`, reinforced by `AGENTS.md` when that file is linked into the project.
31
+
32
+ **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
33
 
29
34
  ## What You Get
30
35
 
@@ -35,8 +40,92 @@ The installer copies each selected skill folder into `.agent/skills/<skill-name>
35
40
  - **Component & Library Planning Gate**: React work must name the shadcn/ui components, custom components, reused components, libraries to add, libraries to avoid, and preset action before coding.
36
41
  - **YAGNI/KISS/DRY Gate**: `rules-dev` is the canonical source for avoiding future-only features, preferring the simplest existing/native path, and removing only true duplicate knowledge.
37
42
  - **Implementation workflow**: `/rules-workflow` keeps coding work tied to approved documents, preconditions, and acceptance criteria.
43
+ - **Agent harness**: a read-only Context Agent proves required documents were read, an Implementation Agent returns a scoped change summary, and a read-only Verification Agent provides independent evidence before completion.
44
+ - **Machine-checkable receipts**: `preflight TASK-ID` checks linked document coverage and `verify TASK-ID` checks command results plus QA/PR evidence; `--strict` turns findings into blocking exit codes.
45
+ - **Versioned harness artifacts**: `validate-harness` checks v1 task manifests, structured messages, ordered state events, role activation, evidence gates, and exclusive write ownership.
38
46
  - **Release verification**: `/verify-implementation` runs the verification family for docs, UI, code, security, performance, DB schema, and skill package readiness.
39
47
 
48
+ ## What's New in 2.0.13: Agent Harness Contracts
49
+
50
+ `solmate-skills@2.0.13` strengthens the existing Solmate workflow with a shared Claude/Codex agent harness. It addresses two recurring failure modes in long AI-assisted projects:
51
+
52
+ 1. An implementation starts from a backlog item without reading the linked concept, UI, technical, and QA documents.
53
+ 2. An agent marks work complete based only on its own summary, without independent verification evidence.
54
+
55
+ The harness makes both boundaries explicit and machine-checkable while preserving the existing skill installation and backlog format.
56
+
57
+ ### How the harness works
58
+
59
+ ```text
60
+ Coordinator
61
+ -> read-only Context Agent -> Context Receipt
62
+ -> Implementation Agent -> Change Receipt
63
+ -> read-only QA Inspector -> Verification Receipt
64
+ -> Done / PR / merge / publish / deploy
65
+ ```
66
+
67
+ - **Context Receipt** records every required backlog reference that was read, the extracted constraints, and any conflict found before implementation.
68
+ - **Change Receipt** records changed files, covered requirements, excluded scope, checks, and remaining risks. It is a handoff, not independent proof.
69
+ - **Verification Receipt** records commands, results, unrun checks, detailed QA evidence, and the independent PASS/FAIL decision.
70
+ - Code and deploy tasks are blocked from implementation without Context evidence and from completion without Verification evidence. Documentation and prototype work remain advisory.
71
+
72
+ The canonical contract lives at [`rules-workflow/resources/agent-harness-contract.md`](./rules-workflow/resources/agent-harness-contract.md).
73
+
74
+ ### Backlog Receipt checks
75
+
76
+ Existing projects can keep their current `00_BACKLOG.md` workflow and add the checks incrementally:
77
+
78
+ ```bash
79
+ # Confirm required linked documents were read before coding
80
+ npx solmate-skills preflight TASK-000
81
+
82
+ # Confirm independent command and QA/PR evidence before completion
83
+ npx solmate-skills verify TASK-000
84
+
85
+ # Turn findings into blocking exit codes for CI or release gates
86
+ npx solmate-skills preflight TASK-000 --strict
87
+ npx solmate-skills verify TASK-000 --strict
88
+ ```
89
+
90
+ ### Versioned manifest, message, and event checks
91
+
92
+ Projects that need structured multi-agent coordination can opt into the v1 contract without rewriting existing backlog Receipts:
93
+
94
+ ```bash
95
+ npx solmate-skills validate-harness manifest _workspace/harness/TASK-000/manifest.json
96
+ npx solmate-skills validate-harness message _workspace/harness/TASK-000/attempt-01/messages/msg-001.json \
97
+ --manifest _workspace/harness/TASK-000/manifest.json
98
+ npx solmate-skills validate-harness events _workspace/harness/TASK-000/events.jsonl \
99
+ --manifest _workspace/harness/TASK-000/manifest.json
100
+ ```
101
+
102
+ [`agent-harness-v1.schema.json`](./rules-workflow/resources/agent-harness-v1.schema.json) defines the manifest, message, and state-event shapes. The validator additionally checks task identity, legal state transitions, active roles, message authority, required evidence, canonical file paths, and exclusive write ownership.
103
+
104
+ | Mode / result | Exit code | Behavior |
105
+ |:---|:---:|:---|
106
+ | Default warning mode, valid | `0` | Reports PASS |
107
+ | Default warning mode, contract finding | `0` | Reports findings without blocking migration |
108
+ | `--strict`, contract finding | `1` | Blocks the workflow or CI step |
109
+ | Invalid command input, unreadable file, malformed JSON/JSONL | `2` | Reports an operational error |
110
+
111
+ ### Compatibility and current scope
112
+
113
+ - Existing `preflight`, `verify`, and backlog Receipt fixtures continue to work without structured artifact files.
114
+ - The structured v1 contract is opt-in and warning-first; projects can move to `--strict` after a real-task pilot.
115
+ - The implementation uses the Node standard library and adds no runtime dependency.
116
+ - Claude Code can install the current namespaced `solmate-*` project agents with `install agents`; Codex follows the same canonical contract through its available delegation mechanism.
117
+ - Specialist personas, runtime orchestration, persistent recovery, pilot automation, and blocking rollout remain separate follow-up work.
118
+ - This release ships the contract and validation foundation; specialist personas and runtime orchestration remain separately gated follow-up work.
119
+
120
+ ## What's New in 2.0.12
121
+
122
+ `solmate-skills@2.0.12` adds a bilingual usage guide and copies it into every target project on install.
123
+
124
+ - [USAGE.md](./USAGE.md) documents all 26 skills in English (default) with Korean below: cheat sheet, orchestrator map, gates, and prompts.
125
+ - `npx solmate-skills install` (single skill, `all`, or `hooks`) now copies `USAGE.md` to the project root.
126
+ - [README.md](./README.md) is trimmed to a 5-minute start; detailed usage lives in `USAGE.md`.
127
+ - `init-skills.sh` symlinks `USAGE.md` alongside `AGENTS.md` for local development.
128
+
40
129
  ## What's New in 2.0.11
41
130
 
42
131
  `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.
@@ -75,30 +164,39 @@ Recent workflow guardrails:
75
164
 
76
165
  ## Install Details
77
166
 
78
- `install all` installs only skill folders that contain `SKILL.md`. Use `install hooks` separately when you want prompt/file-change suggestions that nudge the agent toward `/rules-product`, `/rules-workflow`, and the relevant `verify-*` skills.
167
+ `install all` installs only skill folders that contain `SKILL.md` and adds the namespaced Claude agent adapters. Use `install hooks` separately when you want prompt/file-change suggestions. Use `install agents` to refresh `rules-workflow`, its canonical contract, and the native Claude adapters in an existing project.
79
168
 
80
169
  ---
81
170
 
82
171
  ## Quick Start
83
172
 
84
- 설치 상황에 맞는 스킬을 하나 실행하는 것으로 시작합니다.
173
+ Install skills, then invoke one command based on your situation.
85
174
 
86
- | 상황 | 시작 명령 | 설명 |
175
+ | Situation | Start with | Notes |
87
176
  |:---|:---|:---|
88
- | 신규 프로젝트 아무것도 없을 | `/rules-product` | 현재 단계를 자동 진단하고 Phase 1부터 순서대로 안내 |
89
- | 기획은 있고 코드를 작성하려 | `/rules-dev` | 커밋 형식, 환경변수, TypeScript 기준 등 컨벤션 먼저 정립 |
90
- | 기능 하나를 구현하려 | `/rules-product` → `/rules-workflow` | 현재 Phase를 먼저 진단한 계획 수립부터 PR까지 진행 |
91
- | PR 전 최종 점검 | `/verify-implementation` | 모든 `verify-*` 스킬을 순차 실행하여 통합 보고 |
177
+ | New project or "where do I start?" | `/rules-product` | Diagnoses phase and delegates to the right skill |
178
+ | Implement one feature | `/rules-product` then `/rules-workflow` | Gates must pass before coding |
179
+ | Pre-PR / pre-release check | `/verify-implementation` | Runs the verify-* family in order |
92
180
 
93
- **가장 권장하는 시작 한 줄:**
181
+ **Recommended first line:**
94
182
 
95
- ```
183
+ ```text
96
184
  /rules-product
97
185
  ```
98
186
 
99
- `rules-product`는 프로젝트 상태를 스스로 진단해 현재 어느 단계인지 파악하고, 해당 단계의 올바른 스킬로 위임하는 오케스트레이터입니다. 새 프로젝트든 재개 중인 프로젝트든 동일하게 사용할 수 있습니다.
187
+ ### Orchestrator map
100
188
 
101
- `rules-product` and `rules-workflow` should show a short Flow Status Block at the start of work, before implementation, before verification, and at handoff:
189
+ ```text
190
+ rules-product → diagnose phase, check gates, delegate
191
+ rules-workflow → plan → implement → verify → PR (18 steps)
192
+ verify-implementation → run verify-* skills and report
193
+ ```
194
+
195
+ Full pipeline, gates, backlog template, and all 26 skill entries: **[USAGE.md](./USAGE.md)**
196
+
197
+ ### Flow Status Block
198
+
199
+ `rules-product` and `rules-workflow` report progress in this format:
102
200
 
103
201
  ```text
104
202
  [Flow]
@@ -110,301 +208,52 @@ Gate: UI-First Gate 진행 중
110
208
  권장 스킬: /docs-plan
111
209
  ```
112
210
 
113
- ### Using Skills in an Existing Project
211
+ ### Existing projects
114
212
 
115
- 이미 진행 중인 프로젝트에도 최신 `solmate-skills`를 다시 설치해서 사용할 있습니다. 사용 방식은 신규 프로젝트와 같지만, 시작점은 항상 현재 프로젝트 상태를 먼저 진단하는 것입니다.
116
-
117
- **Update or reinstall skills from the project root:**
213
+ Reinstall from the project root, then diagnose do not restart from Phase 1 by default.
118
214
 
119
215
  ```bash
120
216
  npx solmate-skills@latest install all
121
217
  npx solmate-skills@latest install hooks
218
+ npx solmate-skills@latest install agents
122
219
  ```
123
220
 
124
- **Recommended first prompt:**
125
-
126
- ```text
127
- /rules-product를 사용해서 이 프로젝트의 현재 진행 상태를 진단하고, 다음 작업을 Flow Status Block 기준으로 안내해줘.
128
- ```
221
+ For a `code` or `deploy` backlog item:
129
222
 
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을 포함해서 보고해줘.
223
+ ```bash
224
+ npx solmate-skills preflight TASK-000 --strict
225
+ npx solmate-skills verify TASK-000 --strict
140
226
  ```
141
227
 
142
- 진행 중인 프로젝트에서는 Phase 1부터 강제로 다시 시작하지 않습니다. `/rules-product`가 기존 문서, 코드, 백로그, 변경사항을 보고 현재 위치를 진단한 뒤, 이어서 진행할 Phase와 필요한 Gate를 제안해야 합니다.
228
+ Example prompts: [USAGE.md §9 Recommended Prompts](./USAGE.md#9-recommended-prompts) (EN) · [§9 권장 프롬프트](./USAGE.md#9-권장-프롬프트-모음) (KO)
143
229
 
144
230
  ---
145
231
 
146
- ## Available Skills
147
-
148
- Skills are organized into five categories.
232
+ ## Skills at a Glance
149
233
 
150
- ### Governance
234
+ 26 installable skills plus `hooks` and `agents` utilities. Category summary:
151
235
 
152
- | Skill | Description |
236
+ | Category | Skills |
153
237
  |:---|:---|
154
- | `role-team-lead` | Team lead protocols: branch protection, PR review, DB migration, deployment. |
155
- | `role-team-member` | Team member protocols: branching, Conventional Commits (Korean), PR creation. |
238
+ | Orchestration | `rules-product`, `rules-workflow` |
239
+ | Rules | `rules-docs`, `rules-dev`, `rules-react`, `manage-collaboration`, `manage-decisions`, `manage-skills` |
240
+ | Documentation | `docs-plan`, `docs-dev`, `docs-pitch`, `docs-business` |
241
+ | Verification | `verify-implementation`, `verify-docs`, `verify-ui`, `verify-code`, `verify-security`, `verify-performance`, `verify-drizzle-schema`, `verify-skills` |
242
+ | Roles | `role-team-lead`, `role-team-member` |
243
+ | Tools | `tools-shadcn`, `tools-obsidian` |
244
+ | External | `ext-awesome-design`, `ext-k-skill` |
156
245
 
157
- ### Rules
158
-
159
- | Skill | Description |
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. |
246
+ **Situation cheat sheet, per-skill when/prerequisites/outputs/next:** [USAGE.md](./USAGE.md)
205
247
 
206
248
  ---
207
249
 
208
- ## Usage Guide
250
+ ## Hooks (optional)
209
251
 
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.
257
-
258
- ### HTML UI Preview Gate
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
- ```
331
-
332
- ---
333
-
334
- ### Pitch Deck
335
-
336
- Create a pitch deck from existing `docs-plan` documents.
337
-
338
- **Prerequisites:** `docs-plan` Layer 1 documents (VISION_CORE, LEAN_CANVAS, PRODUCT_SPECS) should exist first.
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:**
252
+ For Claude Code, install hooks to get keyword and file-pattern skill suggestions:
392
253
 
393
254
  ```bash
394
- # 1. Install the hooks skill first (if not already installed)
395
- npx solmate-skills install hooks
396
-
397
- # 2. Run the installer from your project root
255
+ npx solmate-skills@latest install hooks
398
256
  bash .agent/skills/hooks/install.sh
399
257
  ```
400
258
 
401
- This copies two scripts to `.claude/hooks/` and merges the hook config into `.claude/settings.json`:
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`.
259
+ Details: [USAGE.md §8 Hooks](./USAGE.md#8-hooks-claude-code-suggestions) (EN) · [§8 Hooks 한국어](./USAGE.md#8-hooks-claude-code-자동-제안) (KO)