Hacker News new | ask | show | jobs
by muzani 1463 days ago
I've been working on documentation a lot. Nobody seems to want to do it, yet everyone seems to want more.

Everyone can write docs fine, just the way everyone can write code fine. But good docs are a lot of work. The ones that people understand at a glance, instead of having to crawl around. This is something that Google and Oracle can't do, so I don't expect it to be easy.

Also just writing better code. Declarative programming is very easy to read and modify, but can be difficult to think in that way if you're not used to it.

1 comments

Thanks for this wonderful suggestion! I would love to know your thoughts about techniques for enabling a "documentation-centric" culture as well as how to write good documentation. I have realized over the years that it is definitely something that makes or breaks functioning teams. When people want to transition from one team to the other to break some monotony in their work, its great to have documentation that helps a new person onboard. Solves a lot of issues!