How to use the Environment Variable Documentation Generator.
Document configuration names, purpose and defaults without exposing actual secrets. Identify whether a variable is required and where it is read.
Make the workflow fit your task.
Inventory variable names and where the application reads them, recording purpose, required status and safe examples. Distinguish an explicit default from an assumption and keep actual secret values out of the documentation.
- What you provide
- Sanitized configuration names and intended behavior.
- What you get
- Configuration reference without secret values.
See the input and the result.
Illustrative input and output · a teaching example, not a live WebAct run
Example input
Document APP_PORT (listening port) and SMTP_PASSWORD (mail service credential). Defaults, requiredness and code locations have not been supplied.
Completed example
APP_PORT Purpose: port on which the application listens. Example: 3000 (illustrative, not a confirmed default). Default / required / code location: confirm from the application. SMTP_PASSWORD Purpose: credential for the configured mail service. Example value: <set-through-secret-configuration>. Default / required / code location: confirm from the mail integration. Keep the real credential out of shared examples and version control.
Load this input into the prompt, then copy it to WebAct to try the task. Your result may differ from the illustration.
Decisions and troubleshooting.
Should secret configuration documentation include a working credential?
Use a placeholder and explain the approved way to supply it. The documentation should identify the requirement without exposing the secret.
Why does the guide describe a default the application does not use?
Trace the variable to its read site or supplied configuration. Mark unknown behavior rather than guessing from the variable name.
Try it with your own source.
Replace the example with your material in the task prompt. Keep the requirements you need, then copy the task into WebAct.
Customize and copy the task ↑