4 ms·
That is interesting - my experience is the opposite, that how-to guides and tutorials are the most-commonly confused types of documentation. My aim is to make t
by DanieleProcida 7y ago
That is interesting - my experience is the opposite, that how-to guides and tutorials are the most-commonly confused types of documentation. My aim is to make the serve totally different needs:
* tutorials: I'm in charge (the teacher) and I know what the new learner needs to grasp and become comfortable with so that they gain sufficient basic confidence and skills. In the tutorials, the beginner doesn't even know what questions to ask or what language to us when asking questions
* how-to guides: the user is in charge; they are able to formulate the questions, and have the basic confidence and skills. What they need from me are the recipes.
As described, it's the difference between teaching a child to cook, and a book of recipes for somebody who already knows the basics of cooking and the kitchen but wants to know how to cook a particular thing.
If you get teaching a child to cook mixed up with a book of recipes everybody concerned will have a bad time. It matters most for the child, they will never want to learn how to cook with you again.
The same go for tutorials in my experience.
- hanniabu 7y agoThe issue is that tutorials and how to guides signs like the same thing. I prefer to use getting started and how to guides.
- DanieleProcida 7y agoI do that sometimes too: https://brachiograph.readthedocs.io/en/latest/get-started/index.html https://brachiograph.readthedocs.io/en/latest/get-started/in....