Rustの日本語ドキュメントを作ろう

はじめに

こんにちは、KaiTomotakeです。
Rust言語の日本語コミュニティを運営しています。

最近、いいPCを安く手に入れることができて、個人的にかなりウキウキしています。
さて今回は、Rustの標準ライブラリ（std）のドキュメントを日本語で一から書き直すプロジェクトを立ち上げたので、その経緯と現状についてお話しします。

きっかけ

つい先日、rust-jpさんがまとめている日本語ドキュメントの一覧を眺めていたとき、あることに気づきました。

「stdクレートの日本語ドキュメント、ほとんどないじゃん……！」

正確には存在します。
std::vec と std::slice の2つだけは日本語ドキュメントがあります。ただし、更新は数年前で止まっています。

もちろん、std クレートのドキュメント量は膨大です。
1つのモジュールを翻訳するだけでも、かなりの労力が必要になることは想像に難くありません。

それでも、std クレートの日本語ドキュメントがほぼ存在しない現状は、ただでさえ「難しい言語」というイメージを持たれがちなRustにとって、新規参入者の大きな障壁になっていると感じました。

プロジェクトの難しさ以上に、新規参入者が減ってしまうことを防ぐほうが重要だと考え、今回のプロジェクトを始めることにしました。

実践

サイトジェネレーターの選定

プロジェクトを始めるにあたって、まずはひな型を作る必要があります。
そこで重要になるのが、サイトジェネレーターの選定です。

今回は、Rust公式が提供している mdBook を採用しました。

• Rustコードをドキュメント上で実行できる
• Rustコミュニティでは馴染みが深い
• 翻訳・レビューがしやすい

といった点が決め手です。

コントリビュートしやすさの工夫

次に、誰でも参加しやすいプロジェクトにするため、チュートリアルを兼ねるドキュメントを用意しました。

具体的には、std::vec モジュールのMarkdown内に、

• ドキュメント本文の書き方
• 表記ゆれを防ぐためのルール
• 翻訳時の注意点

などを、HTMLコメントとしてまとめています。

これにより、「何を書けばいいのか分からない」「ルールが分からなくて怖い」といった心理的ハードルを下げることを目指しました。

デプロイ

最後はデプロイです。

この部分は、私が運営している Rust Developers JP の管理者の方に手伝っていただきました。

• ドメインを取得
• GitHub Actions で自動ビルド
• Markdownが更新されると自動でサイトに反映

という仕組みを構築し、運用コストを極力下げています。

最後に

• site: https://rsdocsjp.org
• repository: https://github.com/Rust-Developers-JP/rsdocsjp

現在は、std::vec モジュールの一部のみしか整備されていません。
std クレート全体をカバーするには、まだまだ道のりは長いです。

このプロジェクトは、皆さんの協力があってこそ成り立ちます。
翻訳、レビュー、誤字脱字修正など、どんな形でも構いません。

興味を持っていただけた方は、ぜひご参加ください。
皆さんの参加を心よりお待ちしています！