cc-dev-template 0.1.48 → 0.1.49

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.
@@ -0,0 +1,52 @@
1
+ # Step 3: Validate and Test
2
+
3
+ ## Public Knowledge Audit
4
+
5
+ Go through every changed file. Find each code block, CLI command, API call, and implementation detail.
6
+
7
+ For each one, ask: **"Would a fresh Claude instance know how to do this without being told?"**
8
+
9
+ - If yes: delete it. Replace with a high-level instruction.
10
+ - If no: keep it — this is tribal knowledge and belongs in the skill.
11
+
12
+ ## Self-Review
13
+
14
+ Re-read every changed file. For each one, verify:
15
+
16
+ - Would Claude know what to DO after reading this?
17
+ - Are the specific issues from diagnosis resolved?
18
+ - Did the fixes introduce any new problems?
19
+ - Is the writing style correct? (imperative, positive, direct, no meta-descriptions)
20
+ - For procedural skills: does each step chain correctly to the next?
21
+
22
+ ## Run Validation
23
+
24
+ ```bash
25
+ node ~/.claude/skills/creating-agent-skills/scripts/validate-skill.js [skill-path]
26
+ ```
27
+
28
+ Handle results:
29
+ - **Errors:** Fix each one, re-run, repeat until passing
30
+ - **Warnings:** Evaluate and fix most of them
31
+ - **Info:** Review — may be acceptable (e.g., step files chained from other steps rather than SKILL.md)
32
+
33
+ ## Test
34
+
35
+ If the fix affected behavior:
36
+
37
+ 1. Reinstall if the skill is deployed (copy updated files to install location)
38
+ 2. Start a new Claude Code session
39
+ 3. If description changed: test trigger phrases for activation
40
+ 4. If instructions changed: invoke the skill and verify it behaves correctly
41
+ 5. If structure changed: verify all file references work
42
+
43
+ ## If Issues Remain
44
+
45
+ Go back to `references/fix-step-2-apply.md` and address them.
46
+
47
+ ## Completion
48
+
49
+ Summarize what was fixed:
50
+ - Which files changed
51
+ - What was wrong and how it was resolved
52
+ - Confirm with the user that the skill now behaves as expected
@@ -1,121 +0,0 @@
1
- # Audit Existing Skills
2
-
3
- ## Contents
4
-
5
- - [Audit Checklist](#audit-checklist)
6
- - [What To Do](#what-to-do)
7
- - [What Makes a Good Skill](#what-makes-a-good-skill)
8
- - [How to Audit](#how-to-audit)
9
- - [Red Flags](#red-flags)
10
- - [Report Format](#report-format)
11
- - [After the Audit](#after-the-audit)
12
-
13
- ---
14
-
15
- Read `references/principles.md` first.
16
-
17
- ## Audit Checklist
18
-
19
- Copy and track progress:
20
-
21
- ```
22
- - [ ] Discovered available skills
23
- - [ ] Selected skill(s) to audit
24
- - [ ] Read SKILL.md completely
25
- - [ ] Read all files in references/, workflows/, scripts/
26
- - [ ] Evaluated each file for actionability
27
- - [ ] Noted external dependencies
28
- - [ ] Checked structural basics
29
- - [ ] Compiled findings report
30
- - [ ] Presented to user
31
- ```
32
-
33
- ## What To Do
34
-
35
- 1. **Discover skills** - Run `scripts/find-skills.js` to list available skills
36
- 2. **Ask which to audit** - Get user's choice (all, user-level, project-level, or specific skill)
37
- 3. **Read everything** - Read SKILL.md AND every file in references/, workflows/, scripts/
38
- 4. **Evaluate each file** - Ask: Would Claude know what to DO after reading this?
39
- 5. **Report findings** - Present issues with principle violated and suggested fix
40
-
41
- ## What Makes a Good Skill
42
-
43
- **Actionability**: Every file tells Claude what to DO, not what the skill is ABOUT.
44
-
45
- **Progressive disclosure**: SKILL.md is lean (<150 lines). Heavy content lives in references/. Claude loads what it needs when it needs it.
46
-
47
- **Routing coherence**: Multi-phase skills route to reference files. Each file hands off clearly to the next step or completes the flow.
48
-
49
- **No dead ends**: At every point, Claude knows what to do next.
50
-
51
- ## How to Audit
52
-
53
- ### Step 1: Discover and Read Everything
54
-
55
- Use `scripts/find-skills.js` to list available skills. After selecting a skill to audit:
56
-
57
- - Read SKILL.md completely
58
- - Read every file in references/, workflows/, and any other subdirectories
59
- - Trace the execution path: if SKILL.md says "read references/phase1.md", read that file too
60
-
61
- **You cannot audit a skill without reading all its files.**
62
-
63
- ### Step 2: Evaluate Each File
64
-
65
- For each file, ask:
66
-
67
- - After reading this, would Claude know what to DO next?
68
- - Does this tell Claude what to DO, or just describe what the skill is ABOUT?
69
- - Does this file hand off clearly to another file, or is there a dead end?
70
- - Are any referenced files missing?
71
-
72
- ### Step 3: Note External Dependencies
73
-
74
- If the skill references:
75
- - Sub-agents (e.g., "spawn adr-agent")
76
- - Commands (e.g., "run /create-adr")
77
- - Scripts outside the skill directory
78
-
79
- Flag these with their expected locations. They aren't audited here, but the user should know they exist.
80
-
81
- ### Step 4: Check Structural Basics
82
-
83
- - SKILL.md has valid YAML frontmatter (name, description)
84
- - Name matches directory name
85
- - Description explains WHEN to use (trigger phrases), not just WHAT it does
86
- - Files referenced in SKILL.md actually exist
87
-
88
- ## Red Flags
89
-
90
- **Documentation language**: "This skill orchestrates...", "Who this is for:", "Success looks like:" - these describe, they don't instruct.
91
-
92
- **Inline heavy content**: Large YAML schemas, detailed examples, extensive phase explanations - these belong in references/.
93
-
94
- **No clear action**: After reading a file, Claude doesn't know what to do next.
95
-
96
- **Missing routing**: Multi-phase skill but all content inline instead of routing to reference files.
97
-
98
- ## Report Format
99
-
100
- ```markdown
101
- # Audit Report: [skill-name]
102
-
103
- ## Summary
104
- - Files audited: [list all files read]
105
- - External dependencies: [list any sub-agents, commands, scripts referenced]
106
-
107
- ## Findings
108
-
109
- ### [Issue title]
110
- **File**: [path]
111
- **Problem**: [what's wrong]
112
- **Principle**: [which principle is violated - actionability, progressive disclosure, routing, etc.]
113
- **Suggested fix**: [specific rewrite or change]
114
-
115
- ## Passing
116
- [What works well about this skill]
117
- ```
118
-
119
- ## After the Audit
120
-
121
- Present findings to the user. If issues were found, offer to help fix them. For significant rewrites (documentation to instructions), transition to `references/modify.md`.
@@ -1,157 +0,0 @@
1
- # Create a New Skill
2
-
3
- ## Contents
4
-
5
- - [Creation Checklist](#creation-checklist)
6
- - [Step 1: Have a Conversation](#step-1-have-a-conversation)
7
- - [Step 2: Determine Scope and Structure](#step-2-determine-scope-and-structure)
8
- - [Step 3: Craft the Description](#step-3-craft-the-description)
9
- - [Step 4: Write the Skill](#step-4-write-the-skill)
10
- - [Step 5: Choose Install Location](#step-5-choose-install-location)
11
- - [Step 6: Validate](#step-6-validate-feedback-loop)
12
- - [Step 7: Test](#step-7-test)
13
- - [Key Principles](#key-principles)
14
- - [Quality Check](#quality-check)
15
-
16
- ---
17
-
18
- ## Creation Checklist
19
-
20
- Copy and track progress:
21
-
22
- ```
23
- - [ ] Had deep conversation about domain
24
- - [ ] Determined name, scope, structure
25
- - [ ] Crafted description with trigger phrases
26
- - [ ] Wrote skill as instructions (not docs)
27
- - [ ] Chose install location
28
- - [ ] Validated (loop until clean)
29
- - [ ] Tested activation
30
- ```
31
-
32
- ## Step 1: Have a Conversation
33
-
34
- Talk with the user to understand what they need. This is the most important step.
35
-
36
- **Goals of the conversation:**
37
- - Understand the task they want to standardize
38
- - Extract domain knowledge Claude doesn't naturally have
39
- - Learn terminology, patterns, edge cases, gotchas
40
- - Get concrete examples of the task done well
41
-
42
- **Good questions:**
43
- - "Walk me through how you do this today."
44
- - "What's the most important thing to get right?"
45
- - "What mistakes do people commonly make?"
46
- - "What would an expert know that a beginner wouldn't?"
47
-
48
- **Take time here.** The skill's quality depends entirely on understanding the domain deeply. Ask follow-up questions. Request examples. Understand WHY certain approaches work.
49
-
50
- This should feel like a conversation, not a form to fill out.
51
-
52
- ## Step 2: Determine Scope and Structure
53
-
54
- Based on the conversation, decide:
55
-
56
- 1. **Name**: What to call it (hyphen-case, prefer gerund form like `processing-pdfs`)
57
- 2. **Scope**: One focused task or multiple related workflows?
58
- 3. **Complexity**: Does it need references/? scripts/? Or just SKILL.md?
59
-
60
- **Principles:**
61
- - Focused is better than broad
62
- - If it has distinct workflows, use router pattern with references/
63
- - If it needs reliable code execution, add scripts/
64
-
65
- Confirm with user: "I'm thinking this should be called `[name]` and cover [scope]. Sound right?"
66
-
67
- ## Step 3: Craft the Description
68
-
69
- The description determines when Claude activates the skill. This is critical.
70
-
71
- **Collect trigger phrases from user:**
72
- "When you need this skill, what would you say to Claude?"
73
-
74
- List 5-10 phrases they might use, then combine into a description that:
75
- - Uses third person ("This skill should be used when...")
76
- - Includes the actual trigger phrases
77
- - Stays under 1024 characters
78
-
79
- ## Step 4: Write the Skill
80
-
81
- Create the skill files. Apply these principles:
82
-
83
- **The skill must be instructions, not documentation.**
84
- If Claude reads it, it should know what to DO, not just understand what the skill is about.
85
-
86
- **Use progressive disclosure.**
87
- SKILL.md should be lean (<150 lines for routers, <300 for simple skills). Heavy content goes in references/.
88
-
89
- **Apply prompting guidelines:**
90
- - Explain WHY, not just WHAT
91
- - Define what success looks like
92
- - Be clear and direct
93
- - Avoid micromanagement - give goals, not step-by-step unless truly needed
94
-
95
- **Writing style:**
96
- - Imperative form ("Parse the file", not "You should parse")
97
- - Positive framing ("Use X approach", not "Don't use Y")
98
- - No meta-descriptions ("Who this is for", "Success looks like" don't belong in SKILL.md)
99
-
100
- Read `references/principles.md` for the full guide on what makes a good skill.
101
-
102
- ## Step 5: Choose Install Location
103
-
104
- Ask: "Should this be available everywhere (user level) or just this project (project level)?"
105
-
106
- | Level | Path |
107
- |-------|------|
108
- | User | `~/.claude/skills/[name]/` |
109
- | Project | `.claude/skills/[name]/` |
110
-
111
- ## Step 6: Validate (Feedback Loop)
112
-
113
- Write the files, then validate:
114
-
115
- ```bash
116
- node ~/.claude/skills/creating-agent-skills/scripts/validate-skill.js [skill-path]
117
- ```
118
-
119
- **If errors found:**
120
- 1. Fix the specific issue
121
- 2. Run validation again
122
- 3. Repeat until passing
123
-
124
- **Only proceed when validation passes.**
125
-
126
- Then manually verify:
127
- - Is this written as instructions, not documentation?
128
- - Would Claude know what to DO after reading this?
129
- - Is heavy content in references/, not inline?
130
-
131
- ## Step 7: Test
132
-
133
- Guide the user:
134
- 1. Restart Claude Code
135
- 2. Say one of the trigger phrases or use `/skill-name` to invoke directly
136
- 3. Verify the skill activates and behaves as expected
137
-
138
- If it doesn't work, iterate. The conversation isn't over until the skill works.
139
-
140
- ## Key Principles
141
-
142
- **The conversation matters most.** A well-structured skill with shallow domain knowledge is worse than a rough skill with deep expertise captured.
143
-
144
- **Skills are prompts.** Every SKILL.md will be read by Claude. Write it as instructions, not as a README.
145
-
146
- **Trust Claude's intelligence.** Explain goals and principles. Don't micromanage with exact templates unless the task is genuinely complex or error-prone.
147
-
148
- **Progressive disclosure.** Load details only when needed. SKILL.md routes to references/, which contain the heavy content.
149
-
150
- ## Quality Check
151
-
152
- Before finishing, verify:
153
-
154
- 1. **Would Claude know what to DO?** Not just understand what the skill is about.
155
- 2. **Is domain knowledge captured?** The user's expertise should be in the skill.
156
- 3. **Is it lean?** Heavy content in references/, not SKILL.md.
157
- 4. **Does the description have triggers?** Specific phrases the user would say.
@@ -1,131 +0,0 @@
1
- # Modify an Existing Skill
2
-
3
- ## Contents
4
-
5
- - [Modification Checklist](#modification-checklist)
6
- - [Step 1: Find the Skill](#step-1-find-the-skill)
7
- - [Step 2: Read and Understand](#step-2-read-and-understand)
8
- - [Step 3: Understand What to Change](#step-3-understand-what-to-change)
9
- - [Step 4: Plan Changes](#step-4-plan-changes)
10
- - [Step 5: Apply Changes](#step-5-apply-changes)
11
- - [Step 6: Validate](#step-6-validate-feedback-loop)
12
- - [Step 7: Test](#step-7-test)
13
- - [Common Modifications](#common-modifications)
14
-
15
- ---
16
-
17
- ## Modification Checklist
18
-
19
- Copy and track progress:
20
-
21
- ```
22
- - [ ] Found the skill to modify
23
- - [ ] Read and understood current state
24
- - [ ] Clarified what to change
25
- - [ ] Planned specific changes
26
- - [ ] Applied changes
27
- - [ ] Validated (loop until clean)
28
- - [ ] Tested if behavior changed
29
- ```
30
-
31
- ## Step 1: Find the Skill
32
-
33
- Determine which skill to modify.
34
-
35
- If coming from audit, the path is known. Otherwise, ask the user or discover:
36
-
37
- ```bash
38
- node ~/.claude/skills/creating-agent-skills/scripts/find-skills.js
39
- ```
40
-
41
- Confirm the skill exists before proceeding.
42
-
43
- ## Step 2: Read and Understand
44
-
45
- Read the entire skill - SKILL.md and all files in references/, scripts/, assets/.
46
-
47
- Summarize for the user:
48
- - Current structure
49
- - Line count
50
- - Any obvious issues (documentation-style writing, inline content that should be in references)
51
-
52
- ## Step 3: Understand What to Change
53
-
54
- Ask what the user wants to change:
55
- - Fix issues from an audit?
56
- - Improve activation (better description/triggers)?
57
- - Add new capability?
58
- - Refactor structure?
59
- - Fix incorrect behavior?
60
-
61
- Get specific about what's wrong and what "fixed" looks like.
62
-
63
- ## Step 4: Plan Changes
64
-
65
- Before editing, state what will change:
66
- - Which files
67
- - What specifically changes
68
- - Any new files needed
69
-
70
- Confirm with user before proceeding.
71
-
72
- ## Step 5: Apply Changes
73
-
74
- Make the modifications. Key rules:
75
-
76
- **Keep it as instructions, not documentation.**
77
- If rewriting, ensure Claude would know what to DO after reading.
78
-
79
- **Maintain progressive disclosure.**
80
- If adding content, consider whether it belongs in references/ instead of SKILL.md.
81
-
82
- **Follow writing conventions.**
83
- Imperative form, positive framing, no second person.
84
-
85
- Read `references/principles.md` for full guidelines.
86
-
87
- ## Step 6: Validate (Feedback Loop)
88
-
89
- Run validation:
90
-
91
- ```bash
92
- node ~/.claude/skills/creating-agent-skills/scripts/validate-skill.js [skill-path]
93
- ```
94
-
95
- **If errors found:**
96
- 1. Fix the specific issue
97
- 2. Run validation again
98
- 3. Repeat until passing
99
-
100
- **Only proceed when validation passes.**
101
-
102
- Also manually verify:
103
- - Is this instructions, not documentation?
104
- - Would Claude know what to DO?
105
- - Is heavy content in references/?
106
-
107
- ## Step 7: Test
108
-
109
- If the change affects behavior:
110
- 1. Reinstall if needed
111
- 2. Restart Claude Code
112
- 3. Test that the skill works as expected
113
-
114
- ## Common Modifications
115
-
116
- **Fix documentation-style writing:**
117
- Rewrite sections that describe the skill ("This skill does X") as instructions ("Do X").
118
-
119
- **Improve activation:**
120
- Collect trigger phrases from user, add to description in third person with quotes.
121
-
122
- **Move content to references:**
123
- Identify inline content (schemas, detailed explanations) that should be loaded on-demand. Create reference file, add pointer in SKILL.md.
124
-
125
- **Fix second person:**
126
- "You should parse" -> "Parse"
127
- "You can use" -> "Use"
128
-
129
- **Fix negative framing:**
130
- "Don't skip validation" -> "Always validate"
131
- "Never assume" -> "Verify explicitly"