密钥占位符约定

使用便于人类阅读、但不会与真实密钥相似的占位符。

推荐风格

• 优先使用 example-openai-key-not-real 或 example-discord-bot-token 之类的描述性值。
• 对于 shell 代码片段，优先使用 ${OPENAI_API_KEY}，而不是内联的类似令牌的字符串。
• 确保示例明显为虚构内容，并限定于具体用途（提供商、渠道、身份验证类型）。

文档中应避免这些模式

• 字面形式的 PEM 私钥标头或页脚文本。
• 与真实凭据相似的前缀，例如 sk-...、xoxb-...、AKIA...。
• 从运行时日志复制的、看起来真实的持有者令牌。

示例

# 良好export OPENAI_API_KEY="example-openai-key-not-real" # 更好（当文档介绍环境变量接线时）export OPENAI_API_KEY="${OPENAI_API_KEY}"