💡𝚂𝗆𝖺𝗋𝗍𝗆𝖺𝗇 𝙰𝗉𝗉𝗌📱
- 7 Posts
- 4 Comments
💡𝚂𝗆𝖺𝗋𝗍𝗆𝖺𝗇 𝙰𝗉𝗉𝗌📱@programming.devOPto
Programmer Humor@programming.dev•How I, a non-developer, read the tutorial you, a developer, wrote for me, a beginner - annie's blogEnglish
1·2 months agoImagine a chemistry lab tutorial aimed at 9th grade students getting “as a non-chemist, this reads as gibberish” comments from first graders. Nobody would blame the tutorial authors
I tutor Maths. I have a Year 12 student who has forgotten things they were taught in Year 8, and the teacher has done no revision of it in class. Now guess why this student needs a tutor 😂
People need to start putting in the effort.
The people writing the documentation, yes. They need to say what the prerequisite knowledge is, and include links to it for those who don’t know it (or remember it). Only takes a few minutes to do that. See Creating MAUI UI’s in C#
💡𝚂𝗆𝖺𝗋𝗍𝗆𝖺𝗇 𝙰𝗉𝗉𝗌📱@programming.devOPto
Programmer Humor@programming.dev•How I, a non-developer, read the tutorial you, a developer, wrote for me, a beginner - annie's blogEnglish
21·2 months agoIt would be pretty insane to in a tutorial for something at a higher level of expertise, include all the foundational knowledge to get to that level of expertise
You don’t need to include it all. You just need to mention it as pre-requisite knowledge, and link to resources about it for those who don’t have that knowledge. See Creating MAUI UI’s in C#
I get the impression that most people who go to the trouble of writting about how to do something prefere to do explanations rather than recipes
Good documentation includes both. i.e. step-by-step guide, with explanations. See above.
so either seek recipes with an even lower base level
All documentation should cater to all levels. See above.
💡𝚂𝗆𝖺𝗋𝗍𝗆𝖺𝗇 𝙰𝗉𝗉𝗌📱@programming.devOPto
Programmer Humor@programming.dev•How I, a non-developer, read the tutorial you, a developer, wrote for me, a beginner - annie's blogEnglish
24·2 months agoSounds like typical Microsoft documentation to me. Explains in great detail what .NET is, where you can download it from, then jumps straight to the advanced topic they’re covering without any of the intermediate knowledge covered or even linked to (but perhaps referred to only vaguely in passing as an acronym, again with no link, this time no link to what “TLA” is actually short for, so you’re searching for it is fruitless as well).








No it wouldn’t. You just link to resources about pre-requisite knowledge.
Nope. Exact same thing applies to all pre-requisite knowledge.
Now scroll down to the pre-requisite knowledge which has links to things explaining ALL of that.
Exact same number as there is people capable of clicking on the provided links about them in the pre-requisite knowledge section.
…until they read the links in the pre-requisite knowledge, and then they will understand all of it.
says person who didn’t even scroll past the introductory paragraph! 😂 You think people try to learn things by reading only the introductory paragraph?? 😂
And yet, weirdly, if you keep reading you’ll find it caters to people who know nothing about it 😂