本日はのりさんとカイチ二人ということで大人の話をしていきましょうかはいアダルティずっと黙ってるから怖かったですねはい僕はですね大人の話?大人の話しか分かんないですねあれですか保険とかの話ですか違いますちょっと前に出てたやつねしませんしませんか残念ながらただ一応やっぱりひまじんプログラマーの週末エンジニアリングレッスンなので駆け出しプログラマーが中級エンジニアになるための話ということでおお

そこはぶれないですねぶれないぶれないけどちょっと大人な道というかリードミー大人大人ですよリードミーは大人だな子供はリードミーデフォルトのままにするからなきっとそのままできたやつね消しちゃうから見出しレベル1でリポジトリの名前入ってるだけのやつゾーンってねそうあるなとかあとあれねフレームワークとかで

最初にインストールした時に入ってくるReadMeのままのやつとかあーありますねそのまましちゃいますからねしちゃうんだよなーただ中級エンジニアたるものReadMeを適切に書けなければならないということでうん

本日はリードミーの責任範囲気になると嘘ですリードミーの責任範囲これ1点を伝えるのを目的にお話をさせていただきますなるほどよろしくお願いしますどういうことかというとですね責任範囲って言ってもちょっと分かりづらいかと思うのでリードミーに書くべき内容とドキュメントいろいろあると思うんですけどリードミーはここまで書いてリードミー以外のドキュメントでここからは書こうか

っていう意味ですねなるほどしっかり区分けしていくと区分けしていく適当にやってましたね僕はなんか世の中のリードミー見て空気読んで作ってましたそれは悪いことじゃないんじゃないただちょっと自分の中の明確な哲学みたいなのはなかったなというので本日の種本というかイバレンスなんですけどリードミーチェックリストっていう

リードミーのチェックリストを本日

さらいながら二人でやんやん言ってここからここまでがリードミーなんだねっていうお話をしていこうと思いますなるほどちなみにそれ付録って

つってもリポジトリってことは普通に見れるってことですか僕らも見れますリンクも貼っとこうと思いますしなんでしょうこれはドキュメントライティングの作者が書いたわけではなくてもともとあるやつというかそうなんだリードミーに詳しい人が整理してくれてるやつリードミーに詳しい人ちょっと適当こきましたけどさすがにリードミーに詳しいでしょこの人は世界一リードミーを見る機会が多かった人ってことですかどうなんだろうなちなみにこの著者はダニエル・D・ベックさんっていう人ですね

Dの一族ですかそうなのかなDの一族なのかこの人なるほどその発想はなかったなその発想はなかったですけどそうかもしれないななるほどというので言いますね早速はいお願いしますまず一つ目大ベーシックプロジェクトを読者にプロジェクトを読者が特定できるようにしましょうというのでどういうことかというとですねはい

リードミーの置き場所とファイル名について置き場所とファイル名指定をしておりますちなみに意識してたことありますかはい一応ですね多分みんなできてると思うんですけどプロジェクトの頭とか一番上であったりファイル名はちゃんとリードミー.なんちゃらになってるとか

ですよねこの辺はちゃんとしましょうとあと僕あれですねモジュールにもたまに置いてるのを見たことがありますモジュールありますねメインストリームじゃないルートじゃないけどモジュールみたいな

サブディレクトリの中にあるモジュールの中にあるリードミーみたいなやつとかも見たことありますありますねなんか宗教戦争かもしれないんですけど実はそれサブモジュールにすべきなんじゃないかとかあるかもしれないですねリポジトリ分けてなるほどここは今日の話じゃないんで一回置いていきましょうわかりましたこれはできると思うので飛ばしますリードミーは大文字にするのは歴史的な慣習らしいですよ

ユニックス時代の小文字にできなかったっていう意味ですかカットで浅い知識出してきたんで絶対残そう絶対残すわじゃあ次ですねポイント2読者がプロジェクトを評価できるようにしましょうっていう風に書いてます

評価はい何を評価するんだとかはちょっと日本語がふわっとしてて分かりづらいかと思うんですけど82点点数じゃない点数じゃないプロジェクトの内容について書くんじゃなくてこのプロジェクトリポジトリが何をやるか何を達成するかっていう観点でプロジェクトをまず説明するとこ書いてくださいと

何を達成するか目的的な感じですかそうですね例えばなんだろうな

