(新人)エンジニアが開発しやすいREADMEの書き方

2023年6月28日に開催された「Findy×freee」さんのコラボイベントに登壇した「新人エンジニアが入っているプロジェクトにおけるREADMEの書き方」の登壇スライドです エンジニアが開発しやすい環境作りをする(Zenn)

[xKxAxKx]

これくらい書くべきというのはド正論だしその努力も多少なりともしているつもりなんだけれど、いかんせんメンテナンスが結構大変、という現実がある

[mas-higa]

こんなにしっかり書いてくれてたら嬉しいけど、これを維持するのは大変。ブランチ名 main に変えたけど表の中は master のままになってる。本当に大変。

[remonoil]

まっさらな状態から開発始めるとこまでは非エンジニアに教えるレベルで一挙手一投足書くべき。ここが一番つまずくので。次点でコードのどこから読み始めればいいか（≒エントリポイント）

[maid_h]

れどめ大事。

[snobsnog]

確かにこれくらい書いといてくれないと困ること多い。ところでなぜみんな無言ブクマなのか。

[ninjaripaipan]

コメントが一切見えないの怖い