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

Oh hey I really love writing great docs, of course not always I have the opportunity to do so, but could you point me to one you consider great? Can be anything, no need to be some modern live docs. I want to see what is in the past that was so great but we lost, maybe I can incorporate some of it.


I don't have any.

I remember that book explain the command, what the purpose of the command was, the typical scenario for why you would need such command.

It explained the options. No silly explanation like "-sort" sorts the output.

It explained the return values also in detail.

Explained the errors also in detail and what might cause the error.

Most functions today are "explained" by reordering the words in the function name: "canUpdate()" returns true if $x can update.




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

Search: