​

Соглашения об обозначениях секретов-заполнителей

​

Рекомендуемый стиль

• Отдавайте предпочтение описательным значениям, таким как example-openai-key-not-real или example-discord-bot-token.
• В примерах команд оболочки используйте ${OPENAI_API_KEY} вместо встроенных строк, похожих на токены.
• Примеры должны быть заведомо вымышленными и соответствовать назначению (провайдер, канал, тип аутентификации).

​

Избегайте этих шаблонов в документации

• Буквальный текст заголовка или окончания закрытого ключа PEM.
• Префиксы, похожие на действующие учётные данные, например sk-..., xoxb-..., AKIA....
• Реалистично выглядящие bearer-токены, скопированные из журналов среды выполнения.

​

Пример

# Хорошо
export OPENAI_API_KEY="example-openai-key-not-real"

# Лучше (когда документация посвящена настройке переменных окружения)
export OPENAI_API_KEY="${OPENAI_API_KEY}"