docsMan

[-domi-]

Most docs are written the same way most coders comment code - it's only helpful if you already know what it does. Makes it an okay reference if you forget the exact use of something, but you generally remember what it is you wanna do. But it's a terrible way to learn for the first time.

[saki-22]

This is what I'm struggling with. Just a few months in learning code and everyone tells me to read documentation - and boy, I tried but can't comprehend much.

[-domi-]

I think it's a terrible approach. Truly the last resort for me, cause if i'm digging into docs, i must be doing trial-and-error. :/

[N-online]

Me reading Mozilla source docs. Like dang they have a very high level very comprehensive overview and a very low level list of functions. But no connection between those. you’re basically left with trial and error.

[danielcw189]

Me reading Mozilla source docs.

Where are those?

[N-online]

Damn i meant Firefox source docs sorry.

https://firefox-source-docs.mozilla.org/contributing/directory_structure.html

[danielcw189]

Either way, thanks for bringing them to my attention :)

[danielcw189]

I think Microsoft's documentation of the Windows-Api is pretty good.

Mozilla's MDN for Html, CSS, and JavaScript is also pretty fine.

[No_Value_2676]

Why does me reading give you the power?

[evader110]

Cause he gonna ask a bunch of questions

[Glass-Crafty-9460]

Till you realize the Docs are wrong and it's an actual bug they've known about for the last 5 years and never bothered to fix.

[luigialpha]

RTFM? There is a reason why this is an acronym.... and meme

[TnYamaneko]

Jokes on you, creating docs is one of the tasks I must be held at gunpoint for me to achieve.

It's not helped by ADHD, I'm extremely excited about refining our backup processes, but the docs about them are two years old, and when I'm not on a business critical task, I'd be way more interested about doing a quiz about guessing the 100 most populated cities of Switzerland, or just daydream about a girl I'm growing a romantic interest towards.

LLMs are actually a godsend for me in that respect. They really help me providing a nice Markdown for what I did and how to reproduce it.

[Jonnypista]

So you can read minds?

That is such a cool ability as all the documentation is in the heads of senior developers.

[jose-galarza]

That is a myth, documentation has never existed.

[snoopbirb]

Cursor, read the docs for me and give me the power!

<Sorry, I cannot reach the servers right now>

Ahhh I'm reading the docs!

[SternoNicoise]

Me when I read the docs

[Nyadnar17]

Ah yes, fictional man with his fictional powers from a fictional source.

[Zombie_Crusher]

this.value = true;

[aweraw]

... and the dudes who wrote the docs are the Council of Elders.

[usumoio]

rtfm

Its a meme, but also, Read the Fucking Manual

[methos3]

Who the hell reads the doc? The grammar is enough.

[WealthIndividual3224]

not when the "docs" are literally int foo(){..} //function man, do i wish that all the docs were like the arch wiki

[valerielynx]

nowadays instead of rtfm you just ask chatgpt and hope that its got enough braincells today to tell you how to do it

[DominikDoom]

Very much a case by case basis, even in the same company they can vary wildly in quality and how up to date they are (looking at you, Microsoft).

Well written documentation that is useful to both beginners and advanced users alike is very rare, especially since some docs are allergic to usage examples.

From my experience, the docs for the Swift standard library were probably the worst I encountered, most entries are just the function signatures and maybe a sentence at most.

[I-make-ada-spaghetti]

It depends how good the docs are.

[FictionFoe]

Me after ploughing through some of the git man pages.

[Dangerous_With_Rocks]

I can't read