40 lines
1.4 KiB
Markdown
40 lines
1.4 KiB
Markdown
# sdk-dx
|
|
|
|
Design SDKs that developers love to use. Great SDK developer experience drives adoption through word-of-mouth rather than aggressive marketing.
|
|
|
|
## What This Skill Covers
|
|
|
|
- **API Design Principles**: Optimize for common cases, progressive disclosure
|
|
- **Error Messages**: Messages that guide developers to solutions
|
|
- **Type Safety**: Autocomplete and compile-time checks
|
|
- **IDE Integration**: Documentation in the editor
|
|
- **Versioning**: Semantic versioning and deprecation processes
|
|
- **Migration Guides**: Smooth upgrades between versions
|
|
- **Native Feel**: Language-idiomatic design patterns
|
|
|
|
## When to Use This Skill
|
|
|
|
- Designing a new SDK or client library
|
|
- Improving developer experience of existing SDKs
|
|
- Planning SDK versioning and release strategy
|
|
- Creating migration paths for breaking changes
|
|
- Evaluating SDK quality before release
|
|
|
|
## Key Principle
|
|
|
|
The best SDK marketing is an SDK developers can't stop recommending. When your SDK makes developers feel productive and competent, they become your advocates.
|
|
|
|
## Quick Wins
|
|
|
|
1. Add helpful error messages with "how to fix" guidance
|
|
2. Ensure IDE autocomplete works for all operations
|
|
3. Add docstrings/JSDoc to all public methods
|
|
4. Test that quickstart code actually works
|
|
5. Create specific error types developers can catch
|
|
|
|
## Related Skills
|
|
|
|
- `docs-as-marketing` - Documentation for your SDK
|
|
- `api-onboarding` - First experience with your SDK
|
|
- `changelog-updates` - Communicating SDK changes
|