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

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

README.mdの重要性とcsプロジェクトの棚卸

訳あって、職場のC#のプロジェクト(csproj)の棚卸をすることになりました。

要は使われていないプログラムを確認して削除する作業です。

私のチームは、自分含めて2人なので、さほど大きな規模ではありません。

削除すると言ったって1つか2つだろうと整理を進めていました。

が、驚くことに15を超える数のプロジェクトを削除することになりました。

ほとんどが実際にユーザーが使うものではなく

  • もう使われなくなったツール
  • 他のツールに機能が統合されたツール
  • 新しいプロジェクトを開発する以前に試作したプロトタイプ
  • 遊び(!?)で開発してみたツール
  • 開発中止となったアプリケーション

です。

私が開発して結局削除したプロジェクトはツールが多いです。

今の職場に入ってからかれこれ4年となりますが、来て早々プロジェクトの棚卸をして使われていないものをガシガシ削除したのも私です。

削除されるようなものを生み出してしまったのも私自身なのだなあと。

f:id:rimever:20190325202041p:plain
こんな気分

悲しいと言うよりは、振り返って思ったより色々なことに挑戦させてもらったと言うこの職場に対する感謝の気持ちを素直に覚えたものです。

職場が職場だったら、勝手なことor余計なことをしなくていいとバッサリ咎められるでしょうし。

また、気付かされるのは、「このプロジェクト、何だっけ」とならないようにプロジェクトのテキストファイルを残しておくことの重要性です。

最悪コミットログから辿ればいいのですが、こうしたテキストファイルがあると助かります。

最近はGitHubの流れが強いので、職場でGitHubを使っている訳ではないのですがREADME.mdとして追加しました。

README.mdの正しい書き方って何だろう?と下記などを読んだのですが、プロジェクトの説明としては、もっと軽いものでいいかなと思い、簡単な内容にしました。

GitHub - matiassingers/awesome-readme: A curated list of awesome READMEs

とはいえ、今後はプロジェクトを新規作成したら、README.mdを追加する癖をつけた方がいいかな。

かわいいフリー素材集 いらすとやの素材を利用させていただきました。