Rustへ貢献する — ドキュメント

ドキュメントの質も量もこれで十分ということは決してありません。 Rustのドキュメントを様々な側面から改善するのに深い知識は必要としません。 逆にドキュメントを執筆したりレビューしたり編集したりするのはRustを学ぶ良い手段です。 さらにドキュメントの改善点はすぐに見付かりますし、いくらでもあります。 何か書いてあることに不満がありますか？ドキュメントに書いていない情報を見付けましたか？あなたのプルリクエストをお待ちしています。

あなたの書ける最も価値のあるドキュメントは Rustのエコシステムを形成するクレートのドキュメントです。 ソースツリー内にあるドキュメントは比較的カバー率は高いですが日々Rustプログラマが使っている多数の有名なクレートやツールのドキュメントはそうでもありません。 人気のRustプロジェクトへAPIドキュメントを書いてあげるとメンテナから親愛の情を得られるでしょう。

プログラミング言語RustはRustの主要なドキュメントでRustのメインレポジトリでメンテナンスされています。 独自のA-bookラベルを持っていて、継続的に改善されています。 メインレポジトリにある他のドキュメントにはRustリファレンス、標準ライブラリAPIドキュメント、Rustonomicon（unsafeを正しく使うためのガイド）があります。 Rustスタイルガイドラインはまだ未完成で、表立ってはリンクが張られていません。 意欲的なコントリビュータはここを狙うとよい成果が得られるでしょう。 エラーインデックスはコンパイラによって生成されたエラーの詳解を提供します。 新たなエラーが追加されたらこのドキュメントもメンテナンスされないといけませんし、インデックスに反映されていないエラーが常に追加されていきます。 ほとんどのソースツリー内のドキュメントはsrc/docディレクトリにあります。イシュートラッカー上では全てA-docsラベルで管理されています。 最後に、このドキュメントと他のWebのページはRustのWebサイトのGitレポジトリで管理されています。 コントリビュートするには編集してプルリクエストを投げさえすれば大丈夫です。

Rustの重要なドキュメントのうち、かなりの量がメインレポジトリになかったり、Rustプロジェクトによって管理されていなかったりしますが、それでもこれらはRustの成功にとって非常に重要です。 アクティブに開発されていてコントリビュータを必要としているRustの素晴しいドキュメントの例として、Rust By Example、Rust Design Patternsそしてrust-rosettaなどがあります。 貢献すべき他の既存のドキュメントプロジェクトについてはrust-learningを参照して下さい。

他のRustのドキュメンターに#rust-docsで会いましょう。