Create help docs for your integration

Clear, detailed documentation can be a key success factor for driving integration adoption. It can give your customers confidence that your integration is easy to install and easy to use.

Learn how to create three key types of help documentation so that your customers can quickly get started with your Klaviyo integration. Below, we describe the purpose and audience for each help doc, and provide detailed templates for you to use.

📘
In order to be listed in Klaviyo's in-app and public directories tech partners are required to create the 3 pieces of help documentation detailed below: an installation guide, a data reference, and a use case how-to.

Want to learn about creating complementary promotional material? Check out our article on creating promotional material for your integration.

Help doc templates

Below, we give detailed guidance and templates on how to create 3 different types of help docs: installation guides, data references, and use case how-tos. We’ll explain each type of doc and what need it addresses.

Once you create these docs, it’s up to you where to host them. Typically, our partners host their docs on a dedicated help center. It’s also up to you how to present information - will you present all of the information on a single page, or will you spread it across multiple pages? The key is making sure your customers can easily find what they need to successfully use your integration.

We recommend separate pages for each doc template in order to create targeted, “snackable” reads for your customer. We also recommend cross-linking your docs and/or organizing them in a dedicated help center section so that they’re easily findable. If you choose to host all of your integration docs on one page, make sure to use a navigation bar or table of contents for ease of use.

Doc 1: Installation guide

What is an installation guide?

The purpose of an installation guide is to show customers how to install your integration. It should contain all the necessary contextual information for them to get started, how to install the integration, and how to contact support if they need it. It should also explain, at a high level, what your integration does.

Recommended word count: 750 words or less

Read time: 5 min or less

Who are installation guides for?

The audience for installation guides includes those ready to install your integration and those considering installation, who may be interested in what the process entails. Because this guide may be the customer’s first touchpoint with your integration, it’s important not to assume a baseline of knowledge and to give context to the steps you describe.

Examples

Here is an example of an installation guide created by the team at Klaviyo, which follows our template: Getting started with Amazon Buy with Prime.

Here’s an example of an installation guide created by our partners at OctaneAI: Getting started with Klaviyo.

Template

Check out our installation guide template and create your own.

Doc 2: Data reference

What is a data reference?

A data reference provides your customer with a detailed description of the data synced via your integration, that is, data that syncs to Klaviyo, syncs from Klaviyo, or both.

Who are data references for?

Data references are for customers looking to learn about what data is synced via your integration to understand its scope and build their use cases. For instance, if you are syncing an event to Klaviyo, describe the top-level properties of that event in your data reference, so that your customer can use that data in Klaviyo segmentation, flows, etc.

Examples

Here is an example of a data reference created by the team at Klaviyo, which follows our template: Square data reference.

Here’s an example of a data reference created by our partner Narvar: Klaviyo Notify Events and Data Definitions.

Template

Check out our date reference template and create your own.

Doc 3: Use case how-to

What is a use case how-to?

A use case how-to is a set of step-by-step instructions teaching the user how to achieve a specific goal using your integration. For example, how to trigger a Klaviyo flow with events sent from the integration or how to populate data from a synced event into a Klaviyo email template.

You should create use case how-tos for each main use case your customer should implement. These how-tos should educate customers on how to use your integration, and introduce strategies and best practices to maximize value.

A how-to article is short, digestible, and specific. Think of a how-to like a snack: it should be something the reader can consume quickly to take action in their account. The goal of a how-to, or outcome the user is accomplishing, should be clear and direct.

Recommended word count: 750 words or less

Who are use case how-tos for?

The audience for how-tos is anyone who is looking to accomplish a specific task using your integration, beyond the fundamentals of installation. Because how-tos aren’t onboarding resources, you can assume a baseline of knowledge and familiarity from the reader and link off to additional resources to provide context.

Examples

Here is an example of a use case how-to created by the team at Klaviyo, which follows our template: How to create a sending schedule based on SMS engagement.

Here’s an example of a use case how-to created by our partner Friendbuy: How to Send Referral Links Post Purchase in Klaviyo.

Template

Check out our use case how-to template and create your own.

Looking for more inspiration?

Check out the following resources from our partners:

Installation guides examples:

Data reference examples:

Use case how-to examples:

You can also explore the Integrations section of the Klaviyo Help Center to see all of our documentation for Klaviyo-built integrations.

Additional resources

Create promotional material for your integration