​

Convenzioni per i segnaposto dei segreti

​

Stile consigliato

• Preferisci valori descrittivi come example-openai-key-not-real o example-discord-bot-token.
• Per i frammenti di shell, preferisci ${OPENAI_API_KEY} alle stringhe simili a token inserite direttamente.
• Mantieni gli esempi palesemente fittizi e limitati allo scopo previsto (provider, canale, tipo di autenticazione).

​

Schemi da evitare nella documentazione

• Testo letterale dell’intestazione o del piè di pagina di una chiave privata PEM.
• Prefissi che assomigliano a credenziali attive, ad esempio sk-..., xoxb-..., AKIA....
• Token bearer dall’aspetto realistico copiati dai log di runtime.

​

Esempio

# Buono
export OPENAI_API_KEY="example-openai-key-not-real"

# Migliore (quando il documento riguarda il collegamento delle variabili di ambiente)
export OPENAI_API_KEY="${OPENAI_API_KEY}"