اسٹائل گائیڈ
یہ اسٹائل گائیڈ آپ کو لغت کے سامعین، تعریف کی ساخت، تفصیل کی مطلوبہ سطح، اور ایک مستقل انداز کو برقرار رکھنے کے طریقے کو سمجھنے میں مدد کرے گی۔
Cloud Native Glossary CNCF ریپوزٹری کی ڈیفالٹ اسٹائل گائیڈ کی پیروی کرتی ہے۔ اس کے علاوہ، یہ مندرجہ ذیل قواعد پر عمل کرتی ہے:
- آسان، قابل رسائی زبان استعمال کریں، تکنیکی اصطلاحات اور بزبان الفاظ سے گریز کریں۔
- بول چال سے پرہیز کریں
- لغوی اور ٹھوس زبان استعمال کریں
- سکڑائو کو چھوڑ دیں
- غیر فعال آواز کا استعمال احتیاط سے کریں
- جملے کے بیانات کو مثبت شکل میں بنانے کی کوشش کریں
- اقتباسات کے باہر فجائیہ کے نشانات نہ لگائیں
- مبالغہ آرائی نہ کریں
- تکرار سے گریز کریں
- مختصر ہونے کی کوشش کریں
سامعین
یہ لغت ایک تکنیکی اور غیر تکنیکی سامعین کے لیے لکھی گئی ہے۔ براہ کرم یقینی بنائیں کہ تعریفیں آسان الفاظ میں بیان کی گئی ہیں اور تکنیکی علم کو فرض نہ کریں۔ مزید یہ کہ یہ کام ذیل میں تعریف کے تحت کریں۔
ڈیفینیشن ٹیمپلیٹ
ہر لغت کی اصطلاح مارک ڈاؤن فائل میں محفوظ ہوتی ہے اور اس سانچے کی پیروی کرتی ہے:
---
title:
status:
category:
---
## یہ کیا ہے
ٹیکنالوجی یا تصور کا فوری خلاصہ۔
## یہ کیا مسئلہ حل کرتا ہے
اس مسئلے کے بارے میں چند سطریں جس سے یہ خطاب کر رہا ہے۔
## یہ کس طرح مدد کرتا ہے
اس مسئلے کو کیسے حل کرتا ہے اس پر چند سطریں۔
Title
Title کا لیبل ہمیشہ تعریف کے لے آؤٹ کے اوپر ہوگا، اور اس کی قدر عنوان کے معاملے میں ہونی چاہیے۔
---
title: ڈیفینیشن ٹیمپلیٹ
Status
Status لیبل ٹائٹل لیبل کے بعد آئے گا۔ اسٹیٹس لیبل بتاتا ہے کہ آیا تعریفوں کی اچھی طرح جانچ کی گئی ہے یا مزید کوشش کی ضرورت ہے۔
درست اقدار ہیں
- Completed
- Feedback Appreciated
- Not Started
آپ ہمیشہ ایک مکمل تعریف کے خلاف مسئلہ کھول سکتے ہیں۔ جب کہ ایک تعریف بہاؤ میں ہے، اس کی حیثیت کو فیڈ بیک تعریف شدہ میں بدل دیا جائے گا۔
---
title: ڈیفینیشن ٹیمپلیٹ
status: Feedback Appreciated
Category
Category لیبل Status لیبل کے بعد آئے گا۔ اس کی قدر درج ذیل اقدار میں سے ایک ہونی چاہیے:
- ٹیکنالوجی
- صفت
- تصور
---
title: ڈیفینیشن ٹیمپلیٹ
status: Feedback Appreciated
category: تصور
---
تعریف
تین ذیلی عنوانات
ٹیکنالوجی اور تصور کے زمرے کی تعریفیں تین ذیلی عنوانات پر مشتمل ہیں:
- یہ کیا ہے: ہم جس کے بارے میں بات کر رہے ہیں اس کا ایک مختصر اور واضح جائزہ فراہم کرتا ہے۔
- یہ کون سا مسئلہ حل کرتا ہے۔: مسئلہ پر توجہ مرکوز کرتا ہے، حل پر نہیں (جو اگلے حصے میں آتا ہے)۔ درحقیقت اس اصطلاح کا ذکر کرنے سے گریز کریں جس کی تعریف کی گئی ہے۔ مسئلہ اس بات پر مرکوز ہے کہ *کس چیز کی وجہ سے ہمیں اس چیز کی ضرورت پڑی۔
- یہ کس طرح مدد کرتا ہے۔: اب، براہ کرم اصطلاح پر واپس آئیں۔ یہ اوپر بیان کردہ مسئلہ کو کیسے حل کرتا ہے؟
نوٹ کریں کہ صفت کو الگ سیکشنز کی ضرورت نہیں ہے۔ ایک تعریف کافی ہوگی۔
جائزے کی سہولت کے لیے، براہ کرم سمینٹک لائن بریکس (ایک جملہ فی لائن) استعمال کریں۔
معیار سب سے اہم ہے
اگر اسے ضم کر دیا جاتا ہے، تو آپ کا جمع کررہ کام اس اصطلاح کے لیے سرکاری سی این سی ایف تعریف ہو گی (جب تک کہ کوئی اور اسے بہتر نہ کر دے)۔سی این سی ایف کے اعلیٰ معیارات پر پورا اترنے والی اصطلاح بنانے میں جلدی نہیں کی جا سکتی — معیار میں وقت اور محنت درکار ہوتی ہے۔
تحقیق کریں۔: یہاں تک کہ اگر آپ کو یقین ہے کہ آپ اصطلاح کو جانتے ہیں، تو تصدیق کریں کہ آپ نے اسے صحیح سمجھا۔ ہم اکثر تنظیموں میں اصطلاحات کو ایک خاص طریقے سے استعمال کرتے ہیں جو شاید پوری تصویر کی عکاسی نہ کرے۔ جب آپ اپنی تحقیق کرتے ہیں، خاص طور پر جب آپ اس اصطلاح سے 100% واقف نہیں ہیں، متعدد وسائل استعمال کریں۔ بہت سی تعریفیں یک طرفہ ہوتی ہیں، خاص طور پر اگر کسی وینڈر کی طرف سے فراہم کی گئی ہو۔ لغت میں وینڈر غیر جانبدار، عالمی سطح پر قبول شدہ تعریفیں ہونی چاہئیں۔
نقل نہ کریں۔. وہی اصول لغت پر لاگو ہوتے ہیں جو کسی دوسری سنجیدہ اشاعت پر ہوتے ہیں۔ دوسرے لوگوں کے کام کو اس وقت تک کاپی اور پیسٹ نہ کریں جب تک کہ آپ اس کا حوالہ اور تعاون نہ کر رہے ہوں۔ اگر آپ کو تعریف کا کوئی خاص حصہ پسند ہے تو اسے اپنے الفاظ میں بیان کریں۔
مستند وسائل کا حوالہ دیں۔ جب ممکن ہو، مستند وسائل سے لنک کریں جیسے پروجیکٹ دستاویزات۔ نوٹ کریں کہ ہم وینڈرز کے تیار کردہ مواد سے لنک نہیں کر سکتے۔
اسے سادہ رکھنا
لغت کا مقصد پیچیدہ تصورات کو آسان الفاظ میں بیان کرنا — یہ ایک حیرت انگیز طور پر مشکل کام ہے جس میں ممکنہ طور پر متعدد نظرثانی کی ضرورت ہوگی۔ اپنی تعریف کا مسودہ تیار کرتے وقت سامعین کو ہمیشہ ذہن میں رکھیں۔ صنعت کی اصطلاحات اور بز ورڈز استعمال کرنے سے گریز کریں — آپ شاید خود کو ان کی طرف واپس جاتے ہوئے پکڑ لیں گے اور آپ کو خود بخود درست کرنے کی ضرورت پڑ سکتی ہے۔
جب مناسب ہو، حقیقی دنیا کی مثالیں استعمال کریں جو قارئین (خاص طور پر غیر تکنیکی) کو بہتر طور پر سمجھنے میں مدد کرتی ہیں کہ آپ جس تصور کی وضاحت کر رہے ہیں وہ کب اور کیوں متعلقہ ہے۔
جب آپ اسے اپنی تعریف میں استعمال کرتے ہیں تو ہمیشہ موجودہ لغت کی اصطلاحات سے لنک کریں (صرف پہلا ذکر ہائپر لنک ہونا چاہیے)۔
مثال: کے “یہ کیا ہے” سیکشن پر ایک نظر ڈالیں سروس میش تعریف. یہ مائیکرو سروسز، سروس، اعتبار، اور مشاہداتی تعریفوں سے منسلک ہے۔ مزید برآں، یہ مائیکرو سروسز ماحول میں نیٹ ورک کے چیلنجز کا موازنہ کرنے والی ایک حقیقی دنیا کی مثال استعمال کرتا ہے (ایسی چیز جس سے غیر تکنیکی لوگ تعلق نہیں رکھ سکتے) وائی فائی کے مسائل کے لیے (کچھ ایسی چیز جو لیپ ٹاپ استعمال کرنے والا سمجھ سکتا ہے)۔ جہاں ممکن ہو، اس تعلق کو بنانے کی کوشش کریں۔
Google یا Word دستاویز سے شروع کریں
ہم تجویز کرتے ہیں کہ Google یا Word دستاویز کے ساتھ شروع کریں، اسے کچھ دن بیٹھنے دیں، اور دوبارہ ملاحظہ کریں۔ یہ آپ کو ایسے جملے یا تاثرات کو پکڑنے کی اجازت دے گا جو آسان اور زیادہ قابل رسائی طریقے سے کہے جا سکتے ہیں۔ اس کے علاوہ، پروجیکٹ جمع کرانے سے پہلے اسپیل چیک کو یقینی بنائیں۔
اس بات کو یقینی بنانے کے لیے کہ کسی ٹرم پر کام کرتے ہوئے کوئی اور PR جمع نہ کرائے، اس بات کو یقینی بنائیں کہ کسی مسئلے کا دعوی کریں (یا ایک بنائیں) اور یہ آپ کو تفویض کیا گیا ہے۔ اس میں مزید کس طرح شراکت کرنا ہےدستاویز۔
شروع کرنے سے پہلے، براہ کرم شائع شدہ لغت کی کچھ اصطلاحات پڑھیں تفصیل اور مشکل کی سطح کا احساس حاصل کرنے کے لیے اور جب مثالیں مناسب ہوں۔
جائزہ لینے کا عمل: کیا توقع کی جائے
براہ کرم نوٹ کریں کہ ہم اس وقت صرف تین مینٹینرز ہیں جو اپنے فارغ وقت میں یہ کام کر رہے ہیں۔ کبھی کبھار، ہم شرائط کا فوری جائزہ لینے کے قابل ہو جائیں گے۔ دوسرے مواقع پر، اس میں کچھ وقت لگ سکتا ہے — ہم آپ کے صبر کی تعریف کرتے ہیں۔ اگرآپ کے کوئی سوالات ہیں، تو براہ کرم glossary# سلیک چینل میں ہم سے رابطہ کریں۔ (اسے کہاں اور کیسے تلاش کرنا ہے، براہ کرم ہم سے رجوع کریں کس طرح شراکت کرنا ہے دستاویز)۔
ہمارا مقصد لغت کو بہترین ممکنہ وسیلہ بنانا ہے۔ ایک بار جب آپ پی آر جمع کراتے ہیں، تو ہم ایک یا زیادہ نظرثانی کے لیے کہہ سکتے ہیں۔ مایوس نہ ہوں - یہ بہت سے پی آرز کا معاملہ ہے۔ وہ آگے پیچھے اور ہمارا تعاون اس بات کو یقینی بنائے گا کہ آپ کا تعاون واقعی ایک مفید تعریف بن جائے جسے پوری دنیا کے قارئین پڑھتے اور حوالہ دیتے رہیں۔