こんばんは、中尾です。
今回は技術的な話じゃなくて、オルターブースさんのイベントで登壇したお話を記載します。
G's ACADEMY Fukuoka はプログラミングスクールなので、スクールでは教えてくれないような内容で発表をしました。
READMEちゃんと書いていますか？
私が登壇したタイトルですが、タイトルの通りです。
READMEちゃんと書いていますか？
おそらく、プログラミングスクールでは基本的な開発の流れを経験できるのですが、実際の業務では全然違うと思います。その中で大事なことの一つにREADMEがあると思います。 READMEは集団開発する上でも、個人開発する上でも大切だと考えます。 OSSのgithubのREADMEを見てもらったらわかると思いますが、システムの概要から使い方まで書いていますよね？それを書いて欲しいということを言いました。 プラスで使われている技術、環境、デプロイ方法など記載されていることが大事です。 自分で過去のgithubを見返した時に、なにをやっていたのか？などコードを見て思い出せる人はほとんどいないと思います。 過去の自分が何をやっていたのか、っと今に繋げるためにもやって欲しいです。
こういう小さな積み重ねが良いエンジニアになっていくと私は考えます。 っというのを伝えたつもりですが伝われば嬉しいと考えています。
