Convenciones para marcadores de posición de secretos

Usa marcadores de posición que sean legibles para las personas, pero que no se parezcan a secretos reales.

Estilo recomendado

• Prefiere valores descriptivos como example-openai-key-not-real o example-discord-bot-token.
• Para fragmentos de shell, prefiere ${OPENAI_API_KEY} en lugar de cadenas insertadas directamente que parezcan tokens.
• Asegúrate de que los ejemplos sean evidentemente falsos y estén delimitados según su propósito (proveedor, canal, tipo de autenticación).

Evita estos patrones en la documentación

• Texto literal del encabezado o pie de una clave privada PEM.
• Prefijos que se parezcan a credenciales activas, por ejemplo, sk-..., xoxb-..., AKIA....
• Tokens de portador de aspecto realista copiados de los registros de ejecución.

Ejemplo

# Buenoexport OPENAI_API_KEY="example-openai-key-not-real" # Mejor (cuando el documento trata sobre la configuración de variables de entorno)export OPENAI_API_KEY="${OPENAI_API_KEY}"