# Poll: what documentation method do you use? **URL:** \ **Category:** Ruby\ **Created:** [March 13, 2009, 1:38am UTC](https://www.ruby-forum.com/t/poll-what-documentation-method-do-you-use/162712 "2009-03-13T01:38:44Z")\ **Posts on this page:** 5\ **Page:** 1
**Author:** ![john\_maclean](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/j/e8c25b/32.png) [@john\_maclean](https://www.ruby-forum.com/u/john_maclean)\ **Post date:** [March 13, 2009, 1:38am UTC](https://www.ruby-forum.com/t/poll-what-documentation-method-do-you-use/162712/1 "2009-03-13T01:38:44Z")
- ri - source code - rbbr - the net/google - irc and ask - malining list and ask - none of the above – John M. 07739 171 531 MSc (DIC) Timezone: GMT ---
**Author:** ![john\_maclean](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/j/e8c25b/32.png) [@john\_maclean](https://www.ruby-forum.com/u/john_maclean)\ **Post date:** [March 13, 2009, 1:45am UTC](https://www.ruby-forum.com/t/poll-what-documentation-method-do-you-use/162712/2 "2009-03-13T01:45:09Z")
john maclean wrote: > - ri > - source code > - rbbr > - the net/google > - irc and ask > - malining list and ask > - none of the above - “The ruby sidebar” - which I guess falls under the net. - ri - google - more experienced co-worker # ======================================================================= This email, including any attachments, is only for the intended addressee. It is subject to copyright, is confidential and may be the subject of legal or other privilege, none of which is waived or lost by reason of this transmission. If the receiver is not the intended addressee, please accept our apologies, notify us by return, delete all copies and perform no other act on the email. Unfortunately, we cannot warrant that the email has not been altered or corrupted during transmission. ---
**Author:** ![john\_maclean](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/j/e8c25b/32.png) [@john\_maclean](https://www.ruby-forum.com/u/john_maclean)\ **Post date:** [March 13, 2009, 2:45am UTC](https://www.ruby-forum.com/t/poll-what-documentation-method-do-you-use/162712/3 "2009-03-13T02:45:57Z")
john maclean wrote: > - malining list and ask maligning the list? How could we?? (-: > - none of the above I wrote a QnD documenter called “ripdoc”, based on Ruby1.9 Ripper. That means it uses Ruby’s own parse tree to lex Ruby. Then I traverse this tree and emit HTML with CSS tags. Then, I documents the test cases. I move the exemplary ones to the top, put them into thematic order like an outline, and write comments all over them. This page contains the result: [http://assert2.rubyforge.org/](http://assert2.rubyforge.org/) ---
**Author:** ![john\_maclean](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/j/e8c25b/32.png) [@john\_maclean](https://www.ruby-forum.com/u/john_maclean)\ **Post date:** [March 14, 2009, 2:38am UTC](https://www.ruby-forum.com/t/poll-what-documentation-method-do-you-use/162712/4 "2009-03-14T02:38:47Z")
On Thu, Mar 12, 2009 at 7:36 PM, john maclean [removed\_email\_address@domain.invalid](mailto:removed_email_address@domain.invalid) wrote: > - source code > rarely > - rbbr > - the net/google > almost solely the rdoc available on ruby-doc, rarely google > - irc and ask > - malining list and ask > though uncategorized for me, I use the list for learning irb is your friend and after much experimentation is almost documentation 🙂 Todd ---
**Author:** ![john\_maclean](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/j/e8c25b/32.png) [@john\_maclean](https://www.ruby-forum.com/u/john_maclean)\ **Post date:** [March 29, 2009, 12:10am UTC](https://www.ruby-forum.com/t/poll-what-documentation-method-do-you-use/162712/5 "2009-03-29T00:10:46Z")
I used for a long time [ruby-doc.org](http://ruby-doc.org), but now that I discovered that irb can be tweaked with format=ansi --no-pager --interactive, I’ll be using it more often. If I have no idea where to look my method for, I sometimes use [railsbrain.com](http://railsbrain.com) or this mailing-list.