ねえ、知ってた？「Railsドキュメント」はRailsの公式ドキュメントではないんですよ、という話

## TL;DR（最初に結論）

- Railsドキュメント( https://railsdoc.com/ )というサイトはRailsの公式ドキュメントではない
- 最初のとっかかりをつかむために参照するのは良いが、情報の裏取りとして公式サイトの情報も併せてチェックしよう

## はじめに

上記のTL;DRに書いた話をすでに知ってる人や、わかっている人はこの記事を読まなくても大丈夫です。
ですが、Railsを学び始めた初心者プログラマのみなさんは意外と勘違いしている人が多そうなので、注意喚起を兼ねてこの記事を書いておきます。

## 「Railsドキュメント」はRailsの公式ドキュメントではない
Rails関連の調べ物をすると、検索結果の上位によく上がってくる「Railsドキュメント」というサイトがあります。

![Screenshot 2024-08-24 at 11.41.06.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/7465/c29064d5-b9ff-f8d1-311b-5061d95fdd32.png)

こちらのサイトは日本語だし、網羅的だし、説明も丁寧だし、つい参考にしてしまうのはわかるのですが、決してRailsの公式サイトではない点に要注意です。
サイト名もURLもデザインも、いかにも公式っぽい雰囲気になっていますが、 **Railsの公式サイトではありません！**

## 実は運営者情報もよくわからない謎サイト

加えて、このサイトはどこにも運営者情報が載っていません。
かなり昔から存在しているサイトですが（かれこれ10年以上？）、いったいどこの誰がこのサイトを管理・運営しているのか、さっぱりわかりません。

広告を載せて儲けようとするような気配もないですし、中の人はきっと悪い人ではないと思うのですが、とはいえ、運営者がよくわからないサイトというのはちょっと不気味です。

## Railsドキュメントは参照しちゃダメなの？

いえ、そんなことはありません。
Rails APIの使い方が日本語で読める、という意味ではありがたい存在だと思います。
実際、僕もたまにこのサイトの情報を参考にするときはあります。

ですが、公式サイトではないため、全部が全部正しい情報とは限りません。
たまに間違った情報も載っています。

以下はその一例です。

https://x.com/Nkzn/status/1501865922809982981

### 存在はしてるけど反応がないXアカウント
上のツイートをよく見るとわかりますが、実は[@railsdoc](https://x.com/railsdoc
)というRailsドキュメントのXアカウントが存在しています。

ですが、問い合わせの返信はしていないようですし、[該当ページの間違い](https://railsdoc.com/page/model_order
)は今も修正されないままになっています（2024年8月現在）。


![Screenshot 2024-08-24 at 12.00.10.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/7465/1bf56c78-6cd0-1d84-b27a-9376116003a5.png)

ちなみに上のコードは正しく書くならこうですね[^1]。

```diff_ruby 
-Page.order(:category_id :asc)
+Page.order(category_id: :asc)
```

[^1]: ASCがデフォルトなので普通は `Page.order(:category_id)` でいいと思いますが。

### 対応バージョンがRails 7.0なのでちょっと古い
また、2024年8月現在、最新のRailsバージョンは7.2ですが、Railsドキュメントは7.0までしか対応していません。
そのため、最新のRailsを開発する上ではRailsドキュメントは不十分になってしまう可能性もあります。

![Screenshot 2024-08-25 at 17.04.23.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/7465/8e4bda63-f28e-a959-a6e9-0cecd3444a65.png)

## 運営者が不明だと何が困るの？
別に運営者なんて誰でもいいんじゃない？と思う人も中にはおられるかもしれません。

しかし、運営者が不明で連絡が取れない（Xアカウントはあるけど反応してもらえない）、ということになると、記載内容の間違いを指摘したり、改善の要望を伝えたりすることができません。

ページ内にコメントを残すこともできないので、（運営者が自主的に修正しない限り）おかしな情報はおかしなまま残り続けます。

もちろん、Railsドキュメントに限らず、非公式サイトの情報はどんなサイトでも100%信用することはできません[^2]。

ですが、「運営元（または記事の執筆者）が明らかで連絡を入れれば修正してもらえる可能性があるサイト」と、「連絡先がなく、間違った情報が載っていても改善要望すら出せないサイト」では安心感が大きく異なると僕は思います。

[^2]: こういうことを書くと「公式サイトだって間違っていることはあるぞ！」という反論が出てきますが、一般論としては公式サイトの情報の方が非公式サイトよりも信頼できるはずです。

## じゃあどうしたらいいの？
前述の通り、僕は「Railsドキュメントは一切参照するな」と言いたいわけではありません。
最初のとっかかりとして参考にするのは全然OKです。

ただし、初心者の人も以下の2つの行動を心がけてほしいです。

### やってほしいこと1: 公式ドキュメントで情報の裏を取る
Railsドキュメントの内容は間違っている場合もあるので、そのまま鵜呑みにせず、公式サイトで裏を取るようにしてください。

日本語で読めるRailsの公式情報としてはRailsガイドがあります。

https://railsguides.jp/
![Screenshot 2024-08-26 at 6.54.26.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/7465/06b33961-da09-a31b-c818-6a76b610d9cf.png)

また、メソッドやクラスのAPIを調べたい場合は公式のAPIドキュメントである "Ruby on Rails API" を参照してください。

https://api.rubyonrails.org/
![Screenshot 2024-08-26 at 6.54.37.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/7465/ab23aa09-4905-4724-4ef2-35d6ff202889.png)

Ruby on Rails APIは英語で書かれているので初心者の人はちょっと取っつきにくいかもしれません。
ですが、プログラミングを学ぶ上で英語は避けて通れないので、今から英語のドキュメントに慣れる訓練をしていきましょう。

### やってほしいこと2: 参考文献を載せるなら公式サイトの情報を載せる

Qiitaに書かれたRails関連の記事を読むと、参考文献としてRailsドキュメントのリンクが載せてあるのをよく見かけます。

ですが、繰り返し述べているようにRailsドキュメントは公式サイトではない以上、信頼性については何とも言えません。

また、参考文献として載せることで、他の初心者が「なるほど、これが公式サイトなんだな」と勘違いしてしまう可能性もあります（Qiitaや個人ブログとは違って、ぱっと見は公式っぽく見えるサイトなので）。

ですので、参考文献として載せるリンクはRailsドキュメントではなく、RailsガイドやRuby on Rails APIのような本物の公式サイトにしてほしいと思います。

たとえば、`link_to`メソッドの情報を参考文献として載せるのなら、

https://railsdoc.com/page/link_to ではなく、
![Screenshot 2024-08-26 at 6.56.10.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/7465/f88e9065-e26f-fdb6-7fcd-8aa4ec645ed4.png)



https://api.rubyonrails.org/classes/ActionView/Helpers/UrlHelper.html#method-i-link_to を載せるようにしましょう。
![Screenshot 2024-08-26 at 6.56.21.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/7465/bca697f2-50a4-2dc2-098f-8fef2cb6ca0c.png)

## まとめ
というわけで、この記事では「RailsドキュメントはRailsの公式ドキュメントではないんですよ」という話を書いてみました。

Railsドキュメントが初心者にとってわかりやすくて取っつきやすいサイトであることは僕も否定しません。
ですが、一人前の開発者を目指すのであれば公式サイトとそうでないサイトを適切に使い分けられるようになりましょう！

### あわせて読みたい

公式ドキュメントを参照することの重要性については、@chooyan_eng さんのこちらの記事が参考になります。

https://qiita.com/chooyan_eng/items/cd0d3174b77ff1e02c3f

公式ドキュメントは難しくて読み方がわからない！という人は僕が書いた以下のwebブックを参考にしてみてください。
対象としているのはRubyの公式リファレンスですが、基本的な考え方はRuby on Rails APIを読むときも役立つはずです。

https://zenn.dev/jnchito/books/how-to-read-ruby-reference