6
you are viewing a single comment's thread
view the rest of the comments
view the rest of the comments
this post was submitted on 03 Apr 2024
6 points (80.0% liked)
Opensource
1444 readers
94 users here now
A community for discussion about open source software! Ask questions, share knowledge, share news, or post interesting stuff related to it!
⠀
founded 1 year ago
MODERATORS
What are you trying to understand and what type of project are you looking at? Are you looking to run a program or use a library?
Good documentation to me is here’s how to get this installed, here’s a basic overview of getting started, here’s all the methods/functions with their arguments and a description, and optionally some very basic examples programs to sanity check everything is working ok.
Poor documentation is when i find myself reading unit tests to figure out how to use something.
At least there are unit tests...
Bad documentation is when i am digging through source code.
I am not speaking of something in particular. It was more of a general question. I usually figure it out how to install a project (usually...) but my question is more about technical documentation.