新人プログラマは公式ドキュメントで殴れ

公開日:2019-02-14
最終更新:2019-02-20

はじめに

Qiitaは真面目に推敲した記事を書く場所として、Qrunchは掃き溜めにしようと思います。

2/20追記:
使っているうちに気に入ってきたので、Qrunchをどんどん使っていこうと思います。
【さあ】Qrunchのいいところ(Qiita比)【はじめよう】 - sansaisoba’s tech blog

経緯

Qiitaは基本的にタグフィードを、気が向いたときにはトレンドを読んでます。

で、本日見かけた記事 私たちはどうして公式ドキュメントが読めないのか? - Qiita を読んでいて
なんだろこれ…既視感…と思ってたら、Qiitaでちょっと前にバズった記事
新人プログラマをレビューで殺さない方法 - Qiita を書いた方でした。

今回の記事に思ったこと

概ね同意だが、

ここまで言わないと公式ドキュメントを読まないの?というのが率直な感想。

危機感足りなくない?

公式ドキュメントを確認せず、誰が書いたかもわからない二次情報だけを元にして仕事をするのって、

Twitterで流れてきたどっかの一般人が書いた真偽不明なニュースをRTするのと変わらない

です。

とはいえ、一次二次は単純なものではなく、先の記事のコメント

ものによっては、公式ドキュメントが「厳密すぎてものすごく読みづらい」、あるいは「お金を出さないと手に入らない」例もあります。

例えば、JavaScriptの元になった規格書であるECMA-262はネット上に公開されていますが、慣れていてもこれを読み解くのには相当な労力を要します(もちろん、重箱の隅まで調べるときには頼りになりますが)。

Web系の技術に関してはMDN、Linux環境についてはmanのような、「公式ではないけれどそれに準じるようなドキュメントツリー」もありますので、そういうのも使いこなせるようになるといいかもしれません。

には全面的に同意です。

MDNやmanに関しては、多くの人の目に晒され常に正確なものに更新されている情報なので一次情報と同等に扱って良いでしょう。

ウェブ上の記事を判断するポイントとしては、

  • 更新日時
  • サイト運営
  • 書いた人

あたりでしょうか。
ちなみに、Google検索で上位に来るからと言って信頼できるとは限りません。

情報は山程ある

ウェブ上には情報は山程あります。だからこそ、真偽を見極められるスキルは必要です。
そのスキルがないなら、つべこべ言わずに一次情報にあたっておきましょう。

いいか、公式ドキュメントを読むのが一番楽だからそうするんだ

  • 二次情報を正しいものと判断するにはその情報が正しい(であろう)という理由を得る必要がある
  • 一次情報はとりあえず正しいと判断して問題ない
    • 間違ってたら言い訳もつく
    • 公式ドキュメントが間違っていると説明できるくらいなら既に新人ではない

以上。

おまけ

前回の記事に対する私の反応

オープンな記事にはしてませんでしたが、Slack上では以下のように書いてました。

ここに付いてるコメントで「こういう風にネチネチ言ってくる老害いるよね」ってあるけど、この記事のレビュー内容ってそんなにヤバい?

上手いかというと、そうでは無いとは思うが…バックグラウンドが悪いんじゃないかなぁこの人。

例文にhtmlqを参考サイトとして持ってきたり、example.comを使わないあたり、なんかお察しな気がしてき…


これがヤバいとしたら、自分が新人プログラマを殺していたということになり怖いな、と。


実際、ドキュメントに書いてあることを聞かれたら自分ならドキュメントに書いてるよ読もうねと言うし、

公式ドキュメントに「コントローラ」について詳しく載っているので、あとで一緒に読みながら修正していきましょう。

とは絶対言わないなーと思ってw
「あとで」って何だって思ってしまうし、コメントに残したいんで、コメントなり参考記事なりでがっちり書くか、時間がないなら、ドキュメントに書いてるよっていう、確実な返答をしますね。

それでわからなきゃ新人側は教えろと言っていいと思うし、教えなきゃ先輩失格とも思うし。

これ系の記事って時々出てるけど、この記事に関しては書いてる内容ってそんなに酷いこと書いてないよなって思って、これが酷くなるってどれだけ酷い環境なんだwと思った次第です。

今気づいたが

新人プログラマをレビューで殺さない方法 - Qiita#公式ドキュメントで殴る

公式ドキュメントに「コントローラ」について詳しく載っているので、それを参考に修正してみてください。
https://readouble.com/laravel/5.7/ja/controllers.html

先輩!そもそもこれ、公式ドキュメントじゃねぇから!!

https://github.com/laravel-ja/ja-docs-5.7

注意:Laravel開発者のTaylor Otwell氏は、英語のネイティプスピーカーです。英語しか理解できません。 自分の理解できないものには責任が持てないと言う理由から、 公式ドキュメントは英語のみです。そのため、日本語翻訳を「公式」と呼ばないでください。 「日本語ドキュメント」、「和訳翻訳ドキュメント」など適切にお呼びください。

記事が少しでもいいなと思ったらクラップを送ってみよう!
149
+1
選択肢が少ないということは幸せなことなんだよ。

よく一緒に読まれている記事

0件のコメント

ブログ開設 or ログイン してコメントを送ってみよう
目次をみる

技術ブログをはじめよう

Qrunch(クランチ)は、ITエンジニアリングに携わる全ての人のための技術ブログプラットフォームです。

技術ブログを開設する

Qrunchでアウトプットをはじめよう

Qrunch(クランチ)は、ITエンジニアリングに携わる全ての人のための技術ブログプラットフォームです。

Markdownで書ける

ログ機能でアウトプットを加速

デザインのカスタマイズが可能

技術ブログ開設

ここから先はアカウント(ブログ)開設が必要です

英数字4文字以上
.qrunch.io
英数字6文字以上
ログインする