例えばGoogleだったら世の中の情報を全て整理するっていうリードミーを作れどうですか検索できるかな多分検索できるGoogle検索のリポジトリがあるとしたらこれはこうこうこういうデータベースの中からこうこうこういう処理をやって高速にこういう検索ができますって書くんじゃなくてなるほどサマリーってことですねそうですね手続きを書くんじゃなくて

宣言的友愛的なやつだおっしゃる通りですその通りですというところから説明を始めましょうという風に書いてます文例で言うとこの何とかを使ってあなたは何々を何々することができますとかこれは何々するのをサポートしますとか

これは何々に比べてこういうところがいいですなぜならこうだからですとかそういうユーザーに何を届けるかとかどういうメリットがあるのかみたいな切り口でプロジェクトの説明をまずしましょうそれは大事アブストラクトとかなのかなちょっとタイトルは分かりませんが僕はリポジトリについてとかっていう見出して書きがちですねこういうのは

見出しか最初の文章として書いちゃうかも見出しリポジトリ名本文それはあるかも世の中どうなっているんでしょうちょっときれいにリードミー書いてそうなやつ見てみますか思い当たる節あるんですか探してみますか英語なんですけど以前OSSから学ぶ変数関数命名選手権やったときに使ったBOTO3AmazonのPythonの

SDKなんですけどこれを見ると見出しにリポジトリ名一番上の見出しにリポジトリ名バーンってあってそのまま本文でこれは何々するソフトですとソフトウェアですという説明が書いてますねのりさんがさっき言ってたスタイルあー

なるほどツイッターもそうっぽいっすあーじゃあそれがいいんだ見通し消します僕最初のはいここ結構サクッと書いてるっぽいっすねまあ5行4行ぐらいですかうんまあそんぐらいですよねはいまあなのでそのとにかくこのプロジェクトが何を行うのかっていうところにフォーカスして書こうっていうところがまず一つ大事ですとはい

あとはライセンスが必要とかこういう範囲で使っていいよとかあればそれも書きましょうねって書いてましたねライセンスねオープンソースのやつだと結構ありますよねオープンソースだとありますね逆にですよ僕も読んでてオープンソースならありますよねって思ったんですけどクローズドソースプロジェクトはこうしようみたいなのが一応書いてましたっていうのも

社内の公開範囲とか利用範囲を指定する場合もありますよって書いてて大きい会社だとそうなんだなって思って読んでました確かにね良くないかって思うけどね機密情報にアクセスできるようなリポジトリだったら違うのかなどうなんだろうすいませんよく分かりませんでした広がると面倒いっちゃ面倒いのかなまあかもしれないですねそういう人ってそもそもリポジトリ見れるのかな本当ですよね誰まで共有していいよっていうのを分かるようにするためってことか

あーそれもあんのかなでもキッドハブってちなみにえっとなんていうんだあれグループ?チーム?チームかチームで共有しますよね多分基本的にうんチーム使うことが多いから多いですよねうん

チーム以下ならいいよっていう整理になりそうですよねこのチーム以下に作るリポジトリは全部それ以外の交換範囲の場合は別のチーム作ってやるんですよねきっとならそのチームのリードミーに書いた方がいいのかチームのリードミー見たことないなあるのかなあるのかな

次ですねオーガニゼーションでしたオーガニゼーションでした大変失礼いたしました読者がプロジェクトを利用できるように支援しようというのでこれはね大ベーシックですよまず前提となるというか利用できるようなライブラリのバージョンとか色々書き

言語のバージョンとかねライブラリのバージョンとかあとはプロジェクトを一回インストールして使用する手順をまず書きましょう書いてる素晴らしいこのインストールして利用する手順は最後の手順でちゃんと停止させてくださいって書いてますアプリケーションを動かしてハローワールドみたいなの出てじゃあこのプロセス落としてくださいみたいな

そこまで書いてくださいって書いてました僕もへーと思ってなぜですかちなみに次の他のドキュメントにつなぐときに起動から入るからとかそういうスタートとゴールを合わせるというか他の作業をしやすくするためなのかなと僕は捉えましたほう

明確なことは特に言われてないんですね提出させるとこまで書きましょうとしか書いてませんでしたけどでも僕はこのインストールっていう手順で起こしたものだから落とすのが正しいのは確かにって思いましたなるほど動作確認したらそうですね

