Rust 核心开发团队成员 Steve Klabnik 在博客宣布 Rust 文档团队已解散。
Steve 介绍到,早在2016年8月,他们成立了一个团队来负责 Rust 的文档工作。当时主要负责以下工作内容:
-
标准库文档
-
相关书籍和其他长篇文献
-
Cargo 文档
-
错误索引
此外,Rust 文档团队还会以不同的方式为 Rust 生态相关的文档编写提供帮助。首先是以顾问的身份帮助促成希望提供更好的文档的目标;其次是检查整个生态的文档,找到自己能输出贡献并可以为所有 Rust 开发者产生巨大影响的地方。
说白了,Rust 文档团队不仅仅是负责整个生态的文档,还要努力在更多的方面做出贡献,而不仅仅是 Rust 项目本身。
即便如此,此时所做的这些工作对 Rust 的发展都十分有必要,不过因为使用 Rust 的人不多,所以文档也没有太多。但问题在于,一个团队的人给其他众多团队的人写文档,长期来看无疑是行不通的,虽然在短期内这是一个绝对必要的好策略。
最原始的文档发展到现在已经演进成以下状态:
-
标准库文档已基本完成,当有新的 API 加入时,libs 团队会为它们编写最初版本的文档
-
书籍由 Steve 和 Carol 维护
-
Cargo 文档由 Cargo 团队负责
-
错误索引用于记录编译器错误,因此这是编译器团队的工作
除此之外,Rust 文档团队还添加了以下内容:
-
Rust 使用示例
-
rustc
图书和rustc
指南 -
参考手册
-
The Rustonomicon
列表的内容还在继续扩充,但一直以来 Rust 文档团队的成员并没有真正发展起来,Steve 也表示尝试过几次让大家参与进来,但大多数人都不喜欢写文档。所以这个阶段真正写文档的人只有 Steve 自己。不过 Steve 的时间有限,所以从2018年8月份开始,Rust 文档团队就再没有开过一次会议,最近也没有认真讨论过文档 RFC。
因此,Steve 觉得这篇文章并不是宣布 Rust 文档团队的结束,而是现在的情况就是如此。Steve 表示自己仍会继续文档方面的工作,以及维护他负责的书籍,还计划向 Rust 项目提交一些文档相关的 PR。
文章评论