To Ruby developers: Feeble documentation - weakness of Ruby and the Ruby on Rails

Directly I apologize for my English - I used the automatic translator.
If there is a possibility,
find the person, knowing Russian better, it will translate you correctly
the text.

Address to developers of Ruby and Ruby on Rails:

Hi

It would be desirable to express the subjective judgement on a problem
of popularity of Ruby
and the Ruby on Rails in particular. It is very beautiful and laconic
language, very powerful language.
I studied it according to the book, it was necessary to read 2 times up
to the end to understand all
details. And I not for nothing spent the time. It is very powerful tool
for development. The same it
is possible to tell and about the Ruby on Rails. Agree that it not the
simplest systems that here so
from the first everything to understand. I am the professional
programmer with more than
20-year experience, studied many systems and programming languages -
Pascal, C, C ++, Java, Prolog,
Delphi, PHP, developed different systems. Don’t think that I am a school
student any. Knowing all this
languages, I after all delighted with Ruby!

And here, by the way, about PHP. I learned it an experimental way, with
site use www.php.net. Here in
than all charm of this site - there is ALL and directly! There is as the
language syntax description,
and the description of all functions in case of what if it is function,
that is links to the similar
functions accompanying. Everything is easy and simple - the person
gradually learns more and more,
plunges into this environment more and more development. Any puzzles and
guesses. For me the study of
PHP was simple and fast.

And so I have a question. Why, possessing so powerful possibilities,
Ruby
and Ruby on Rails still
possess such feeble documentation? After all this most important
in popularity of ANY system -
existence of GOOD documentation when to the person always is where to
address for the sparvochny
information instead of to build own guesses, not to rummage in source
codes. To rummage in source
codes is programming for the sake of programming, and after all people
simply want to use the tool.
To receive quickly necessary information on system is already a success
half, in my judgement. Not enough
description of functions, is necessary still that the person could see
similar functions that could
follow as on a chain. You look on documentation on the same www.php.net
also look at Ruby and
Ruby on Rails documentation. In yours documentation
(http://www.ruby-doc.org/core-1.9.3/), for
example, I couldn’t find the description of method_missing, but in other
source (http://apidock.com/)
it is. Unless it is impossible to create a normal site with
documentation where there would be all
and directly? Why the person shall guess, rummage about something in
source codes? About Ruby on Rails
documentation (http://api.rubyonrails.org/) I generally am silent -
there is no description many
methods if there is a description, not clearly what it can accept
parameters and that they mean,
there is no description of classes, their correlations.

You developed such fine system, a magnificent programming language,
excellent framework, so why you
can’t develop normal, distinct documentation? In it popularity of PHP
and weakness of Ruby, only in it.
There would be same good documentation, then long ago Ruby would walk
ahead Planet (Earth) at all -
(“To be number one”). It seems to me davny already it is time to supply
design team with design team
DOCUMENTATION. After all the maturity of any product is characterized
just by convenient and extensive
documentation, including.

I think that many are stopped just by this moment in study when people
face that simply can’t move
easily further in study and use of these systems - Ruby and the Ruby on
Rails.

And once again thanks for so excellent tools!

Yours faithfully, Sergey

===

Обращение к разработчикам Ruby и Ruby on Rails:

Здравствуйте

Хочется высказать свое субъективное мнение на проблему популярности Ruby
и Ruby on Rails в частности.
Это очень красивый и лаконичный язык, очень мощный язык. Я его изучил по
книге, пришлось прочитать
2 раза, чтобы до конца уяснить все детали. И я не зря потратил свое
время. Это очень мощный инструмент
для разработки. То же самое можно сказать и про Ruby on Rails.
Согласитесь, что это не самые простые
системы, чтобы вот так с первого раза все понять. Я профессиональный
программист с более чем
20-летним опытом работы, изучил немало систем и языков программирования

  • Pascal, C, C++, Java, Prolog,
    Delphi, PHP, разрабатывал различные системы. Не думайте, что я школьник
    какой-нибудь. Зная все эти
    языки, я все-таки в восторге от Ruby!

И вот, кстати, о PHP. Его я выучил экспериментальным путем, с
использованием сайта www.php.net. Вот в
чем вся прелесть этого сайта - там есть ВСЕ и сразу! Там есть как
описание синтаксиса языка, так и
описание всех функций, при чем если это функция, то есть ссылки на
похожие функции, сопутствующие.
Все легко и просто - человек постепенно все больше и больше узнает, все
больше погружается в эту среду
разработки. Никаких головоломок и догадок. Для меня изучение PHP было
простым и быстрым.

Так вот у меня вопрос. Почему, обладая столь мощными возможностями, Ruby
и Ruby on Rails до сих пор
обладают такой слабой документацией? Ведь это самое главное в
популярности ЛЮБОЙ системы -
наличие ХОРОШЕЙ документации, когда человеку всегда есть куда обратиться
за спарвочной
информацией, а не строить собственные догадки, не рыться в исходниках.
Рыться в исходниках - это
программирование ради программирования, а ведь люди просто хотят
использовать инструмент. Получить
быстро нужную информацию о системе - это уже половина успеха, я считаю.
Мало описания функций, надо
еще чтобы человек мог видеть похожие функции, чтобы мог следовать как по
цепочке. Вы посмотрите
на документацию на том же www.php.net и посмотрите на документацию Ruby
и Ruby on Rails. В вашей
документации (http://www.ruby-doc.org/core-1.9.3/), например, я не смог
найти описание method_missing,
зато в другом источнике (http://apidock.com/) оно есть. Разве нельзя
создать нормальный сайт с
документацией, где было бы все и сразу? Почему человек должен о чем-то
догадываться, рыться в
исходниках? Про документацию Ruby on Rails (http://api.rubyonrails.org/)
я вообще молчу - нет описания
многих методов, если есть описание, то не понятно какие он может
принимать параметры и что они
означают, нет описания классов, их взаимосвязей.

Вы разработали такую прекрасную систему, великолепный язык
программирования, превосходный
фреймворк, так почему вы не можете разработать нормальную, внятную
документацию? В этом
популярность PHP и слабость Ruby, только в этом. Была бы такая же
хорошая документация, тогда давно
бы Ruby шагал впереди планеты всей. Мне кажется давное уже пора снабдить
команду разработчиков
командой разработчиков ДОКУМЕНТАЦИИ. Ведь зрелость любого продукта
характеризуется как раз
удобной и обширной документацией, в том числе.

Я думаю, что многих останавливает как раз этот момент в изучении, когда
люди сталкиваются с тем, что
просто не могут легко двигаться дальше в изучении и использовании этих
систем - Ruby и Ruby on Rails.

И еще раз спасибо за столь превосходные инструменты!

С Уважением, Сергей