そういうことをちゃんと書いて書き終わったらその通りでやってできるかなっていうのを自分でちゃんとテストしましょうねっていうのを書いてましたねこれはね書いてますよね皆さんちゃんとね書いてます次いきます読者がプロジェクトに参加できるように支援しましょうというのでさっきとなんか違いました?えーと

参加なので評価でもなく動作できるようにするでもなく参加ですなるほどこれ具体的にどういうことかというとプロジェクトのドキュメントをさらに入手するにはどこに行けばよいかを書いたりとかあとは何かあった時に助けを求められる場所を書いておきましょうメーリスなのかイシューなのかフォーラムなのか

サポートが必要な時のポリシーみたいなものをリドゥミーに書いておきましょうっていう話ですねなのでOSSだとよくありますよねそうかそうだろうなOSSだとコントリビューターにプロジェクトに追加してもらいたい場合に伝える方法とかポリシーが書いてる

でクローズドだとバグの報告方法を記載しましょうという風に書いてますねこれは僕はやったことがありません僕もないですないんですがまあでもチームのルールみたいなのは暗黙のルールとしてあるんですよ今それはちょっと良くないっていうかこれ暗黙だわってちょっとこのドキュメントを見て気づきましたなるほどねいやーこれどうだろうなちっちゃい会社だとやんないんじゃないですかねバグの報告とかのうん

方法とか管理方法とかって結構ふわっとしてる感じですかしてるかもそうなんだ結構野良ツールでもうんかっちりやってますそうなんだはい野良ツールはさなんかわかる使うユーザーが多分開けてるから逆にうん

小さい会社の社内プロジェクトみたいなやつってさ携わる人もどんどん変わるし使う人もどんどん変わるしそうなのかそれゆえ情報を共有するためにルールを明文化しておかないと大変なことにならないのかそんな活発に開発もされてないしねそれがあるのかもしれないバグ見っけと思ったらどうする感じなんですかね勝手にとりあえず一周にポーンと残して残しておきましたチャットポーン

おしまいちゃんと一周に残してくれるんですよ一周には残すからとりあえずメモっておかなきゃとはなるそういう暗黙のルールがあるってことですねそっか同じ感じです一周に残して残しておきました直さなきゃいかなかったらそのプロジェクトに紐づくチケット切って対応するみたいな感じですけどねうん

かっちりやるならそういうのを書いておきましょうとリードミーでお疲れ様でしたとお疲れ様でしたともう終わりですかそうですね最終チェックをして終わるぐらいですとそのぐらいでいいんですリードミーはそうなんだ他は別のドキュメントにしてくださいと書いてますリファレンスAPIの使い方とかなんでしょうね

例えばですけどアプリケーションだとしたら初期データ初期ユーザーのデータの入れ方とかあるのかなマイグレーションはでもインストールに入るか環境立ち上げるのに入れちゃうかな具体例は思いつきませんけど設定の変更方法とか月額課金のお金の値段変える設定の仕方とか運用ルールとか別のドキュメントにしましょうってことなんですかねなるほどねリードミーの長さの

目安も書いててくれてめっちゃ抽象的なんですけど3,4画面超えちゃう場合はだからスクロールですよね多分3,4画面分超えちゃう場合は目次をちゃんと追加して読みやすくしたりとか他のドキュメントに移しましょうと分割してっていうようなことは書いてますねなのでちょっとおさらいをするとまずReadMeの責務何だったかというとプロジェクトの概要を書く

これはこういうことを達成するソフトウェアですと次にこれの利用範囲どこからどこまで公開していいとか書きますとインストールの方法を書きますとバグがあったらここに打ってねこれだけですこれをリードミに書いて他のドキュメントはこっちよってリードミに書いてあげてくださいとなるほど

いうのがこのリードミーチェックリストに書いてる内容でした心が軽くなりました確かに僕だから結構太ったリードミーを書いてたなって思ったんですよこのドキュメント見てて確かにフレームワークとか最初にインストールした時に入ってるリードミーってさ見出しある程度書かれててさ英語だから全消しするんですけど

なんか英語圏の人はこれに当てはめて書いたらいい感じになるよみたいなにしてるのかなって思ってたんですけど結構あれボリュームないですかあのーすいませんわかりませんはいあのー即消ししたことしかない即消し確かに即消ししたことしかなくてすいません読んだことないですね正直ちょっと一個見てみていいですかお願いします

