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.
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…
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…