@codihaus/claude-skills 1.6.10 → 1.6.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/package.json
CHANGED
package/skills/_registry.md
CHANGED
|
@@ -22,9 +22,10 @@ Central registry of all available skills. Reference this to suggest relevant ski
|
|
|
22
22
|
| Skill | Purpose | Called By |
|
|
23
23
|
|-------|---------|-----------|
|
|
24
24
|
| `/utils/diagram` | Create/validate Mermaid diagrams | `/dev-scout`, `/dev-specs`, `/dev-arch` |
|
|
25
|
-
| `/utils/docs-graph` | View documentation relationships | `/debrief`, `/dev-specs`, `/dev-arch` |
|
|
26
25
|
| `/utils/gemini` | Large context scanning (1M tokens) | `/dev-scout` for large codebases |
|
|
27
26
|
|
|
27
|
+
**Note:** Documentation graph (`docs-graph.json`) is automatically updated by Claude Code hook, not a skill.
|
|
28
|
+
|
|
28
29
|
## Skill Flow
|
|
29
30
|
|
|
30
31
|
```
|
|
@@ -66,9 +67,6 @@ Need to document what was built?
|
|
|
66
67
|
|
|
67
68
|
Need to visualize something?
|
|
68
69
|
→ /utils/diagram (usually called by other skills)
|
|
69
|
-
|
|
70
|
-
Need to see doc relationships?
|
|
71
|
-
→ /utils/docs-graph (usually called by other skills)
|
|
72
70
|
```
|
|
73
71
|
|
|
74
72
|
## Trigger Phrases
|
|
@@ -86,7 +84,6 @@ When user says... → Suggest skill
|
|
|
86
84
|
| "review my code", "check this PR" | `/dev-review` |
|
|
87
85
|
| "what was built", "summarize changes", "document implementation" | `/dev-changelog` |
|
|
88
86
|
| "create diagram", "architecture diagram", "flow chart" | `/utils/diagram` |
|
|
89
|
-
| "what links to this", "doc relationships" | `/utils/docs-graph` |
|
|
90
87
|
|
|
91
88
|
## Cross-Skill Suggestions
|
|
92
89
|
|
|
@@ -147,11 +144,6 @@ During each skill, consider suggesting:
|
|
|
147
144
|
- Called by other skills, not typically invoked directly
|
|
148
145
|
- Used for: architecture diagrams, flow charts, ERD
|
|
149
146
|
|
|
150
|
-
### /utils/docs-graph
|
|
151
|
-
- Utility skill for documentation relationships
|
|
152
|
-
- Called by other skills to understand dependencies
|
|
153
|
-
- Auto-updated by Claude Code hooks
|
|
154
|
-
|
|
155
147
|
## Quality Attributes
|
|
156
148
|
|
|
157
149
|
All skills reference `skills/_quality-attributes.md` for their respective level:
|
package/skills/debrief/SKILL.md
CHANGED
|
@@ -10,7 +10,7 @@ version: 3.9.0
|
|
|
10
10
|
> - **Before**: Use `/dev-scout` if existing codebase
|
|
11
11
|
> - **During**: Calls `/dev-arch` to validate architecture feasibility
|
|
12
12
|
> - **After**: Use `/dev-specs` for implementation plans
|
|
13
|
-
> - **
|
|
13
|
+
> - **Auto**: `docs-graph.json` updated by hook for relationships
|
|
14
14
|
|
|
15
15
|
Create and maintain the unified BRD for a project. Handles initial requirements and feature additions.
|
|
16
16
|
|
|
@@ -11,14 +11,26 @@ version: 3.0.0
|
|
|
11
11
|
> - **After**: Use `/dev-specs` for implementation plans
|
|
12
12
|
> - **Utils**: `/utils/diagram` for architecture visualization
|
|
13
13
|
|
|
14
|
-
Discover and document **how the codebase works** - patterns, rules, and team conventions
|
|
14
|
+
Discover and document **how the codebase works** - patterns, rules, and team conventions for EXISTING code.
|
|
15
15
|
|
|
16
16
|
## When to Use
|
|
17
17
|
|
|
18
18
|
- Understand **how the project works** before implementation
|
|
19
19
|
- Document **team patterns and conventions** for new engineers
|
|
20
20
|
- Discover **architectural patterns** that must be followed
|
|
21
|
-
- Capture **
|
|
21
|
+
- Capture **existing features** and how they're implemented
|
|
22
|
+
|
|
23
|
+
## What Scout Does vs Doesn't
|
|
24
|
+
|
|
25
|
+
**Scout documents EXISTING code:**
|
|
26
|
+
- ✅ How the project currently works (patterns, conventions)
|
|
27
|
+
- ✅ Complete list of existing features
|
|
28
|
+
- ✅ How each feature is implemented (for understanding/extending)
|
|
29
|
+
|
|
30
|
+
**Scout does NOT plan NEW features:**
|
|
31
|
+
- ❌ NOT for creating implementation specs
|
|
32
|
+
- ❌ NOT for planning new features
|
|
33
|
+
- ❌ Use `/dev-specs` for new feature planning
|
|
22
34
|
|
|
23
35
|
**Not for:** Listing files, counting components, inventorying routes (use Glob/Grep fresh instead)
|
|
24
36
|
|
|
@@ -78,37 +90,48 @@ Discover and document **how the codebase works** - patterns, rules, and team con
|
|
|
78
90
|
|
|
79
91
|
### Project-Level: `tech-context.md` (~150-200 lines)
|
|
80
92
|
|
|
81
|
-
Answers
|
|
93
|
+
Answers: **How does this project work?**
|
|
82
94
|
|
|
83
|
-
**
|
|
84
|
-
- How we make API calls
|
|
85
|
-
-
|
|
86
|
-
-
|
|
87
|
-
-
|
|
88
|
-
- Tech stack choices (framework, libraries, tools)
|
|
95
|
+
**For new developers, provide:**
|
|
96
|
+
- **Patterns** - How we make API calls, access data, structure code (with file/location references)
|
|
97
|
+
- **Conventions** - Team standards for naming, formatting, git workflow
|
|
98
|
+
- **Stack** - Tech choices and why
|
|
99
|
+
- **All existing features** - Complete list (important: don't miss any!)
|
|
89
100
|
|
|
90
|
-
**
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
101
|
+
**Format:** Overview + location reference, NOT do/don't lists
|
|
102
|
+
|
|
103
|
+
**Example:**
|
|
104
|
+
```markdown
|
|
105
|
+
### API Communication
|
|
106
|
+
**Pattern:** All API calls go through `lib/api/client.ts` wrapper
|
|
107
|
+
**Location:** See `lib/api/client.ts` for implementation
|
|
108
|
+
**Usage:** Import `apiClient` and call methods
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
NOT:
|
|
112
|
+
```markdown
|
|
113
|
+
✅ DO: Use apiClient
|
|
114
|
+
❌ DON'T: Use fetch directly
|
|
115
|
+
```
|
|
95
116
|
|
|
96
117
|
### Feature-Level: `codebase-context.md`
|
|
97
118
|
|
|
98
|
-
Answers
|
|
119
|
+
Answers: **How does THIS already-implemented feature work?**
|
|
99
120
|
|
|
100
|
-
**
|
|
121
|
+
**Purpose:** Document existing implementation for understanding/extending, NOT create specs
|
|
122
|
+
|
|
123
|
+
**Prerequisite:** MUST have `tech-context.md` first
|
|
101
124
|
|
|
102
125
|
**Captures:**
|
|
103
|
-
- How this feature
|
|
104
|
-
- Where
|
|
105
|
-
- How
|
|
106
|
-
-
|
|
126
|
+
- How this feature uses the patterns (reference tech-context.md)
|
|
127
|
+
- Where key files are (locations, entry points)
|
|
128
|
+
- How it currently works (flow, architecture)
|
|
129
|
+
- How to extend it (what to modify where)
|
|
107
130
|
|
|
108
|
-
**Does NOT
|
|
109
|
-
-
|
|
110
|
-
-
|
|
111
|
-
-
|
|
131
|
+
**Does NOT:**
|
|
132
|
+
- Create implementation specs (this is for EXISTING code)
|
|
133
|
+
- Repeat patterns (reference tech-context.md instead)
|
|
134
|
+
- Include do/don't lists (show pattern usage with locations)
|
|
112
135
|
|
|
113
136
|
## Success Criteria
|
|
114
137
|
|
|
@@ -128,6 +151,7 @@ Answers the question: **How does THIS feature work?**
|
|
|
128
151
|
- Detect tech stack from package.json, configs
|
|
129
152
|
- Sample 2-3 files per category to discover patterns
|
|
130
153
|
- Extract conventions from configs
|
|
154
|
+
- **Discover ALL existing features** (don't miss any - scan routes, pages, API endpoints)
|
|
131
155
|
|
|
132
156
|
**Deep Mode:**
|
|
133
157
|
- All of Medium +
|
|
@@ -135,14 +159,22 @@ Answers the question: **How does THIS feature work?**
|
|
|
135
159
|
- Code convention detection
|
|
136
160
|
- Git & team process
|
|
137
161
|
|
|
162
|
+
**Output:** `tech-context.md` with patterns + complete feature list
|
|
163
|
+
|
|
138
164
|
### Feature-Level
|
|
139
165
|
|
|
140
|
-
**
|
|
166
|
+
**Purpose:** Document existing implementation for understanding/extending
|
|
167
|
+
|
|
168
|
+
**NOT FOR:** Creating specs or planning new features
|
|
169
|
+
|
|
170
|
+
**Lightweight approach:**
|
|
141
171
|
|
|
142
172
|
1. **Check prerequisite:** tech-context.md exists? If not, run project-level first
|
|
143
173
|
2. **Read patterns:** Load tech-context.md (now you know API pattern, data access, conventions)
|
|
144
174
|
3. **Focus on feature:** Find files (Glob/Grep), read 2-3 key files, identify entry points
|
|
145
|
-
4. **Document:** How
|
|
175
|
+
4. **Document existing code:** How it works NOW, where files are, how to extend
|
|
176
|
+
|
|
177
|
+
**Output:** `codebase-context.md` describing current implementation
|
|
146
178
|
|
|
147
179
|
## Pattern Discovery Rules
|
|
148
180
|
|
|
@@ -39,23 +39,32 @@
|
|
|
39
39
|
|
|
40
40
|
## Architecture Patterns (How We Build)
|
|
41
41
|
|
|
42
|
+
**Format:** Overview + location reference (NOT do/don't lists)
|
|
43
|
+
|
|
42
44
|
### 1. API Communication
|
|
43
|
-
**
|
|
44
|
-
**
|
|
45
|
-
**Example:** {code
|
|
46
|
-
**Why:** {reason}
|
|
45
|
+
**Pattern:** {description of approach}
|
|
46
|
+
**Location:** `{file/folder}` - {what's there}
|
|
47
|
+
**Usage Example:** {short code snippet showing usage}
|
|
47
48
|
|
|
48
49
|
### 2. Data Access
|
|
49
|
-
{
|
|
50
|
+
**Pattern:** {description}
|
|
51
|
+
**Location:** `{file/folder}`
|
|
52
|
+
**Usage Example:** {snippet}
|
|
50
53
|
|
|
51
54
|
### 3. Client-Side Data Fetching
|
|
52
|
-
{
|
|
55
|
+
**Pattern:** {description}
|
|
56
|
+
**Location:** `{file/folder}`
|
|
57
|
+
**Usage Example:** {snippet}
|
|
53
58
|
|
|
54
59
|
### 4. Validation & Forms
|
|
55
|
-
{
|
|
60
|
+
**Pattern:** {description}
|
|
61
|
+
**Location:** `{file/folder}`
|
|
62
|
+
**Usage Example:** {snippet}
|
|
56
63
|
|
|
57
64
|
### 5. State Management
|
|
58
|
-
{
|
|
65
|
+
**Pattern:** {description}
|
|
66
|
+
**Location:** `{file/folder}`
|
|
67
|
+
**Usage Example:** {snippet}
|
|
59
68
|
|
|
60
69
|
## Code Conventions (Team Standards)
|
|
61
70
|
|
|
@@ -94,6 +103,16 @@
|
|
|
94
103
|
### Available MCPs
|
|
95
104
|
{what they provide}
|
|
96
105
|
|
|
106
|
+
## Existing Features (Complete List)
|
|
107
|
+
|
|
108
|
+
**IMPORTANT:** List ALL features found in codebase, don't sample.
|
|
109
|
+
|
|
110
|
+
| Feature | Status | Location | Key Files |
|
|
111
|
+
|---------|--------|----------|-----------|
|
|
112
|
+
| {feature} | Complete | `{folder}` | `{main files}` |
|
|
113
|
+
|
|
114
|
+
**Discovery method:** Scan routes, pages, components, API endpoints
|
|
115
|
+
|
|
97
116
|
## Project Structure (High-Level)
|
|
98
117
|
|
|
99
118
|
{core directories only, not exhaustive}
|
|
@@ -131,7 +150,8 @@
|
|
|
131
150
|
## 2. Feature-Level: codebase-context.md
|
|
132
151
|
|
|
133
152
|
**Location:** `plans/features/{feature}/codebase-context.md`
|
|
134
|
-
**Purpose:**
|
|
153
|
+
**Purpose:** Document how THIS already-implemented feature works (for understanding/extending)
|
|
154
|
+
**NOT FOR:** Creating specs or planning new features (use /dev-specs for that)
|
|
135
155
|
**Prerequisite:** MUST read tech-context.md first (patterns already documented)
|
|
136
156
|
**Length:** ~100-150 lines
|
|
137
157
|
|
|
@@ -186,35 +206,27 @@
|
|
|
186
206
|
|
|
187
207
|
## Integration Points
|
|
188
208
|
|
|
189
|
-
**Where to add new code:**
|
|
190
|
-
{location + pattern}
|
|
191
|
-
|
|
192
|
-
**What to extend:**
|
|
193
|
-
{existing abstraction}
|
|
194
|
-
|
|
195
209
|
**Dependencies:**
|
|
196
210
|
{what must exist}
|
|
197
211
|
|
|
198
212
|
**Used By:**
|
|
199
213
|
{what depends on this}
|
|
200
214
|
|
|
201
|
-
##
|
|
202
|
-
|
|
203
|
-
**✅ DO:**
|
|
204
|
-
{feature-specific guidance}
|
|
205
|
-
|
|
206
|
-
**❌ DON'T:**
|
|
207
|
-
{feature-specific anti-pattern}
|
|
215
|
+
## How to Extend
|
|
208
216
|
|
|
209
|
-
|
|
217
|
+
**To add new functionality:**
|
|
218
|
+
1. Location: `{file/folder}`
|
|
219
|
+
2. Pattern reference: See tech-context.md → {section}
|
|
220
|
+
3. Example: {how similar functionality was added}
|
|
210
221
|
|
|
211
|
-
|
|
222
|
+
**To modify behavior:**
|
|
223
|
+
1. Location: `{file}`
|
|
224
|
+
2. Pattern reference: See tech-context.md → {section}
|
|
225
|
+
3. Note: {what to watch out for}
|
|
212
226
|
|
|
213
|
-
##
|
|
227
|
+
## Gotchas & Notes
|
|
214
228
|
|
|
215
|
-
|
|
216
|
-
**Follow pattern:** See tech-context.md → {section}
|
|
217
|
-
**Watch out:** {warning}
|
|
229
|
+
{feature-specific issues, edge cases, known limitations}
|
|
218
230
|
```
|
|
219
231
|
|
|
220
232
|
---
|
|
@@ -1,177 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: utils/docs-graph
|
|
3
|
-
description: View and query the documentation knowledge graph
|
|
4
|
-
version: 1.3.0
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
# /utils/docs-graph - Documentation Graph Viewer
|
|
8
|
-
|
|
9
|
-
> **Skill Awareness**: See `skills/_registry.md` for all available skills.
|
|
10
|
-
> - **Auto-updated**: By Claude Code hook on Write/Edit to plans/
|
|
11
|
-
> - **Called by**: `/dev-specs`, `/debrief`, `/dev-arch` for relationships
|
|
12
|
-
> - **Note**: Utility skill, typically called by other skills
|
|
13
|
-
|
|
14
|
-
View and query relationships between planning documents.
|
|
15
|
-
|
|
16
|
-
## When to Use
|
|
17
|
-
|
|
18
|
-
- See overview of all plans and their relationships
|
|
19
|
-
- Find related documents before making changes
|
|
20
|
-
- Check impact of changes (what links to this?)
|
|
21
|
-
- Verify links are valid
|
|
22
|
-
|
|
23
|
-
## Usage
|
|
24
|
-
|
|
25
|
-
```
|
|
26
|
-
/utils/docs-graph # Show graph summary
|
|
27
|
-
/utils/docs-graph auth # Show nodes related to "auth"
|
|
28
|
-
/utils/docs-graph --check # Verify all links resolve
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
## How It Works
|
|
32
|
-
|
|
33
|
-
**Automatic Updates:**
|
|
34
|
-
- PostToolUse hook triggers on Write/Edit to `plans/`
|
|
35
|
-
- Regenerates entire graph from all files in `plans/`
|
|
36
|
-
- Updates `plans/docs-graph.json` and `plans/docs-graph.md`
|
|
37
|
-
- Timeout: 3 minutes
|
|
38
|
-
|
|
39
|
-
**Graph Files:**
|
|
40
|
-
```
|
|
41
|
-
plans/
|
|
42
|
-
├── docs-graph.json # Machine-readable graph data
|
|
43
|
-
└── docs-graph.md # Mermaid visualization
|
|
44
|
-
```
|
|
45
|
-
|
|
46
|
-
## Expected Outcome
|
|
47
|
-
|
|
48
|
-
**Summary mode (default):**
|
|
49
|
-
- Node count by type
|
|
50
|
-
- Edge count
|
|
51
|
-
- Mermaid diagram from docs-graph.md
|
|
52
|
-
|
|
53
|
-
**Query mode (with argument like "auth"):**
|
|
54
|
-
- Matching nodes
|
|
55
|
-
- Incoming links (what references this)
|
|
56
|
-
- Outgoing links (what this references)
|
|
57
|
-
|
|
58
|
-
**Check mode (--check):**
|
|
59
|
-
- Report broken links
|
|
60
|
-
- Suggest fixes
|
|
61
|
-
|
|
62
|
-
## Wikilink Convention
|
|
63
|
-
|
|
64
|
-
Documents use `[[wikilinks]]` to reference each other:
|
|
65
|
-
|
|
66
|
-
```markdown
|
|
67
|
-
# UC-AUTH-001: Login
|
|
68
|
-
|
|
69
|
-
> **Feature**: [[feature-auth]]
|
|
70
|
-
> **Related**: [[uc-auth-002]], [[uc-auth-003]]
|
|
71
|
-
> **Spec**: [[spec-auth-001]]
|
|
72
|
-
```
|
|
73
|
-
|
|
74
|
-
**Link ID format:**
|
|
75
|
-
- Use cases: `[[uc-auth-001]]` (lowercase, no slug)
|
|
76
|
-
- Features: `[[feature-auth]]`
|
|
77
|
-
- Specs: `[[spec-auth-001]]`
|
|
78
|
-
- Change requests: `[[cr-001]]`
|
|
79
|
-
|
|
80
|
-
## Node Types
|
|
81
|
-
|
|
82
|
-
| Type | Source | Shape (Mermaid) |
|
|
83
|
-
|------|--------|-----------------|
|
|
84
|
-
| brd | `brd/README.md` | Stadium `[[]]` |
|
|
85
|
-
| use-case | `brd/use-cases/**/*.md` | Rectangle `[]` |
|
|
86
|
-
| change-request | `brd/changes/*.md` | Hexagon `{{}}` |
|
|
87
|
-
| feature | `features/*/README.md` | Pill `([])` |
|
|
88
|
-
| spec | `features/*/specs/**/*.md` | Parallelogram `[//]` |
|
|
89
|
-
| scout | `**/scout.md` | Cylinder `[()]` |
|
|
90
|
-
|
|
91
|
-
## Example Output
|
|
92
|
-
|
|
93
|
-
### Summary
|
|
94
|
-
|
|
95
|
-
```
|
|
96
|
-
Documentation Graph Summary
|
|
97
|
-
===========================
|
|
98
|
-
Nodes: 12 | Edges: 18
|
|
99
|
-
|
|
100
|
-
By Type:
|
|
101
|
-
use-case: 5
|
|
102
|
-
feature: 2
|
|
103
|
-
spec: 4
|
|
104
|
-
brd: 1
|
|
105
|
-
|
|
106
|
-
View full graph: plans/docs-graph.md
|
|
107
|
-
```
|
|
108
|
-
|
|
109
|
-
### Query: `/utils/docs-graph auth`
|
|
110
|
-
|
|
111
|
-
```
|
|
112
|
-
Nodes matching "auth": 4
|
|
113
|
-
|
|
114
|
-
uc-auth-001 (use-case) - Login
|
|
115
|
-
← feature-auth, spec-auth-001
|
|
116
|
-
→ feature-auth
|
|
117
|
-
|
|
118
|
-
uc-auth-002 (use-case) - Signup
|
|
119
|
-
← feature-auth
|
|
120
|
-
→ uc-auth-001, feature-auth
|
|
121
|
-
|
|
122
|
-
feature-auth (feature) - Authentication
|
|
123
|
-
← uc-auth-001, uc-auth-002, uc-auth-003
|
|
124
|
-
→ (none)
|
|
125
|
-
|
|
126
|
-
spec-auth-001 (spec) - Login Spec
|
|
127
|
-
← (none)
|
|
128
|
-
→ uc-auth-001
|
|
129
|
-
```
|
|
130
|
-
|
|
131
|
-
### Check: `/utils/docs-graph --check`
|
|
132
|
-
|
|
133
|
-
```
|
|
134
|
-
Link Check Results
|
|
135
|
-
==================
|
|
136
|
-
✓ 16 valid links
|
|
137
|
-
✗ 2 broken links
|
|
138
|
-
|
|
139
|
-
Broken:
|
|
140
|
-
plans/brd/use-cases/auth/UC-AUTH-001-login.md:5
|
|
141
|
-
[[uc-auth-004]] - node not found
|
|
142
|
-
|
|
143
|
-
plans/features/auth/specs/UC-AUTH-001/README.md:12
|
|
144
|
-
[[feature-billing]] - node not found
|
|
145
|
-
|
|
146
|
-
Suggestions:
|
|
147
|
-
- uc-auth-004: Did you mean uc-auth-003?
|
|
148
|
-
- feature-billing: Create plans/features/billing/README.md
|
|
149
|
-
```
|
|
150
|
-
|
|
151
|
-
## Tools Used
|
|
152
|
-
|
|
153
|
-
| Tool | Purpose |
|
|
154
|
-
|------|---------|
|
|
155
|
-
| `Bash` | Run graph.py script |
|
|
156
|
-
| `Read` | Read docs-graph.json, docs-graph.md |
|
|
157
|
-
| `Glob` | Find plan files |
|
|
158
|
-
|
|
159
|
-
## Integration
|
|
160
|
-
|
|
161
|
-
| Skill | Relationship |
|
|
162
|
-
|-------|--------------|
|
|
163
|
-
| `/debrief` | Creates use cases with wikilinks |
|
|
164
|
-
| `/dev-specs` | Creates specs linking to use cases |
|
|
165
|
-
| `/dev-scout` | Creates scout.md for features |
|
|
166
|
-
|
|
167
|
-
## Troubleshooting
|
|
168
|
-
|
|
169
|
-
**Graph not updating:**
|
|
170
|
-
- Check hook is in `.claude/settings.local.json`
|
|
171
|
-
- Verify `jq` is installed
|
|
172
|
-
- Run `/utils/docs-graph --regenerate` to force update
|
|
173
|
-
|
|
174
|
-
**Broken links:**
|
|
175
|
-
- Run `/utils/docs-graph --check` to find issues
|
|
176
|
-
- Update wikilinks to match node IDs
|
|
177
|
-
- Node IDs are lowercase, no slug (e.g., `uc-auth-001` not `UC-AUTH-001-login`)
|