UX Writing Technical Specification API Docs Technical Documentation Knowledge Base Translation English Installation Guides Help Docs Troubleshooting Handbooks Support Docs Project Docs Portuguese Release Notes German SDK Product Discovery UX Design Spanish Copywriting Microcopy Educational Material Localization User Guides

Title

:information_source: Before using this template, read the accompanying quickstart template guide.

Overview

This quickstart guides you through:

:information_source: (Optional) Link each part to its corresponding section for easy access.

It is intended for {audience}. It assumes that you have basic knowledge of:

:information_source: Link each concept to its corresponding content that helps users understand the concepts and ideas behind your software.

Before you start

:information_source: This section is optional.

Before running this quickstart, complete the following prerequisites:

Install

:information_source: This section is optional. Use this section to provide installation instructions.

Part 1: {Task name}

:information_source: Use this section to summarize what users complete in the following steps.

Step 1: {Step name}

:information_source: You can use this format to describe your step:

Explanatory text

(Optional) Code sample or screenshot that helps your users complete this step.

(Optional) Result on completing this step.

(Optional) Sub step 1: {Substep name}

:information_source: Beware of asking your users to do too much in one step. If needed, break a step into one or two smaller substeps.

Part 2: {Task name}

…

Step 2: {Step name}

…

(Optional) Sub step 2: {Subtask name}

…

Part n: {Task name}

…

Step n: {Step name}

…

(Optional) Sub step n: {Subtask name}

…

Next steps

Now that you’ve completed this quickstart, try these to learn more about {feature}.

Back