見出し画像

公式ドキュメントを読むこと

StackOverflowQiita など便利な Q&A や Tips を閲覧できるサービスが沢山あるが、大抵の場合、公式ドキュメントを読む方がこれらのサービスで調べるより早くて正確になることが経験上多い。

サンプルや実際の使い方を知る、特に Qiita の場合は日本語でそういった情報にアクセスできる利点から、検索ワードを駆使して、なんとかこれらのサイトから目的の情報を得ようとすることがあるが、この方法には3つの欠点がある。

一つは、質問の仕方を検索するという絡め手を使わなければいけないこと。特に英語の場合は難度が上がる。知りたい質問の細かなニュアンスに近づけることが難しいことが多い。一つは、情報が既に古くなっている可能性があること。一つは、情報が間違っている、または不足していることがままあること。

特に、情報が古い、間違っているケースが最悪、かつよく起こることで、一生懸命英語を読んで得た情報や日本語情報のサンプルを試してみてそれが時間の無駄だった時のやるせなさったらない。

特に新しいライブラリや言語の場合、信頼できる日本語化された情報は極端に少ないのが常だ。であれば、 Q&A や Tips を頑張って英文解釈するより、最初から公式ドキュメント(これはほぼ100%英語だ)をあたって解釈した方が良い。

かくいう私も、そうはいうものの目先の問題の解決にとらわれて公式ドキュメントではなく、検索による一気呵成の解決を図ろうとすることが度々あるが、なんやかんやと時間を潰して、結局、最善の一手は公式ドキュメントを読めば書いてあった、ということが度々ある。

公式ドキュメントがほとんど未整備のものも中にはあるが、そういうライブラリはよほど人気があるものをのぞいて使わないに限る。

公式ドキュメントを読むことは、まさに急がば回れなのだ。
どうせ英語からは逃げられないのだから、エンジニアは諦めて英語の公式ドキュメントを読もう。その方がほとんどの場合、早く済む。

この記事が気に入ったらサポートをしてみませんか?