Hacker Newsnew | past | comments | ask | show | jobs | submitlogin

What I personally hate in documentation is raw English. Give me a synopsis, a bunch of examples, a dump of typedefs, a tree/graph of connections between concept names. I can understand it immediately as long as you write it in latin script.

But if you only blah blah, blah blah blah blah <optionname> blah blah blah, blah blah, blah blah blah <value1> blah, blah blah blah blah blah blah <value3> blah blah <value1> blah blah, then screw your manual and you too.

Also, “documentation” in README.md and in markdown in general. The laziest form, especially unreadable on 4+ level headers which are indistinguishable from just text.



Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: