Documenter les variables d’environnement sans révéler de secrets.
Documentez noms, rôle et valeurs par défaut sans révéler de vrais secrets. Indiquez si une variable est obligatoire et où elle est lue.
Adaptez le processus à votre tâche.
Inventoriez les noms et leurs points de lecture dans l’application, avec rôle, caractère obligatoire et exemples sûrs. Distinguez valeur par défaut explicite et hypothèse et excluez les vrais secrets de la documentation.
- Ce que vous fournissez
- Noms de configuration sans données sensibles et comportement prévu.
- Ce que vous obtenez
- Référence de configuration sans valeurs secrètes.
Consultez les données et le résultat.
Entrée et sortie illustratives · exemple pédagogique, pas une exécution WebAct en direct
Exemple champ
Document APP_PORT (listening port) and SMTP_PASSWORD (mail service credential). Defaults, requiredness and code locations have not been supplied.
Exemple complet
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.
Chargez ces données dans le prompt, puis copiez-le dans WebAct pour essayer la tâche. Votre résultat peut différer de l'illustration.
Décisions et dépannage.
La documentation des secrets doit-elle inclure un identifiant fonctionnel ?
Utilisez un espace réservé et expliquez la méthode approuvée pour le fournir. La documentation doit préciser l’exigence sans exposer le secret.
Pourquoi le guide décrit-il une valeur par défaut inutilisée par l’application ?
Suivez la variable jusqu’au point de lecture ou à la configuration fournie. Marquez le comportement inconnu plutôt que de le deviner depuis le nom.
Essayez avec votre propre source.
Remplacez l'exemple par vos données dans le prompt. Gardez les exigences nécessaires, puis copiez la tâche dans WebAct.
Personnaliser et copier la tâche ↑