ZIPで納品するときの中身と構成｜README・バージョン・不要ファイルを整理する

成果物をZIPで渡すとき、中身が正しくても「どれを開けばいいか分からない」と納品品質は下がります。

受け手が最初の30秒で理解できる構成にしておくと、質問の往復も減ります。

ZIP直下を散らかさない

悪い例は、ZIPを開いた瞬間に20個のファイルが並ぶ状態です。

できれば、1つのルートフォルダーを置き、その中を整理します。

ProjectName_v1.0/
  README.md
  app/
  docs/
  samples/

READMEを入口にする

READMEには、

• これは何か
• 最初に何を開くか
• 動作条件
• 基本操作
• フォルダー説明
• 既知の制限

を短く書きます。

説明を複数ファイルへ散らすより、「まずREADME」が明確な方が使いやすくなります。

バージョンを揃える

ZIP名、フォルダー名、README内の版番号をそろえます。

例：

CSVTool_v1.2.zip

中のフォルダーも、

CSVTool_v1.2/

READMEも、

Version: 1.2

と一致させます。

不要ファイルを入れない

開発時に必要でも、納品には不要なものがあります。

• 一時ファイル
• キャッシュ
• バックアップ
• エディタ設定
• デバッグログ
• テスト出力
• 古い版
• .env

特に秘密情報を含む設定ファイルは注意します。

相対パスを確認する

HTML、アプリ、スクリプト、Excel外部リンクなどは、自分のPCの絶対パスを参照していないか確認します。

別のPCへ展開して動くことが理想です。

再展開テストをする

完成したZIPを、元フォルダーとは別の場所へ展開します。

そこでREADMEから順に操作して、

• 起動できる
• ファイルが見つかる
• サンプルが開ける
• 説明どおり動く

ことを確認します。

ZIP納品の品質は、「圧縮できたか」ではなく、受け手が迷わず再現できるかで決まります。