Konvensi placeholder rahasia

Gunakan placeholder yang mudah dibaca manusia, tetapi tidak menyerupai rahasia asli.

Gaya yang disarankan

• Utamakan nilai deskriptif seperti example-openai-key-not-real atau example-discord-bot-token.
• Untuk cuplikan shell, utamakan ${OPENAI_API_KEY} daripada string menyerupai token yang ditulis langsung.
• Pastikan contoh tampak jelas palsu dan dibatasi sesuai tujuan (penyedia, saluran, jenis autentikasi).

Hindari pola ini dalam dokumentasi

• Teks harfiah header atau footer kunci privat PEM.
• Prefiks yang menyerupai kredensial aktif, misalnya sk-..., xoxb-..., AKIA....
• Token bearer yang tampak realistis dan disalin dari log runtime.

Contoh

# Baikexport OPENAI_API_KEY="example-openai-key-not-real" # Lebih baik (ketika dokumentasi membahas pengaturan variabel lingkungan)export OPENAI_API_KEY="${OPENAI_API_KEY}"