再见,文档团队

2020年3月27日 · Steve Klabnik 代表 核心团队

我开门见山地说:文档团队不再存在了。

早在 2016年8月,我们组建了一个团队来编写 Rust 的文档。以下是最初的描述和动机

Rust 文档团队将负责上面列出的所有事项。具体来说,它们将涉及 Rust 项目的以下领域

  • 标准库文档
  • 书籍和其他长篇文档
  • Cargo 的文档
  • 错误索引

此外,文档团队将以几种方式帮助生态系统文档。首先,以咨询的方式:帮助那些希望为其 crate 编写更好文档的人理解如何实现这一目标。此外,监控整个生态系统文档,并确定我们可以为所有 Rustaceans 做出贡献并产生重大影响的地方。如果 Rust 项目本身拥有出色的文档,但生态系统的文档很糟糕,那么人们仍然会对 Rust 的文档情况感到沮丧,尤其考虑到我们不包含电池的态度。需要明确的是,这并不意味着拥有生态系统文档的所有权,而是努力以不仅仅是 Rust 项目本身的方式做出贡献。

我们将在 #rust-docs IRC 房间中进行协调,并根据团队的需要定期举行会议。定期会议对于协调更广泛的目标非常重要;参与对于团队成员至关重要。我们每周举行会议。

当时,这一切都非常需要。当时没有那么多人从事 Rust 工作,文档也不多。

但是文档是一件有趣的事情。它实际上是一个跨领域的问题。一个团队为其他众多团队编写文档实际上在长期来看并不奏效。在短期内,这是一个绝对必要且好的策略。今天,它没有那么有意义了。让我们再次看看那些最初的资源

  • 标准库的文档几乎已经填写完毕,并且在添加新 API 时,libs 团队会编写一些初始文档。
  • 这本书由 Steve 和 Carol 维护。
  • Cargo 的文档是 Cargo 团队的责任(而文档团队实际上从未在这里提供帮助。我一直想帮忙,但多年以后,它就是没成功。)
  • 错误索引描述了编译器错误,因此这是编译器团队的工作。

我们还添加了更多内容

  • Rust by Example
  • rustc 书籍和 rustc 指南
  • 参考
  • The nomicon

名单还在不断增加。一直以来,团队的成员并没有真正增加;我曾多次尝试让人们参与进来,但大多数人就是不喜欢编写文档。目前,唯一真正编写文档的人是我,而且我最近也没有太多时间。因此,我们自 2018 年 8 月以来就没有举行过文档团队会议。现在也没有真正的文档 RFC。因此,这篇博文并不是真正宣布文档团队的结束,而是在描述今天已经存在的事实。

我仍然会继续我在核心方面的工作,以及书籍方面的工作。我计划在将来提交更多文档 PR。

我要感谢过去曾加入该团队的每个人,以及多年来提交文档 PR 的每个人。很多人真的很喜欢 Rust 的文档,如果没有你们所有人,这一切都不可能实现。