随着近期 Rails Wiki 项目的重新振兴，我们看到人们询问 Rails 文档的各个部分如何相互配合。我想阐述 Rails Activists 看待所有内容如何在今后相互配合可能是有用的。

Rails 是一个大型成熟的框架，具有许多功能 – 并且随着 Merb 合并，未来将有更多内容需要学习。因此，它对各个层次的开发者在尝试理解如何有效地使用 Rails 时提出了挑战。有许多资源可以帮助学习过程，包括商业书籍和杂志、屏幕录制和播客、教程、博客条目和培训课程。但还有一系列正式的书面文档项目。

没有一刀切的文档。不同的开发者在学习 Rails 时会带来不同的技能集、背景和专业的成熟度等级。至少有四级官方文档，它们重叠，但满足不同的需求

• 内嵌文档，代码本身中的注释（你可以在任何 Rails 项目中通过运行 rake doc:rails 来查看）。
• Rails 指南
• Rails 书本（Rails 3.0 的新项目）
• Rails wiki

尽管乍一看时似乎有大量的重叠，但我们的感觉是这些项目中的每一个都占据一个独特（且有价值的）细分市场。

RDoc

• 针对语法问题提供即时帮助
• 由实际核心开发者来维护，而且通常是最新的

Rails 指南

• 针对于特定问题域提供集中的“如何”帮助
• 面向中级开发者，可能具有 Rails 经验
• 有大量现有的高质量素材
• 已经持续修订来跟踪 edge Rails 的更改
• 可以包括特定版本教程代码示例
• 可以作为核心 Rails 的一部分交付，为新开发者提供“触手可及的指导”

Rails 书本

• 提供高层架构指导和对各个部分如何相互配合的概述
• 深入钻研“Rails 方式”的理念，因此读者可以理解框架为何会那样运作
• 面向新接触 Rails 的开发者或那些希望从“树木”转到“森林”视图的开发者
• 提供在 Rails 3 的时间框架内对 Rails 进行概念化和在可选模块（ORM、路由 DSL 等）之间进行选择的帮助
• 可以在翻译的同时利用 Merb 体验，并吸收众多作者的贡献
• 很大程度上独立于版本
• 以指南不能的方式提供端到端文档的结构化路径

Rails Wiki

• 可以迅速响应新软件和新问题的社区驱动文档
• 指向外部信息的良好存储库
• 在底层软件中可能是 Rails 自身的一个展示
• 放置累积社区知识的地方，即使是那些通常不需要的部分

重要的是要注意，我们并不会将这四个项目视为完全独立、互不关联的努力。特别是，对于寻求更多细节的人来说，这本书似乎会链接到指南，而指南则会链接到这本书，以便那些寻求更多高级指导的人。我们还预计 Wiki 会将读者引向指南和这本书（以及其他信息来源）。

那么，您可以做些什么来参与呢？如果您是一位作家、翻译或编辑，那么任何这些文档项目都很乐意获得您的帮助

• 为 RDoc 做出贡献，编写一个带有良好注释的 Rails 补丁或签出 docrails 项目。
• 要帮助 Rails 指南，请与 Pratik Naik 或 Mike Gunderloy 联系，或访问 IRC freenode 上的 #docrails 频道。
• 要参与 Rails Book，请联系 Matt Aimonetti。
• 要添加到 Rails Wiki，请加入 rubyonrails-wiki 组。