まずは自己紹介
こんにちは。KaiTomotakeと申します。
普段はRust Developers JPというRust言語のコミュニティを運営しております。
RustとPythonを主に使っており、最近はJSやZigも勉強中です。
リファレンス・ドキュメント制作とは
この記事におけるリファレンス・ドキュメント制作とは、言語やライブラリのドキュメントを日本語に翻訳したり、コードを読んで得た理解を書いたりすることです。
リファレンス・ドキュメント制作の良い点
本題に入りましょう。
リファレンス・ドキュメント制作は非常に素晴らしい活動です。その良い点も本当にたくさんあるのですが、とりあえず重要な部分だけを書いてきます。
１．英語のリファレンスやドキュメントを翻訳することにより、英語力が身につく
昨今はグローバル社会と呼ばれ、国際的に通じる力を身につけることが非常に重要になってきています。また、プログラミングを行うにあたって、ライブラリや言語仕様の理解にはどうしても英語のドキュメントを読まなければならぬこともあるでしょう。
そんなとき、英語力を持っているかいないかの差は非常に絶大です。
英語のリファレンスやドキュメントを翻訳することにより、通常の英語力とプログラミング関係の専門的な英語力が身につきます。
２．実際の内部のコードを読んで理解することにより、コードリーディング力が身につく
リファレンスやドキュメントを書くためには、時には内部のコードを読んで理解しなければならぬことがあるでしょう。例えば標準ライブラリのリファレンスを書くときには、内部のコードを読むことは推奨です。
しかし、内部のコードというものは膨大です。普通は一朝一夕で読めるものではありません。
だからこそ、重要な部分を的確に見抜いてそこを素早く読む、コードリーディング力が身につくと私は考えます。
３．言語特有の思想やスタイルが理解できるようになる
正直、これがもっとも大切なポイントです。
標準ライブラリのコードは、通常その言語の思想やスタイルに沿っています。
Pythonの標準ライブラリが良い例でしょう。
多くの人はPythonにジェネリクスがあることを知りません。しかし、内部的には可読性向上やコーディング支援のために多くの場合使用されています。
こういった実際に使われているスタイルを学ぶことによって、より可読性の高い洗練されたコードがかけるようになるでしょう。
４．言語の発展に貢献できる
日本語のリファレンス・ドキュメント制作は、初心者がその言語を使用する足場になります。英語が出来ないもしくは苦手な方は、英語の文章を見るだけで忌避してしまうものです。だからこそ、日本語のドキュメントは言語の発展にとって非常に重要なのです。
最初は日本語のドキュメントを読み、上達してくると英語のドキュメントも読みじめる。私がまさにそうでした。
リファレンス・ドキュメント制作の悪い点
良い点を書いたので、悪い点も書かなければなりません。
しかしながら、私としましてはほとんど悪い点はないように思えます。
強いて言うのならば、非常に大変で時間を食う作業であることが挙げられるでしょう。
しかし、非常に大変で時間を食うからこそ、誰もやらないため価値がそこにあると私は考えています。
終わりに
どうでしたか？ ほんの少しでも「ドキュメント制作やってみようかな」と思ってくだされば、それほど光栄なことはありません。
是非、あなたの得意な分野・言語のリファンレンス・ドキュメント制作に挑戦してみてください！
補足
私が現在参加しているリファレンス・ドキュメント制作の一覧です。
| プロジェクト | 分野・言語 | 主催 |
|---|---|---|
| rsdocsjp | Rust言語 | Rust Developers JP |
| Pythonドキュメント | Python | PythonJP |
| cpprefjp | C++ | cpprefjp |
rsdocsjpは、私がオーナーを務めるプロジェクトです。
ただの翻訳ではなく執筆者の理解を優先する、独自の方針を取っています。
興味がある方は是非ご参加ください！
質問などありましたら、 RustDevelopersJPのコミュニティ にて受け付けております。