見出し画像

プログラマーなら!ドキュメントを読めるようになろうぜP1

ドキュメント読めないプログラマーってマジ?
思わず、僕は退職目前で声を大にしてしまった。

だって、プログラマー志望でドキュメントを見たことないって。
それは難しいよ、成長するのは。

思うようにコードがかけないんですとか、
エラー対策が組めないとか、
エラー回避用のコードがかけないとか。
情報が探してもなかなか乗っていないとか。

確かに全部挫折する要因だけどさ。
そりゃあ、ドキュメントを見ずにできるわけないでしょ。

と、一人のプログラマーとしては思ってしまうわけで。
無理だよ、流石に。
ドキュメントは読めた方が良いと思う。

なので、今日はプログラマーを目指す人へ。
若しくは、今悩んでいる人へ。
ドキュメントが読めないでどれだけ損をしているのか紹介しよう。


ドキュメントの読めないプログラマー

最近、同年代プログラマーと会話していると二つの派閥がある。
それは、「ドキュメント命」という派閥と、
「ドキュメントは不要」という派閥だ。

勿論僕は、ドキュメント命という派閥なのだ。
皆さんはどちらだろうか?
正直な話、簡単なコードならドキュメントはいらない。
でも、結局のところドキュメントが読めないと困る。
確実に動作する完全なコードを書くことができないからだ。

ネット上に溢れている情報も、
基本的にはドキュメントを引用したものだから。
自分で解読するか、誰かが解読している誤情報を探すか。
誤情報に踊らされている自覚があるのかないのか。
それは、非常に重要な事ではないだろうか。

勿論、すべての情報が誤情報だとは言わない。

ただ、知っておいて欲しい。
プログラムを組むうえで、
ドキュメントが読めないのは致命傷だと。

ドキュメントが読めないとどうなるの?

僕が主に感じているのは、三つだ。

  • 「正しい記述と情報を手に入れられない」

  • 「開発象全体が理解できていない」

  • 「新しい開発が無い」

これは、プログラマーとして問題だ。
由々しき事態に直面していると言える。
基本的には誰かが開発した何かを、
今の段階は切り貼りして開発していると思う。

だけど、先端ではそんな事ばかりではなく、
エラー処理やデバッグで、
情報が無いモノに遭遇する
事もある。

そんな時、ドキュメントが読めないと、
そもそもエラーの情報を探すこともできないのだ。
当たり前だけど、ドキュメントの中には、
どの場合にどのパターンのエラーが出て、
何を見なければならないのか。

ドキュメントは、ここまで詳しく詳細に書いてある。
この情報がなければ、エラーは解決しない。

正しく密度の高い情報を一気に入手できる

正しい記述と情報が無い結局のところ、堂々巡りだ。
普段見ている各種サイトなどは、
ドキュメントを基に誰かが切り貼りしているんだ。
つまり、僕らは知らないだけなんだ。
気がつかない間に、ドキュメントの端っこに触れている。

そして恐ろしいのが、開発環境の違い。
若しくはプログラマーレベルの違いで、エラーの出方が違うことだ。
その時、どう解決したらいいのだろうか。

初心者程、玄人ほどこの沼にハマる。
今一度、その情報が正しいのかどうかを検討しなければならない。

基本的にプログラマーはバイリンガルになっており、普通に5言語くらいは開発経験がある。そうなってくると、ドキュメントをザっと読んで何となく書いて、何となく理解した気に成ってしまう

でも、実際には、そういう開発経験豊富な人ほどすごく基本に忠実だ。
自分の書ける言語ごとに、特徴がある事を知っている。
その為、何か問題があるとドキュメントを確認する癖がある

ブログなどではそのような記述はないのが酷いけど。
何を信じて開発するべきなのか知っているのだ。

最終的にドキュメントの怪しい部分を探して読み漁り、
答えを見つけている人が多い。
だが、ドキュメントが解読できないと、
このアクションを取ることができない。

プログラムが難しいとか、できないとか。
ネット上の情報を見ても思ったように動作しないのは、当たり前だ。

だって、ドキュメントが読めないから。
正しいコードの記述方法と、動作方法を知らない
単に、プログラム言語と言っても、
言語によって書き方も、
エラーの出方もコンパイル方法も違う。

だから、正しい情報を知り、正しくコードを記述する事が出来る。
これができて、初めてプログラマーになれる。

残念ながらAI開発がこの先主流になるが、
AIが読み込むwebページなどは指定できないので、
結局のところドキュメントが読める人しか残らない。

