On Thu, Mar 27, 2014 at 11:48:21PM -0400, Frank Z wrote:
> Just looking at Node.js' documentation feels like looking at a dictionary.
> If I used this as my sole guide for making a node.js app, I'd probably
> never even think to use a package.json file, ever... (and what's the point
> if I'm not submitting my app to NPM?).

I think you're right, actually. I saw how this developed, and so it makes sense
to me, but from that perspective, the very API-reference style documentation
leaves a lot to be desired.

Maybe if I get time I'll see if I can write something. Pull requests are
accepted, too -- if you've ideas of what documentation you want to see, I'd be
happy to help shepherd some things.

That said, node's documentation shies away from prescriptivism: It will tell
you what you can do, but not what you should do, since that's a lot more
nebulous and people don't agree on that.

What sort of documentation would you love to see? What's hard as a new user,
and what's obvious?

Aria

Attachment: pgptQBgh0xZ3X.pgp
Description: PGP signature

Reply via email to