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

Commit

Permalink
Add more tutorial writing tips to guide
Browse files Browse the repository at this point in the history
  • Loading branch information
itsdeannat committed Oct 20, 2021
1 parent 691ca3b commit ac4d135
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion tutorial/about-tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,8 @@ Use this section to include links to other tutorials, such as tutorials that all

## Helpful tips when writing your tutorial

* Keep your tutorial focused. If needed, link out to other pieces of documentation that might explain some concept in more depth.
* Keep your tutorial focused. If needed, include links to other pieces of documentation that explain concepts or terms in more depth.
* If users will copy and paste code samples, make sure they include the following:
* Any required `import` or `using` statements
* Code comments that explain what the code does
* Lengthy tutorials can overwhelm users. Consider condensing or removing steps or reevaluating the scope of the tutorial.

0 comments on commit ac4d135

Please sign in to comment.