2011年6月2日,星期四

来自文档战线的消息

由 fxn 发布

新的配置指南

Rails 3.1 将会附带一本由 Ryan Bigg (@ryanbigg) 撰写的关于配置 Rails 应用程序的全新全面指南。目前的草稿已可在 edge guides 中找到。

Rails 文档团队

文档团队,该团队大约在三年前成立,由 Pratik Naik (@lifo)、Mike Gunderloy (@MikeG1) 和我组成,在启动 docrails 方面发挥了关键作用。还有许多 API 贡献者和指南作者。向 Pratik 和 Mike 致敬,他们的努力非常出色,为项目的这一方面给予了决定性的推动。

经过这么多年的努力,文档维护已在 master 中定期进行。因此,我们不再设立独立的文档团队。就像我们没有独立的测试团队一样。测试和文档是 Ruby on Rails 的有机组成部分,完整的补丁应该或应当有适当的测试和文档覆盖。

Rails 指南审阅者

审阅指南需要特殊的技能和奉献精神,这需要有自己的标准和节奏。将有一个指南审阅团队负责处理新内容。我很高兴地宣布,Vijay Dev (@vijay_dev) 将成为该团队的第一位成员。Vijay 近几个月在 docrails 上做了出色的工作。欢迎加入! :)

下一步

Rails 文档在过去几年里有了很大的改进,内容更多,编辑质量也更好。但仍有很多工作要做。以下是一些可以着手的工作想法:

  • 一个新的文档生成器,它会评估源码树并进行内省,生成 API,并结合解析器提取文档片段。

  • API 中的方法有一个切换可见性的链接,可以显示其源代码。如果有一个可以显示其测试的切换器,那岂不是太棒了?

  • 指南的测试覆盖率。

  • 一个华丽的模板设计怎么样?

如果您想对其中任何一个进行开发,请尽管去做!