بیش از ۵ سال مدیر فنی و بیش از ۱۲ سال برنامه نویس بک اند هستم
چرا نیاز به فایل README هست
درود
سجاد هستم چندسالی که مدیر فنی هستم و ی مشکلی که با بچه های تیم دارم این هست که فایل README رو کلا از پروژه حذف میکنن
باید بپرسم واقعا چرا ؟?♂️
بزارید از اینجا شروع کنیم که اصلا چی هست ؟?
این فایل شناسنامه پروژه شما هستش و اطلاعات اصلی پروژه و اطلاعات تماستون و … داخلش مینویسد که اگه کسی دیگه پروژه شما رو دید سریع متوجه میشه که جریان چی هستش
حالا چنتا مثال میگم که چه کسانی از این فایل استفاده میکنن
مثلا یک دواپس کار با دیدن نحوه اجرای پروژه که در فایل README نوشتید پروژه شما را روی سرور دیپلوی می کند.
یا یک تستر پروژه شما رو وقتی می‌خواهد تست کن با دیدن فایل README راحت پروژه را اجرا و تست می کند.
یا کسی که می‌خواهد code review کند با دیدن فایل README راحت پروژه رو اجرا و ریویوو می‌کند.
یا کسی که کی می خواهد از کد شما استفاده کند با دیدن فایل README راحت از پروژه یا لایبری شما استفاده می‌کند.
حالا بهتون میگم که چه چیزی داخل این فایل بنویسید
- عنوان پروژه
- لینک دموی پروژه در صورت داشتن
- اینوایرمنت های لازم مثلا نوع سیستم عامل و …
- نحوه اجرا پروژه یا نحوه استفاده از پروژه یا لایبری
- موارد مهم که در هنگام استفاده امکان به مشکل خوردن کاربر وجود دارد
- لایسنس
- اطلاعات تماس
- و دیگر هیچ
یک مثال واستون میزارم
مثل این لینک
از این پس لطفا فایل README را حذف نکنید
ممنون از این که وقتتون رو‌گرفتم
تشکر
سجاد محمدی نژاد
مطلبی دیگر از این انتشارات
آن روز بارانی (2)
مطلبی دیگر از این انتشارات
سکوت کَر کننده!
مطلبی دیگر از این انتشارات
زن اکبر آقا مکانیک!