点击上方蓝字关注我们
理清头脑混沌,觉醒心智天地
在上周,有篇 “神文” 在 Rust 社区传播着,标题上写着:「Rust 文档团队解散了」。我一看,就知道又是国内某些技术媒体故意断章取义,睁眼说瞎话了。
Mar. 27, 2020 · Steve Klabnik on behalf of the core team
2020年3月27。Steve Klabnik 代表核心团队
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,在开发者语境下则表示:「它已自备全套工具,不用再自己折腾各种库了」。
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.
错误索引描述了编译器错误,所以这是编译器团队的工作。
Rust by Example,
《通过例子学 Rust》
The rustc
book and rustc
guide
《Rust 编译器 rustc 之书》和 《rustc 导读》(译注,现在应该是改成了 Rustc 开发导读, rustc-dev-guide)
The reference
Rust 参考
The nomicon
《Rust 秘典》
我要感谢过去在这个团队中的每一个人,也要感谢多年来提交了文档 PR 的每一个人。这些年,如果没有你们,根本不会有现在这么多人喜欢 Rust 的文档。