改善 Rails 文档是 Rails 基金会成立的核心支柱之一，因此我们很高兴分享该使命的进展情况。

由于过去 20 年来来自社区的有机贡献，Rails 文档已处于令人惊叹的位置——可以说，这是技术领域中最深入、最可靠的文档集之一。

我们在基金会中的使命是组建一支团队，用细致入微的眼光检查这份令人印象深刻的工作。我们想要填补任何缺口，检查内容是否仍是最新的，并确保写作风格一致、清晰易懂，让从经验丰富的 Rails 开发人员到第一次学习 Rails（或 Web 开发）的新开发人员都能理解。

该团队已经组建，工作刚刚开始，因此我们将介绍我们的工作方式、下一步计划以及你可以如何提供帮助。

团队

• 卡洛斯·安东尼奥·达席尔瓦
• 里德瓦娜·汗
• 布米·沙阿

流程

• 步骤 1：审计 我们对整个 Rails 文档站点及在 Rails 仓库中标记为 ‘文档’ 的公开问题进行了详尽的审计，记下每个指南中缺少的内容或可以改进的内容。
• 步骤 2：撰写和团队审查 对某个部分或指南进行审计后，将分配给作者进行审查/编辑/撰写。作为团队的一员，作者还将相互审查对方的工作，以便在进入下一步之前，每个指南或部分至少有两双眼睛看过。
• 步骤 3：PR 和社区审查 完成对某个文档部分的修改并准备好征求社区意见后，我们在 GitHub 上的 Rails 仓库中创建一个 PR，在标题中标记为 RF-DOCS 和 rails foundation 标签。这些 PR 将保持开放状态一周，之后，作者将处理所有反馈，我们将合并该 PR。

最后一步是 Rails 社区发挥作用的地方。

如何提供帮助

如果你有兴趣帮助改进文档，请留意命名为 RF-DOCS 并标记为 rails foundation 的 PR。如果你有使用特定组件或功能的经验，我们很乐意你从技术角度审查并评论该 PR。

此外，如果你发现指南中需要修改的部分，可以随时在 Rails 仓库中公开问题并标记为 ‘文档’。我们将继续监控这些问题，团队将根据需要介入。

‘我偶尔为文档提供 PR 贡献。我应该停止吗？’ ‘我有一个关于文档更新的开放 PR。我应该关闭它吗？’

绝对不会。Rail 文档之所以能达到今天的水平，要归功于这类的社区贡献，因此这一项目旨在与该文档并驾齐驱，而不是打断它的进程。请继续做出贡献。

情况可能会发生改变

如果这种工作方式变得难以控制，或者如果它阻碍了核心 Rails、贡献者和问题团队的工作重点，我们保留改变这种工作方式的权利。

如果您对上述任何内容有任何疑问或反馈，请随时联系 [email protected]。

敬请期待：我们很快就会针对即将推出的教程和指南的用户体验设计分享更多更新。