Tutorials and Use Cases

Our documentation allows for three different types of "how-to" content:

If you just want to show a bit of sample code that demonstrates to a reader how to perform a single task, then you need a code snippet.

If you want to teach a reader how to build something, then you'll need either a Tutorial or a Use Case. This page will help you decide which of those two formats is right for your content.

Characteristics of a Tutorial

Tutorials demonstrate how to complete a specific, well-defined task, using a step-by-step format. They nearly always involve a single product.

If all of the following apply, then use the Tutorial format:

Tutorial examples:

Characteristics of a Use Case

While Tutorials provide step-by-step instructions on how to do specific things with one product, Use Cases describe far more complex scenarios, that may use several Vonage API products, and optionally products from other vendors.

Use Cases do not have to provide a step-by-step approach, although sometimes they do. Tutorials always use the step-by-step approach.

If several of the following apply, then consider the Use Case format:

Use Case examples

Building your Tutorial or Use Case

Once you have decided on the appropriate format, you should first learn how to structure the content of your Tutorial or Use Case:

Then, see the appropriate guide to learn how to add your new Tutorial or Use Case to our documentation platform: