Commit b25446a
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
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
18 | 18 | | |
19 | 19 | | |
20 | 20 | | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
21 | 55 | | |
22 | 56 | | |
23 | 57 | | |
| |||
164 | 198 | | |
165 | 199 | | |
166 | 200 | | |
167 | | - | |
| 201 | + | |
| 202 | + | |
| 203 | + | |
168 | 204 | | |
169 | 205 | | |
170 | 206 | | |
| |||
0 commit comments