公式ドキュメントを読もう

みんなのウェディングの高井です。

最近、若手のエンジニアと話をする機会が多くあります。そういった場で、ここが重要ですよと伝えたい話のうちのひとつがこの話になります。別のところに書いていたものですが、すこし手を入れた上で再掲します。


ハッカーの世界には昔から「RTFM」という言葉があります(参照)。ようするに「マニュアルを読め」という言葉なのですが、これはとても重要な言葉です。

色々な人によってブログにメモやノウハウが記載され、簡単に検索でみつかる世の中ではあります。また、そのためのサービスや技術的な質疑的な質問をすることのできるサービスも沢山あります。

しかし、検索サービスは、その内容が正しいことまで保証してくれません。見つかった記事の著者が誤解している場合もあれば、理解していない場合もあります。そして、ほとんどの場合は最新の情報ではありません。

マニュアルや公式ドキュメントであれば、それが正しい情報なのか、間違っている情報なのか悩む心配はありません。(まれにマニュアルが正しくないことがありますが、プロジェクトにコントリビュートするチャンスなので、ラッキーだとおもいましょう)

正しい情報が手に入る良質な資料があるのに、最初に不確かなブログやメモを参照するのは、時間の無駄です。疑問点があれば、まずは公式のマニュアルやドキュメントを参照するようにしましょう。また、ソースコードも間違いがない情報源になります。

たとえば、Railsは非常によくドキュメンテーションがされているプロジェクトです。疑問点があれば、Rails GuidesやAPIガイドを読むことで、だいたいの問題を解消することができます。

ノウハウサイトからコードや設定の断片をコピーアンドペーストをして、「うまくいった」「うまくいかなかった」とトライアンドエラーを繰り返すのは、エンジニアリングではありません。これは、まったくの間違いです。

まずは公式マニュアルや公式ドキュメントを読むクセをつけましょう。これができるか、できないかでエンジニアとしての成長も大きく違ってきます。