Conventions relatives aux espaces réservés pour les secrets

Utilisez des espaces réservés lisibles par l’utilisateur, mais qui ne ressemblent pas à de véritables secrets.

Style recommandé

• Privilégiez des valeurs descriptives comme example-openai-key-not-real ou example-discord-bot-token.
• Pour les extraits de commandes shell, préférez ${OPENAI_API_KEY} aux chaînes intégrées ressemblant à des jetons.
• Veillez à ce que les exemples soient manifestement fictifs et adaptés à leur objectif (fournisseur, canal, type d’authentification).

Motifs à éviter dans la documentation

• Texte littéral d’en-tête ou de pied de page d’une clé privée PEM.
• Préfixes ressemblant à des identifiants réels, par exemple sk-..., xoxb-..., AKIA....
• Jetons porteurs d’apparence réaliste copiés depuis les journaux d’exécution.

Exemple

# Bonexport OPENAI_API_KEY="example-openai-key-not-real" # Mieux (lorsque la documentation porte sur la configuration des variables d’environnement)export OPENAI_API_KEY="${OPENAI_API_KEY}"