🔥

公式ドキュメントを読むことによってのメリット

1 min read

記事の背景・課題

現状の技術のキャッチアップ
二年間エンジニアとして働いていて技術をキャッチアップ、実装の設計などを考える時に
一番最初に見るのはQiitaやzenn,noteだったりする。
記事を参照してうまくいかない時は公式のgithubのエラー報告、issueなどで出ているやり取り、stackoverflowを見て解決などをしているが公式ドキュメントをゆっくり見てコードの深い理解をすると言うことをしてこなかったので自分の技術の理解を深めるためにやろうと思います。

作業の流れ(毎回こうとは言い難いが)

  1. タスクや実装をすることが決まる
  2. 実装内容や仕様が満たせ得るであろう処理を書いている、過去同じような実装をしている記事を探す
  3. それを参照しつつ、自分の仕事のコードに落とし込む
  4. わからない処理が出てきた時(その処理の説明がわかりやすくされた記事や公式ドキュメントを読む)
  5. 実装する

課題

  • 使えば便利な言語・ライブラリ・フレームワークの支援を使い切れてなくコードが汚かったり読みにくいことがあると感じる(先輩エンジニアのコードと見比べた時に)
  • zennとQiitaからコードを持ってくるので処理の深い理解がないまま進み、他のコードを追加する時に時間がかかったりする
  • ios15などを対応に伴い記事がないことが多かったので、公式ドキュメントなどの一時情報が大事であると認識させられたため

なぜ公式ドキュメントを読んでこなかったのか

  • 英語が読めない google翻訳でも日本語のニュアンスが変でよくわからない時がある
  • 公式だと簡易的な使い方は載っているイメージだが実際のコードに落とし込んだ時にどう実務のコードに落とし込めばいいのかわからない

公式を読むことによってこのようなメリットがあるのではと思ってること

  • zennとかQiitaから持ってくる他のコードの理解が深くなる
  • フレームワークやライブラリにある機能をフル活用してあとで自分が役になる設計や実装ができる
  • 技術選択でなぜその技術を使うのかを深く説明ができ、他の技術との比較がしやすくなる

読んでこなかったので読み方のコツなどあればと思って記事を探した

記事を読んでみて下記を意識して読んでいこうと思います(⚠️読んだ記事は読んだ記事一覧の場所で読むことができます)

読むコツ

  • 翻訳機能を使って日本語でもいいから読み進める(DeepLを今回しよう)
  • なぜそのその技術を使うのかをわかりやすく書いた日本語記事を読んで公式ドキュメントを読むハードルを下げる
  • フレームワーク・ライブラリによっては、公式ドキュメントが読ませる目的で書かれていなかったり、書かれている情報に不足が多かったりするものがあるのでその時は「Githubでリポジトリのissueを参照する」、「リポジトリのコードを直接参照する」、日本語記事を読むなどをする
  • githubに上がっているサンプルコードを参照する

仕事において

  • 目先のタスクに追われるのではなくドキュメントを読む癖や時間をとる

読んでみていいなと思った点をまとめてみる

今の仕事の技術がNext(React) FirebaseなのでいったんNextReactのbata版の公式が出たので読んでみて実務でどう落とし込めそうなのかはこれから別記事でまとめようと思います
React

https://beta.reactjs.org/
Next.js
https://nextjs.org/docs/getting-started

読んだ記事一覧

下記の記事は3150だった

https://qiita.com/hiraike32/items/f0a211cceb0ecc516b6c

Discussion

ログインするとコメントできます