そんなことないですねそんなことなかったですか?はいそもそもこうやって書いたらいい感じになるよっていう感じのテンプレートでもなかったです

今ちょっとララベルのやつ見てるんですけどララベルの場合はまず最初にロゴがボーン来てますダウンロード数とかライセンスとか書かれた後にララベルってこういうもんですよララベルの使い方ここで学べますよスポンサーこの人たちですよコントリビューティングだから貢献者たちのリストはここにありますよコードオブコンダクトコンダクトってなんだろ

行動規範コーディングルールっぽいななんかあーなるほどうんコントリビュート要はプロジェクトが作る時のコーディングルールこんな感じですよとかセキュリティのやつこんな感じですよとかしか書いてなかったです自己主張激しいですねじゃあとにかくフレームワークについて書いてるんですねっぽいですまあそれでいいですよねうんそれでいいわこれはテンプレート書いてもねその通り使うとは限りないしねそりゃ全消しするわそりゃ全消しする正しい

いやでもありがとうございます今の勉強になりましたちょっと他のフレームワークも気になるところですがサクッと入れるやつがなくて実はえ?あのGitHubのリポジトリのやつがそのまま来てるわけじゃないのかな違うか全部嘘言ったかもしれないもしかしてうんやっぱさっき言ったやつあってましたあってました?はいまあじゃあ消して叱るべきですねはいまあというので意外にリードミー各範囲狭いぞというところでちゃんと

まあ、ReadMeに書くべきことはReadMeドキュメントに書くべきことはドキュメントっていう風にすることでまあ、見る側も探しやすくなりますしまあ、ちょっとこの常識がどこまで広がってるか次第ですけど使う側もね、情報を探しやすくなると思うので

分かれてた方がこの量なら書けそうですそうですねはいっていうのでなんかこれで書くこと少ねーよって言われたらでもリードミーチェックリスト結構これディファクトスタンダードだと思うんですけどここにこういう風に書いてますけど何かあって腹立つ腹立つはい言えるような大人になっちゃダメですよはいハレーションは少なくいきましょうそうですねはいというのでちょっと今日はリードミーチェックリストを紹介しましたありがとうございますはい

時間がちょっと余ってるのでお便りいきますラジオネームほうれん草ボンバーさんほうれん草ボンバーさんありがとうございますざっとメール読みます読まれたら2回目です初回からポッドキャスト欠かさずに拝聴しております初回からすごいこの度ひまじんプログラマーのおかげで転職することができましたおめでたいっすねほんまかいな

そんなに効果あります?これなんか彼女できる人ができるのも近いんじゃないですかマジで?ありえるなそんなにうさんくささありますよ確かにな神社と同じじゃんほぼ続きいきますねえー

95話フロントエンジニアのためのAWSいろはで私の投稿を取り上げていただいた話を面接でしたところ面接官と技術系ポッドキャストの話で盛り上がり採用に至りましたなるほど某有名ポッドキャスト番組で取り上げられたんですよって言ったってことですかどうだったろうね有名かわからんすけどね

いやでもポッドキャストの話で盛り上がるのはそれはそれで良かったと思うんですけど確かにね別に採用に至ったのはそれじゃないですね間違いないよね他の実力だと思います面接官の方はモザイクFMというウェブエンジニア向けのポッドキャストを聞いてました一時期あれですよねポッドキャストアワードとかに入って

はいはいそこでじゅんぺいさんのりさんかいちさんは技術系ポッドキャストで聞いてる番組はありますでしょうかおすすめのポッドキャストラジオ番組があれば紹介してほしいですはい

なるほどはいまずじゅんぺいは聞いてませんはいじゅんぺいは聞いてなかったらしいです僕は先週聞いたらなんか聞いてないって言ってたのでちょっとカイチとノリでお話しちゃいますそうですねじゅんぺい君はずっとダンスの曲ばっか聞いてるちょっとわかんねえそれはそれはどうかわかんないけどモザイクFMね僕もちょっと聞いたことはあるんですけど今は聞いてないんですよね同じくなんですよすごいな120回もやってるんだ

