密钥占位符约定¶

使用人类可读但不类似真实密钥的占位符。

推荐风格¶

• 优先使用描述性值，例如 example-openai-key-not-real 或 example-discord-bot-token。
• 对于 shell 代码片段，优先使用 ${OPENAI_API_KEY}，而不是内联的类似 token 的字符串。
• 保持示例明显为假，并限定于用途范围（提供商、渠道、认证类型）。

在文档中避免这些模式¶

• 字面的 PEM 私钥头部或尾部文本。
• 类似有效凭据的前缀，例如 sk-...、xoxb-...、AKIA...。
• 从运行时日志中复制的、看起来真实的 bearer token。

示例¶

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

# Better (when the doc is about env wiring)
export OPENAI_API_KEY="${OPENAI_API_KEY}"