From: Jari Williamsson Date: 2007-11-27T17:04:18+09:00 Subject: So, here's a challenge! (was: Re: "Why I Program In Ruby (And Maybe Why You Shouldn't)") Trollen Lord wrote: > Still. The whole pile of "documentation" is like that. Unfriendly > and plain useless. I agree with lots of what you said, and I think much of it can be because many might think of Ruby as a way to cut corners? Why are there so few projects on Rubyforge that leave their alpha/beta stages to Production/Stable? Why are there so few libs with really good documentation? Why is there not even good documentation on how to create a Gem or maintaining it with Hoe? Why are there so few documentation packages that use anything other than the old frame-based default template? And so on. Anyway: Is there a utility that analyzes the data that RDoc is processing for documentation (or analyze the result)? It should scan for methods with missing documentation, methods with missing examples, count cross-references, etc, etc. If not, this is the challenge: to create such a utility! Developers should get help to spot weak documentation and it should be possible to rate one's documentation and be able to say things like "Documentation gets a 97% quality rating by " Best regards, Jari Williamsson