GitのリポジトリにはREADME.mdがありますよね。

あれって何を書いたらいいか迷いますよね。

READMEに書くこと。

結論、LittlePocket.Lab的には、必要最低限の実行手順のみ記述するようにしています。

具体的には以下の４つです。

1. プロジェクトの概要を簡潔に。
2. ビルドの手順（環境構築）
3. テストの手順（テストの実行方法）
4. デプロイ手順（デプロイの仕組みや実行方法）

READMEに書かないこと。

1. プロジェクト固有の事情
2. コードのTips
3. その他ドキュメント

なぜ最低限しか書かないの？

README.mdを頻繁に更新しようとするとレビューの際にREADME.mdまで対象になってしまうからです。

なので、Git管理するREADME.mdにはプロジェクトで必須の情報だけ記述し、その他のドキュメントは別のツールで管理するようにしています。

最悪、ドキュメントが失われても実行手順さえわかればリカバリーできますからね。

その逆はかなり大変です。