|
| 1 | +--- |
| 2 | +layout: post |
| 3 | +title: "Goodbye, docs team" |
| 4 | +author: Steve Klabnik |
| 5 | +description: "The docs team is winding down" |
| 6 | +team: the core team <https://www.rust-lang.org/governance/teams/core> |
| 7 | +--- |
| 8 | + |
| 9 | +I'll cut right to the chase: the docs team no longer exists. |
| 10 | + |
| 11 | +Back in [August of 2016](https://github.com/rust-lang/rfcs/pull/1683), we |
| 12 | +formed a team to work on documenting Rust. Here's the original description |
| 13 | +and motivation: |
| 14 | + |
| 15 | +> The Rust documentation team will be responsible for all of the things |
| 16 | +> listed above. Specifically, they will pertain to these areas of the Rust |
| 17 | +> project: |
| 18 | +> |
| 19 | +> * The standard library documentation |
| 20 | +> * The book and other long-form docs |
| 21 | +> * Cargo's documentation |
| 22 | +> * The Error Index |
| 23 | +> |
| 24 | +> Furthermore, the documentation team will be available to help with |
| 25 | +> ecosystem documentation, in a few ways. Firstly, in an advisory capacity: |
| 26 | +> helping people who want better documentation for their crates to understand |
| 27 | +> how to accomplish that goal. Furthermore, monitoring the overall ecosystem |
| 28 | +> documentation, and identifying places where we could contribute and make a |
| 29 | +> large impact for all Rustaceans. If the Rust project itself has wonderful |
| 30 | +> docs, but the ecosystem has terrible docs, then people will still be |
| 31 | +> frustrated with Rust's documentation situation, especially given our |
| 32 | +> anti-batteries-included attitude. To be clear, this does not mean owning the |
| 33 | +> ecosystem docs, but rather working to contribute in more ways than just the |
| 34 | +> Rust project itself. |
| 35 | +> |
| 36 | +> We will coordinate in the #rust-docs IRC room, and have regular meetings, |
| 37 | +> as the team sees fit. Regular meetings will be important to coordinate |
| 38 | +> broader goals; and participation will be important for team members. We hold |
| 39 | +> meetings weekly. |
| 40 | +
|
| 41 | +At the time, all of this was sorely needed. There weren't as many people working |
| 42 | +on Rust, and there wasn't that much documentation. |
| 43 | + |
| 44 | +But documentation is a funny thing. It's really a cross-cutting concern. One |
| 45 | +team of folks writing docs for tons of other teams of folks doesn't really |
| 46 | +*work*, long-term. In the short term, it was an absolutely necessary and good |
| 47 | +strategy. Today, it doesn't make as much sense. Let's look again at those original |
| 48 | +resources: |
| 49 | + |
| 50 | +* The standard library's documentation is pretty much filled out, and when new APIs |
| 51 | + are added, the libs team writes some initial docs. |
| 52 | +* The book is maintained by Steve and Carol. |
| 53 | +* Cargo's documentation is the responsibility of the Cargo team (and the docs |
| 54 | + team never really helped here. I always wanted to, but years later, it just |
| 55 | + hasn't worked out.) |
| 56 | +* The error index describes compiler errors, and so that's the compiler team's |
| 57 | + job. |
| 58 | + |
| 59 | +We've also added way more stuff: |
| 60 | + |
| 61 | +* Rust by Example |
| 62 | +* The `rustc` book and `rustc` guide |
| 63 | +* The reference |
| 64 | +* The nomicon |
| 65 | + |
| 66 | +The list goes on and on. And all this time, the membership of the team didn't |
| 67 | +really grow; I tried several times to get folks involved, but most people |
| 68 | +just plain don't like writing docs. At this point, the only person really |
| 69 | +writing docs is me, and I haven't had a ton of time lately either. So we |
| 70 | +haven't had a docs team meeting since August of 2018. There also aren't |
| 71 | +really docs RFCs these days. As such, this blog post isn't really announcing |
| 72 | +the end of the docs team as much as it is describing what is already true |
| 73 | +today. |
| 74 | + |
| 75 | +I will still be doing my work on core, and the book. And I plan on submitting |
| 76 | +some more docs PRs in the future. |
| 77 | + |
| 78 | +I would like to thank everyone who's been on the team in the past, and |
| 79 | +everyone who's submitted documentation PRs over the years. A lot of people |
| 80 | +really love Rust's documentation, and that wouldn't have been possible |
| 81 | +without all of you. |
0 commit comments