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

Commit

Permalink
Implementing final bits of community feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
itsdeannat committed Apr 17, 2022
1 parent f1f1ca3 commit 0445753
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 5 deletions.
6 changes: 3 additions & 3 deletions tutorial/tutorial-template-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ The tutorial template includes:

## Why do I need tutorials?

Tutorials are integral to helping your users become acquainted with your product. They are learning-oriented, which means that they teach users a specific skill, like debugging a JavaScript application.
Tutorials are integral to helping your users become acquainted with your product. They are learning-oriented and are usually focused on teaching users a specific skill, like debugging a JavaScript application.

Tutorials are often confused with how-to guides because they help users achieve a specific goal. However, how-to guides assume that your users have some experience with your product or are familiar with certain concepts.
Tutorials are often confused with how-to guides because they do help users achieve a specific goal. However, how-to guides assume that your users have some experience with your product or are familiar with certain concepts. They also are usually focused on helping users complete a specific task, like how to add an email account to Microsoft Outlook.

In comparison, tutorials give your users hands-on experience with your product so that they can understand key concepts about your product in a more practical context. Hands-on learning often helps learners gain a deeper understanding of the product by helping them see how they can use a tool to accomplish a task they care about.
In comparison, tutorials give your users hands-on experience with your product so that they can understand key concepts about your product in a more practical context. Hands-on learning often helps learners gain a deeper understanding of the product by helping them see how they can use a tool to accomplish a task they care about.

## Helpful tips when writing your tutorial

Expand Down
10 changes: 8 additions & 2 deletions tutorial/tutorial-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,15 @@ By the end of this tutorial, you'll be able to:

## Before you begin

{Use this section to tell users about any steps they need to complete before they start the tutorial.}
{Use this section to tell users about any prerequisites needed before they start the tutorial, such as:

Before you start the tutorial, complete these steps:
* Expected prior knowledge.
* Software or hardware to obtain.
* Environments to set up and configure.
* Access codes to obtain.
}

Before you start the tutorial, you should:

* Prerequisite 1
* Prerequisite 2
Expand Down

0 comments on commit 0445753

Please sign in to comment.