120回やってますねモザイクFMもあれ1本1本結構長いやつだよねさほどいやーちょっと見ましょうどういうのだったかあんま覚えてないんですよね長い長いわ長いよね僕長い系のやつダメなんですよねわかるちょっと1時間超えると重くなってわかるー

はいっていうのでじゃあなんか山でもいいポッドキャストらしいので気になる方聞いてみてくださいわかりましたディスるのは良くないですよそうですね別にディスってもないんですけどなんならちょっとあまり聞けてないのでよくわかってません

はいじゃあちょっとおすすめポッドゲストの話しましょうかはいどうしようかな僕からでいいですかなんか僕の方が浅そうなんでお願いしますはいじゃあ3つはい僕聞いてるのは技術系で聞いてるの3つですはい1つ目が早速技術系がちょっと際どいかもしれませんがゆるコンピューター学ラジオですねあー僕もですはいはいこれあのテクノロジーランキングでもう堂々の1位ですねぶっちぎってますねいやぶっちぎだよねこれまじでゆるコンピューターはぶっちぎですねうーん

さっくり言うと比較的技術者じゃない人に向けてるのかなに向けてコンピューター科学って言ってますけどどっちかというとエンジニアリング的な内容が多い話をどんどんしてますね例えばで言うとGoogle検索じゃないなネットワークの仕組みの話とか直近はAIですねAIの歴史とか仕組みとか

あと異人系の話ですね面白おかしくそこがポイントですよね僕らも結構面白おかしく話そうとしてるんですけど彼らが多分トップオブエンタメですねというので非常に楽しく聞いてます2つ目がこれも被ると思ったんですけど深堀FMですね深堀FMはなんていうんだ

オーガナイザーじゃないいわしさんですかねいわしさんがやってるポッドキャストで内容としては業界とか技術系のスペシャリストみたいな人を呼んできてその人が話すお話に対していわしさんが

モデレーターとして話を深掘りして結構ディープな内容が聞けるというかそうですねものすごく情報密度の高いそうだね全くついていけない時とかあるもんありますねうん

全くついていけない時もあるけど知らないことだけどついていける時もあるよねわかりやすいみたいなその質問したかったわみたいなそうなんですよねモデレーターの質問力の高さを感じますよね個人的には一番情報密度の高いポッドキャストだと思ってます質が高いですねとにかくたまにというか今まで

直近含め2回ぐらい多分英語のエピソードがあるんですけど個人的には英語のエピソード海外のエンジニアの人と話すやつあったあったあった個人的にはギリギリ聞き取れるギリギリのラインですごい嬉しいです英語力の成長がそうそうこれならギリギリ聞けるなっていうレベルなんですよ俺的には

英語のオーディオブックなんて聞けないし全然別のケビンズイングリッシュルームの英語のポッドキャストの僕は聞けませんけど深堀FMの英語エピソードはギリ聞けるんですよでもわかるかもしれないすごくゆっくり簡単な単語で話してくれるしあとウェブ系というかエンジニアリング系なので知ってる技術用語もいっぱい出てくるんでそれで保管して話聞けるしっていうので楽しく聞いてますはい

3つ目これは被んないと思っててEMFMです被ってるかいEMFMは僕も聞いてますEMFM面白いなと思っててこれはエンジニアリングマネージャーやってる3名の方が雑談というか気になってるトピックについて話してるポッドキャストですかね更新頻度もそんなに高くないんですけど

わかるっていう話をしててマネージャー層の悩みなのかもしれないですがすごい共感できたりとかあとは結構エンジニアリングとして結構キャリアを積まれてる3人がお話ししてるので洞察とか普通に勉強になるなと思って聞いてます広木さんとかってあれですよねエンジニアリング組織論への正体書いてる人ですよねそうなんですかガチモンですねガチモンマネージャーですねはい

エンジニアリング組織論の正体かあの人が言ってるそのいろんなモチベーションの話とかワンオンワンの話とかそれ系がすごい刺さるなと思って分かる刺さるっていうのがカイチ以上ですなるほどじゃあ僕今出たやつから外していきます1個目はですね

ちょっとこれ更新頻度めちゃめちゃ少ないんですけどテクスタFMあーテクスタFMはいはいはい更新頻度が少なすぎて聞いてる気持ちにもなってないんですけど公開されたやつは全部聞いてますあんまり聞かないですよねこれはT和田さんが出てるやつでピクスターの会社のなんかテックリードの人と和田さんがワンオンワンしてるみたいな

