Ruby on Rails

【初心者向け】RubyやRailsのドキュメントは何を参照すればよいのか

どうも、Kohei(@koheinishino_)です。

この記事を読んでいる方の中には、現在進行系でRuby on Railsの勉強中であったり、実際に業務で開発している方が多いのではないかと思いますが、今まで一度は

RubyやRailsの公式ドキュメントってどれ見ればええの?

と思ったことはないでしょうか?

自分はRubyを触り始めて半年間はそう思ったことが何度かありますw

この記事では上記のような方に向けて、RubyとRuby on Railsの公式ドキュメントとされているものを2つずつ紹介していきます。

自分はQiitaや個人ブログの情報の裏付けとして今回紹介するドキュメントを利用することが多いので、似たような使い方を考えている方は是非参考にしてみてください!

リンクだけ知りたいよーって方は下記から飛んでみてください!

Ruby on Railsのドキュメント

Rubyのドキュメント

ドキュメント – Ruby

こちらはどんなときに読むべきかというと、「ひとまずRuby公式で推奨されているドキュメントを一覧で確認したい」ときです。

各チュートリアルやリファレンスマニュアル等のリンク集になります。

普段から使うというよりかはググってヒットしたページを見て、「この情報ソースってオフィシャルだったっけ?」といった感じで情報を利用する前の確認程度に使うイメージです。

英語版もありますがサクッと確認する程度であれば日本語版でも充分かと。

この後紹介する各Rubyバージョンのリファレンスマニュアルへのリンクもここに記載されています。

プログラミング言語 Ruby リファレンスマニュアル

こちらはどんなときに読むべきかというと、「文法やライブラリの使い方や動作内容を確認したい」ときです。

有志の方々が整備しているドキュメントで最新バージョンのRubyだと未完成のページが存在することもありますが、情報としては公式に近い立ち位置となります。

上記で紹介したリンク集から各バージョンのリファレンスマニュアルに飛べます。

Rubyの教科書のようなイメージで、自分の場合は文法やライブラリの使い方(書き方)をサッと確認する際によく使います。

開発で様々なバージョンのRubyを使う場合は、各バージョンをまたいで検索をかけられる「るりまサーチ」というサイトをブックマークしておくのもオススメです。

Ruby on Railsのドキュメント

Ruby on Rails ガイド

こちらはどんなときに読むべきかというと、「Ruby on Railsの概念を体系的に学びたい」ときです。

Railsで採用されているMVCフレームワークのモデル・ビュー・コントローラの解説であったり、テスト技法やセキュリティについてなどの少し高度な内容もここで確認できます。

英語版を基に日本語に翻訳されたものなのでより正確な情報を知りたい場合は英語版を閲覧するのが良いかもしれませんが、詳細な内容ではなく基本的な内容を学びたい場合や初学者のうちは日本語版でも充分かと思います。

自分の場合はActive Recordでのクエリの投げ方やバリデーションの書き方をよく確認しています。あとはフロント部分の実装が苦手なので、アセットパイプラインの仕組みやJavaScriptとの連携方法のページで都度理解を深めていくことが多いです。

Railsドキュメント

こちらはどんなときに読むべきかというと、「Ruby on Rails特有のメソッドの動作を確認したい」ときです。

例えばfindとfind_byの違いを調べたいときに、直接メソッド名を指定してページの解説を閲覧できます。また「条件を指定して最初の1件を取得(find)」や「IDを指定してレコードを取得(find_by)」のように逆引きでメソッド名を調べられます

他にRuby on Rails APIという公式でも推奨されているサイトも存在するのですが、英語版しかなくRailsの最新バージョンの内容のみの記載になっているので少々使いにくいです…。

バージョンは下記のようにURLの末尾に設定すれば切り替えられるのですが割と面倒ですw

実際の業務での最新版への対応であったり詳細に動作を確認したい場合は有用ですが、初学者のうちはRailsドキュメントでの確認で問題ないかと思います。

参考

おすすめ書籍

以下は個人的にRubyやRailsの学習に大変役立った書籍です。

公式ドキュメントよりも分かりやすく解説されているため、体系的に学習を進めていきたい方はチェックしてみてください!

プロを目指す人のためのRuby入門 言語仕様からテスト駆動開発・デバッグ技法まで Software Design plus
created by Rinker
パーフェクト Ruby on Rails 【増補改訂版】 (Perfect series)
created by Rinker
ABOUT ME
Kohei Nishino
Webエンジニア、ブロガーです。新卒未経験で開発エンジニアとして大手SIerに入社し2年で退職。その後、派遣と業務委託を半年ほど経て都内のWeb系企業にエンジニアとして転職。しばらくは本業コミットのため技術的な話が多めです。Ruby on Rails / React.js / AWS