[Rd] how to document stuff most users don't want to see

Seth Falcon seth at userprimary.net
Wed Oct 7 05:40:01 CEST 2009


Writing good documentation is hard.  I can appreciate the desire to
find technological solutions that improve documentation.  However, the
benefit of a help system that allows for varying degrees of verbosity
is very likely to be overshadowed by the additional complexity imposed
on the help system.

Users would need to learn how to tune the help system.  Developers
would need to learn and follow the system of variable verbosity.  This
time would be better spent by developers simply improving the
documentation and by users by simply reading the improved
documentation.

My $0.02.

+ seth

-- 
Seth Falcon | @sfalcon | http://userprimary.net/user



More information about the R-devel mailing list