Opensource

1113 readers

64 users here now

A community for discussion about open source software! Ask questions, share knowledge, share news, or post interesting stuff related to it!

Credits

Icon base by Lorc under CC BY 3.0 with modifications to add a gradient

⠀

founded 11 months ago

MODERATORS

[email protected]

How do I know if a project has a good documentation? (jlai.lu)

submitted 5 months ago by [email protected] to c/[email protected]

3 comments fedilink hide all child comments

Hey!

I not good at understanding a project from its code. So, I try as much as I can to understand it from its technical documentation first. But so many time I fell overwhelm by the information: I don't know were to start to read and I don't know how to find a specific information.

How can I know when I'm lacking in understanding the project and when the project is lacking good documentation?
Where should I start while studying a documentation which readme doesn't say "read this next"?

Thank you

top 3 comments

sorted by: hot top controversial new old

[–] [email protected] 9 points 5 months ago (2 children)

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.

[–] [email protected] 4 points 5 months ago

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.

[–] [email protected] 1 points 5 months ago

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.