documentation یعنی چه؟
تلفظ: داکیومِنتِیشِن · نوع: اسم
معنی documentation: مستندات؛ نوشتههای راهنمای یک ابزار
document در انگلیسی یعنی سند و نوشته. documentation همهی نوشتههایی است که سازندههای یک زبان، کتابخانه یا برنامه مینویسند تا بگویند چطور کار میکند و چطور باید از آن استفاده کنی. برنامهنویسها کوتاهش میکنند و میگویند docs. وقتی نمیدانی یک تابع چه میگیرد و چه پس میدهد، اولین جای درست برای نگاه کردن همینجاست.
documentation در جمله
Please read the documentation before you open a new issue.
لطفاً قبل از اینکه یک issue تازه باز کنی، مستندات را بخوان.
documentation در کد
>>> help(len)
len(obj, /)
Return the number of items in a container.در پایتون با help مستندات یک تابع را همانجا در ترمینال میبینی.
نکته
این کلمه جمع بسته نمیشود: نمیگویند documentations. شکل کوتاهش docs است که همیشه با s میآید: «Check the docs».
کلمههای مرتبط
- reference: مرجع؛ فهرست کامل تابعها و گزینهها
- README: فایل معرفی پروژه؛ اولین چیزی که باید بخوانی
- docstring: متن راهنمای یک تابع، درون خود کد
درس این کلمه
documentation یکی از هشت کلمهی درس «انواع راهنما» در فاز 7: خواندن مستندات از دورهی انگلیسی برای برنامهنویسها است. بقیهی کلمههای این درس:
- guide: راهنما؛ نوشتهای که یک کار را یاد میدهد
- tutorial: آموزش قدمبهقدم با ساختن یک چیز
- reference: مرجع؛ فهرست کامل تابعها و گزینهها
- example: مثال؛ نمونه
- getting started: شروع کار؛ اولین قدمها
- overview: نگاه کلی؛ مرور کوتاه
- quick start: شروع سریع؛ کوتاهترین راه تا اولین اجرا