Download Firefox: WindowsMac OS X
logo       
Google Custom Search
    AddThis Social Bookmark Button

Re: Ruby Docs with annotations and searching: msg#00024

Subject: Re: Ruby Docs with annotations and searching
Of course, if you want to go ahead with the web site, I've nothing
against that. I just don't think it'll be as productive a way to
generate documentation as actually writing documentation. If I'm wrong,
that's good too

I believe that both things can (and should) happen in parallel?

1. There needs to be a better system for viewing and searching the
rails and ruby docs and for simple annotating. Not everyone can or
will put in the effort to do the type of documentation that you
describe. I think Rannotate is a good solution (some agree and some
disagree :)
2. And yes, more real documentation needs to happen too.

People will add comments, I think the snippet sites are a great
example of this. Make it easy enough and you'll get a lot of
incredibly useful code samples.

http://www.bigbold.com/snippets/

--
Conor




<Prev in Thread] Current Thread [Next in Thread>