Skip to main content

Env Variable Documentation

Document environment variables with descriptions, defaults, validation rules, and examples

Template Fields

Project / Service NametextRequired

e.g., payment-service, My SaaS app, API gateway

Environment VariablesmultilineRequired

List your env vars, e.g.: DATABASE_URL REDIS_URL STRIPE_SECRET_KEY NEXT_PUBLIC_API_URL LOG_LEVEL

ScopeselectRequired
Full .env documentationNew variables onlySecurity-sensitive varsPublic/client-side vars
Output Formatselect
.env.example file with commentsMarkdown tableREADME sectionAll formats
Deployment Environmentsmultiselect
Local developmentCI/CDStagingProduction
Use This Template

Related Templates

Bug Report

Write a clear, actionable bug report that developers can act on immediately

README Generator

Create a professional README.md for any project or repository

API Endpoint Documentation

Document an API endpoint with request/response examples

Git Commit Message

Write clear, conventional commit messages with proper scope and description