You know your software's documentation sucks when it forces its users go snoop through the source code to find out how to set it up...

My work project documentation sucks which l wrote it. I have to dig into the source code and see how it works 😭

But what if you document your source code so well that you can run the source code through a documentation generator and generate the documentation for the project?

That is the only documentation that I believe in. It stays up-to-date with code changes provided that the developers making the code changes modifies the source documentation accordingly.

I don't mind going through source code as long as the code itself is properly documented.

I don't want to run the logic in my head when I'm reading the source code though.