example-designlisted
Install: claude install-skill viktorbezdek/skillstack
# Example Design
Create code examples that teach effectively through progressive complexity.
## Decision Tree: Which Example Type?
```
What does the user need?
├─ Show a single concept → Snippet (5-15 lines)
├─ Working code for a feature → Complete example (20-50 lines)
├─ Step-by-step teaching → Tutorial (multi-file, progressive)
└─ Reference for production use → Reference app (full project)
```
## Example Types
| Type | Purpose | Length | When to Use |
|------|---------|--------|-------------|
| Snippet | Single concept | 5-15 lines | Quick reference, API parameter demo |
| Complete example | Working code | 20-50 lines | Feature walkthrough, integration demo |
| Tutorial | Step-by-step | Multi-file | Onboarding, learning path |
| Reference app | Production patterns | Full project | Architecture reference, starter template |
## Progressive Complexity
```
Level 1: Minimal (happy path)
↓
Level 2: Add configuration
↓
Level 3: Add error handling
↓
Level 4: Add edge cases
↓
Level 5: Production-ready
```
Each level must be runnable independently. Never skip a level — the reader needs the progression to build understanding incrementally.
## Example Anatomy
```python
# 1. Context: What this does
"""Fetch user data from API"""
# 2. Setup: Prerequisites
import requests
# 3. Core: Main concept (highlight this)
response = requests.get("/users/123") # <-- Key line
user = response.json()
# 4. Result: Expected output
print(user["name"]) # Output: "Alice"
```
##