undefined | Better HN

0 pointshiphipjorge8y ago0 comments

Maybe documentation should include uses cases? Newer users to npm + node might think this does something different. Just a suggestions.

0 comments

3 comments · 1 top-level

BigJono8y ago· 2 in thread

Maybe documentation for everything should contain use cases, first, before anything.

Every Javascript tool has documentation the wrong way round. Quick start guides and installation instructions are useless if you don't even have a good reason to use the tool in the first place.

always_good8y ago

Dunno, if you need to be convinced to use a tool, then maybe you aren't yet in the market for said tool. I think it's a cherry on top to describe use-cases but not so critical that there's some sort of ecosystem problem that you describe.

BigJono8y ago

The purpose is to un-convince people from using it. Way too often people have already made up their mind by the time they reach the docs, based purely on how popular the tool is, how flashy the front page is, or whatever bad advice they've received from someone who feels the need to justify their library of choice.

1 more reply

j / k navigate · click thread line to collapse