6 ms·
I feel like ranting here, but I'll keep it short. Documentation is a task that is never trivial, but it can be made bloody hard, or not, if you optimise for th
by Arnt 6y ago
I feel like ranting here, but I'll keep it short.
Documentation is a task that is never trivial, but it can be made bloody hard, or not, if you optimise for that. If you ignore documentation as a priority you're optimising for everything else, which implicitly breaks documentation.
But it doesn't have to be impossible, if the trivial aspects as designed to be minimal and the impact on documentation is allowed to dominate other impacts.
https://rant.gulbrandsen.priv.no/udoc/trolltech-documentation-process https://rant.gulbrandsen.priv.no/udoc/trolltech-documentatio... is relevant, even if most documentation isn't developer documentation. (It's about the Qt developer documentation, which IMO is/was the best developer documentation ever written and maintained by a small team, and no big team has ever done much better either. The hard thinking and work on that was mine.)
The key is that if documentation has such a low status that any other consideration can override it, the result will suck. And if documentation has such a low status that the writing tools suck, so will the result.