SmartmanApps

joined 2 years ago
MODERATOR OF
[–] SmartmanApps@programming.dev 5 points 6 months ago

RTFM

The problem is the manuals which are written exactly as described in the post

[–] SmartmanApps@programming.dev 0 points 6 months ago

“it’s very easy!”

A lot of experienced people say that, and it isn't to a beginner. The infamous example in Maths circles is "the proof is left as an exercise for the reader". In other words, "I couldn't be bothered writing this because I'm assuming you already know how to do it".

It’s a curse of knowledge

Yep, the people who write the Microsoft documentation assume that the readers know everything they already know.

[–] SmartmanApps@programming.dev 2 points 6 months ago

use developer language

Microsoft uses Microsoft language, and the only people who understand it are people who have been Microsoft programmers for a long time.

sitting in the bubble of experts

Yep, the Microsoft ecosystem is completely unwelcome to newbies. It's by experts for experts, and everyone else can go to hell

[–] SmartmanApps@programming.dev 1 points 6 months ago

Imagine 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#

[–] SmartmanApps@programming.dev 2 points 6 months ago

I think TLA means “Three Letter Acronym” in some circles

Yes, that was why I used it. Microsoft doco is full of unexplained TLA's - you have to already know what it means and how to use the thing. You knew what TLA meant. Now read the Miscrosoft doco where you don't know what any of the MS TLA's mean, and they don't tell you.

[–] SmartmanApps@programming.dev 3 points 6 months ago* (last edited 6 months ago)

I’ve seen cases where the documentation of the rather critical parameter “flags” was just the word “flags”.

In Microsoft documentation it would just say "FLGs", with no explanation of what FLG is, nor any links to resources about FLGs. you either already know what it is or you now can't continue any further with the documentation (because a search for FLG also fails to find what it is). Throughout their documentation it is heavily assumed you are a long-time Microsoft programmer and already know all of this. i.e. it is completely unwelcoming to Microsoft beginners (and even some who aren't beginners)

[–] SmartmanApps@programming.dev 4 points 6 months ago

They seem to exist solely as a reminder to those who already know

Perfect description of the entire Microsoft .NET documentation, signed, .NET beginner who not only didn't have a .NET background, but not even a Microsoft programming background (which is also heavily assumed throughout - way to make newbies feel completely unwelcome in your ecosystem!).

[–] SmartmanApps@programming.dev 0 points 6 months ago (14 children)

most people writing these things aren’t paid.

I wasn't paid to write Creating MAUI UI's in C#. Didn't stop me from doing a proper job of it.

[–] SmartmanApps@programming.dev 4 points 6 months ago (9 children)

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

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.

[–] SmartmanApps@programming.dev 3 points 6 months ago (1 children)

Instead of writing that snarky comment you could’ve instead used the web for its original purpose and conduct your own research and not bug strangers on the internet to do your bidding

You're not the only one they're doing it to (I went to their profile to see if this is a pattern, and it sure is).

sleep-pc: a .NET Native AOT tool to make Windows sleep after a timeout

[–] SmartmanApps@programming.dev 2 points 6 months ago

Instead of squabbling and giving bullshit responses, you could have contributed something useful

I told you the answers are in the blog post, which you could've just read to begin with, instead of bothering people with irrelevant comments, but here you are yet again, commenting instead of reading the post.

[–] SmartmanApps@programming.dev 73 points 6 months ago (3 children)

Sounds 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).

view more: ‹ prev next ›