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

Commit

Permalink
Some minor edits to quickstart drafts
Browse files Browse the repository at this point in the history
  • Loading branch information
itsdeannat committed Sep 6, 2021
1 parent bda84de commit 373fbdc
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 11 deletions.
16 changes: 9 additions & 7 deletions tutorial/quickstart-tutorial/about-quickstart-tutorial.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
# The quickstart tutorial template

The quickstart or `Hello World!` tutorial template is generally for introducing your users to your product or framework for the first time. Users can typically complete these tutorials in less than 15 minutes. It's task-based and installation-focused.
The quickstart or `Hello World!` tutorial is for introducing your users to your product or framework for the first time. Users can typically complete these tutorials in less than 15 minutes. It's task-based and installation-focused.

## About the overview section

Use this section to provide a short description of your product and its purpose, and to describe what the user will accomplish in this tutorial.

## About the prerequisites section

Use this section to list any prerequisites for completing the tutorial. This may include operating systems, languages, package managers, or software.
You can also state the intended audience for your tutorial and mention any concepts users should be familiar with before starting the tutorial.

## About the installation section

Expand All @@ -20,12 +18,16 @@ If you're writing a tutorial that's code focused, you might use this section to

The steps section is where you describe what the user needs to do. For a quickstart tutorial, you can walk the user through installing your product and then completing a small project to verify their installation.

How you write your steps will vary depending on your organization's style guide.
### Writing your steps

For each step, provide some background information about the task so users know what they're about to do and why.

If users should see a result after completing a particular step, make sure to include it. This might mean including a screenshot of a dialog or terminal output.

## About the summary section

Use the summary section of the tutorial to sum up what tasks your user completed during the tutorial, and to summarize what your users now know how to do.
Use this section to summarize what tasks your user completed during the tutorial, and to summarize what your users now know how to do.

## About the next steps section

Use this section to include links to other tutorials, such as tutorials that allow users to learn about other features. You can also include links to relevant resources, like articles, blogs, or videos.
Use this section to include links to other tutorials. You can also include links to relevant resources, like articles, blogs, or videos.
10 changes: 6 additions & 4 deletions tutorial/quickstart-tutorial/quickstart-tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Include any code samples, snippets, or screenshots that will help your user comp
{Provide background information for the task here. You might want to define any terminology here and provide any overview of this task's purpose.
Include any code samples, snippets, or screenshots that will help your user complete the task}.

{If users should see a result after complete this step, make sure to include it.}
{If users should see a result after completing this step, make sure to include it.}

#### (Optional) Sub step 1 - {Subtask name}

Expand All @@ -42,7 +42,7 @@ Use this section to summarize what users will complete in the following steps.
{Provide background information for the task here. You might want to define any terminology here and provide any overview of this task's purpose.
Include any code samples, snippets, or screenshots that will help your user complete the task}.

{If users should see a result after complete this step, make sure to include it.}
{If users should see a result after completing this step, make sure to include it.}

#### (Optional) Sub step 1 - {Subtask name}

Expand All @@ -53,7 +53,7 @@ Include any code samples, snippets, or screenshots that will help your user comp
{Provide background information for the task here. You might want to define any terminology here and provide any overview of this task's purpose.
Include any code samples, snippets, or screenshots that will help your user complete the task}.

{If users should see a result after complete this step, make sure to include it.}
{If users should see a result after completing this step, make sure to include it.}

### Summary

Expand All @@ -67,4 +67,6 @@ In this tutorial, you learned how to:

### Next steps

Now that you've completed this tutorial, try these tutorials to learn more about {features}.
{Use this section to provide links to other tutorials or resources for users who want to learn more about the concepts covered in the tutorial.}

Now that you've completed this tutorial, try these tutorials to learn more about {feature}. If you're interested in learning more about {concept}, visit {resource link}.

0 comments on commit 373fbdc

Please sign in to comment.