Re:ゼロから始める文系プログラマ

未経験がプログラミングを通して人生を変える

【重要】プログラミングにおける公式ドキュメントの読み方・メリット


スポンサードリンク
 

f:id:ShotaNukumizu_1000:20211011093731p:plain

おはようございます。Shotaです。

皆さんはプログラミングをする際に、公式ドキュメントを読んでいますか?

公式ドキュメントとは、プログラミング言語フレームワークやライブラリについてその公式組織が出している文書です。言い換えれば、公式ドキュメントはプログラマー向けに書かれた説明書兼チュートリアルです。基本的に英語で書かれているものが大半です。

プログラミング学習において、公式ドキュメントを読むことは一番重要です。管理人もプログラミングの勉強をすすめる上で、公式ドキュメントの内容に助けられたことは何回もありました。

しかし、プログラマーやプログラミング初心者の中には

😥「公式ドキュメントが全く読めない...」

このように悩んでいる方も少なくないと思います。

そこで今回の記事では、

  • 公式ドキュメントが読めない3つの理由
  • 公式ドキュメントのメリット3つ
  • 公式ドキュメントの読み方


これらの内容を中心に解説していきます。

それでは早速、本題に入りましょう。



公式ドキュメントが読めない3つの理由


理由1:公式ドキュメントを読む意味が感じられない

😶「技術的な記事はQiitaあるいはブログにたくさん上がっているから、わざわざ公式ドキュメントを読まなくてもよくね?

このように考えている方もいるかもしれません。

しかし、日本語で書かれている記事の大半は公式ドキュメントの二次情報になります。

間違った情報が書かれているかもしれないし、あるいは情報が古くなったりしているかもしれません。また、詳細なAPIの仕様だったり、各バージョンの変更点などを日本語の公式ドキュメントで探すのは難しいと思います。

プロのプログラマーになるためには二次情報に頼ってばかりではダメです。実装で困ったとき、自分の力で必要な情報にたどり着けるように公式ドキュメントを読む必要があるのです。


理由2:英語がわからない

f:id:ShotaNukumizu_1000:20210922154708p:plain

英語が読めないという理由で公式ドキュメントを読むのが辛い...と感じている人も少なくないと思います。

英語が読めない場合の対処法は主に2つあります。


管理人の場合は前者をおすすめしますが、それだと時間がかかってしまいますので後者のほうがいいと思います。

chrome.google.com


理由3:公式ドキュメントを読む時間がない

f:id:ShotaNukumizu_1000:20211011103117p:plain

最初のうちは、公式ドキュメントを読むのにとても時間を要します。仕事などで時間に追われている場合はなかなか手が回らずに日本語の記事情報をコピペして済ませてしまうこともあるでしょう。

ところが、それではプログラミングのスキルは向上しません。

まずは、しっかりと言語やフレームワークに触れるための時間を最低30分でもいいから取るのが大事です。

しっかりと公式ドキュメントに触れて言語の仕様を理解するのは、プログラミングを勉強する上では大事です。


公式ドキュメントのメリット3つ


メリット1:必ず正しいことが書かれている

公式ドキュメントには必ず正しいことが書かれています。プログラミングを勉強している時にわからないことが合ったり上図にコードを書けなかったりすることがあっても、公式ドキュメントを調べれば正解にアプローチできます。

プログラミング言語フレームワークはバージョンが更新されると記述方法が大きく変わることも珍しくありません。

公式ドキュメントには必ず最新の記述方法が記載されているので、公式ドキュメントが読めると常に最新のバージョンに対応できます。


メリット2:情報が網羅されている

f:id:ShotaNukumizu_1000:20211011103304p:plain

公式ドキュメントには必ず全ての情報が記載されています。公式ドキュメントを調べることで、今まで使ったことのない機能を知ることができます。


メリット3:公式が推奨する実装方法やサンプルがある

公式ドキュメントを読みながらコードを書くことはプログラミング初心者にとってかなり難しい作業だと思います。

しかし、公式ドキュメント内にはサンプルコードが記載されていることが多いです。言い換えれば、動くコードが記載されているということです。

そのため、以下のようなステップを踏むことでコードの理解を深められます。

① サンプルコードをコピペして実行する

② サンプルコードの値を自分で変化させて挙動を確認する

③ 公式ドキュメントに記載されている他の引数も入れて挙動を確認する


公式ドキュメントの読み方

公式ドキュメントは英語で書かれていることが多いです。先程も述べましたが、英語が苦手で公式ドキュメントを読むモチベが上がらない人もいらっしゃるかと思います。

その時はDeepLを使ってみてください。

www.deepl.com

是非読者の皆さんも活用してみてください!


まとめ

今回の記事では公式ドキュメントが読めない理由、メリットや読み方を中心に解説しました。

公式ドキュメントを読めるようになると、プログラミングの勉強をスムーズに進められます。

ところが、公式ドキュメントだけを見るべきであるとお伝えしたいわけではありません。Webで検索すれば公式ドキュメントよりもわかりやすく伝えてくれる記事をたくさん見つけられます。

「最初の学習にわかりやすい記事を使い、知識の深堀りに公式ドキュメントを使う」というように学習ツールの一つとして活用していただければ幸いです。

今回の記事はこれで終了です。

【参考サイト】

qiita.com

blog.kikagaku.co.jp

www.itnavi.jp