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

  • towerful@programming.dev
    link
    fedilink
    arrow-up
    4
    ·
    8 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.