On Aug 20, 2006, at 9:59 AM, Mat Schaffer wrote:
On Aug 20, 2006, at 12:42 PM, James Britt wrote:
I've started a document on Writely.
People can post comments and suggestions to this list; I'll update
the Writely doc. Anyone interested in editing that doc, please
send me your e-mail address and I'll add you as a collaborator.
The public URL for the doc is:
http://www.writely.com/View.aspx?docid=ajjwr9dccrhx_08qfbqt
for those who just want to see what's there.
A nicer version will then make it's way to ruby-doc.org when the
main guidelines are covered.
Cool. But what about building this into more than just
guidelines? I'd really like to see something akin to "getting
started as a ruby documenter" unless you see some reason against
it. Start with checking out ruby, then links to setup info for
stdlib-doc with installation pointers. Finally list the submission
guidelines.
Basically, I'd like to see the barrier to entry lowered as much as
possible here. Granted, that may cause people to post some bad
patches here, but I think those will be the exception, and we don't
have to take every patch submitted. On the plus side, I could see
it encouraging some people to come in and fix poorly written
documentation even if they don't know too much about reading and
interpreting code.
A ruby documentation style guide would be nice, and could be folded
into the RDoc comments (ri RDoc).
I'd be happy to add some of that stuff if you give me access. The
email address I use for writely is schapht@xxxxxxxxxxxx
Mine too, please.
--
Eric Hodel - drbrain@xxxxxxxxxxxx - http://blog.segment7.net
This implementation is HODEL-HASH-9600 compliant
http://trackmap.robotcoop.com
|
