エンジニア必須知識!?みんなから好かれるREADME.mdの作り方
こんにちは。エンジニアの山田です。みなさん、READMEを書いたことがありますでしょうか。エンジニアの方なら一度は見たことがあると思います。README(リードミー)とは?説明書であり『まず最初に読んでほしいドキュメント』です。READ(読んで!) ME(私を!)ですので、READMEファイルがあるプロジェクトはぜひ読むようにしましょう。READMEは書き手によって精度がまちまちですが、わかりやすく、見やすいREADMEはメンバーから好かれ、ありがたがられます。そして共通認識を持つことで開発・改修がしやすくなります。今回はそんなREADMEの作り方のポイントを紹介していきます!ポイント1...
Chat with the team