Skip to content
This repository has been archived by the owner on Sep 24, 2022. It is now read-only.

Commit

Permalink
Updated review comments provided for the second draft by Alyssa
Browse files Browse the repository at this point in the history
  • Loading branch information
gayathri-krishnaswamy committed Mar 16, 2022
1 parent 816b257 commit fb1a28a
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 16 deletions.
19 changes: 10 additions & 9 deletions quickstarts/quickstart-template-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,19 +33,20 @@ Quickstart guides are often confused with getting started and marketing guides.

A quickstart is often the first opportunity for your users to form a positive impression on your product, and build an opinion on the technology it was built on. It can:
- Make users comfortable using the application.
- Lead to the willingness to handle complex workflows.
- Motivate the users to take up more complex tasks.
- Reduce users' onboarding time and give them the feeling that the application is easy to use.
- Improve the user experience, and help reduce costs by lowering the number of support requests.

## Before writing a quickstart
Before you start working on your quickstart, identify:- Primary feature of your application.
- Quickest and the easiest way to implement end-to-end the primary feature of your application.
- Use case that your user can complete within 1 - 2 hours with a preference for a shorter time.
- Audience as it helps the users determine if the quickstart is relevant for their use.
Before you start working on your quickstart, identify:
- The primary feature of your application.
- The quickest and the easiest way to implement end-to-end the primary feature of your application.
- An use case that your user can complete within 1 - 2 hours with a preference for a shorter time.
- The audience, as it helps the users determine if the quickstart is relevant for their use.

## Best practices for writing a quickstart
- Avoid complicating the quickstart by including error scenarios/complex use cases.
- Lengthy quickstarts can overwhelm users. Consider condensing or removing steps or reevaluating the scope of the quickstart.
- Lengthy quickstarts can overwhelm users. Consider condensing or removing steps or reevaluating the scope of the quickstart.
- Avoid complicating the quickstart by including error scenarios or complex use cases.
- Remove the burden of setup requirements as much as possible through sandbox accounts.
- Ensure that the quickstart works and provides the advertised result.
- For code samples, ensure that you include:
Expand All @@ -72,8 +73,8 @@ For easy understanding, consider classifying the prerequisites into different ca

This section is optional.

:memo: Not all quickstart guides require an installation section. Include this section if:
- Installation and/or configuration is done at the same time, and by the same person running the quickstart.
:memo: Not all quickstart guides require an installation section. Include this section if:
- Installation and/or configuration is done at the same time, and by the same person running the quickstart.
- Installation of specific software(s) is a prerequisite to running the quickstart.

The purpose of this section is to provide instructions to your users on how to install and configure a particular software/tool before running the quickstart.
Expand Down
14 changes: 7 additions & 7 deletions quickstarts/quickstart-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@
## Overview

This quickstart guides you through:
- [Part 1](#part-1-taskname)
- [Part 2](#part-2-taskname)
- [Part n](#part-n-taskname)
- [Part 1](#part-1-task-name)
- [Part 2](#part-2-task-name)
- [Part n](#part-n-task-name)

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

Expand Down Expand Up @@ -40,10 +40,10 @@ Before running this quickstart, complete the following prerequisites:

### 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.
: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}

Expand Down

0 comments on commit fb1a28a

Please sign in to comment.