READMEを書かないと…

  • 他プロジェクトでも参考になるものかどうかがソースを見ないと分からない
  • プロジェクトを引き継いだけどビルドの仕方が分からない
  • 案件の開発以外の情報がどこに記載されているか分からない
  • そもそもセットアップ方式が分からない

記載する内容

はじめに

初めは案件の概要や、開発以外の情報が記載されているbacklogへのリンクを記述する。 また、プロジェクトの構成と依存関係を記載すると良い。

パッケージ構成

プロジェクトの配下にあるパッケージ構成を記載し、どんなパッケージごとの役割があるのか記載する。 どのクラスをどこに配置すれば良いか迷わなくなったり、知らない間にパッケージ構成がカオスになることを避けられる。

開発環境

どんなアーキテクチャを使って開発しているか分かるように、バージョンと用途を記載する。これを記載しておけばどんな技術を使っているのか把握しやすくなる。

ローカル環境構築手順

ローカル環境の構築手順は必ず記載する。 ボリュームが多くなりがちになるので、細かなことはwikiに記載する。

起動方法

ローカル環境を構築できても、起動の仕方に苦戦するので、デバッグする時の手順と合わせて記載する。

その他開発情報

案件のメンバーに応じて、開発に必要な情報をまとめておく。

  • 開発方針とコーディング規約
  • ブランチの管理と開発の流れ など。