Mohammad Keshavarz
Mohammad Keshavarz
خواندن ۱ دقیقه·۲ سال پیش

چطور برای پروژه برنامه نویسی داکیومنت بنویسیم؟

یکی از کارهایی که کمتر کسی حوصله انجام دادنش رو داره همین داکیومنت نویسیه. بیان و نوشتن اینکه چه کاری انجام دادی در ظاهر کار خسته کننده و شاید بی فایده‌ای به نظر بیاد چون با خودمون میگیم که: “خب نفر بدی که میاد برنامه نویسه! حتما یه نگاه به کدهای من بندازه میدونه چی نوشتم”

برای همین تو پروژه ها یکی از کارهای نسبتا پرچالش انتقال دانش پروژه به افراد تازه وارد هست.
برای این افراد سوالات زیادی نسبت به کدها و تصمیم های تو پروژه ایجاد میشه که بهترین راه حل نوشتن داکیومنت مناسب برای انتقال دانش است.

اما این جمله درست نیست چون بعضی تصمیم‌ها تو ذهن ما یا به صورت شفاهی بین تیم انجام شده و ما نتیجه این تصمیم‌ها رو توی کد اجرا می کنیم و میبینیم.

از جمله کاربردهای داکیومنت اینه که زمان بقیه اعضای تیم کمتر صرف جواب دادن به سوال های تکراری و متداول میشه چون بیشتر سوالاتی که برای افراد ممکنه پیش بیاد تو داکیومنت نوشته شده.

تو این پست سعی کردم بیشتر درباره داکیومنت نویسی توضیح بدم.

چطور برای پروژه داکیومنت بنویسیم؟

بقیه قسمت ها هم به زودی منتشر میشه :))

پروژهداکیومنتمستندنویسیdocumentdocumentation
شاید از این پست‌ها خوشتان بیاید