8 نکته برای خواندن مستندات

سه شنبه 4 آذر 1399

خواندن مستندات به خصوص برای برنامه نویسان تازه کار، کار آسانی نیست و ممکن است کمی سردرگم شوند. در این مقاله قصد دارم چند نکته در مورد خواندن مستندات ارائه دهم.

8 نکته برای خواندن مستندات

1. صبور باش

به قول معروف، راه یک ساله را نمیشه یک شبه رفت. درست مثل هر فرایند یادگیری دیگر، یادگیری یا خواندن مستندات نیز به زمان نیاز دارد. اگر احساس ناامیدی کردید، کمی استراحت کنید، بدن خود را کمی حرکت دهید و سپس با چشمانی تازه و سرصاف تر به آن برگردید.

 

2. شرایط (Terms) را مرور کنید

هنگام خواندن مستندات، با اصطلاحاتی مانند: متد (method)، نمونه (instance) و شی (object) روبرو می شوید که در خارج از دنیای کدنویسی دارای مفاهیم مختلفی باشد. هنگام شروع، اصطلاحات کلیدی (key terms) را مرتباً مرور کنید تا زمانی که مفهوم این اصطلاحات برایتان روشن شود.

 

3. استفاده از کتاب های الکترونیکی

منابع آنلاین جایی است که این روزها برای دریافت سریع اطلاعات ابتدا به آنجا می رویم، اما منابع آنلاین ممکن است کاملاً دقیق نباشند. کتاب ها ممکن است با تغییر تکنولوژی منسوخ شوند اما آنها می توانند به عنوان یادگیری مفاهیم اصلی مناسب باشند. هنگام خواندن مستندات به صورت آنلاین کتاب ها می توانند به روشن شدن مفاهیم بسیار کمک کنند. 
(البته منظور از کتاب ها، کتاب های زبان انگلیسی است)

 

4. از چندین منبع استفاده کنید

مستندات معمولا برای افرادی نوشته شدند که درک عمیقی از حوزه برنامه نویسی دارند. بنابراین، ممکن است کمی گمراه شوید زیرا نویسنده فرض می کند خوانندگان از قبل یک نکته اساسی را می دانند. متاسفانه، برنامه نویس های تازه کار نمی دانند چه چیزی نمی دانند. مطالعه در مورد یک موضوع در چندین سایت ممکن است خلا دانش را که ممکن است برنامه نویس های تازه کار نداشته باشند، پر کند. خواندن مطالب در چندین سایت همچنین به شما کمک می کند منابع را به روشی که برای شما مناسب است انتخاب کنید. (TopLearn)

 

5. بخش Overview را مطالعه کنید

بسیاری از اوقات می خواهیم مستقیماً به سراغ مسئله ای برویم که می خواهیم آن را حل کنیم. خواندن overview، در صورت وجود چارچوبی برای آنچه که کد باید انجام دهد، فراهم می کند. خواندن مستندات بدون بررسی overview می تواند شما را بدون اطلاعاتی که می تواند به شما در درک بهتر آنچه در زیر هود اتفاق می افتد کمک کند.

 

6. ورژن را بررسی کنید

تغییرات کد این یک واقعیت است. کنترل ورژن و شماره ورژن به شما در راهنمایی هنگام خواندن اسناد کمک می کنند. یادداشت های تغییر و اطلاعات ورژن را بررسی کنید تا بفهمید چه وقت و چگونه به مشکلات کد پرداخته شده است.

 

7. خواندن کد را بیاموزید

وقتی می خواهید بفهمید یک برنامه چیست، خواندن مستندات کافی نیست. خواندن سورس کدها می تواند دید خیلی خوبی به شما بدهد. نه تنها با کپی کردن، بلکه با خواندن و آنالیز آنچه که کد انجام می دهد، از تمام مثال های کد استفاده کنید. خود کد را امتحان کنید تا در عمل مشاهده کنید. همه چیز را تغییر دهید و دوباره آن را اجرا کنید. بشکنید سپس نحوه رفع آن را بفهمید.

 

8. کد را پاک کنید

یکی از اولین چیزهایی که در TTS یاد گرفتم تمیز و مرتب بودن کد من بود. تمام آن indenting ها و ردیف بندی bracket ها به شما در خواندن کد کمک می کند و به طور گسترده ای، می فهمید که هنگام خواندن اسناد چه اتفاقی می افتد.

 

در پایان، بهترین راه برای یادگیری صبور بودن با خود، خواندن مستندات و نوشتن کدهای بسیار زیاد است.

برگرفته از:‌ techtalentsouth.com

مهدی نیسی

نویسنده 3 مقاله در برنامه نویسان

کاربرانی که از نویسنده این مقاله تشکر کرده اند

در صورتی که در رابطه با این مقاله سوالی دارید، در تاپیک های انجمن مطرح کنید

نظرات کاربران

برای درج نظر باید وارد سایت شوید