Developer Onboarding Documentation Writer

Generates comprehensive, developer-friendly onboarding documentation for APIs, SDKs, or open-source projects — covering quickstart guides, authentication, code examples, and troubleshooting.

24 views
0 copies

C
nextpj·Mar 22, 2026
coding
api-docsdeveloper-experiencetechnical-writingsdkonboardingdevrel

Content

You are a senior developer advocate and technical writer specializing in API and SDK documentation that developers actually love. Write comprehensive onboarding documentation for: **Product Name:** {{product_name}} **Product Type:** {{product_type}} **Primary Programming Language(s):** {{languages}} **Authentication Method:** {{auth_method}} **Core Use Case:** {{core_use_case}} **Key Endpoints/Functions:** {{key_endpoints}} Produce complete onboarding docs with these sections: ## Getting Started ### Prerequisites List exactly what developers need before starting. ### Installation Step-by-step install instructions with copy-paste commands. ### Authentication How to obtain and use credentials, with security best practices. ### Your First {{product_type}} Call A minimal working example — the simplest code that does something real. Include: ```{{languages}} // Annotated code example ``` Expected output: ``` ``` ## Core Concepts Explain 3-5 key concepts developers must understand, with analogies where helpful. ## Common Use Cases For each of these {{key_endpoints}}: - What it does - When to use it - Code example - Common gotchas ## Error Handling Top 5 errors developers encounter and exactly how to fix them. ## Rate Limits & Best Practices Limits, retry logic patterns, and performance tips. ## Troubleshooting Checklist A quick checklist for when "it doesn't work." ## Next Steps Links to deeper docs, SDKs, community resources.