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

Depth?

Like, three line basic how-to vs. one that shows how to (!) achieve something more complex, or not intuitively possible to perform with the tool being documented. Explanations that only tell you why you would not want to use the tool, sort of a laundry list of things that you can't or shouldn't be doing with it, and should be using something else, as opposed to a comprehensive look into how (or why) the tool works, and how it is better than competition, for example.

Not sure if that makes sense from a more systematic point of view, but it could easily help structure your documentation: "The Tutorial" and below it "list of additonal advanced and obscure mini-tutorials".

This is not to say anything about the length of each document, but naturally shallower ones could often be shorter.



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

Search: