شروع به عنوان یک توسعه دهنده وب می تواند بسیار طاقت فرسا باشد. شما با بسیاری از فن آوری های مختلف برای انتخاب بمباران شده اید. اما چیزی که می تواند شما را از همه افرادی که شروع به کار می کنند متمایز کند، نظم و انضباط است که در پروژه های خود اعمال می کنید. و یکی از بهترین راه‌ها برای اضافه کردن آن به پروژه‌هایتان، نوشتن مستندات مناسب از فرآیندتان است.

README.md

Readme یک فایل متنی است که توسط توسعه دهندگان برای توضیح و معرفی پروژه های خود به کاربران خارجی استفاده می شود. این شامل اطلاعاتی است که برای آشنایی با پروژه مربوطه لازم است. این به عنوان راهی برای پاسخ به تمام سوالات متداولی که سایر توسعه دهندگان ممکن است در مورد پروژه داشته باشند، مانند شناسایی پشته فناوری یا نصب آن برای استفاده شخصی استفاده می شود.

چرا باید Readme بنویسم

Readme معمولاً هنگام اضافه کردن پروژه ها به مخازن شما نادیده گرفته می شود. به‌عنوان یک تازه‌کار، نوشتن سطرهای طولانی که احتمالاً هیچ‌کس قرار نیست آن‌ها را بخواند، غیر ضروری به نظر می‌رسد. اما ممکن است پس از مدتی به کد خود بازگردید و آن فایل readme به شما کمک زیادی می کند تا بفهمید چه چیزی چیست. یک فایل readme خوب باید به خوبی خود پروژه باشد.

Readme در رشد بسیار مهم است

افزودن یک فایل readme ممکن است به عنوان یک گام کوچک به نظر برسد زیرا اغلب نادیده گرفته می شود، اما این یک گام کوچک می تواند راه طولانی در حرفه توسعه شما داشته باشد. پروژه های شما در GitHub اساسا نمونه کار شما هستند. بسیار نادر است که بعد از شروع کار شروع به جذب مشتریان بزرگ کنید، بنابراین تا زمانی که نام خود را به دست آورید، افزودن پروژه های خود به روشی قابل ارائه به مخازن خود بهترین راه برای نشان دادن استعدادهای خود به مشتریان احتمالی شما است. اگر در مرحله یادگیری هستید و سعی می کنید در پروژه های آزمایشی مختلف کدنویسی کنید، بهتر است آنها را با توضیحات خوب به مخازن خود اضافه کنید. بهترین بخش در مورد این توضیحات این است که حتی یک فرد غیر فنی (شاید یک استخدام کننده) می تواند از این فایل ها ایده ای از استعدادهای شما بدست آورد.

نکاتی در مورد نوشتن توضیحات خوب

ملزومات:

عنوان:

اطمینان حاصل کنید که عناوین خاص و دقیقی را اضافه کنید که توضیح دهد پروژه در مورد چیست

هدف پروژه:

آنچه را که می خواهید با ساخت این پروژه به دست آورید ذکر کنید. خوب است که توسعه را با در نظر گرفتن موارد قابل تحویل شروع کنید.

پشته فناوری:

فریمورک یا کتابخانه ای را که استفاده می کنید اضافه کنید و اگر دلیل استفاده از آن را در وهله اول اضافه کنید بسیار عالی خواهد بود.

نصب و راه اندازی

اگر پروژه شما یک نرم افزار یا یک برنامه است، مطمئن شوید که دستورالعمل های مناسبی را در مورد نحوه نصب آن بر روی هر پلتفرمی که از آن پشتیبانی می کنید، اضافه کنید.

واقعا برجسته شوید:

اگر احساس می‌کنید کمی شیک هستید و واقعاً می‌خواهید با سختی بیشتر تأثیر خوبی بگذارید، این بخش‌ها را نیز اضافه کنید.

• فهرست مطالب
• گیف های پروژه در حال عمل
• دامنه عملکردها
• وضعیت پروژه
• منابع
• اطلاعات دیگر

نظر خود را در مورد این مقاله و فایل های Readme به من بگویید.