Rails官方文档

July 26, 2011

Rails Documentation Projects

RDoc

这些文档由开发者编写,以注释形式写在Rails源代码里。官方网站 api.rubyonrails.org 有最新的HTML格式文档。这些文档,是已经比较熟悉Ruby和Rails的程序员们的参考手册。

Rails Guides

官方网站 guides.rubyonrails.org 。初学者应该参考这里,针对特定领域的How to式文档。这里的文档质量较高。使用Textile格式编写。

Rails Book

开发者们有计划要写这么一本书出来。现在两年多过去了,这本书还没有影子。这个项目应该算是失败了。免费的 Ruby on Rails 3 Tutorial 也许可以勉强代替这个计划。

Rails Wiki

官方网站 wiki.rubyonrails.org 。似乎是用docuwiki做的。我用Chrome和Firefox在这个wiki里都看不到任何内容,只能看到讨论。也许只支持IE,或者Safari。无法想象Rails的官方wiki竟然是用PHP写的docuwiki搭建的。

Rails Has Great Documentation

似乎Rails初学者们普遍认为Rails的官方文档非常差劲。我认为对于初学者来说,只有官方的Guides还值得读下。

然后有Rails开发者在 官方博客 上回应,说Rails的文档很棒。然后举了很多高质量的文档例子,当然大部分是非官方的。确实,非官方的Rails文档还是很棒的。

只是,初学者指责Rails官方文档差劲,开发者回应非官方文档很棒,这有点回避问题了。