6
How do I know if a project has a good documentation? (jlai.lu)
submitted 2 years ago by to c/opensource@programming.dev
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

all 3 comments

sorted by: hot top controversial new old
[–] 9 points 2 years 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.

  • permalink
  • fedilink
  • source
  • hideshow 2 child comments
    •
  • [–] [S] 1 point 2 years 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.

  • permalink
  • fedilink
  • source
  • parent