Ask HN: How do I write good documentation?

Re:Ask HN: How do I write good documentation? by Fizzadar on Monday October 06, 2014 @04:46AM (#8414865)

This, self-taught as well starting with PHP and their docs (with examples and user-added examples) are the best I've seen.

I've also noticed a lot more packages (npm mostly) with synopsis sections which essentially forms a 'full example', I find these immensely helpful.

[ Parent | on HN ]

Re:Ask HN: How do I write good documentation? by progx on Monday October 06, 2014 @05:37AM (#8414968)

Yes php-documentation is really beginner friendly because of the small examples and the comments.

One of the best documentations ive seen in the last time was from phalconPHP http://docs.phalconphp.com/en/latest/index.html

Well written and many comprehensible examples within in the doc.

I think, that writing a good documentaton is harder than programming.

[ Parent | on HN ]