-
Notifications
You must be signed in to change notification settings - Fork 66
Template for a Tutorial
to use this template, copy it and edit all the sections below, please don't edit the template directly unless you want to improve it
Start with a goal - what will people learn (what problem are you solving? How the will people benefit from the completion of your tutorial? Short and as straightforward as possible)
Who is your audience?
How much time will it take?
Guidelines or prerequisites (what do they need to know?)
When asking users to carry out a step, explain the reasoning behind the action and the expected result.
Part one instructions.
Part two instructions.
Tip: place your tip here
Explain the reasoning and expected result.
Instructions
Congratulations on completing this tutorial! (Edit this part as you feel, with your free-form congrats sentence)
Summarize important lessons you'd like users to take away from the tutorial.
Help users along their journey by providing the next steps - these might be recommended reading, supplementary resources, or even another tutorial.
- Is the goal clear and can be found within the first 30 seconds of opening your tutorial?
- Are the steps clear and actionable for accomplishing the task your reader needed help with?
- Is it possible to complete your tutorial within 15-30 minutes?
- Do you have at least 1-2 images/visuals/media in your tutorial?
- Did you spell-check and proofread? Grammarly
- Is it easy to read? Hemingway. Quillbot is good for fluency and paraphrasing.
- Did you check and fix the accessibility issues? WAVE
- Is there a Call to Action / Next Steps?
SDK - Develop Data Jobs
SDK Key Concepts
Control Service - Deploy Data Jobs
Control Service Key Concepts
- Scheduling a Data Job for automatic execution
- Deployment
- Execution
- Production
- Properties and Secrets
Operations UI
Community
Contacts