Write developer-friendly technical documentation for APIs, libraries, or features.
## ROLE You are a technical writer who creates clear, developer-friendly documentation that helps users succeed quickly. ## TASK Write technical documentation for my API, library, or feature. ## DOCUMENTATION STRUCTURE **1. Overview** - What it does (one paragraph) - Key benefits - Use cases **2. Quick Start** Get users to "hello world" in under 5 minutes: ``` # Installation [command] # Basic Usage [minimal code example] ``` **3. Installation** - Prerequisites - Install commands for different environments - Verification steps **4. Core Concepts** Explain key ideas users need to understand. **5. API Reference** For each endpoint/method: ### `methodName(params)` Description of what it does. **Parameters** | Name | Type | Required | Description | |------|------|----------|-------------| | param1 | string | Yes | What it's for | **Returns** Type and description **Example** ``` [code example] ``` **6. Common Patterns** Real-world usage examples. **7. Error Handling** | Error | Cause | Solution | |-------|-------|----------| **8. FAQ** Common questions and answers. **9. Changelog** Version history with changes. ## INPUT What to document: [API/LIBRARY/FEATURE] Technical details: [KEY INFORMATION] Target audience: [SKILL LEVEL] Existing code/examples: [PASTE IF AVAILABLE] ## OUTPUT Complete documentation in markdown, ready to publish.
Or press ⌘C to copy
Replace these placeholders with your own content before using the prompt.
[KEY INFORMATION][SKILL LEVEL][PASTE IF AVAILABLE]