4 ms·
I always wondered if great tools like vim, nmap, git, etc. are successful because they have great documentation, or have great docs because they are successful.
by gbog 14y ago
I always wondered if great tools like vim, nmap, git, etc. are successful because they have great documentation, or have great docs because they are successful.
maybe the answer is in the middle and above, great tool makers are great docs writer.
- swah 14y agoIts amazing how most manpages are better written than the average paper from academia or product manuals.
- andreasvc 14y agoPapers from academia present new results in a specialist area. It's not surprising that they will be less readable and contain more jargon than a manpage. The latter is intended to show how to use something for the general computer user, not how it manages to do it. Furthermore manpages have the chance to undergo many revisions, papers generally do not.
- gbog 14y ago> It's not surprising Being "not surprised" seem to be the new meme on HN. Anyway, let me disagree: when you know how to write words in a sentence, you do it well under any circumstances. (I forgot its name but there is a story of this British poet whose one-sentence instruction sticker on how to handle the toilet flush was such a precise and cristalline piece of prose) So no, if academic papers are so poorly written now compared to manpages or academic papers centuries ago, it is because academic people are worse writers.