@fro.bot/systematic 1.23.0 → 1.23.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/agents/research/best-practices-researcher.md +9 -3
- package/agents/research/framework-docs-researcher.md +2 -0
- package/agents/research/git-history-analyzer.md +9 -6
- package/agents/research/issue-intelligence-analyst.md +232 -0
- package/agents/research/repo-research-analyst.md +6 -10
- package/commands/.gitkeep +0 -0
- package/package.json +1 -1
- package/skills/agent-browser/SKILL.md +4 -3
- package/skills/ce-brainstorm/SKILL.md +242 -52
- package/skills/ce-compound/SKILL.md +60 -40
- package/skills/ce-compound-refresh/SKILL.md +528 -0
- package/skills/ce-ideate/SKILL.md +371 -0
- package/skills/ce-plan/SKILL.md +40 -39
- package/skills/ce-plan-beta/SKILL.md +572 -0
- package/skills/ce-review/SKILL.md +7 -6
- package/skills/ce-work/SKILL.md +85 -75
- package/skills/create-agent-skill/SKILL.md +1 -1
- package/skills/create-agent-skills/SKILL.md +6 -5
- package/skills/deepen-plan/SKILL.md +11 -11
- package/skills/deepen-plan-beta/SKILL.md +323 -0
- package/skills/document-review/SKILL.md +14 -8
- package/skills/generate_command/SKILL.md +3 -2
- package/skills/lfg/SKILL.md +10 -7
- package/skills/report-bug/SKILL.md +15 -14
- package/skills/resolve_parallel/SKILL.md +2 -1
- package/skills/resolve_todo_parallel/SKILL.md +1 -1
- package/skills/slfg/SKILL.md +7 -4
- package/skills/test-browser/SKILL.md +3 -3
- package/skills/test-xcode/SKILL.md +2 -2
- package/agents/workflow/every-style-editor.md +0 -66
- package/commands/agent-native-audit.md +0 -279
- package/commands/ce/brainstorm.md +0 -145
- package/commands/ce/compound.md +0 -240
- package/commands/ce/plan.md +0 -636
- package/commands/ce/review.md +0 -525
- package/commands/ce/work.md +0 -456
- package/commands/changelog.md +0 -139
- package/commands/create-agent-skill.md +0 -9
- package/commands/deepen-plan.md +0 -546
- package/commands/deploy-docs.md +0 -120
- package/commands/feature-video.md +0 -352
- package/commands/generate_command.md +0 -164
- package/commands/heal-skill.md +0 -147
- package/commands/lfg.md +0 -20
- package/commands/report-bug.md +0 -151
- package/commands/reproduce-bug.md +0 -100
- package/commands/resolve_parallel.md +0 -36
- package/commands/resolve_todo_parallel.md +0 -37
- package/commands/slfg.md +0 -32
- package/commands/test-browser.md +0 -340
- package/commands/test-xcode.md +0 -332
- package/commands/triage.md +0 -311
- package/commands/workflows/brainstorm.md +0 -145
- package/commands/workflows/compound.md +0 -10
- package/commands/workflows/plan.md +0 -10
- package/commands/workflows/review.md +0 -10
- package/commands/workflows/work.md +0 -10
- package/skills/brainstorming/SKILL.md +0 -190
- package/skills/skill-creator/SKILL.md +0 -210
- package/skills/skill-creator/scripts/init_skill.py +0 -303
- package/skills/skill-creator/scripts/package_skill.py +0 -110
- package/skills/skill-creator/scripts/quick_validate.py +0 -65
|
@@ -1,145 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: workflows:brainstorm
|
|
3
|
-
description: Explore requirements and approaches through collaborative dialogue before planning implementation
|
|
4
|
-
argument-hint: '[feature idea or problem to explore]'
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
# Brainstorm a Feature or Improvement
|
|
8
|
-
|
|
9
|
-
**Note: The current year is 2026.** Use this when dating brainstorm documents.
|
|
10
|
-
|
|
11
|
-
Brainstorming helps answer **WHAT** to build through collaborative dialogue. It precedes `/workflows:plan`, which answers **HOW** to build it.
|
|
12
|
-
|
|
13
|
-
**Process knowledge:** Load the `brainstorming` skill for detailed question techniques, approach exploration patterns, and YAGNI principles.
|
|
14
|
-
|
|
15
|
-
## Feature Description
|
|
16
|
-
|
|
17
|
-
<feature_description> #$ARGUMENTS </feature_description>
|
|
18
|
-
|
|
19
|
-
**If the feature description above is empty, ask the user:** "What would you like to explore? Please describe the feature, problem, or improvement you're thinking about."
|
|
20
|
-
|
|
21
|
-
Do not proceed until you have a feature description from the user.
|
|
22
|
-
|
|
23
|
-
## Execution Flow
|
|
24
|
-
|
|
25
|
-
### Phase 0: Assess Requirements Clarity
|
|
26
|
-
|
|
27
|
-
Evaluate whether brainstorming is needed based on the feature description.
|
|
28
|
-
|
|
29
|
-
**Clear requirements indicators:**
|
|
30
|
-
- Specific acceptance criteria provided
|
|
31
|
-
- Referenced existing patterns to follow
|
|
32
|
-
- Described exact expected behavior
|
|
33
|
-
- Constrained, well-defined scope
|
|
34
|
-
|
|
35
|
-
**If requirements are already clear:**
|
|
36
|
-
Use **question tool** to suggest: "Your requirements seem detailed enough to proceed directly to planning. Should I run `/workflows:plan` instead, or would you like to explore the idea further?"
|
|
37
|
-
|
|
38
|
-
### Phase 1: Understand the Idea
|
|
39
|
-
|
|
40
|
-
#### 1.1 Repository Research (Lightweight)
|
|
41
|
-
|
|
42
|
-
Run a quick repo scan to understand existing patterns:
|
|
43
|
-
|
|
44
|
-
- task repo-research-analyst("Understand existing patterns related to: <feature_description>")
|
|
45
|
-
|
|
46
|
-
Focus on: similar features, established patterns, AGENTS.md guidance.
|
|
47
|
-
|
|
48
|
-
#### 1.2 Collaborative Dialogue
|
|
49
|
-
|
|
50
|
-
Use the **question tool** to ask questions **one at a time**.
|
|
51
|
-
|
|
52
|
-
**Guidelines (see `brainstorming` skill for detailed techniques):**
|
|
53
|
-
- Prefer multiple choice when natural options exist
|
|
54
|
-
- Start broad (purpose, users) then narrow (constraints, edge cases)
|
|
55
|
-
- Validate assumptions explicitly
|
|
56
|
-
- Ask about success criteria
|
|
57
|
-
|
|
58
|
-
**Exit condition:** Continue until the idea is clear OR user says "proceed"
|
|
59
|
-
|
|
60
|
-
### Phase 2: Explore Approaches
|
|
61
|
-
|
|
62
|
-
Propose **2-3 concrete approaches** based on research and conversation.
|
|
63
|
-
|
|
64
|
-
For each approach, provide:
|
|
65
|
-
- Brief description (2-3 sentences)
|
|
66
|
-
- Pros and cons
|
|
67
|
-
- When it's best suited
|
|
68
|
-
|
|
69
|
-
Lead with your recommendation and explain why. Apply YAGNI—prefer simpler solutions.
|
|
70
|
-
|
|
71
|
-
Use **question tool** to ask which approach the user prefers.
|
|
72
|
-
|
|
73
|
-
### Phase 3: Capture the Design
|
|
74
|
-
|
|
75
|
-
Write a brainstorm document to `docs/brainstorms/YYYY-MM-DD-<topic>-brainstorm.md`.
|
|
76
|
-
|
|
77
|
-
**Document structure:** See the `brainstorming` skill for the template format. Key sections: What We're Building, Why This Approach, Key Decisions, Open Questions.
|
|
78
|
-
|
|
79
|
-
Ensure `docs/brainstorms/` directory exists before writing.
|
|
80
|
-
|
|
81
|
-
**IMPORTANT:** Before proceeding to Phase 4, check if there are any Open Questions listed in the brainstorm document. If there are open questions, YOU MUST ask the user about each one using question before offering to proceed to planning. Move resolved questions to a "Resolved Questions" section.
|
|
82
|
-
|
|
83
|
-
### Phase 4: Handoff
|
|
84
|
-
|
|
85
|
-
Use **question tool** to present next steps:
|
|
86
|
-
|
|
87
|
-
**Question:** "Brainstorm captured. What would you like to do next?"
|
|
88
|
-
|
|
89
|
-
**Options:**
|
|
90
|
-
1. **Review and refine** - Improve the document through structured self-review
|
|
91
|
-
2. **Proceed to planning** - Run `/workflows:plan` (will auto-detect this brainstorm)
|
|
92
|
-
3. **Share to Proof** - Upload to Proof for collaborative review and sharing
|
|
93
|
-
4. **Ask more questions** - I have more questions to clarify before moving on
|
|
94
|
-
5. **Done for now** - Return later
|
|
95
|
-
|
|
96
|
-
**If user selects "Share to Proof":**
|
|
97
|
-
|
|
98
|
-
```bash
|
|
99
|
-
CONTENT=$(cat docs/brainstorms/YYYY-MM-DD-<topic>-brainstorm.md)
|
|
100
|
-
TITLE="Brainstorm: <topic title>"
|
|
101
|
-
RESPONSE=$(curl -s -X POST https://www.proofeditor.ai/share/markdown \
|
|
102
|
-
-H "Content-Type: application/json" \
|
|
103
|
-
-d "$(jq -n --arg title "$TITLE" --arg markdown "$CONTENT" --arg by "ai:compound" '{title: $title, markdown: $markdown, by: $by}')")
|
|
104
|
-
PROOF_URL=$(echo "$RESPONSE" | jq -r '.tokenUrl')
|
|
105
|
-
```
|
|
106
|
-
|
|
107
|
-
Display the URL prominently: `View & collaborate in Proof: <PROOF_URL>`
|
|
108
|
-
|
|
109
|
-
If the curl fails, skip silently. Then return to the Phase 4 options.
|
|
110
|
-
|
|
111
|
-
**If user selects "Ask more questions":** YOU (Claude) return to Phase 1.2 (Collaborative Dialogue) and continue asking the USER questions one at a time to further refine the design. The user wants YOU to probe deeper - ask about edge cases, constraints, preferences, or areas not yet explored. Continue until the user is satisfied, then return to Phase 4.
|
|
112
|
-
|
|
113
|
-
**If user selects "Review and refine":**
|
|
114
|
-
|
|
115
|
-
Load the `document-review` skill and apply it to the brainstorm document.
|
|
116
|
-
|
|
117
|
-
When document-review returns "Review complete", present next steps:
|
|
118
|
-
|
|
119
|
-
1. **Move to planning** - Continue to `/workflows:plan` with this document
|
|
120
|
-
2. **Done for now** - Brainstorming complete. To start planning later: `/workflows:plan [document-path]`
|
|
121
|
-
|
|
122
|
-
## Output Summary
|
|
123
|
-
|
|
124
|
-
When complete, display:
|
|
125
|
-
|
|
126
|
-
```
|
|
127
|
-
Brainstorm complete!
|
|
128
|
-
|
|
129
|
-
Document: docs/brainstorms/YYYY-MM-DD-<topic>-brainstorm.md
|
|
130
|
-
|
|
131
|
-
Key decisions:
|
|
132
|
-
- [Decision 1]
|
|
133
|
-
- [Decision 2]
|
|
134
|
-
|
|
135
|
-
Next: Run `/workflows:plan` when ready to implement.
|
|
136
|
-
```
|
|
137
|
-
|
|
138
|
-
## Important Guidelines
|
|
139
|
-
|
|
140
|
-
- **Stay focused on WHAT, not HOW** - Implementation details belong in the plan
|
|
141
|
-
- **Ask one question at a time** - Don't overwhelm
|
|
142
|
-
- **Apply YAGNI** - Prefer simpler approaches
|
|
143
|
-
- **Keep outputs concise** - 200-300 words per section max
|
|
144
|
-
|
|
145
|
-
NEVER CODE! Just explore and document decisions.
|
|
@@ -1,10 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: workflows:compound
|
|
3
|
-
description: "[DEPRECATED] Use /ce:compound instead — renamed for clarity."
|
|
4
|
-
argument-hint: "[optional: brief context about the fix]"
|
|
5
|
-
disable-model-invocation: true
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
NOTE: /workflows:compound is deprecated. Please use /ce:compound instead. This alias will be removed in a future version.
|
|
9
|
-
|
|
10
|
-
/ce:compound $ARGUMENTS
|
|
@@ -1,10 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: workflows:plan
|
|
3
|
-
description: "[DEPRECATED] Use /ce:plan instead — renamed for clarity."
|
|
4
|
-
argument-hint: "[feature description, bug report, or improvement idea]"
|
|
5
|
-
disable-model-invocation: true
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
NOTE: /workflows:plan is deprecated. Please use /ce:plan instead. This alias will be removed in a future version.
|
|
9
|
-
|
|
10
|
-
/ce:plan $ARGUMENTS
|
|
@@ -1,10 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: workflows:review
|
|
3
|
-
description: "[DEPRECATED] Use /ce:review instead — renamed for clarity."
|
|
4
|
-
argument-hint: "[PR number, GitHub URL, branch name, or latest]"
|
|
5
|
-
disable-model-invocation: true
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
NOTE: /workflows:review is deprecated. Please use /ce:review instead. This alias will be removed in a future version.
|
|
9
|
-
|
|
10
|
-
/ce:review $ARGUMENTS
|
|
@@ -1,10 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: workflows:work
|
|
3
|
-
description: "[DEPRECATED] Use /ce:work instead — renamed for clarity."
|
|
4
|
-
argument-hint: "[plan file, specification, or todo file path]"
|
|
5
|
-
disable-model-invocation: true
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
NOTE: /workflows:work is deprecated. Please use /ce:work instead. This alias will be removed in a future version.
|
|
9
|
-
|
|
10
|
-
/ce:work $ARGUMENTS
|
|
@@ -1,190 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: brainstorming
|
|
3
|
-
description: This skill should be used before implementing features, building components, or making changes. It guides exploring user intent, approaches, and design decisions before planning. Triggers on "let's brainstorm", "help me think through", "what should we build", "explore approaches", ambiguous feature requests, or when the user's request has multiple valid interpretations that need clarification.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Brainstorming
|
|
7
|
-
|
|
8
|
-
This skill provides detailed process knowledge for effective brainstorming sessions that clarify **WHAT** to build before diving into **HOW** to build it.
|
|
9
|
-
|
|
10
|
-
## When to Use This Skill
|
|
11
|
-
|
|
12
|
-
Brainstorming is valuable when:
|
|
13
|
-
- Requirements are unclear or ambiguous
|
|
14
|
-
- Multiple approaches could solve the problem
|
|
15
|
-
- Trade-offs need to be explored with the user
|
|
16
|
-
- The user hasn't fully articulated what they want
|
|
17
|
-
- The feature scope needs refinement
|
|
18
|
-
|
|
19
|
-
Brainstorming can be skipped when:
|
|
20
|
-
- Requirements are explicit and detailed
|
|
21
|
-
- The user knows exactly what they want
|
|
22
|
-
- The task is a straightforward bug fix or well-defined change
|
|
23
|
-
|
|
24
|
-
## Core Process
|
|
25
|
-
|
|
26
|
-
### Phase 0: Assess Requirement Clarity
|
|
27
|
-
|
|
28
|
-
Before diving into questions, assess whether brainstorming is needed.
|
|
29
|
-
|
|
30
|
-
**Signals that requirements are clear:**
|
|
31
|
-
- User provided specific acceptance criteria
|
|
32
|
-
- User referenced existing patterns to follow
|
|
33
|
-
- User described exact behavior expected
|
|
34
|
-
- Scope is constrained and well-defined
|
|
35
|
-
|
|
36
|
-
**Signals that brainstorming is needed:**
|
|
37
|
-
- User used vague terms ("make it better", "add something like")
|
|
38
|
-
- Multiple reasonable interpretations exist
|
|
39
|
-
- Trade-offs haven't been discussed
|
|
40
|
-
- User seems unsure about the approach
|
|
41
|
-
|
|
42
|
-
If requirements are clear, suggest: "Your requirements seem clear. Consider proceeding directly to planning or implementation."
|
|
43
|
-
|
|
44
|
-
### Phase 1: Understand the Idea
|
|
45
|
-
|
|
46
|
-
Ask questions **one at a time** to understand the user's intent. Avoid overwhelming with multiple questions.
|
|
47
|
-
|
|
48
|
-
**Question Techniques:**
|
|
49
|
-
|
|
50
|
-
1. **Prefer multiple choice when natural options exist**
|
|
51
|
-
- Good: "Should the notification be: (a) email only, (b) in-app only, or (c) both?"
|
|
52
|
-
- Avoid: "How should users be notified?"
|
|
53
|
-
|
|
54
|
-
2. **Start broad, then narrow**
|
|
55
|
-
- First: What is the core purpose?
|
|
56
|
-
- Then: Who are the users?
|
|
57
|
-
- Finally: What constraints exist?
|
|
58
|
-
|
|
59
|
-
3. **Validate assumptions explicitly**
|
|
60
|
-
- "I'm assuming users will be logged in. Is that correct?"
|
|
61
|
-
|
|
62
|
-
4. **Ask about success criteria early**
|
|
63
|
-
- "How will you know this feature is working well?"
|
|
64
|
-
|
|
65
|
-
**Key Topics to Explore:**
|
|
66
|
-
|
|
67
|
-
| Topic | Example Questions |
|
|
68
|
-
|-------|-------------------|
|
|
69
|
-
| Purpose | What problem does this solve? What's the motivation? |
|
|
70
|
-
| Users | Who uses this? What's their context? |
|
|
71
|
-
| Constraints | Any technical limitations? Timeline? Dependencies? |
|
|
72
|
-
| Success | How will you measure success? What's the happy path? |
|
|
73
|
-
| Edge Cases | What shouldn't happen? Any error states to consider? |
|
|
74
|
-
| Existing Patterns | Are there similar features in the codebase to follow? |
|
|
75
|
-
|
|
76
|
-
**Exit Condition:** Continue until the idea is clear OR user says "proceed" or "let's move on"
|
|
77
|
-
|
|
78
|
-
### Phase 2: Explore Approaches
|
|
79
|
-
|
|
80
|
-
After understanding the idea, propose 2-3 concrete approaches.
|
|
81
|
-
|
|
82
|
-
**Structure for Each Approach:**
|
|
83
|
-
|
|
84
|
-
```markdown
|
|
85
|
-
### Approach A: [Name]
|
|
86
|
-
|
|
87
|
-
[2-3 sentence description]
|
|
88
|
-
|
|
89
|
-
**Pros:**
|
|
90
|
-
- [Benefit 1]
|
|
91
|
-
- [Benefit 2]
|
|
92
|
-
|
|
93
|
-
**Cons:**
|
|
94
|
-
- [Drawback 1]
|
|
95
|
-
- [Drawback 2]
|
|
96
|
-
|
|
97
|
-
**Best when:** [Circumstances where this approach shines]
|
|
98
|
-
```
|
|
99
|
-
|
|
100
|
-
**Guidelines:**
|
|
101
|
-
- Lead with a recommendation and explain why
|
|
102
|
-
- Be honest about trade-offs
|
|
103
|
-
- Consider YAGNI—simpler is usually better
|
|
104
|
-
- Reference codebase patterns when relevant
|
|
105
|
-
|
|
106
|
-
### Phase 3: Capture the Design
|
|
107
|
-
|
|
108
|
-
Summarize key decisions in a structured format.
|
|
109
|
-
|
|
110
|
-
**Design Doc Structure:**
|
|
111
|
-
|
|
112
|
-
```markdown
|
|
113
|
-
---
|
|
114
|
-
date: YYYY-MM-DD
|
|
115
|
-
topic: <kebab-case-topic>
|
|
116
|
-
---
|
|
117
|
-
|
|
118
|
-
# <Topic Title>
|
|
119
|
-
|
|
120
|
-
## What We're Building
|
|
121
|
-
[Concise description—1-2 paragraphs max]
|
|
122
|
-
|
|
123
|
-
## Why This Approach
|
|
124
|
-
[Brief explanation of approaches considered and why this one was chosen]
|
|
125
|
-
|
|
126
|
-
## Key Decisions
|
|
127
|
-
- [Decision 1]: [Rationale]
|
|
128
|
-
- [Decision 2]: [Rationale]
|
|
129
|
-
|
|
130
|
-
## Open Questions
|
|
131
|
-
- [Any unresolved questions for the planning phase]
|
|
132
|
-
|
|
133
|
-
## Next Steps
|
|
134
|
-
→ `/workflows:plan` for implementation details
|
|
135
|
-
```
|
|
136
|
-
|
|
137
|
-
**Output Location:** `docs/brainstorms/YYYY-MM-DD-<topic>-brainstorm.md`
|
|
138
|
-
|
|
139
|
-
### Phase 4: Handoff
|
|
140
|
-
|
|
141
|
-
Present clear options for what to do next:
|
|
142
|
-
|
|
143
|
-
1. **Proceed to planning** → Run `/workflows:plan`
|
|
144
|
-
2. **Refine further** → Continue exploring the design
|
|
145
|
-
3. **Done for now** → User will return later
|
|
146
|
-
|
|
147
|
-
## YAGNI Principles
|
|
148
|
-
|
|
149
|
-
During brainstorming, actively resist complexity:
|
|
150
|
-
|
|
151
|
-
- **Don't design for hypothetical future requirements**
|
|
152
|
-
- **Choose the simplest approach that solves the stated problem**
|
|
153
|
-
- **Prefer boring, proven patterns over clever solutions**
|
|
154
|
-
- **Ask "Do we really need this?" when complexity emerges**
|
|
155
|
-
- **Defer decisions that don't need to be made now**
|
|
156
|
-
|
|
157
|
-
## Incremental Validation
|
|
158
|
-
|
|
159
|
-
Keep sections short—200-300 words maximum. After each section of output, pause to validate understanding:
|
|
160
|
-
|
|
161
|
-
- "Does this match what you had in mind?"
|
|
162
|
-
- "Any adjustments before we continue?"
|
|
163
|
-
- "Is this the direction you want to go?"
|
|
164
|
-
|
|
165
|
-
This prevents wasted effort on misaligned designs.
|
|
166
|
-
|
|
167
|
-
## Anti-Patterns to Avoid
|
|
168
|
-
|
|
169
|
-
| Anti-Pattern | Better Approach |
|
|
170
|
-
|--------------|-----------------|
|
|
171
|
-
| Asking 5 questions at once | Ask one at a time |
|
|
172
|
-
| Jumping to implementation details | Stay focused on WHAT, not HOW |
|
|
173
|
-
| Proposing overly complex solutions | Start simple, add complexity only if needed |
|
|
174
|
-
| Ignoring existing codebase patterns | Research what exists first |
|
|
175
|
-
| Making assumptions without validating | State assumptions explicitly and confirm |
|
|
176
|
-
| Creating lengthy design documents | Keep it concise—details go in the plan |
|
|
177
|
-
|
|
178
|
-
## Integration with Planning
|
|
179
|
-
|
|
180
|
-
Brainstorming answers **WHAT** to build:
|
|
181
|
-
- Requirements and acceptance criteria
|
|
182
|
-
- Chosen approach and rationale
|
|
183
|
-
- Key decisions and trade-offs
|
|
184
|
-
|
|
185
|
-
Planning answers **HOW** to build it:
|
|
186
|
-
- Implementation steps and file changes
|
|
187
|
-
- Technical details and code patterns
|
|
188
|
-
- Testing strategy and verification
|
|
189
|
-
|
|
190
|
-
When brainstorm output exists, `/workflows:plan` should detect it and use it as input, skipping its own idea refinement phase.
|
|
@@ -1,210 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: skill-creator
|
|
3
|
-
description: Guide for creating effective skills. This skill should be used when users want to create a new skill (or update an existing skill) that extends Claude's capabilities with specialized knowledge, workflows, or tool integrations.
|
|
4
|
-
license: Complete terms in LICENSE.txt
|
|
5
|
-
disable-model-invocation: true
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
# Skill Creator
|
|
9
|
-
|
|
10
|
-
This skill provides guidance for creating effective skills.
|
|
11
|
-
|
|
12
|
-
## About Skills
|
|
13
|
-
|
|
14
|
-
Skills are modular, self-contained packages that extend Claude's capabilities by providing
|
|
15
|
-
specialized knowledge, workflows, and tools. Think of them as "onboarding guides" for specific
|
|
16
|
-
domains or tasks—they transform Claude from a general-purpose agent into a specialized agent
|
|
17
|
-
equipped with procedural knowledge that no model can fully possess.
|
|
18
|
-
|
|
19
|
-
### What Skills Provide
|
|
20
|
-
|
|
21
|
-
1. Specialized workflows - Multi-step procedures for specific domains
|
|
22
|
-
2. Tool integrations - Instructions for working with specific file formats or APIs
|
|
23
|
-
3. Domain expertise - Company-specific knowledge, schemas, business logic
|
|
24
|
-
4. Bundled resources - Scripts, references, and assets for complex and repetitive tasks
|
|
25
|
-
|
|
26
|
-
### Anatomy of a Skill
|
|
27
|
-
|
|
28
|
-
Every skill consists of a required SKILL.md file and optional bundled resources:
|
|
29
|
-
|
|
30
|
-
```
|
|
31
|
-
skill-name/
|
|
32
|
-
├── SKILL.md (required)
|
|
33
|
-
│ ├── YAML frontmatter metadata (required)
|
|
34
|
-
│ │ ├── name: (required)
|
|
35
|
-
│ │ └── description: (required)
|
|
36
|
-
│ └── Markdown instructions (required)
|
|
37
|
-
└── Bundled Resources (optional)
|
|
38
|
-
├── scripts/ - Executable code (Python/Bash/etc.)
|
|
39
|
-
├── references/ - Documentation intended to be loaded into context as needed
|
|
40
|
-
└── assets/ - Files used in output (templates, icons, fonts, etc.)
|
|
41
|
-
```
|
|
42
|
-
|
|
43
|
-
#### SKILL.md (required)
|
|
44
|
-
|
|
45
|
-
**Metadata Quality:** The `name` and `description` in YAML frontmatter determine when Claude will use the skill. Be specific about what the skill does and when to use it. Use the third-person (e.g. "This skill should be used when..." instead of "Use this skill when...").
|
|
46
|
-
|
|
47
|
-
#### Bundled Resources (optional)
|
|
48
|
-
|
|
49
|
-
##### Scripts (`scripts/`)
|
|
50
|
-
|
|
51
|
-
Executable code (Python/Bash/etc.) for tasks that require deterministic reliability or are repeatedly rewritten.
|
|
52
|
-
|
|
53
|
-
- **When to include**: When the same code is being rewritten repeatedly or deterministic reliability is needed
|
|
54
|
-
- **Example**: `scripts/rotate_pdf.py` for PDF rotation tasks
|
|
55
|
-
- **Benefits**: Token efficient, deterministic, may be executed without loading into context
|
|
56
|
-
- **Note**: Scripts may still need to be read by Claude for patching or environment-specific adjustments
|
|
57
|
-
|
|
58
|
-
##### References (`references/`)
|
|
59
|
-
|
|
60
|
-
Documentation and reference material intended to be loaded as needed into context to inform Claude's process and thinking.
|
|
61
|
-
|
|
62
|
-
- **When to include**: For documentation that Claude should reference while working
|
|
63
|
-
- **Examples**: `references/finance.md` for financial schemas, `references/mnda.md` for company NDA template, `references/policies.md` for company policies, `references/api_docs.md` for API specifications
|
|
64
|
-
- **Use cases**: Database schemas, API documentation, domain knowledge, company policies, detailed workflow guides
|
|
65
|
-
- **Benefits**: Keeps SKILL.md lean, loaded only when Claude determines it's needed
|
|
66
|
-
- **Best practice**: If files are large (>10k words), include grep search patterns in SKILL.md
|
|
67
|
-
- **Avoid duplication**: Information should live in either SKILL.md or references files, not both. Prefer references files for detailed information unless it's truly core to the skill—this keeps SKILL.md lean while making information discoverable without hogging the context window. Keep only essential procedural instructions and workflow guidance in SKILL.md; move detailed reference material, schemas, and examples to references files.
|
|
68
|
-
|
|
69
|
-
##### Assets (`assets/`)
|
|
70
|
-
|
|
71
|
-
Files not intended to be loaded into context, but rather used within the output Claude produces.
|
|
72
|
-
|
|
73
|
-
- **When to include**: When the skill needs files that will be used in the final output
|
|
74
|
-
- **Examples**: `assets/logo.png` for brand assets, `assets/slides.pptx` for PowerPoint templates, `assets/frontend-template/` for HTML/React boilerplate, `assets/font.ttf` for typography
|
|
75
|
-
- **Use cases**: Templates, images, icons, boilerplate code, fonts, sample documents that get copied or modified
|
|
76
|
-
- **Benefits**: Separates output resources from documentation, enables Claude to use files without loading them into context
|
|
77
|
-
|
|
78
|
-
### Progressive Disclosure Design Principle
|
|
79
|
-
|
|
80
|
-
Skills use a three-level loading system to manage context efficiently:
|
|
81
|
-
|
|
82
|
-
1. **Metadata (name + description)** - Always in context (~100 words)
|
|
83
|
-
2. **SKILL.md body** - When skill triggers (<5k words)
|
|
84
|
-
3. **Bundled resources** - As needed by Claude (Unlimited*)
|
|
85
|
-
|
|
86
|
-
*Unlimited because scripts can be executed without reading into context window.
|
|
87
|
-
|
|
88
|
-
## Skill Creation Process
|
|
89
|
-
|
|
90
|
-
To create a skill, follow the "Skill Creation Process" in order, skipping steps only if there is a clear reason why they are not applicable.
|
|
91
|
-
|
|
92
|
-
### Step 1: Understanding the Skill with Concrete Examples
|
|
93
|
-
|
|
94
|
-
Skip this step only when the skill's usage patterns are already clearly understood. It remains valuable even when working with an existing skill.
|
|
95
|
-
|
|
96
|
-
To create an effective skill, clearly understand concrete examples of how the skill will be used. This understanding can come from either direct user examples or generated examples that are validated with user feedback.
|
|
97
|
-
|
|
98
|
-
For example, when building an image-editor skill, relevant questions include:
|
|
99
|
-
|
|
100
|
-
- "What functionality should the image-editor skill support? Editing, rotating, anything else?"
|
|
101
|
-
- "Can you give some examples of how this skill would be used?"
|
|
102
|
-
- "I can imagine users asking for things like 'Remove the red-eye from this image' or 'Rotate this image'. Are there other ways you imagine this skill being used?"
|
|
103
|
-
- "What would a user say that should trigger this skill?"
|
|
104
|
-
|
|
105
|
-
To avoid overwhelming users, avoid asking too many questions in a single message. Start with the most important questions and follow up as needed for better effectiveness.
|
|
106
|
-
|
|
107
|
-
Conclude this step when there is a clear sense of the functionality the skill should support.
|
|
108
|
-
|
|
109
|
-
### Step 2: Planning the Reusable Skill Contents
|
|
110
|
-
|
|
111
|
-
To turn concrete examples into an effective skill, analyze each example by:
|
|
112
|
-
|
|
113
|
-
1. Considering how to execute on the example from scratch
|
|
114
|
-
2. Identifying what scripts, references, and assets would be helpful when executing these workflows repeatedly
|
|
115
|
-
|
|
116
|
-
Example: When building a `pdf-editor` skill to handle queries like "Help me rotate this PDF," the analysis shows:
|
|
117
|
-
|
|
118
|
-
1. Rotating a PDF requires re-writing the same code each time
|
|
119
|
-
2. A `scripts/rotate_pdf.py` script would be helpful to store in the skill
|
|
120
|
-
|
|
121
|
-
Example: When designing a `frontend-webapp-builder` skill for queries like "Build me a todo app" or "Build me a dashboard to track my steps," the analysis shows:
|
|
122
|
-
|
|
123
|
-
1. Writing a frontend webapp requires the same boilerplate HTML/React each time
|
|
124
|
-
2. An `assets/hello-world/` template containing the boilerplate HTML/React project files would be helpful to store in the skill
|
|
125
|
-
|
|
126
|
-
Example: When building a `big-query` skill to handle queries like "How many users have logged in today?" the analysis shows:
|
|
127
|
-
|
|
128
|
-
1. Querying BigQuery requires re-discovering the table schemas and relationships each time
|
|
129
|
-
2. A `references/schema.md` file documenting the table schemas would be helpful to store in the skill
|
|
130
|
-
|
|
131
|
-
To establish the skill's contents, analyze each concrete example to create a list of the reusable resources to include: scripts, references, and assets.
|
|
132
|
-
|
|
133
|
-
### Step 3: Initializing the Skill
|
|
134
|
-
|
|
135
|
-
At this point, it is time to actually create the skill.
|
|
136
|
-
|
|
137
|
-
Skip this step only if the skill being developed already exists, and iteration or packaging is needed. In this case, continue to the next step.
|
|
138
|
-
|
|
139
|
-
When creating a new skill from scratch, always run the `init_skill.py` script. The script conveniently generates a new template skill directory that automatically includes everything a skill requires, making the skill creation process much more efficient and reliable.
|
|
140
|
-
|
|
141
|
-
Usage:
|
|
142
|
-
|
|
143
|
-
```bash
|
|
144
|
-
scripts/init_skill.py <skill-name> --path <output-directory>
|
|
145
|
-
```
|
|
146
|
-
|
|
147
|
-
The script:
|
|
148
|
-
|
|
149
|
-
- Creates the skill directory at the specified path
|
|
150
|
-
- Generates a SKILL.md template with proper frontmatter and TODO placeholders
|
|
151
|
-
- Creates example resource directories: `scripts/`, `references/`, and `assets/`
|
|
152
|
-
- Adds example files in each directory that can be customized or deleted
|
|
153
|
-
|
|
154
|
-
After initialization, customize or remove the generated SKILL.md and example files as needed.
|
|
155
|
-
|
|
156
|
-
### Step 4: Edit the Skill
|
|
157
|
-
|
|
158
|
-
When editing the (newly-generated or existing) skill, remember that the skill is being created for another instance of Claude to use. Focus on including information that would be beneficial and non-obvious to Claude. Consider what procedural knowledge, domain-specific details, or reusable assets would help another Claude instance execute these tasks more effectively.
|
|
159
|
-
|
|
160
|
-
#### Start with Reusable Skill Contents
|
|
161
|
-
|
|
162
|
-
To begin implementation, start with the reusable resources identified above: `scripts/`, `references/`, and `assets/` files. Note that this step may require user input. For example, when implementing a `brand-guidelines` skill, the user may need to provide brand assets or templates to store in `assets/`, or documentation to store in `references/`.
|
|
163
|
-
|
|
164
|
-
Also, delete any example files and directories not needed for the skill. The initialization script creates example files in `scripts/`, `references/`, and `assets/` to demonstrate structure, but most skills won't need all of them.
|
|
165
|
-
|
|
166
|
-
#### Update SKILL.md
|
|
167
|
-
|
|
168
|
-
**Writing Style:** Write the entire skill using **imperative/infinitive form** (verb-first instructions), not second person. Use objective, instructional language (e.g., "To accomplish X, do Y" rather than "You should do X" or "If you need to do X"). This maintains consistency and clarity for AI consumption.
|
|
169
|
-
|
|
170
|
-
To complete SKILL.md, answer the following questions:
|
|
171
|
-
|
|
172
|
-
1. What is the purpose of the skill, in a few sentences?
|
|
173
|
-
2. When should the skill be used?
|
|
174
|
-
3. In practice, how should Claude use the skill? All reusable skill contents developed above should be referenced so that Claude knows how to use them.
|
|
175
|
-
|
|
176
|
-
### Step 5: Packaging a Skill
|
|
177
|
-
|
|
178
|
-
Once the skill is ready, it should be packaged into a distributable zip file that gets shared with the user. The packaging process automatically validates the skill first to ensure it meets all requirements:
|
|
179
|
-
|
|
180
|
-
```bash
|
|
181
|
-
scripts/package_skill.py <path/to/skill-folder>
|
|
182
|
-
```
|
|
183
|
-
|
|
184
|
-
Optional output directory specification:
|
|
185
|
-
|
|
186
|
-
```bash
|
|
187
|
-
scripts/package_skill.py <path/to/skill-folder> ./dist
|
|
188
|
-
```
|
|
189
|
-
|
|
190
|
-
The packaging script will:
|
|
191
|
-
|
|
192
|
-
1. **Validate** the skill automatically, checking:
|
|
193
|
-
- YAML frontmatter format and required fields
|
|
194
|
-
- Skill naming conventions and directory structure
|
|
195
|
-
- Description completeness and quality
|
|
196
|
-
- File organization and resource references
|
|
197
|
-
|
|
198
|
-
2. **Package** the skill if validation passes, creating a zip file named after the skill (e.g., `my-skill.zip`) that includes all files and maintains the proper directory structure for distribution.
|
|
199
|
-
|
|
200
|
-
If validation fails, the script will report the errors and exit without creating a package. Fix any validation errors and run the packaging command again.
|
|
201
|
-
|
|
202
|
-
### Step 6: Iterate
|
|
203
|
-
|
|
204
|
-
After testing the skill, users may request improvements. Often this happens right after using the skill, with fresh context of how the skill performed.
|
|
205
|
-
|
|
206
|
-
**Iteration workflow:**
|
|
207
|
-
1. Use the skill on real tasks
|
|
208
|
-
2. Notice struggles or inefficiencies
|
|
209
|
-
3. Identify how SKILL.md or bundled resources should be updated
|
|
210
|
-
4. Implement changes and test again
|