より良いエンジニアを目指して

1日1つ。良くなる!上手くなる!

プロジェクトの説明としてREADME.mdの書き方を考えた

社内のレガシーコードの作り換えを行うことになったのですが、プロジェクト名がXXX0001Aといった機械的な名称で驚きました。

これじゃ、何が何だか分からん。

とはいえ、レガシーコードの脱却の悩ましいところは、ドラスティックに変えられなかったりする点にあります。

とりあえず、README.mdファイルでこのプロジェクトが何のモジュールであるかを記述しようと考えました。

何か参考になるものないかなと調べたところ、以下が良さげでした。

deeeet.com

プロジェクト名
===

## 項目1

説明

## 項目2

説明

f:id:rimever:20201118193626p:plain