Write an SDK or client library guide — installation, quick start, configuration, common patterns, and error handling. Produces a complete developer reference from zero to production usage.
How this skill is triggered — by the user, by Claude, or both
Slash command
/developer-docs-writer:write-sdk-guideThis skill is limited to the following tools:
The summary Claude sees in its skill listing — used to decide when to auto-load this skill
Write an SDK guide for $ARGUMENTS using the mandatory process and structure below.
Write an SDK guide for $ARGUMENTS using the mandatory process and structure below.
Before writing, understand the full surface area:
Grep and GlobOutput: A list of public API methods, configuration options, auth mechanisms, and supported versions.
The first thing a developer reads. It must get them from zero to a working API call in under 2 minutes.
# [SDK Name] Guide
## Installation
\`\`\`bash
[Package manager command — e.g., npm install @acme/sdk]
\`\`\`
**Requirements:** [Language] [minimum version]+
## Quick start
\`\`\`[language]
[Complete working example: import, authenticate, make one API call, print result.
Must be under 15 lines. Must work with copy-paste.]
\`\`\`
**Expected output:**
\`\`\`
[What the developer should see]
\`\`\`
Rules for quick start:
"string" or "foo"Output: Installation command and a working quick-start example.
Document every configuration option the SDK accepts:
## Configuration
### Client options
| Option | Type | Default | Description |
|---|---|---|---|
| `apiKey` | string | — (required) | Your API key. Get it from: [dashboard location] |
| `baseUrl` | string | `https://api.example.com/v1` | API base URL. Override for staging or self-hosted. |
| `timeout` | number | `30000` | Request timeout in milliseconds |
| `retries` | number | `3` | Number of automatic retries on 5xx errors |
| `logger` | Logger \| null | `null` | Custom logger instance. Pass `console` for debug output. |
### Environment variables
The SDK reads these environment variables as fallbacks:
| Variable | Maps to | Example |
|---|---|---|
| `ACME_API_KEY` | `apiKey` | `sk_live_abc123` |
| `ACME_BASE_URL` | `baseUrl` | `https://api-staging.example.com/v1` |
### Example: custom configuration
\`\`\`[language]
[Complete example showing non-default configuration]
\`\`\`
Rules for configuration:
Output: Complete configuration reference table with examples.
Document the patterns developers will use most frequently:
## Common patterns
### Pagination
\`\`\`[language]
[Complete example: fetch a paginated list, iterate through all pages]
\`\`\`
### Error handling
\`\`\`[language]
[Complete example: try/catch with typed errors, show how to inspect error details]
\`\`\`
**Error types:**
| Error class | HTTP status | When it occurs | How to handle |
|---|---|---|---|
| `ValidationError` | 400 | Invalid request parameters | Fix the request — check `error.details` for field-level errors |
| `AuthenticationError` | 401 | Invalid or expired credentials | Refresh token or check API key |
| `RateLimitError` | 429 | Too many requests | Wait `error.retryAfter` seconds, then retry |
| `ServerError` | 5xx | Service issue | Automatic retry (configurable). If persistent, contact support |
### Retry and timeout
\`\`\`[language]
[Example: configuring retry behaviour, handling timeouts]
\`\`\`
### Logging and debugging
\`\`\`[language]
[Example: enabling debug logging to troubleshoot requests]
\`\`\`
Add patterns specific to the SDK — e.g., file uploads, streaming responses, batch operations, webhook verification — based on what the SDK actually supports.
Output: Code examples for pagination, error handling, retry, and debugging at minimum.
For typed languages, document the key types. For all languages, provide a method quick-reference:
## Method reference
### [Resource name]
| Method | Description | Returns |
|---|---|---|
| `client.users.list(options?)` | List all users. Supports pagination. | `PagedResponse<User>` |
| `client.users.get(id)` | Get a user by ID. | `User` |
| `client.users.create(data)` | Create a new user. | `User` |
| `client.users.update(id, data)` | Update an existing user. | `User` |
| `client.users.delete(id)` | Delete a user. | `void` |
### Key types
\`\`\`[language]
[Type definitions for the most important models — User, Order, etc.]
\`\`\`
Rules for method reference:
Output: Method reference table and key type definitions.
| Check | Requirement |
|---|---|
| Quick start works | Can a developer copy-paste and get a response in < 2 minutes? |
| Every code example runs | No incomplete snippets, no missing imports |
| Every config option documented | Nothing discoverable only by reading source |
| Error types are complete | Does the error table cover all error classes the SDK throws? |
| Realistic data | Are examples using plausible values, not "test" or "foo"? |
| Version stated | Is the SDK version this guide covers stated in the header? |
| Auth explained once, referenced everywhere | Is there one clear auth section, not repeated setup in every example? |
"[email protected]", not "[email protected]" or "string"./developer-docs-writer:write-api-docs./developer-docs-writer:write-integration-guide.# [SDK Name] Guide
## Installation
[Package manager command, requirements]
## Quick start
[Under-15-line working example]
## Configuration
[Options table, env vars, custom config example]
## Common patterns
### Pagination
### Error handling
### Retry and timeout
### Logging and debugging
[Additional SDK-specific patterns]
## Method reference
[Per-resource method tables]
## Key types
[Type definitions]
## Troubleshooting
[Common errors and fixes]
## Migration guide (if applicable)
[Breaking changes from previous version]
Provides behavioral guidelines to reduce common LLM coding mistakes, focusing on simplicity, surgical changes, assumption surfacing, and verifiable success criteria.
Searches, retrieves, and installs Agent Skills from prompts.chat registry using MCP tools like search_skills and get_skill. Activates for finding skills, browsing catalogs, or extending Claude.
Creates, edits, and optimizes skills for Claude Code, including drafting, evaluating with test prompts, iterating on performance, and improving skill descriptions for better triggering accuracy.
npx claudepluginhub hpsgd/turtlestack --plugin developer-docs-writer