---
read_when:
    - نوشتن مستنداتی که شامل توکن‌ها، کلیدهای API یا قطعه‌های اطلاعات اعتبارسنجی هستند
    - به‌روزرسانی مثال‌هایی که ممکن است توسط ابزارهای تشخیص اسرار اسکن شوند
summary: قراردادهای جای‌نگهدار ایمن در برابر اسکنر اسرار برای مستندات و نمونه‌ها
title: قراردادهای جای‌نگهدار اطلاعات محرمانه
x-i18n:
    generated_at: "2026-07-27T16:10:25Z"
    model: gpt-5.6
    postprocess_version: locale-links-v1
    prompt_version: 32
    provider: openai
    source_hash: 0864f0fcc6fb1e4a3147b4b2ce0aac475437a19d694f3d059374782428c7f248
    source_path: reference/secret-placeholder-conventions.md
    workflow: 16
---

# قراردادهای جای‌نگهدار راز

از جای‌نگهدارهایی استفاده کنید که برای انسان خوانا باشند، اما به رازهای واقعی شباهت نداشته باشند.

## سبک توصیه‌شده

- مقادیر توصیفی مانند `example-openai-key-not-real` یا `example-discord-bot-token` را ترجیح دهید.
- برای قطعه‌کدهای شل، `${OPENAI_API_KEY}` را به رشته‌های درون‌خطی شبیه توکن ترجیح دهید.
- مثال‌ها را به‌وضوح جعلی و محدود به هدف (ارائه‌دهنده، کانال، نوع احراز هویت) نگه دارید.

## از این الگوها در مستندات اجتناب کنید

- متن تحت‌اللفظی سرآیند یا پابرگ کلید خصوصی PEM.
- پیشوندهایی که به اعتبارنامه‌های فعال شباهت دارند، برای مثال `sk-...`، `xoxb-...`، `AKIA...`.
- توکن‌های حامل با ظاهر واقعی که از گزارش‌های زمان اجرا کپی شده‌اند.

## مثال

```bash
# خوب
export OPENAI_API_KEY="example-openai-key-not-real"

# بهتر (وقتی مستند درباره اتصال متغیرهای محیطی است)
export OPENAI_API_KEY="${OPENAI_API_KEY}"
```