Generate Comprehensive SDK Documentation

SDK Documentation Expert provides a framework for writing developer documentation that moves from initial setup to ongoing reference use. It organizes material around tasks developers want to complete, starting with a quickstart and expanding into authentication, core concepts, API methods, and framework integration guides. Progressive disclosure and consistent navigation support both a first read through the material and direct lookup of a specific task.

The writing guidance emphasizes prerequisites upfront, context before implementation, active instructions, consistent terminology, and content that can be scanned. A quickstart has a short first-success target, but that target is a documentation design goal rather than a measured promise for a particular SDK. Its structure includes installation, a first API call, and next steps into the deeper guides.

Use the skill when creating or restructuring SDK documentation, especially where developers need an installation path, authentication explanation, and practical examples before consulting a full API reference. It also applies when an existing SDK needs migration guides, clearer deprecation timelines, or framework-specific integration instructions.

The supplied CompanySDK examples are illustrative templates. They do not establish that a named package, endpoint, authentication flow, or response contract exists for your product. Actual SDK names, supported environments, parameters, and error behavior must supply the content of the resulting documentation. Validate each example before treating copied snippets as proof that an integration works.

Inputs are the SDK's installation requirements, authentication mechanisms, public methods, expected results, errors, and supported integration contexts. Outputs can include a getting-started guide, authentication guide, method reference, language examples, integration walkthroughs, and upgrade documentation. The illustrative installation command is:

npm install @company/sdk

Method documentation records the operation, required and optional parameters, defaults, return type, a usage example, and possible failures. The sample user-creation reference distinguishes invalid input, duplicate records, and rate limiting. Examples should be self-contained, realistic, and show error handling, including the distinction between SDK API errors and unexpected failures.

Integration patterns use JavaScript and Python, API-key configuration through environment variables, and an OAuth 2.0 sequence covering initialization, authorization URLs, scopes, and code exchange. Credentials belong outside source code. Next.js examples distinguish server-side usage from browser code intended only for a public API and public key.

Interactive documentation options include real-call Try it controls, downloadable samples, starter projects, parameter builders, and runnable examples through CodeSandbox or a similar platform. These are suggestions for documentation capabilities, not bundled services.

The framework serves developers writing SDK guides and maintaining developer experience over time. Maintenance includes semantic documentation versions, major-version migration paths, explicit deprecated-feature timelines, and upgrade guidance for breaking changes. The validation checklist covers examples in CI/CD, installation on clean environments, working links and references, and feedback through surveys and usage analytics.