Ask Lemmy
A Fediverse community for open-ended, thought provoking questions
Please don't post about US Politics. If you need to do this, try [email protected]
Rules: (interactive)
1) Be nice and; have fun
Doxxing, trolling, sealioning, racism, and toxicity are not welcomed in AskLemmy. Remember what your mother said: if you can't say something nice, don't say anything at all. In addition, the site-wide Lemmy.world terms of service also apply here. Please familiarize yourself with them
2) All posts must end with a '?'
This is sort of like Jeopardy. Please phrase all post titles in the form of a proper question ending with ?
3) No spam
Please do not flood the community with nonsense. Actual suspected spammers will be banned on site. No astroturfing.
4) NSFW is okay, within reason
Just remember to tag posts with either a content warning or a [NSFW] tag. Overtly sexual posts are not allowed, please direct them to either [email protected] or [email protected].
NSFW comments should be restricted to posts tagged [NSFW].
5) This is not a support community.
It is not a place for 'how do I?', type questions.
If you have any questions regarding the site itself or would like to report a community, please direct them to Lemmy.world Support or email [email protected]. For other questions check our partnered communities list, or use the search function.
Reminder: The terms of service apply here too.
Partnered Communities:
Logo design credit goes to: tubbadu
view the rest of the comments
That documentation is supposed to explain how a thing works to people who don't know how it works. I know, sounds extremely obvious, but you'd be surprised how much documentation out there is written in a way, expecting you to already know what it's talking about. No. I do not. It is the documentation's job to explain ME what IT is talking about...
I agree with a caveat. If you are looking up documentation for an API or something software engineer adjacent, I think its fair for the authors of the documentation to assume the reader has a background in computer science, and shouldn't have to explain topics that are explained in computer science curriculum. Same with other documentation that is intended to be used by specialists in their respective fields.
Couldn't have explained it better myself. Everyday items? Yeah, should be documentation for a person's first time using it.
Explaining logarithms in mathematics? Gonna need previous algebra knowledge, that's a given.
I know, but a library or a piece of software should explain it's own functions. I might know my way around the tech stack, but if you don't explain what your library does, I have no way of knowing it...
Where on the doll did the man page touch you?
The man page was empty.