文档更新：工作已开始

改进 Rails 文档是 Rails 基金会成立的核心目标之一，因此我们很高兴与大家分享有关此使命进展的更新。

得益于社区过去 20 年的自发贡献，Rails 文档已经处于一个非常出色的状态——可以说是技术领域最深入、最健全的文档之一。

我们基金会的使命是组建一个团队，对这项令人印象深刻的工作进行仔细审查。我们希望填补任何空白，检查内容是否仍然是最新的，并确保内容的书写风格一致、清晰且易于所有级别的开发人员理解——无论是经验丰富的 Rails 开发者，还是第一次学习 Rails（或 Web 开发）的新手。

团队已经组建，工作刚刚开始，以下是我们如何工作、下一步是什么以及您如何提供帮助。

团队

流程

第一步：审计 我们正在对整个 Rails 文档站点以及 Rails 仓库中标记为“docs”的开放 issue 进行全面审计，记录每个指南中缺失或可以改进的地方。
第二步：撰写与团队评审 当一个部分或指南审计完成后，将分配给一名撰稿人进行评审/编辑/撰写。作为团队，撰稿人还会相互评审彼此的工作，以确保每个指南或部分在进入下一步之前至少经过两双眼睛的审阅。
第三步：PR 与社区评审 一旦文档被完善并准备好接受社区意见，我们将在 GitHub 的 Rails 仓库中创建一个 PR，并在标题中标记“RF-DOCS”，并附上“rails foundation”标签。这些 PR 将开放一周，之后撰稿人将处理任何反馈，然后我们将合并 PR。

最后一步就是您，Rails 社区，参与进来的地方。

如何提供帮助

如果您有兴趣帮助改进文档，请留意标题为“RF-DOCS”并标记为“rails foundation”的 PR。如果您在特定组件或功能方面有经验，我们非常希望您能从技术角度审阅并评论这些 PR。

此外，如果您发现某个指南部分需要改进，请随时在 Rails 仓库中创建一个 issue 并标记为“docs”。我们将继续监控这些 issue，团队将在需要时介入。

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

绝对不。Rails 文档之所以成为如今这样出色的资源，得益于社区的贡献，因此本项目旨在与之协同工作，而不是干扰它。请继续贡献。

可能会发生变化

如果我们发现这种工作方式变得不切实际，或者妨碍了 Rails Core、Committers 和 Issues 团队专注于他们的工作，我们将保留更改这种工作方式的权利。

如果您对以上任何内容有任何疑问或反馈，请随时通过 foundation@rubyonrails.org 联系我们。

敬请期待：我们将很快分享更多关于即将推出的教程和指南 UX 设计的更新。