Skip to content

Commit b25446a

Browse files
sjnimsclaude
andauthored
docs(agent-development): add minimal working example after Overview (#29)
## Summary Adds a Quick Start section with a minimal, copy-paste ready agent example to improve onboarding for new users. Also enhances the model field documentation to more clearly emphasize `inherit` as the recommended default. ## Problem Fixes #25 The first example users see is the "Complete Format" which includes all frontmatter fields with explanations. New users often want a quick-start template that "just works" before diving into all the options. ## Solution Added a **Quick Start** section immediately after Overview with: - ~25-line minimal working agent example - Complete and copy-paste ready - Link to detailed Agent File Structure section for more options Also improved the `model` field recommendation: ```markdown **Recommendation:** Use `inherit` (recommended default) unless the agent specifically needs: - `haiku` for fast, cost-sensitive operations - `opus` for complex reasoning requiring maximum capability ``` ### Alternatives Considered - Putting Quick Start at the end: Rejected because new users read top-to-bottom - Making the Complete Format example smaller: Would lose important context for advanced users ## Changes - `plugins/plugin-dev/skills/agent-development/SKILL.md`: Added Quick Start section, improved model recommendation ## Testing - [x] Markdownlint passes - [x] Word count remains under 2,000 (1,891 words) - [x] Example is complete and valid agent format --- 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude <noreply@anthropic.com>
1 parent 73f2b2c commit b25446a

1 file changed

Lines changed: 37 additions & 1 deletion

File tree

  • plugins/plugin-dev/skills/agent-development

plugins/plugin-dev/skills/agent-development/SKILL.md

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,40 @@ Agents are autonomous subprocesses that handle complex, multi-step tasks indepen
1818

1919
> **⚠️ Field Name Difference:** Agents use `tools` to restrict tool access. Skills use `allowed-tools` for the same purpose. Don't confuse these when switching between component types.
2020
21+
## Quick Start
22+
23+
Minimal working agent (copy-paste ready):
24+
25+
```markdown
26+
---
27+
name: my-reviewer
28+
description: Use this agent when the user asks to review code. Examples:
29+
30+
<example>
31+
Context: User wrote new code
32+
user: "Review my changes"
33+
assistant: "I'll use the my-reviewer agent to analyze the code."
34+
<commentary>
35+
Code review request triggers the agent.
36+
</commentary>
37+
</example>
38+
39+
model: inherit
40+
color: blue
41+
---
42+
43+
You are a code reviewer. Analyze code for issues and provide feedback.
44+
45+
**Process:**
46+
1. Read the code
47+
2. Identify issues
48+
3. Provide recommendations
49+
50+
**Output:** Summary with file:line references for each finding.
51+
```
52+
53+
For complete format with all options, see [Agent File Structure](#agent-file-structure).
54+
2155
## When to Use Agents vs Commands vs Skills
2256

2357
| Component | Best For | Triggering | Example Use Case |
@@ -164,7 +198,9 @@ Which model the agent should use.
164198
- `sonnet` - Balanced performance; most use cases (default recommendation)
165199
- `opus` - Complex reasoning; detailed analysis; highest capability needed
166200

167-
**Recommendation:** Use `inherit` unless agent needs specific model capabilities.
201+
**Recommendation:** Use `inherit` (recommended default) unless the agent specifically needs:
202+
- `haiku` for fast, cost-sensitive operations
203+
- `opus` for complex reasoning requiring maximum capability
168204

169205
### color (required)
170206

0 commit comments

Comments
 (0)