すごいですねワンオンワンを公開してるみたいな感じでやってるっぽいんですよ確かはいはいはいはいなんですけどその内容が結構オブジェクト思考というか実際のコードにすごい寄っててへー僕が結構興味ある分野のところなので僕はこれ毎回欠かさず聞きますねなるほどそれはちょっと興味引かれるな面白かったのはなんかあのなんだっけなデザインパターンデザインパターン23個だか21個だかちょっと忘れたんですけど23個あって

そっから20年経ってどう?みたいな話をそのゴフの人たちが集まってしてるみたいな記事の感想の回とかね僕好きですねそれは気になるなそんなのあるんだ今使われてないパターンはどれ?みたいな話とかしてて結構そのT和田さんがね歴史と絡めて話してくれるんで面白いですねそうなんですねへー聞いてみよう聞いてみよう

ちょっとこれ技術系に入れるかギリギリ悩むんですけどレイヤーXナウって聞いてますねランキング上がってるの見るなテクノロジーに入ってるあれそこまでもあんま見てないんですけどレイヤーXっていう結構イケてるベンチャー企業の

あと3つ目ミスリーディングチャット

全く知らん全く知らない全く知らないこれはですねコンピューターサイエンス系の論文を解説するっていううわーむずそうやつ背伸びして聞いてますこれ面白いですね面白いというか消化できるんですか?消化できないことも結構多いですいやーすごいなー多いんですけどこうなりたいなーって思いながら聞いてます114話まで

すげー多分このポッドキャスト番組を運用するってなったらすごいエネルギーいるんだろうなと思いながら聞いてますね確かに聞いてますねのりさんやっぱりですねありがとうございますこの辺ですかね全部聞くのはさすがに苦しいので気になったのがあればねテクスター気になるなテクスター聞きやすいですよすごいなこれこの

ミスリーディングチャットミスリーディングチャットすごいネタ困んないだろうなそうだねネタ困んないけど大変だよね本当にもう普段から読んでる人なら大変じゃないんだろうけどちょっと今からこういう番組やろうって言ったら死んじゃう死んじゃいますねすげーわすげーはいありがとうございますはいこれで聞いてる方々の視聴が分散してしまうのは大変に

確かに嫌な気持ちになるんですがまあでもしょうがないねそれはそれでね他のポッドキャストを聞いてそっちの方がおもろいやんってなったら自然とおたなのでそうですね僕らの努力が足りないだけでございますそうですね逆にこうやって自分たちを追い込むことによって強くなるみたいな筋トレみたいなもんですからね確かに

気になったらぜひ聞いてもらって面白いポッドキャストも世の中いっぱいあるのでポッドキャストおもろいらしいぞって周りのポッドキャスト聞いてない奴らに広めてもらったらね多分ウィンなんで市場がでかくなれば勝ちなんで本当にすごいよな論文論文やばいねしかもある程度この人たちが解釈してくれるんで

たぶん論文読むよりは深く軽いんじゃないかなって思いますまあ確かにはいさすがに話してるってことは伝える気持ちは持って話してるんでしょうかねうん多少コメントによると結構わかりやすいらしいですよはははははわかってないやんはははははそういうもんですねちょっとまたついていけないですねというのであのーじゃあひまじんプログラマーを聞いて転職ができましたとかはい

恋人ができましたとか大金持ちになりましたとか子供を授かりましたとかありましたらぜひお便りお待ちしてますのでお願いいたしますでは最後に宣伝でハッシュタグひまじんプログラマーひまじんは

ひらがなプログラマーはカタカナプログラマーはカタカナツイートしていただけますとフィードバックいただけますと僕らのポッドキャストの改善にもなりますし聞いている人本当にいるんだなっていうのを知れて僕らのモチベーションアップになりますのでぜひお願いしますお願いしますGoogleフォームの方でも質問とか何でもかんでも受け付けてますのでそちらも気軽に送っていただけると非常に嬉しいですお願いします話題には困ってないんですけどね本当かな本当かなはい

はいっていうので今週のポッドキャスト終わりますありがとうございましたまた次回バイ

ひまじんプログラマーの週末エンジニアリングレッスン各種ポッドキャストで配信中