this post was submitted on 25 Sep 2025
555 points (95.7% liked)
Programmer Humor
26640 readers
2141 users here now
Welcome to Programmer Humor!
This is a place where you can post jokes, memes, humor, etc. related to programming!
For sharing awful code theres also Programming Horror.
Rules
- Keep content in english
- No advertisements
- Posts must be related to programming or programmer topics
founded 2 years ago
MODERATORS
you are viewing a single comment's thread
view the rest of the comments
view the rest of the comments
The more advanced the level of knowledge on something the more foundation knowledge somebody has to have to even begin to understand things at that level.
It 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 so that an absolute beginner can understand what's going on.
Imagine if you were trying to explain something Mathematical that required using Integrals and you started by "There this symbol, '1' which represents a single item, and if you bring another single item, this is calling addition - for which we use the symbol '+' and the count of entities when you have one single entity and 'added' another single entity is represented by the symbol '2'. There is also the concept of equality, which means two matematical things represent the same and for which the symbol we use is '=' - writting this with Mathematical symbols, '1 + 1 = 2'" and built the explanation up from there all the way to Integrals before you could even start to explain what you wanted to explain in the first place.
That said, people can put it in "recipe" format - a set of steps to be blindly followed without understanding - but even there you have some minimal foundational knowlegde required - consider a cooking recipe: have you ever seen any that explains how does one weight ingredients or what is "boiling" or "baking"?
So even IT "recipes" especially designed so that those with a much lower level of expertise than the one required to actually understand what's going on have some foundational knowledge required to actually execute the steps of the recipe.
Last but not least 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, because there's some enjoyment in teaching about something to others, which you get when you explain it but seldom from merely providing a list of steps for others to blindly follow without understanding.
So, if one wants to do something way above the level of expertise one has, look for "recipe" style things rather than explanations - the foundational expertise required to execute recipes is way lower than the one required to undertand explanations - and expect that there are fewer recipes out there than explanations. Further, if you don't understand what's in a recipe then your expertise is below even the base level of that recipe (for example, if somebody writes "enter so and so in the command prompt" and you have no fucking clue what a "command prompt" is, you don't meet the base requirements to even blindly follow the recipe), so either seek recipes with an even lower base level or try and learn those base elements.
Further, don't even try and understand the recipe if your expertise level is well below what you're trying to achieve: sorry but you're not going to get IT's "Integrals" stuff if your expertise is at the level of understanding "multiplication".
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#
Good documentation includes both. i.e. step-by-step guide, with explanations. See above.
All documentation should cater to all levels. See above.
For "all documentation" to "cater to all levels" it would have to explain to people "how do you use a keyboard" and everything from there upwards, because there are people at that level hence it's part of "all levels".
I mean the your own example of good documentation starts with an intro of "goals" saying:
For 99% of people almost all that is about as understandable as Greek (expect for Greek people, for whom it's about as understandable as Chinese).
I mean, how many people out there in the whole World (non-IT people as illustrated in the actual article linked by the OP) do you think know what the hell is "Visual Studio", ".Net", "Multi-platform Application User Interface", "template", "C#", "XAML", "binding" (in this context).
I mean, if IT knowledge was a scale of 1 to 10 with 10 the greatest, you're basically thinking it's "catering to all levels" when an explanation for something that is level 8 knowledge (advanced programming) has a baseline required level of 7 (programming). I mean, throw this at somebody that "knows how to use Excel" which is maybe level 4 and they'll be totally lost, much less somebody who only knows how to check their e-mail using a browser without even properly understanding the concept of "browser (like my father) which is maybe level 2 (he can actually use a mouse and keyboard, otherwise I would've said level 1).
I think you're so way beyond the average person in your expertise in this domain that you don't even begin to suspect just how little of our domain the average person knows compared to an mere programmer.
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 😂
Cool but nobody's about to link to prerequisite information like typing on a keyboard. Same for math, a book focusing on integration isn't going to say "read this book for the basics of addition btw".
And why should one even cater to that? If a person is interested enough they can just.. look up the things they don't understand, that's not exactly hard
they say to someone who does indeed link to all pre-requisite knowledge. 😂 You know some Tech people do indeed recommend doing a touch-typing course, right?
I'm a Maths teacher. You'll find that Maths textbooks do indeed run through any pre-requisites for the topic. e.g. "We discussed back in Chapter 2...".
Because it's useless to a large chunk of your audience if you don't.
No they just can't, not when no information at all has been given on what this is so that you have something to search for. See Microsoft doco where they use TLA's, don't tell you what the TLA is short for, don't link to any information about the TLA, and searching for "TLA" (since they've not told you what TLA is short for) fails to bring up any information about this thing they are talking about. Now the tutorial is completely useless to you because you have no idea what they're talking about and can't find anything about what they're talking about. "Draw the rest of the owl"
It's very hard when you have no search keywords at all to work with.
No, you're not supposed to follow years of computer science courses in a university. A good tutotial will provide all prerequisite knowledge for you. Including high school.