Rails Plugin Documentations

As computer scientist I am working since 20 years now and since 2 years I have a lot of fun programming in Ruby or better in JRuby.

At the moment I am working on my first bigger Ruby on Rails project and have to state something which I wouldn’t perhaps have agreed with in my earlier years too:

Code (even well documented) is no substitute for good documentation!

I would like to address this specially into the direction of some developers who are writing really great plugins for RoR. A little bit more documentation about the basic ideas would lower the threshold for Rails newbies like me a lot. Naturally I am able to figure out how a plugin really works without documentation and I am sure that I can learn a lot from this experience. But eventually I will end up writing my plugins myself because that makes me faster then figuring out how something works which another programmer has developed.

So please keep in mind: Writing code in a computer language which is easier to understand and comes more natural does not subsitute for a good documentation!

This entry was posted in All, JRuby and tagged , . Bookmark the permalink.

Leave a Reply

Your email address will not be published.