​

Convenções para placeholders de segredos

​

Estilo recomendado

• Prefira valores descritivos como example-openai-key-not-real ou example-discord-bot-token.
• Em trechos de shell, prefira ${OPENAI_API_KEY} em vez de strings semelhantes a tokens inseridas diretamente.
• Mantenha os exemplos claramente fictícios e específicos para a finalidade (provedor, canal, tipo de autenticação).

​

Evite estes padrões na documentação

• Texto literal de cabeçalho ou rodapé de chave privada PEM.
• Prefixos semelhantes a credenciais reais, por exemplo, sk-..., xoxb-..., AKIA....
• Tokens de portador com aparência realista copiados de logs de execução.

​

Exemplo

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

# Melhor (quando a documentação trata da configuração de variáveis de ambiente)
export OPENAI_API_KEY="${OPENAI_API_KEY}"