اصطلاحات العناصر النائبة للأسرار

استخدم عناصر نائبة يسهل على البشر قراءتها، لكنها لا تشبه الأسرار الحقيقية.

الأسلوب الموصى به

• فضّل القيم الوصفية مثل example-openai-key-not-real أو example-discord-bot-token.
• بالنسبة إلى مقتطفات الصدفة، فضّل ${OPENAI_API_KEY} على السلاسل المضمّنة التي تشبه الرموز المميزة.
• اجعل الأمثلة زائفة بوضوح ومحددة النطاق وفقًا للغرض (المزوّد، القناة، نوع المصادقة).

تجنّب هذه الأنماط في الوثائق

• نص الترويسة أو التذييل الحرفي لمفتاح PEM خاص.
• البادئات التي تشبه بيانات اعتماد فعّالة، مثل sk-... وxoxb-... وAKIA....
• رموز الحامل التي تبدو واقعية والمنسوخة من سجلات وقت التشغيل.

مثال

# جيدexport OPENAI_API_KEY="example-openai-key-not-real" # أفضل (عندما تتناول الوثيقة ربط متغيرات البيئة)export OPENAI_API_KEY="${OPENAI_API_KEY}"