谁 TM 说 Rust 文档团队解散了?!

点击上方蓝字关注我们

理清头脑混沌,觉醒心智天地

在上周,有篇 “神文” 在 Rust 社区传播着,标题上写着:「Rust 文档团队解散了」。我一看,就知道又是国内某些技术媒体故意断章取义,睁眼说瞎话了。

谁 TM 说 Rust 文档团队解散了?!

看看,各位看看,这就是国内大名鼎鼎的知名技术媒体!呵呵。盗版横行也就罢了,还在这故意歪曲事实,实名鄙视这家媒体!!!也许继续割韭菜和传播盗版文件更适合你们!
我也不想多说什么,把原文翻译一遍,大家来看看吧!

正文

Goodbye, docs team 再会,文档团队

Mar. 27, 2020 · Steve Klabnik on behalf of the core team

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

I'll cut right to the chase: the docs team no longer exists.我就开门见山吧:文档团队已经名存实亡。Back in August of 2016, we formed a team to work on documenting Rust. Here's the original description and motivation:2016 年 8 月,我们成立了一个团队为 Rust 提供文档。以下是原始的描述和动机(节选):

The Rust documentation team will be responsible for all of the things listed above. Specifically, they will pertain to these areas of the Rust project:

  • The standard library documentation

  • The book and other long-form docs

  • Cargo's documentation

  • The Error Index

Furthermore, the documentation team will be available to help with ecosystem documentation, in a few ways. Firstly, in an advisory capacity: helping people who want better documentation for their crates to understand how to accomplish that goal. Furthermore, monitoring the overall ecosystem documentation, and identifying places where we could contribute and make a large impact for all Rustaceans. If the Rust project itself has wonderful docs, but the ecosystem has terrible docs, then people will still be frustrated with Rust's documentation situation, especially given our anti-batteries-included attitude. To be clear, this does not mean owning the ecosystem docs, but rather working to contribute in more ways than just the Rust project itself.

We will coordinate in the #rust-docs IRC room, and have regular meetings, as the team sees fit. Regular meetings will be important to coordinate broader goals; and participation will be important for team members. We hold meetings weekly.

Rust 文档团队将负责上面列出的所有事情。具体来说,是与 Rust 项目的以下领域相关:

  • 标准库文档

  • The Book (TRPL,The Rust Programming Language)和其他的长篇文档

  • Cargo 文档

  • Error 索引文档

此外,文档编制团队将以几种方式提供有关生态系统文档编制的帮助。 首先,以咨询顾问的身份:帮助希望为自己的 crate 提供更好文档的人们了解如何实现该目标。 此外,监测整个生态系统的文档,并确定可以为所有的 Rustaceans (Rust 开发者们) 做出贡献和产生重大影响的地方。

如果 Rust 项目本身具有出色的文档,但是生态系统具有糟糕的文档,那么人们仍然会对 Rust 的文档状况感到沮丧,尤其是考虑到我们对「 anti-batteries-included 」的态度。需要明确的是,这并不意味着拥有生态系统文档,而是要致力于以更多方式做出贡献,而不仅仅是 Rust 项目本身。
我们将在 #rust-docs IRC 会议室进行协调,并在团队认为合适的情况下举行例行会议。定期会议对于协调更广泛的目标很重要;参与对于团队成员而言很重要。我们每周都会开会。

译注: anti-batteries-included ,代表 「反-batteries-included」,而 batteries-included,在开发者语境下则表示:「它已自备全套工具,不用再自己折腾各种库了」。

At the time, all of this was sorely needed. There weren't as many people working on Rust, and there wasn't that much documentation.当时,所有这些都是迫切需要的。当时,没有那么多人从事 Rust 方面的工作,也没有那么多的文档。But documentation is a funny thing. It's really a cross-cutting concern. One team of folks writing docs for tons of other teams of folks doesn't really work, long-term. In the short term, it was an absolutely necessary and good strategy. Today, it doesn't make as much sense. Let's look again at those original resources:但文档是一件有趣的事情。它是一个跨团队的问题。一个团队为其他团队写文档并不能长期有效。从短期来看,这是一个绝对必要的好策略。如今,这已经没有多大意义了。让我们再看看那些原始资源 :

  • The standard library's documentation is pretty much filled out, and when new APIs are added, the libs team writes some initial docs.

标准库的文档已经基本填满了,当添加了新的 api 时,libs 团队会编写一些初始文档。

  • The book is maintained by Steve and Carol.

The Book (TRPL,The Rust Programming Language)由 Steve 和 Carol 来维护。

  • Cargo's documentation is the responsibility of the Cargo team (and the docs team never really helped here. I always wanted to, but years later, it just hasn't worked out.)

Cargo 的文档是由 Cargo 团队负责的 (而 docs 团队在这方面从未提供过帮助)。我一直想这么做,但多年后,还是没未达成这个愿望。)

  • The error index describes compiler errors, and so that's the compiler team's job.

错误索引描述了编译器错误,所以这是编译器团队的工作。

We've also added way more stuff:我们还添加了更多的材料:

  • Rust by Example,

《通过例子学 Rust》

  • The rustc book and rustc guide

《Rust 编译器 rustc 之书》和 《rustc 导读》(译注,现在应该是改成了 Rustc 开发导读, rustc-dev-guide)

  • The reference

Rust 参考

  • The nomicon

《Rust 秘典》

The list goes on and on. And all this time, the membership of the team didn't really grow; I tried several times to get folks involved, but most people just plain don't like writing docs. At this point, the only person really writing docs is me, and I haven't had a ton of time lately either. So we haven't had a docs team meeting since August of 2018. There also aren't really docs RFCs these days. As such, this blog post isn't really announcing the end of the docs team as much as it is describing what is already true today.这个清单不胜枚举。一直以来,团队成员并没有真正增长。我尝试了几次让人们参与其中,但是大多数人只是不喜欢写文档。在这一点上,唯一真正写文档的人是我,最近我也没有很多时间。因此,自 2018 年 8 月以来,我们还没有召开过文档团队会议。这些天也没有真正的 RFC 文档。 因此,此博客文章并没有真正宣布文档团队的结束,而只是描述了今天已经存在的事实。I will still be doing my work on core, and the book. And I plan on submitting some more docs PRs in the future. 我将继续做我在核心团队的工作,以及维护 The Book。我计划在未来提交更多的文档 PR (Pull Request)。I would like to thank everyone who's been on the team in the past, and everyone who's submitted documentation PRs over the years. A lot of people really love Rust's documentation, and that wouldn't have been possible without all of you.

我要感谢过去在这个团队中的每一个人,也要感谢多年来提交了文档 PR 的每一个人。这些年,如果没有你们,根本不会有现在这么多人喜欢 Rust 的文档。

结语

我觉得,只要是有基本的阅读能力的人,看完上面的全文,根本不会得出那家无良技术媒体的结论。通过 Rust 官网,完全可以看到 Rust 团队详尽的文档,这是其他语言完全比不上的。因为 Rust 社区就是 Rust 语言的一部分。

谁 TM 说 Rust 文档团队解散了?!

谁 TM 说 Rust 文档团队解散了?!

感谢阅读。点击阅读原文,可查看 Steve 的博客原文。

来源链接:mp.weixin.qq.com