4 ms·
Agree with this analysis, when docs are written well, it's quite nice to read them through. They're succinct yet thoughtful. Most docs aren't like that though,
by waboremo 3y ago
Agree with this analysis, when docs are written well, it's quite nice to read them through. They're succinct yet thoughtful.
Most docs aren't like that though, they are either trying to do far too much (being a marketing page + docs + list of jargon + competitive analysis etc), or are so minimal they do as you say and are exclusively useful to those already very knowledgeable about it.
I think docs organizers should plan it as if they were writing a short linear novel to improve those glaring issues. It would go a very long way to improving general readability even if you don't read them that way. Easier said than done of course, but there's value the "cover to cover" mentality.