[prepend]

I hate writing documentation, really appreciate reading great documentation, and hate reading ok or marginal documentation.

My current approach is just to read source only for docs so whatever is in the readme.md and the source files is good enough if a project doesn’t have someone smart who’s into documentation.

And then like “meta docs” generated from markdown in git that links to logs of projects.

Most of the stuff I work on is internal only and even paid people seem to have bad docs as well.

Source + markdown is good enough and seems to attract more internal edits so at least material is more likely to be correct.

Any other scheme seems to fail based on the size of the group so I don’t bother trying to make a specific structure other than “use your judgement, make code readable, make sure any design work not in code is in markdown in the same repo.”