Ruby on Rails

On 26 April 2012 16:26, Peter Hickman <peterhickman386@googlemail.com> wrote:
> On 26 April 2012 15:04, Scott Ribe <scott_ribe@elevated-dev.com> wrote:
>> Also, telling people who are trying to learn Rails and being blocked by incomplete docs to write the docs themselves is really kind of silly ;-)
>
> No this is the best thing to do. When you are experienced you tend to
> forget what you need to know and the entry will be terse and assume so
> many things. When a beginner documents something it will be just what
> another beginner will need, down to the "obvious" things that
> experienced programmers take for granted and assumes that everyone
> knows.
>
> Remember that an experienced programmer will probably skip the
> documentation and go straight for the source code, so as long as the
> source code exists then the documentation in perfect as far as an
> experienced programmer in concerned.
>
> What constitues good documentation depends on your needs. The OP is a
> beginner and therefore wants beginners documentation, as such the
> documentation written by another beginner would be ideal.

+1, I myself added some clarification to (if I remember correctly) the
date_select helper docs when I was only a short distance into the
learning curve. I had a problem using the method and was helped out
here, at which point I improved the docs so that, hopefully, no-one
would have the same problem that I did.

Colin

--
You received this message because you are subscribed to the Google Groups "Ruby on Rails: Talk" group.
To post to this group, send email to rubyonrails-talk@googlegroups.com.
To unsubscribe from this group, send email to rubyonrails-talk+unsubscribe@googlegroups.com.
For more options, visit this group at http://groups.google.com/group/rubyonrails-talk?hl=en.