<Language name> SDK

A topic that describes an SDK for a single programming language.

Optional

Topic structure

Each SDK topic should have the following structure:

Overview

A 1–3 sentences intro that explains what the developers can do with the SDK. Include a real-life use case example.

(Optional) A “how it works” diagram

Add a diagram if the users need to understand the communication/action flow that involves the SDK. Example: twilio.com/docs/voice/sdks/javascript

(Optional) Release notes

Include the release notes if the SDK is developed and released.

Getting started

This subsection must contain the following information:

Using <SDK>

A reference subsection that contains the following information:

  • List of the components of the SDK the developers can use.
  • What the developers can use the components for.
    • A list of use cases
    • Optionally, a separate resource reference section with sample responses, errors, etc.

Examples

(Optional) A code tutorial

A tutorial for an actual use case that walks the developer through the whole process.

Example: developer.spotify.com/documentation/web-playback-sdk/howtos/web-app-player

(Optional) Troubleshooting

A list of the most common issues and the related fixes.