Cómo documentar variables de entorno sin revelar secretos.
Documenta nombres, propósito y valores por defecto sin revelar secretos reales. Identifica si una variable es obligatoria y dónde se lee.
Adapta el flujo de trabajo a tu tarea.
Inventaría los nombres y dónde los lee la aplicación, registrando propósito, obligatoriedad y ejemplos seguros. Distingue un valor por defecto explícito de un supuesto y excluye los secretos reales de la documentación.
- Qué aportas
- Nombres de configuración sin datos sensibles y comportamiento previsto.
- Qué obtienes
- Referencia de configuración sin valores secretos.
Mira la entrada y el resultado.
Entrada y salida ilustrativas · ejemplo didáctico, no una ejecución de WebAct en directo
Ejemplo campo
Document APP_PORT (listening port) and SMTP_PASSWORD (mail service credential). Defaults, requiredness and code locations have not been supplied.
Ejemplo completo
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.
Carga esta entrada en el prompt y cópialo en WebAct para probar la tarea. Tu resultado puede diferir del ejemplo.
Decisiones y solución de problemas.
¿Debe la documentación de configuración secreta incluir una credencial funcional?
Usa un marcador y explica la forma aprobada de proporcionarla. La documentación debe identificar el requisito sin revelar el secreto.
¿Por qué la guía describe un valor por defecto que la aplicación no usa?
Sigue la variable hasta su punto de lectura o la configuración aportada. Señala lo desconocido en lugar de adivinar por el nombre.
Pruébalo con tu propia fuente.
Sustituye el ejemplo por tu material en el prompt. Conserva los requisitos que necesites y copia la tarea en WebAct.
Personalizar y copiar la tarea ↑