天天看點

誰 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 文檔團隊解散了?!