IMHO it is all part of the documentation to enable people to up ramp.
What is missing from most documentation is simple Use Case.
You need a video / tutorial that is JUST 'Wheres the starting point'
Then one addressing what you expect most people to do.
Each tutorial should be no more than 5 minutes, ideally 1 minute.
(hmm sounds like breaking up your code into manageable parts)
Making it easy to find the tutorials is important.
If one tutorial needs another, then point to it. Do not just say "before you start make sure you understand quantum theory"
You know this is like the 'one man band' where the person is playing a dozen instruments. "I do not understand, you know how to read music, why don't you strap this on and perform?" Er I don't know how to play the xylophone.
Ok let me teach you each instrument.... then we can put it together. Here is the symbol, here is the harmonica, we will just integrate these 2.
Hope this helps.
What is missing from most documentation is simple Use Case.
You need a video / tutorial that is JUST 'Wheres the starting point'
Then one addressing what you expect most people to do.
Each tutorial should be no more than 5 minutes, ideally 1 minute. (hmm sounds like breaking up your code into manageable parts)
Making it easy to find the tutorials is important.
If one tutorial needs another, then point to it. Do not just say "before you start make sure you understand quantum theory"
You know this is like the 'one man band' where the person is playing a dozen instruments. "I do not understand, you know how to read music, why don't you strap this on and perform?" Er I don't know how to play the xylophone.
Ok let me teach you each instrument.... then we can put it together. Here is the symbol, here is the harmonica, we will just integrate these 2.
Hope this helps.