19 Oct
2009
19 Oct
'09
5:49 p.m.
On Mon, Oct 19, 2009 at 4:32 PM, Kyle Murphy
If they have to spend three hours trying to track down some obscure research paper that's referenced in your documentation a half dozen times in as many functions, you're not providing enough detail and assuming too great a knowledge of the domain.
Even just a paragraph or two giving some background information and example use cases would help immensely here; sometimes I just want to quickly assess whether a library might be useful for solving a particular problem, and "go read this paper" stops me cold.