社内のレガシーコードの作り換えを行うことになったのですが、プロジェクト名がXXX0001A
といった機械的な名称で驚きました。
これじゃ、何が何だか分からん。
とはいえ、レガシーコードの脱却の悩ましいところは、ドラスティックに変えられなかったりする点にあります。
とりあえず、README.mdファイルでこのプロジェクトが何のモジュールであるかを記述しようと考えました。
何か参考になるものないかなと調べたところ、以下が良さげでした。
プロジェクト名 === ## 項目1 説明 ## 項目2 説明