READMEでの環境変数のドキュメント

環境変数のドキュメント

適切な環境変数のドキュメントは、何時間ものデバッグとSlackメッセージを防ぎます。環境変数を使用するすべてのアプリケーションは、READMEでそれらを明確に文書化する必要があります。

.env.exampleパターン

リポジトリに.env.exampleファイルを含め（gitにコミット）、READMEで参照します。

変数ドキュメントテーブル

明確でスキャン可能なドキュメントにテーブルを使用します：

変数	必須	デフォルト	説明
DATABASE_URL	はい	-	PostgreSQL接続文字列
REDIS_URL	いいえ	redis://localhost:6379	キャッシュ用Redis接続
PORT	いいえ	3000	サーバーポート

カテゴリ別にグループ化

多くの変数を持つアプリケーションの場合、グループ化します。

シークレット処理ガイダンス

> **重要**: 実際の認証情報を含む`.env`ファイルをgitにコミットしないでください。
> 本番環境にはシークレットマネージャーを使用してください。

環境ごとの違い

変数が環境によって変わる場合、文書化します。