ccstart 2.0.0 → 2.1.0
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/README.md +61 -280
- package/bin/create-project.bak.js +1 -1
- package/bin/create-project.js +176 -6
- package/package.json +3 -3
- package/template/claude/CLAUDE.md +97 -6
- package/template/claude/agents/backend.md +0 -1
- package/template/claude/agents/blockchain.md +0 -1
- package/template/claude/agents/checker.md +0 -1
- package/template/claude/agents/coder.md +0 -1
- package/template/claude/agents/frontend.md +0 -1
- package/template/claude/agents/planner.md +0 -1
- package/template/claude/agents/researcher.md +0 -1
- package/template/claude/agents/shadcn.md +0 -1
- package/template/claude/skills/commit/SKILL.md +97 -0
- package/template/claude/skills/create-pr/SKILL.md +84 -0
- package/template/claude/skills/create-ticket/SKILL.md +102 -0
- package/template/claude/skills/design-feature/SKILL.md +111 -0
- package/template/claude/skills/design-principles/skill.md +237 -0
- package/template/claude/skills/skill-creator/SKILL.md +356 -0
- package/template/claude/plans/README.md +0 -53
|
@@ -0,0 +1,237 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: design-principles
|
|
3
|
+
description: Enforce a precise, minimal design system inspired by Linear, Notion, and Stripe. Use this skill when building dashboards, admin interfaces, or any UI that needs Jony Ive-level precision - clean, modern, minimalist with taste. Every pixel matters.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Design Principles
|
|
7
|
+
|
|
8
|
+
This skill enforces precise, crafted design for enterprise software, SaaS dashboards, admin interfaces, and web applications. The philosophy is Jony Ive-level precision with intentional personality — every interface is polished, and each is designed for its specific context.
|
|
9
|
+
|
|
10
|
+
## Design Direction (REQUIRED)
|
|
11
|
+
|
|
12
|
+
**Before writing any code, commit to a design direction.** Don't default. Think about what this specific product needs to feel like.
|
|
13
|
+
|
|
14
|
+
### Think About Context
|
|
15
|
+
|
|
16
|
+
- **What does this product do?** A finance tool needs different energy than a creative tool.
|
|
17
|
+
- **Who uses it?** Power users want density. Occasional users want guidance.
|
|
18
|
+
- **What's the emotional job?** Trust? Efficiency? Delight? Focus?
|
|
19
|
+
- **What would make this memorable?** Every product has a chance to feel distinctive.
|
|
20
|
+
|
|
21
|
+
### Choose a Personality
|
|
22
|
+
|
|
23
|
+
Enterprise/SaaS UI has more range than you think. Consider these directions:
|
|
24
|
+
|
|
25
|
+
**Precision & Density** — Tight spacing, monochrome, information-forward. For power users who live in the tool. Think Linear, Raycast, terminal aesthetics.
|
|
26
|
+
|
|
27
|
+
**Warmth & Approachability** — Generous spacing, soft shadows, friendly colors. For products that want to feel human. Think Notion, Coda, collaborative tools.
|
|
28
|
+
|
|
29
|
+
**Sophistication & Trust** — Cool tones, layered depth, financial gravitas. For products handling money or sensitive data. Think Stripe, Mercury, enterprise B2B.
|
|
30
|
+
|
|
31
|
+
**Boldness & Clarity** — High contrast, dramatic negative space, confident typography. For products that want to feel modern and decisive. Think Vercel, minimal dashboards.
|
|
32
|
+
|
|
33
|
+
**Utility & Function** — Muted palette, functional density, clear hierarchy. For products where the work matters more than the chrome. Think GitHub, developer tools.
|
|
34
|
+
|
|
35
|
+
**Data & Analysis** — Chart-optimized, technical but accessible, numbers as first-class citizens. For analytics, metrics, business intelligence.
|
|
36
|
+
|
|
37
|
+
Pick one. Or blend two. But commit to a direction that fits the product.
|
|
38
|
+
|
|
39
|
+
### Choose a Color Foundation
|
|
40
|
+
|
|
41
|
+
**Don't default to warm neutrals.** Consider the product:
|
|
42
|
+
|
|
43
|
+
- **Warm foundations** (creams, warm grays) — approachable, comfortable, human
|
|
44
|
+
- **Cool foundations** (slate, blue-gray) — professional, trustworthy, serious
|
|
45
|
+
- **Pure neutrals** (true grays, black/white) — minimal, bold, technical
|
|
46
|
+
- **Tinted foundations** (slight color cast) — distinctive, memorable, branded
|
|
47
|
+
|
|
48
|
+
**Light or dark?** Dark modes aren't just light modes inverted. Dark feels technical, focused, premium. Light feels open, approachable, clean. Choose based on context.
|
|
49
|
+
|
|
50
|
+
**Accent color** — Pick ONE that means something. Blue for trust. Green for growth. Orange for energy. Violet for creativity. Don't just reach for the same accent every time.
|
|
51
|
+
|
|
52
|
+
### Choose a Layout Approach
|
|
53
|
+
|
|
54
|
+
The content should drive the layout:
|
|
55
|
+
|
|
56
|
+
- **Dense grids** for information-heavy interfaces where users scan and compare
|
|
57
|
+
- **Generous spacing** for focused tasks where users need to concentrate
|
|
58
|
+
- **Sidebar navigation** for multi-section apps with many destinations
|
|
59
|
+
- **Top navigation** for simpler tools with fewer sections
|
|
60
|
+
- **Split panels** for list-detail patterns where context matters
|
|
61
|
+
|
|
62
|
+
### Choose Typography
|
|
63
|
+
|
|
64
|
+
Typography sets tone. Don't always default:
|
|
65
|
+
|
|
66
|
+
- **System fonts** — fast, native, invisible (good for utility-focused products)
|
|
67
|
+
- **Geometric sans** (Geist, Inter) — modern, clean, technical
|
|
68
|
+
- **Humanist sans** (SF Pro, Satoshi) — warmer, more approachable
|
|
69
|
+
- **Monospace influence** — technical, developer-focused, data-heavy
|
|
70
|
+
|
|
71
|
+
---
|
|
72
|
+
|
|
73
|
+
## Core Craft Principles
|
|
74
|
+
|
|
75
|
+
These apply regardless of design direction. This is the quality floor.
|
|
76
|
+
|
|
77
|
+
### The 4px Grid
|
|
78
|
+
All spacing uses a 4px base grid:
|
|
79
|
+
- `4px` - micro spacing (icon gaps)
|
|
80
|
+
- `8px` - tight spacing (within components)
|
|
81
|
+
- `12px` - standard spacing (between related elements)
|
|
82
|
+
- `16px` - comfortable spacing (section padding)
|
|
83
|
+
- `24px` - generous spacing (between sections)
|
|
84
|
+
- `32px` - major separation
|
|
85
|
+
|
|
86
|
+
### Symmetrical Padding
|
|
87
|
+
**TLBR must match.** If top padding is 16px, left/bottom/right must also be 16px. Exception: when content naturally creates visual balance.
|
|
88
|
+
|
|
89
|
+
```css
|
|
90
|
+
/* Good */
|
|
91
|
+
padding: 16px;
|
|
92
|
+
padding: 12px 16px; /* Only when horizontal needs more room */
|
|
93
|
+
|
|
94
|
+
/* Bad */
|
|
95
|
+
padding: 24px 16px 12px 16px;
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
### Border Radius Consistency
|
|
99
|
+
Stick to the 4px grid. Sharper corners feel technical, rounder corners feel friendly. Pick a system and commit:
|
|
100
|
+
|
|
101
|
+
- Sharp: 4px, 6px, 8px
|
|
102
|
+
- Soft: 8px, 12px
|
|
103
|
+
- Minimal: 2px, 4px, 6px
|
|
104
|
+
|
|
105
|
+
Don't mix systems. Consistency creates coherence.
|
|
106
|
+
|
|
107
|
+
### Depth & Elevation Strategy
|
|
108
|
+
|
|
109
|
+
**Match your depth approach to your design direction.** Depth is a tool, not a requirement. Different products need different approaches:
|
|
110
|
+
|
|
111
|
+
**Borders-only (flat)** — Clean, technical, dense. Works for utility-focused tools where information density matters more than visual lift. Linear, Raycast, and many developer tools use almost no shadows — just subtle borders to define regions. This isn't lazy; it's intentional restraint.
|
|
112
|
+
|
|
113
|
+
**Subtle single shadows** — Soft lift without complexity. A simple `0 1px 3px rgba(0,0,0,0.08)` can be enough. Works for approachable products that want gentle depth without the weight of layered shadows.
|
|
114
|
+
|
|
115
|
+
**Layered shadows** — Rich, premium, dimensional. Multiple shadow layers create realistic depth for products that want to feel substantial. Stripe and Mercury use this approach. Best for cards that need to feel like physical objects.
|
|
116
|
+
|
|
117
|
+
**Surface color shifts** — Background tints establish hierarchy without any shadows. A card at `#fff` on a `#f8fafc` background already feels elevated. Shadows can reinforce this, but color does the heavy lifting.
|
|
118
|
+
|
|
119
|
+
Choose ONE approach and commit. Mixing flat borders on some cards with heavy shadows on others creates visual inconsistency.
|
|
120
|
+
|
|
121
|
+
```css
|
|
122
|
+
/* Borders-only approach */
|
|
123
|
+
--border: rgba(0, 0, 0, 0.08);
|
|
124
|
+
--border-subtle: rgba(0, 0, 0, 0.05);
|
|
125
|
+
border: 0.5px solid var(--border);
|
|
126
|
+
|
|
127
|
+
/* Single shadow approach */
|
|
128
|
+
--shadow: 0 1px 3px rgba(0, 0, 0, 0.08);
|
|
129
|
+
|
|
130
|
+
/* Layered shadow approach (when appropriate) */
|
|
131
|
+
--shadow-layered:
|
|
132
|
+
0 0 0 0.5px rgba(0, 0, 0, 0.05),
|
|
133
|
+
0 1px 2px rgba(0, 0, 0, 0.04),
|
|
134
|
+
0 2px 4px rgba(0, 0, 0, 0.03),
|
|
135
|
+
0 4px 8px rgba(0, 0, 0, 0.02);
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
**The craft is in the choice, not the complexity.** A flat interface with perfect spacing and typography is more polished than a shadow-heavy interface with sloppy details.
|
|
139
|
+
|
|
140
|
+
### Card Layouts Vary, Surface Treatment Stays Consistent
|
|
141
|
+
Monotonous card layouts are lazy design. A metric card doesn't have to look like a plan card doesn't have to look like a settings card. One might have a sparkline, another an avatar stack, another a progress ring, another a two-column split.
|
|
142
|
+
|
|
143
|
+
Design each card's internal structure for its specific content — but keep the surface treatment consistent: same border weight, shadow depth, corner radius, padding scale, typography. Cohesion comes from the container chrome, not from forcing every card into the same layout template.
|
|
144
|
+
|
|
145
|
+
### Isolated Controls
|
|
146
|
+
UI controls deserve container treatment. Date pickers, filters, dropdowns — these should feel like crafted objects sitting on the page, not plain text with click handlers.
|
|
147
|
+
|
|
148
|
+
**Never use native form elements for styled UI.** Native `<select>`, `<input type="date">`, and similar elements render OS-native dropdowns and pickers that cannot be styled. Build custom components instead:
|
|
149
|
+
|
|
150
|
+
- Custom select: trigger button + positioned dropdown menu
|
|
151
|
+
- Custom date picker: input + calendar popover
|
|
152
|
+
- Custom checkbox/radio: styled div with state management
|
|
153
|
+
|
|
154
|
+
**Custom select triggers must use `display: inline-flex` with `white-space: nowrap`** to keep text and chevron icons on the same row. Without this, flex children can wrap to new lines.
|
|
155
|
+
|
|
156
|
+
### Typography Hierarchy
|
|
157
|
+
- Headlines: 600 weight, tight letter-spacing (-0.02em)
|
|
158
|
+
- Body: 400-500 weight, standard tracking
|
|
159
|
+
- Labels: 500 weight, slight positive tracking for uppercase
|
|
160
|
+
- Scale: 11px, 12px, 13px, 14px (base), 16px, 18px, 24px, 32px
|
|
161
|
+
|
|
162
|
+
### Monospace for Data
|
|
163
|
+
Numbers, IDs, codes, timestamps belong in monospace. Use `tabular-nums` for columnar alignment. Mono signals "this is data."
|
|
164
|
+
|
|
165
|
+
### Iconography
|
|
166
|
+
Use **Phosphor Icons** (`@phosphor-icons/react`). Icons clarify, not decorate — if removing an icon loses no meaning, remove it.
|
|
167
|
+
|
|
168
|
+
Give standalone icons presence with subtle background containers.
|
|
169
|
+
|
|
170
|
+
### Animation
|
|
171
|
+
- 150ms for micro-interactions, 200-250ms for larger transitions
|
|
172
|
+
- Easing: `cubic-bezier(0.25, 1, 0.5, 1)`
|
|
173
|
+
- No spring/bouncy effects in enterprise UI
|
|
174
|
+
|
|
175
|
+
### Contrast Hierarchy
|
|
176
|
+
Build a four-level system: foreground (primary) → secondary → muted → faint. Use all four consistently.
|
|
177
|
+
|
|
178
|
+
### Color for Meaning Only
|
|
179
|
+
Gray builds structure. Color only appears when it communicates: status, action, error, success. Decorative color is noise.
|
|
180
|
+
|
|
181
|
+
When building data-heavy interfaces, ask whether each use of color is earning its place. Score bars don't need to be color-coded by performance — a single muted color works. Grade badges don't need traffic-light colors — typography can do the hierarchy work. Look at how GitHub renders tables and lists: almost entirely monochrome, with color reserved for status indicators and actionable elements.
|
|
182
|
+
|
|
183
|
+
---
|
|
184
|
+
|
|
185
|
+
## Navigation Context
|
|
186
|
+
|
|
187
|
+
Screens need grounding. A data table floating in space feels like a component demo, not a product. Consider including:
|
|
188
|
+
|
|
189
|
+
- **Navigation** — sidebar or top nav showing where you are in the app
|
|
190
|
+
- **Location indicator** — breadcrumbs, page title, or active nav state
|
|
191
|
+
- **User context** — who's logged in, what workspace/org
|
|
192
|
+
|
|
193
|
+
When building sidebars, consider using the same background as the main content area. Tools like Supabase, Linear, and Vercel rely on a subtle border for separation rather than different background colors. This reduces visual weight and feels more unified.
|
|
194
|
+
|
|
195
|
+
---
|
|
196
|
+
|
|
197
|
+
## Dark Mode Considerations
|
|
198
|
+
|
|
199
|
+
Dark interfaces have different needs:
|
|
200
|
+
|
|
201
|
+
**Borders over shadows** — Shadows are less visible on dark backgrounds. Lean more on borders for definition. A border at 10-15% white opacity might look nearly invisible but it's doing its job — resist the urge to make it more prominent.
|
|
202
|
+
|
|
203
|
+
**Adjust semantic colors** — Status colors (success, warning, error) often need to be slightly desaturated or adjusted for dark backgrounds to avoid feeling harsh.
|
|
204
|
+
|
|
205
|
+
**Same structure, different values** — The hierarchy system (foreground → secondary → muted → faint) still applies, just with inverted values.
|
|
206
|
+
|
|
207
|
+
---
|
|
208
|
+
|
|
209
|
+
## Anti-Patterns
|
|
210
|
+
|
|
211
|
+
### Never Do This
|
|
212
|
+
- Dramatic drop shadows (`box-shadow: 0 25px 50px...`)
|
|
213
|
+
- Large border radius (16px+) on small elements
|
|
214
|
+
- Asymmetric padding without clear reason
|
|
215
|
+
- Pure white cards on colored backgrounds
|
|
216
|
+
- Thick borders (2px+) for decoration
|
|
217
|
+
- Excessive spacing (margins > 48px between sections)
|
|
218
|
+
- Spring/bouncy animations
|
|
219
|
+
- Gradients for decoration
|
|
220
|
+
- Multiple accent colors in one interface
|
|
221
|
+
|
|
222
|
+
### Always Question
|
|
223
|
+
- "Did I think about what this product needs, or did I default?"
|
|
224
|
+
- "Does this direction fit the context and users?"
|
|
225
|
+
- "Does this element feel crafted?"
|
|
226
|
+
- "Is my depth strategy consistent and intentional?"
|
|
227
|
+
- "Are all elements on the grid?"
|
|
228
|
+
|
|
229
|
+
---
|
|
230
|
+
|
|
231
|
+
## The Standard
|
|
232
|
+
|
|
233
|
+
Every interface should look designed by a team that obsesses over 1-pixel differences. Not stripped — *crafted*. And designed for its specific context.
|
|
234
|
+
|
|
235
|
+
Different products want different things. A developer tool wants precision and density. A collaborative product wants warmth and space. A financial product wants trust and sophistication. Let the product context guide the aesthetic.
|
|
236
|
+
|
|
237
|
+
The goal: intricate minimalism with appropriate personality. Same quality bar, context-driven execution.
|
|
@@ -0,0 +1,356 @@
|
|
|
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
|
+
---
|
|
6
|
+
|
|
7
|
+
# Skill Creator
|
|
8
|
+
|
|
9
|
+
This skill provides guidance for creating effective skills.
|
|
10
|
+
|
|
11
|
+
## About Skills
|
|
12
|
+
|
|
13
|
+
Skills are modular, self-contained packages that extend Claude's capabilities by providing
|
|
14
|
+
specialized knowledge, workflows, and tools. Think of them as "onboarding guides" for specific
|
|
15
|
+
domains or tasks—they transform Claude from a general-purpose agent into a specialized agent
|
|
16
|
+
equipped with procedural knowledge that no model can fully possess.
|
|
17
|
+
|
|
18
|
+
### What Skills Provide
|
|
19
|
+
|
|
20
|
+
1. Specialized workflows - Multi-step procedures for specific domains
|
|
21
|
+
2. Tool integrations - Instructions for working with specific file formats or APIs
|
|
22
|
+
3. Domain expertise - Company-specific knowledge, schemas, business logic
|
|
23
|
+
4. Bundled resources - Scripts, references, and assets for complex and repetitive tasks
|
|
24
|
+
|
|
25
|
+
## Core Principles
|
|
26
|
+
|
|
27
|
+
### Concise is Key
|
|
28
|
+
|
|
29
|
+
The context window is a public good. Skills share the context window with everything else Claude needs: system prompt, conversation history, other Skills' metadata, and the actual user request.
|
|
30
|
+
|
|
31
|
+
**Default assumption: Claude is already very smart.** Only add context Claude doesn't already have. Challenge each piece of information: "Does Claude really need this explanation?" and "Does this paragraph justify its token cost?"
|
|
32
|
+
|
|
33
|
+
Prefer concise examples over verbose explanations.
|
|
34
|
+
|
|
35
|
+
### Set Appropriate Degrees of Freedom
|
|
36
|
+
|
|
37
|
+
Match the level of specificity to the task's fragility and variability:
|
|
38
|
+
|
|
39
|
+
**High freedom (text-based instructions)**: Use when multiple approaches are valid, decisions depend on context, or heuristics guide the approach.
|
|
40
|
+
|
|
41
|
+
**Medium freedom (pseudocode or scripts with parameters)**: Use when a preferred pattern exists, some variation is acceptable, or configuration affects behavior.
|
|
42
|
+
|
|
43
|
+
**Low freedom (specific scripts, few parameters)**: Use when operations are fragile and error-prone, consistency is critical, or a specific sequence must be followed.
|
|
44
|
+
|
|
45
|
+
Think of Claude as exploring a path: a narrow bridge with cliffs needs specific guardrails (low freedom), while an open field allows many routes (high freedom).
|
|
46
|
+
|
|
47
|
+
### Anatomy of a Skill
|
|
48
|
+
|
|
49
|
+
Every skill consists of a required SKILL.md file and optional bundled resources:
|
|
50
|
+
|
|
51
|
+
```
|
|
52
|
+
skill-name/
|
|
53
|
+
├── SKILL.md (required)
|
|
54
|
+
│ ├── YAML frontmatter metadata (required)
|
|
55
|
+
│ │ ├── name: (required)
|
|
56
|
+
│ │ └── description: (required)
|
|
57
|
+
│ └── Markdown instructions (required)
|
|
58
|
+
└── Bundled Resources (optional)
|
|
59
|
+
├── scripts/ - Executable code (Python/Bash/etc.)
|
|
60
|
+
├── references/ - Documentation intended to be loaded into context as needed
|
|
61
|
+
└── assets/ - Files used in output (templates, icons, fonts, etc.)
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
#### SKILL.md (required)
|
|
65
|
+
|
|
66
|
+
Every SKILL.md consists of:
|
|
67
|
+
|
|
68
|
+
- **Frontmatter** (YAML): Contains `name` and `description` fields. These are the only fields that Claude reads to determine when the skill gets used, thus it is very important to be clear and comprehensive in describing what the skill is, and when it should be used.
|
|
69
|
+
- **Body** (Markdown): Instructions and guidance for using the skill. Only loaded AFTER the skill triggers (if at all).
|
|
70
|
+
|
|
71
|
+
#### Bundled Resources (optional)
|
|
72
|
+
|
|
73
|
+
##### Scripts (`scripts/`)
|
|
74
|
+
|
|
75
|
+
Executable code (Python/Bash/etc.) for tasks that require deterministic reliability or are repeatedly rewritten.
|
|
76
|
+
|
|
77
|
+
- **When to include**: When the same code is being rewritten repeatedly or deterministic reliability is needed
|
|
78
|
+
- **Example**: `scripts/rotate_pdf.py` for PDF rotation tasks
|
|
79
|
+
- **Benefits**: Token efficient, deterministic, may be executed without loading into context
|
|
80
|
+
- **Note**: Scripts may still need to be read by Claude for patching or environment-specific adjustments
|
|
81
|
+
|
|
82
|
+
##### References (`references/`)
|
|
83
|
+
|
|
84
|
+
Documentation and reference material intended to be loaded as needed into context to inform Claude's process and thinking.
|
|
85
|
+
|
|
86
|
+
- **When to include**: For documentation that Claude should reference while working
|
|
87
|
+
- **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
|
|
88
|
+
- **Use cases**: Database schemas, API documentation, domain knowledge, company policies, detailed workflow guides
|
|
89
|
+
- **Benefits**: Keeps SKILL.md lean, loaded only when Claude determines it's needed
|
|
90
|
+
- **Best practice**: If files are large (>10k words), include grep search patterns in SKILL.md
|
|
91
|
+
- **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.
|
|
92
|
+
|
|
93
|
+
##### Assets (`assets/`)
|
|
94
|
+
|
|
95
|
+
Files not intended to be loaded into context, but rather used within the output Claude produces.
|
|
96
|
+
|
|
97
|
+
- **When to include**: When the skill needs files that will be used in the final output
|
|
98
|
+
- **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
|
|
99
|
+
- **Use cases**: Templates, images, icons, boilerplate code, fonts, sample documents that get copied or modified
|
|
100
|
+
- **Benefits**: Separates output resources from documentation, enables Claude to use files without loading them into context
|
|
101
|
+
|
|
102
|
+
#### What to Not Include in a Skill
|
|
103
|
+
|
|
104
|
+
A skill should only contain essential files that directly support its functionality. Do NOT create extraneous documentation or auxiliary files, including:
|
|
105
|
+
|
|
106
|
+
- README.md
|
|
107
|
+
- INSTALLATION_GUIDE.md
|
|
108
|
+
- QUICK_REFERENCE.md
|
|
109
|
+
- CHANGELOG.md
|
|
110
|
+
- etc.
|
|
111
|
+
|
|
112
|
+
The skill should only contain the information needed for an AI agent to do the job at hand. It should not contain auxilary context about the process that went into creating it, setup and testing procedures, user-facing documentation, etc. Creating additional documentation files just adds clutter and confusion.
|
|
113
|
+
|
|
114
|
+
### Progressive Disclosure Design Principle
|
|
115
|
+
|
|
116
|
+
Skills use a three-level loading system to manage context efficiently:
|
|
117
|
+
|
|
118
|
+
1. **Metadata (name + description)** - Always in context (~100 words)
|
|
119
|
+
2. **SKILL.md body** - When skill triggers (<5k words)
|
|
120
|
+
3. **Bundled resources** - As needed by Claude (Unlimited because scripts can be executed without reading into context window)
|
|
121
|
+
|
|
122
|
+
#### Progressive Disclosure Patterns
|
|
123
|
+
|
|
124
|
+
Keep SKILL.md body to the essentials and under 500 lines to minimize context bloat. Split content into separate files when approaching this limit. When splitting out content into other files, it is very important to reference them from SKILL.md and describe clearly when to read them, to ensure the reader of the skill knows they exist and when to use them.
|
|
125
|
+
|
|
126
|
+
**Key principle:** When a skill supports multiple variations, frameworks, or options, keep only the core workflow and selection guidance in SKILL.md. Move variant-specific details (patterns, examples, configuration) into separate reference files.
|
|
127
|
+
|
|
128
|
+
**Pattern 1: High-level guide with references**
|
|
129
|
+
|
|
130
|
+
```markdown
|
|
131
|
+
# PDF Processing
|
|
132
|
+
|
|
133
|
+
## Quick start
|
|
134
|
+
|
|
135
|
+
Extract text with pdfplumber:
|
|
136
|
+
[code example]
|
|
137
|
+
|
|
138
|
+
## Advanced features
|
|
139
|
+
|
|
140
|
+
- **Form filling**: See [FORMS.md](FORMS.md) for complete guide
|
|
141
|
+
- **API reference**: See [REFERENCE.md](REFERENCE.md) for all methods
|
|
142
|
+
- **Examples**: See [EXAMPLES.md](EXAMPLES.md) for common patterns
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
Claude loads FORMS.md, REFERENCE.md, or EXAMPLES.md only when needed.
|
|
146
|
+
|
|
147
|
+
**Pattern 2: Domain-specific organization**
|
|
148
|
+
|
|
149
|
+
For Skills with multiple domains, organize content by domain to avoid loading irrelevant context:
|
|
150
|
+
|
|
151
|
+
```
|
|
152
|
+
bigquery-skill/
|
|
153
|
+
├── SKILL.md (overview and navigation)
|
|
154
|
+
└── reference/
|
|
155
|
+
├── finance.md (revenue, billing metrics)
|
|
156
|
+
├── sales.md (opportunities, pipeline)
|
|
157
|
+
├── product.md (API usage, features)
|
|
158
|
+
└── marketing.md (campaigns, attribution)
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
When a user asks about sales metrics, Claude only reads sales.md.
|
|
162
|
+
|
|
163
|
+
Similarly, for skills supporting multiple frameworks or variants, organize by variant:
|
|
164
|
+
|
|
165
|
+
```
|
|
166
|
+
cloud-deploy/
|
|
167
|
+
├── SKILL.md (workflow + provider selection)
|
|
168
|
+
└── references/
|
|
169
|
+
├── aws.md (AWS deployment patterns)
|
|
170
|
+
├── gcp.md (GCP deployment patterns)
|
|
171
|
+
└── azure.md (Azure deployment patterns)
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
When the user chooses AWS, Claude only reads aws.md.
|
|
175
|
+
|
|
176
|
+
**Pattern 3: Conditional details**
|
|
177
|
+
|
|
178
|
+
Show basic content, link to advanced content:
|
|
179
|
+
|
|
180
|
+
```markdown
|
|
181
|
+
# DOCX Processing
|
|
182
|
+
|
|
183
|
+
## Creating documents
|
|
184
|
+
|
|
185
|
+
Use docx-js for new documents. See [DOCX-JS.md](DOCX-JS.md).
|
|
186
|
+
|
|
187
|
+
## Editing documents
|
|
188
|
+
|
|
189
|
+
For simple edits, modify the XML directly.
|
|
190
|
+
|
|
191
|
+
**For tracked changes**: See [REDLINING.md](REDLINING.md)
|
|
192
|
+
**For OOXML details**: See [OOXML.md](OOXML.md)
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
Claude reads REDLINING.md or OOXML.md only when the user needs those features.
|
|
196
|
+
|
|
197
|
+
**Important guidelines:**
|
|
198
|
+
|
|
199
|
+
- **Avoid deeply nested references** - Keep references one level deep from SKILL.md. All reference files should link directly from SKILL.md.
|
|
200
|
+
- **Structure longer reference files** - For files longer than 100 lines, include a table of contents at the top so Claude can see the full scope when previewing.
|
|
201
|
+
|
|
202
|
+
## Skill Creation Process
|
|
203
|
+
|
|
204
|
+
Skill creation involves these steps:
|
|
205
|
+
|
|
206
|
+
1. Understand the skill with concrete examples
|
|
207
|
+
2. Plan reusable skill contents (scripts, references, assets)
|
|
208
|
+
3. Initialize the skill (run init_skill.py)
|
|
209
|
+
4. Edit the skill (implement resources and write SKILL.md)
|
|
210
|
+
5. Package the skill (run package_skill.py)
|
|
211
|
+
6. Iterate based on real usage
|
|
212
|
+
|
|
213
|
+
Follow these steps in order, skipping only if there is a clear reason why they are not applicable.
|
|
214
|
+
|
|
215
|
+
### Step 1: Understanding the Skill with Concrete Examples
|
|
216
|
+
|
|
217
|
+
Skip this step only when the skill's usage patterns are already clearly understood. It remains valuable even when working with an existing skill.
|
|
218
|
+
|
|
219
|
+
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.
|
|
220
|
+
|
|
221
|
+
For example, when building an image-editor skill, relevant questions include:
|
|
222
|
+
|
|
223
|
+
- "What functionality should the image-editor skill support? Editing, rotating, anything else?"
|
|
224
|
+
- "Can you give some examples of how this skill would be used?"
|
|
225
|
+
- "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?"
|
|
226
|
+
- "What would a user say that should trigger this skill?"
|
|
227
|
+
|
|
228
|
+
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.
|
|
229
|
+
|
|
230
|
+
Conclude this step when there is a clear sense of the functionality the skill should support.
|
|
231
|
+
|
|
232
|
+
### Step 2: Planning the Reusable Skill Contents
|
|
233
|
+
|
|
234
|
+
To turn concrete examples into an effective skill, analyze each example by:
|
|
235
|
+
|
|
236
|
+
1. Considering how to execute on the example from scratch
|
|
237
|
+
2. Identifying what scripts, references, and assets would be helpful when executing these workflows repeatedly
|
|
238
|
+
|
|
239
|
+
Example: When building a `pdf-editor` skill to handle queries like "Help me rotate this PDF," the analysis shows:
|
|
240
|
+
|
|
241
|
+
1. Rotating a PDF requires re-writing the same code each time
|
|
242
|
+
2. A `scripts/rotate_pdf.py` script would be helpful to store in the skill
|
|
243
|
+
|
|
244
|
+
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:
|
|
245
|
+
|
|
246
|
+
1. Writing a frontend webapp requires the same boilerplate HTML/React each time
|
|
247
|
+
2. An `assets/hello-world/` template containing the boilerplate HTML/React project files would be helpful to store in the skill
|
|
248
|
+
|
|
249
|
+
Example: When building a `big-query` skill to handle queries like "How many users have logged in today?" the analysis shows:
|
|
250
|
+
|
|
251
|
+
1. Querying BigQuery requires re-discovering the table schemas and relationships each time
|
|
252
|
+
2. A `references/schema.md` file documenting the table schemas would be helpful to store in the skill
|
|
253
|
+
|
|
254
|
+
To establish the skill's contents, analyze each concrete example to create a list of the reusable resources to include: scripts, references, and assets.
|
|
255
|
+
|
|
256
|
+
### Step 3: Initializing the Skill
|
|
257
|
+
|
|
258
|
+
At this point, it is time to actually create the skill.
|
|
259
|
+
|
|
260
|
+
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.
|
|
261
|
+
|
|
262
|
+
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.
|
|
263
|
+
|
|
264
|
+
Usage:
|
|
265
|
+
|
|
266
|
+
```bash
|
|
267
|
+
scripts/init_skill.py <skill-name> --path <output-directory>
|
|
268
|
+
```
|
|
269
|
+
|
|
270
|
+
The script:
|
|
271
|
+
|
|
272
|
+
- Creates the skill directory at the specified path
|
|
273
|
+
- Generates a SKILL.md template with proper frontmatter and TODO placeholders
|
|
274
|
+
- Creates example resource directories: `scripts/`, `references/`, and `assets/`
|
|
275
|
+
- Adds example files in each directory that can be customized or deleted
|
|
276
|
+
|
|
277
|
+
After initialization, customize or remove the generated SKILL.md and example files as needed.
|
|
278
|
+
|
|
279
|
+
### Step 4: Edit the Skill
|
|
280
|
+
|
|
281
|
+
When editing the (newly-generated or existing) skill, remember that the skill is being created for another instance of Claude to use. Include 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.
|
|
282
|
+
|
|
283
|
+
#### Learn Proven Design Patterns
|
|
284
|
+
|
|
285
|
+
Consult these helpful guides based on your skill's needs:
|
|
286
|
+
|
|
287
|
+
- **Multi-step processes**: See references/workflows.md for sequential workflows and conditional logic
|
|
288
|
+
- **Specific output formats or quality standards**: See references/output-patterns.md for template and example patterns
|
|
289
|
+
|
|
290
|
+
These files contain established best practices for effective skill design.
|
|
291
|
+
|
|
292
|
+
#### Start with Reusable Skill Contents
|
|
293
|
+
|
|
294
|
+
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/`.
|
|
295
|
+
|
|
296
|
+
Added scripts must be tested by actually running them to ensure there are no bugs and that the output matches what is expected. If there are many similar scripts, only a representative sample needs to be tested to ensure confidence that they all work while balancing time to completion.
|
|
297
|
+
|
|
298
|
+
Any example files and directories not needed for the skill should be deleted. The initialization script creates example files in `scripts/`, `references/`, and `assets/` to demonstrate structure, but most skills won't need all of them.
|
|
299
|
+
|
|
300
|
+
#### Update SKILL.md
|
|
301
|
+
|
|
302
|
+
**Writing Guidelines:** Always use imperative/infinitive form.
|
|
303
|
+
|
|
304
|
+
##### Frontmatter
|
|
305
|
+
|
|
306
|
+
Write the YAML frontmatter with `name` and `description`:
|
|
307
|
+
|
|
308
|
+
- `name`: The skill name
|
|
309
|
+
- `description`: This is the primary triggering mechanism for your skill, and helps Claude understand when to use the skill.
|
|
310
|
+
- Include both what the Skill does and specific triggers/contexts for when to use it.
|
|
311
|
+
- Include all "when to use" information here - Not in the body. The body is only loaded after triggering, so "When to Use This Skill" sections in the body are not helpful to Claude.
|
|
312
|
+
- Example description for a `docx` skill: "Comprehensive document creation, editing, and analysis with support for tracked changes, comments, formatting preservation, and text extraction. Use when Claude needs to work with professional documents (.docx files) for: (1) Creating new documents, (2) Modifying or editing content, (3) Working with tracked changes, (4) Adding comments, or any other document tasks"
|
|
313
|
+
|
|
314
|
+
Do not include any other fields in YAML frontmatter.
|
|
315
|
+
|
|
316
|
+
##### Body
|
|
317
|
+
|
|
318
|
+
Write instructions for using the skill and its bundled resources.
|
|
319
|
+
|
|
320
|
+
### Step 5: Packaging a Skill
|
|
321
|
+
|
|
322
|
+
Once development of the skill is complete, it must be packaged into a distributable .skill file that gets shared with the user. The packaging process automatically validates the skill first to ensure it meets all requirements:
|
|
323
|
+
|
|
324
|
+
```bash
|
|
325
|
+
scripts/package_skill.py <path/to/skill-folder>
|
|
326
|
+
```
|
|
327
|
+
|
|
328
|
+
Optional output directory specification:
|
|
329
|
+
|
|
330
|
+
```bash
|
|
331
|
+
scripts/package_skill.py <path/to/skill-folder> ./dist
|
|
332
|
+
```
|
|
333
|
+
|
|
334
|
+
The packaging script will:
|
|
335
|
+
|
|
336
|
+
1. **Validate** the skill automatically, checking:
|
|
337
|
+
|
|
338
|
+
- YAML frontmatter format and required fields
|
|
339
|
+
- Skill naming conventions and directory structure
|
|
340
|
+
- Description completeness and quality
|
|
341
|
+
- File organization and resource references
|
|
342
|
+
|
|
343
|
+
2. **Package** the skill if validation passes, creating a .skill file named after the skill (e.g., `my-skill.skill`) that includes all files and maintains the proper directory structure for distribution. The .skill file is a zip file with a .skill extension.
|
|
344
|
+
|
|
345
|
+
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.
|
|
346
|
+
|
|
347
|
+
### Step 6: Iterate
|
|
348
|
+
|
|
349
|
+
After testing the skill, users may request improvements. Often this happens right after using the skill, with fresh context of how the skill performed.
|
|
350
|
+
|
|
351
|
+
**Iteration workflow:**
|
|
352
|
+
|
|
353
|
+
1. Use the skill on real tasks
|
|
354
|
+
2. Notice struggles or inefficiencies
|
|
355
|
+
3. Identify how SKILL.md or bundled resources should be updated
|
|
356
|
+
4. Implement changes and test again
|
|
@@ -1,53 +0,0 @@
|
|
|
1
|
-
# Plans
|
|
2
|
-
|
|
3
|
-
This directory contains project plans and architectural documents.
|
|
4
|
-
|
|
5
|
-
## Purpose
|
|
6
|
-
Store detailed implementation plans, architectural decisions, and strategic roadmaps created by the planner agent or during project planning sessions.
|
|
7
|
-
|
|
8
|
-
## Plan Structure
|
|
9
|
-
Each plan should be a markdown file with:
|
|
10
|
-
- Clear objectives and goals
|
|
11
|
-
- Detailed implementation steps
|
|
12
|
-
- Technical architecture decisions
|
|
13
|
-
- Risk analysis and mitigation strategies
|
|
14
|
-
- Success metrics
|
|
15
|
-
|
|
16
|
-
## Example Plan Format
|
|
17
|
-
```markdown
|
|
18
|
-
# PLAN-XXX: [Plan Title]
|
|
19
|
-
|
|
20
|
-
## Executive Summary
|
|
21
|
-
[High-level overview]
|
|
22
|
-
|
|
23
|
-
## Objectives
|
|
24
|
-
- [ ] Objective 1
|
|
25
|
-
- [ ] Objective 2
|
|
26
|
-
|
|
27
|
-
## Architecture
|
|
28
|
-
[Technical approach and design]
|
|
29
|
-
|
|
30
|
-
## Implementation Phases
|
|
31
|
-
### Phase 1: Foundation
|
|
32
|
-
- Task 1
|
|
33
|
-
- Task 2
|
|
34
|
-
|
|
35
|
-
### Phase 2: Core Features
|
|
36
|
-
- Task 3
|
|
37
|
-
- Task 4
|
|
38
|
-
|
|
39
|
-
## Risks & Mitigations
|
|
40
|
-
| Risk | Impact | Mitigation |
|
|
41
|
-
|------|--------|------------|
|
|
42
|
-
| Risk 1 | High | Strategy 1 |
|
|
43
|
-
|
|
44
|
-
## Success Metrics
|
|
45
|
-
- Metric 1
|
|
46
|
-
- Metric 2
|
|
47
|
-
```
|
|
48
|
-
|
|
49
|
-
## Plan Naming Convention
|
|
50
|
-
Use format: `PLAN-XXX-brief-description.md`
|
|
51
|
-
|
|
52
|
-
## Current Plans
|
|
53
|
-
[List active plans here]
|