開発象全体のイメージができるか

簡単な話だが、
何故この言語は必要なのだろうか?
を、一瞬でも考えたことがあるだろうか。

その認識が無ければ、そもそも正しく言語を選択する事もできない。
フレームワーク然り、言語然り、ライブラリ然り。
なんでもそうだが、成り立ちというものがある。

その成り立ちを把握せずに、
「この言語が人気だから」という理由で開発していくと、
力技で無駄に複雑なコードを記述しなければならない。
しかも、自分が成長していくわけでもない。

成長していくには、一つ指針がある。
簡単かつ高速に、分かりやすいコードを書けることだ。
そして、目的の機能を実装していくのは絶対条件。

その為には、正しく言語を選択して利用、運用していくことがコツだ。

これを実現するには、各種言語などの開発理論を知っておく必要がある。「何故この言語が存在するのか」を知っておかなければ、開発の全体像は愚か、なぜその言語を使って開発するのかも分からない。
公式ドキュメントを読み込んで、どんな特徴があってメリットがあるのか。知っているデメリットに対しどのようにアプローチしていけば穴埋めできるのか。

把握しているのか、把握していないのか。
それは、完成したシステムがゴミか製品化できるか。
それくらい、大きな違いを生み出してしまう。

新しい開発が全くない、簡単な開発だったらいいかもしれない。
ただ、その開発は空しいモノではないだろうか。
既存の発見しやすい物だけで機能を作る」に落ち着いてしまうから。

webで検索すると、「このページ使えねぇな」とならないだろうか。
だが、ドキュメントを読んで推敲できなければ、変わらない。
その「使えない情報」だけで、開発していく必要がある。

それは、あなたの限界を一気に早めて開発の成長を阻害していく。

あなたの悩みの答えは、確実にドキュメントの中に存在する。

だが、ドキュメントまで手が伸びないと、ネット検索して情報が無ければ諦めてしまう事になる。それは、そこで開発が停止する事に等しくできる範囲で適当になコードが完成する。
とても、悲しい事ではないだろうか。

プログラマーなのに、創造性もないもない。
そんな開発、したくないでしょう?

新しい技術やツールの利用ができない

開発者は新しい技術やツールを効果的に活用することが難しくなる。
例えば、新しいライブラリやフレームワークを導入する場合だ。

その公式ドキュメントを理解できなければ、正しい使い方やベストプラクティスを把握することができない。
その結果、誤った実装や非効率なコードが生まれ、プロジェクト全体の品質や進捗に悪影響を及ぼす。

ドキュメントを読む力が不足していると、問題解決のスピードも遅くなる。開発中にエラーやバグが発生した場合、公式ドキュメントやFAQ、フォーラムなどの情報源から適切な解決策を見つける必要がある。

これができないと、時間と労力を無駄にしてしまう。
これにより、プロジェクトの納期が遅れたり、クライアントやチームメンバーとの信頼関係が損なわれる可能性が大いにある。

「あの人なんで成長するのかな」という視点で見てみると、個人的な経験で行くと「ドキュメント」に行きつく。先輩社員にドキュメントで殴られたなんて良く聞く話だが、逃げても最終的には「ドキュメントが壁のように反り立っている」と思う。

組織的なプログラマ育成で立ち止まるのは、この習慣の有無だろう。ドキュメントを読む習慣のない場所は、大抵「調べて分からないのなら仕方ない」で終わる。プログラムって、そんな話ではないのにね。
開発レベルが、最終的には「ドキュメントを読む文化があるかないか」に帰着するのは、このためだ。

この先を考えるとデメリットしかない

そのデメリットをかかえたままプログラマーになると、確実に挫折してしまう。今、IT業界は人材を欲しており、本当にどうでもいい情報で溢れている。

簡単に書けるとか、早いコードの書き方とか。沢山の解説記事があるけど、結局のところ「最前線付近の人はドキュメントと格闘している」のだ。システム開発に携わるようになると、寧ろドキュメントを作る側になる。そうなると、ドキュメントを読んだ経験が無ければそもそも、書く事もできない。貴方がもしも、IT業界に興味があるのなら。まず、ドキュメントを読む癖をつけた方がいい。

ドキュメントを読めないプログラマーはそれこそ、AIに淘汰されて行くのだと思う。


いいなと思ったら応援しよう!

レン_歩くエッセイスト
最後まで読んで頂きありがとうございます。 応援していただけると励みになります。頂きましたチップは活動費として利用させていただきます。 今後ともよろしくお願いいたします