فاز 7: خواندن مستندات
مستندات همیشه با چند ده کلمه و چند الگوی جمله نوشته میشوند. اینها را بشناس تا هر راهنمایی را بخوانی.
درس 1: انواع راهنما
- documentation: مستندات؛ نوشتههای راهنمای یک ابزار
- guide: راهنما؛ نوشتهای که یک کار را یاد میدهد
- tutorial: آموزش قدمبهقدم با ساختن یک چیز
- reference: مرجع؛ فهرست کامل تابعها و گزینهها
- example: مثال؛ نمونه
- getting started: شروع کار؛ اولین قدمها
- overview: نگاه کلی؛ مرور کوتاه
- quick start: شروع سریع؛ کوتاهترین راه تا اولین اجرا
درس 2: توصیف یک تابع
- returns: برمیگرداند؛ پس میدهد
- takes: میگیرد (به عنوان ورودی)
- accepts: میپذیرد؛ قبول میکند
- throws: خطا پرتاب میکند
- defaults to: اگر ندهی، این مقدار را میگیرد
- optional: اختیاری؛ میشود ننوشت
- required: الزامی؛ حتماً باید باشد
- default: پیشفرض؛ مقداری که از قبل گذاشتهاند
درس 3: کادرهای توجه
- note: نکته؛ یادداشت
- tip: ترفند؛ پیشنهاد مفید
- caution: احتیاط؛ مراقب باش
- important: مهم
- see also: این را هم ببین
- for example: برای مثال؛ مثلاً
- in other words: به بیان دیگر؛ یعنی
- such as: مانند؛ از قبیل
درس 4: فعلهای مستندات ۱
- specify: مشخص کردن؛ دقیق گفتن
- provide: فراهم کردن؛ دادن
- contain: در خود داشتن؛ شامل بودن
- represent: نشاندهندهی چیزی بودن؛ نماینده بودن
- describe: توصیف کردن؛ شرح دادن
- indicate: نشان دادن؛ خبر دادن از چیزی
- refer to: اشاره کردن به؛ رجوع کردن به
- depend on: وابسته بودن به؛ بستگی داشتن به
درس 5: فعلهای مستندات ۲
- allow: اجازه دادن؛ ممکن کردن
- prevent: جلوگیری کردن
- ensure: مطمئن شدن؛ تضمین کردن
- avoid: دوری کردن از؛ انجام ندادن
- support: پشتیبانی کردن؛ از پسِ چیزی برآمدن
- recommend: توصیه کردن؛ پیشنهاد کردن
- expect: انتظار داشتن
- assume: فرض کردن
درس 6: وضعیت یک قابلیت
- available: در دسترس؛ موجود
- compatible: سازگار
- supported: پشتیبانیشده
- experimental: آزمایشی
- legacy: قدیمی و بهارثرسیده
- read-only: فقطخواندنی
- case-sensitive: حساس به حروف بزرگ و کوچک
- backward compatible: سازگار با نسخههای قبلی
درس 7: کلمههای ربط
- however: با این حال؛ اما
- therefore: بنابراین؛ پس
- otherwise: وگرنه؛ در غیر این صورت
- instead: بهجایش؛ در عوض
- by default: بهطور پیشفرض
- as well as: و همچنین؛ بهعلاوهی
- unless: مگر اینکه
- whether: اینکه آیا … یا نه
درس 8: چند تا؟
- each: هر (یکییکی)
- every: هر؛ همهی
- either: یکی از این دو؛ یا … یا
- neither: هیچکدام از این دو؛ نه … نه
- both: هر دو
- at least: دستکم؛ حداقل
- at most: حداکثر؛ دستِ بالا
- up to: تا (سقفِ یک مقدار)
درس 9: قدمبهقدم
- step: قدم؛ مرحله
- following: زیر؛ آنچه در ادامه میآید
- above: بالا؛ بالاتر در همین صفحه
- below: پایین؛ پایینتر در همین صفحه
- prerequisite: پیشنیاز
- requirement: نیازمندی؛ چیزِ لازم
- usage: طرز استفاده؛ میزان مصرف
- installation: نصب