3 ms·
Extracting the criteria about how to write good documentation out of this article is ... wait, this article about good documentation is itself bad documentation
by AtlasBarfed 4y ago
Extracting the criteria about how to write good documentation out of this article is ... wait, this article about good documentation is itself bad documentation. Is that real irony?
Listicles are pilloried, but for things like this they are good practice.
I'm really disappointed in most documentation recommendations. I'll have to check out DO's docs. It would be nice to have a comparison criteria to help show what different techniques and structures work well.
Unaddressed is one of the greatest long-term issues, I have to deal with it all the time in cassandra and other fast-evolving platforms: versioning documentation for the specific platform, and SEO'ing it so newer documentation subsumes older docs in the search indices.