背景

新しい技術を使う際に、SEには「検証活動」が常に付いて回る。
新人時代には、検証活動を行う際にフォルダ構成が雑で、上司によく怒られた。
そんなわけで、私が検証活動を行う際にフォルダ構成構築で心掛けていることをまとめておく。

気を付けるべきこと

入力データと出力データは全てファイル化して残す

当たり前のようだが、新人の時は意外と忘れがちだった。
残せるものなら実行時のログも残しておくと良い。

検証1回あたりでフォルダを切る

もし各検証で共通的に使用するファイルがあったとしても、各回のフォルダにそれぞれ格納しておくべきだろう。
なぜならそれが検証に使用したファイルの「証拠」となるからだ。

例えば以下のようなフォルダ構成にしておくと良い。

├ 検証1
|    ├ input
|    │   ├ input_file_A
|    │   └ input_file_Common
|    └ output
|        ├ output_file_A
|        └ output_file_B
|    
└ 検証2
    ├ input
    │   ├ input_file_B
    │   └ input_file_Common
    └ output
        ├ output_file_C
        └ output_file_D

検証1と検証2ではinput_file_Commonという共通のファイルを使用している。この場合、各検証ごとに格納しておく方が第三者から見てわかりやすいだろう。

今後も見つければ追記予定です。