Skip to content

Conversation

@sarah11918
Copy link
Member

NOTE: This Draft PR is a work-in-progress and not ready for line-by-line review by the community just yet. The docs team is actively working on it and will ask for feedback when some key issues have been addressed.

This:

  • is a comprehensive, start-from-square-one, onboarding tutorial
  • accommodates and is geared towards, but does not entirely limit itself to, those with very little experience
  • is a text-based, code-along-on-your-machine walkthrough to provide helpful content for new users while our ability to add interactive code samples etc. is still developing

BACKGROUND CONTEXT (Based on diataxis.fr)

“A tutorial turns new learners into users.”

Tutorials are specifically targeted at newcomers who may not know anything about how your product works, and should hold their hand through their first experience with your product. A tutorial should get a learner started, not make them an expert.

Having completed a tutorial, the learner should be in a position to start to make sense of (not necessarily be proficient or well-versed in):

  • the rest of the documentation
  • the product itself

Learning takes place through what the pupil DOES. Facts and explanations are almost irrelevant at this stage. What matters is what you can get the learner to DO.

A tutorial for beginners is not the same as “best practice.” It’s OK to have new learners do things differently from an advanced user. The learner should enjoy the experience, see immediate success from their actions, and gain confidence and a sense of achievement.

After completing the tutorial, the learner needs only to be in a position to want to, and to be able to, learn more.

@netlify
Copy link

netlify bot commented Jul 22, 2022

Deploy Preview for astro-docs-2 ready!

Name Link
🔨 Latest commit f8aeb2b
🔍 Latest deploy log https://app.netlify.com/sites/astro-docs-2/deploys/634f3148210b78000868626b
😎 Deploy Preview https://deploy-preview-1089--astro-docs-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@delucis delucis marked this pull request as ready for review October 18, 2022 22:51
@delucis delucis dismissed Jutanium’s stale review October 18, 2022 22:52

Changes made!

Copy link
Member

@delucis delucis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I APPROVE THIS PR 👍

@sarah11918
Copy link
Member Author

THANK YOU EVERYONE! 💜 GO TEAM DOCS!

@sarah11918 sarah11918 merged commit 5c0d32c into main Oct 18, 2022
@sarah11918 sarah11918 deleted the tutorial branch October 18, 2022 23:17
@dsomel21
Copy link
Contributor

Amazing work!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

add new content Document something that is not in docs. May require testing, confirmation, or affect other pages.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants