Table of Contents
- Table of Contents
- Define the topic
- Define the scope and depth
- Define the reader
- Break it down
- Define the individual units of the tutorial
- Group the units to form macro units
- Group macro units into form large parts
- Define a purpose
- Form a holistic narrative
- Edit the first draft
- Define a title
This guide serves to lay out the process of writing the perfect tutorial and the art and science behind it.
Define the topic
Purposefully select a topic for a tutorial.
Define the scope and depth
Define the scope of the tutorial as to how much of the topic and what aspects of the topic the tutorial will cover.
Define the reader
- Someone who has never developed before
- Junior developer
- Mid developer
- Senior developer
- Old master
Break it down
Break the topic down into a table of contents
Define the individual units of the tutorial
Are there going to be examples, code samples, images, animated images, videos, quotes, etc
Gather the resources for reference.
Fill those units with content
Group the units to form macro units
Group relevant units into macro units so they form a micro narrative that consistently flows as it is read.
Group macro units into form large parts
Group relevant macro units into large parts of the tutorial
Define a purpose
Define a singular and visceral purpose (may be composite of other purposes) of the tutorial
Form a holistic narrative
Form a holistic narrative and arrange all of the content in pertinence to the visceral purpose.
Edit the first draft
Edit the first draft with the purpose in mind.
Proofread the tutorial in a site like Grammarly.
Define a title
Define a title that will both represent the tutorial itself and help the user find most easily.