پروژه FreeBSD

این صفحه حاوی جزئیات یک پروژه نگارش فنی است که برای فصل اسناد Google پذیرفته شده است.

خلاصه پروژه

سازمان منبع باز:
پروژه FreeBSD
نویسنده فنی:
پادشاه توستر
نام پروژه:
صفحه‌های مدیریت گمشده را بنویسید، بخش‌های EXAMPLE را به صفحه‌های مرد اضافه کنید
طول پروژه:
طول استاندارد (3 ماه)

شرح پروژه

صفحات مرد گم شده را بنویسید:

در https://wiki.freebsd.org/MissingManpages فهرستی از manpages موجود است. شروع به نوشتن هر چه بیشتر صفحات مرد از آن لیست کنید. با کمک مربی خود، نویسنده یا شخصی را که اخیراً فایل منبعی را که صفحه مرد مورد نظر در مورد آن است تغییر داده است، برای اطلاعات پس زمینه و جزئیات پیدا کنید.

افزودن بخش EXAMPLE به صفحات man:

صفحات مرد FreeBSD در بسیاری از جاها شامل بخش های EXAMPLE هستند که کاربرد اساسی ابزار یا دستور شرح داده شده در آن را توضیح می دهند. ویکی FreeBSD دارای فهرستی از صفحات man بدون مثال است ( https://wiki.freebsd.org/ManPagesWithoutExamples ). در مواردی که داشتن آنها منطقی به نظر می رسد، تا حد امکان به این صفحات man نمونه ها اضافه کنید. یک روش کلی برای معرفی دستور/ابزار در این بخش‌ها بیابید (یعنی ابتدا شروع سریع، نمونه‌های پیشرفته‌تر بعد) و آن را در صفحات man که ابزارها/دستورهای مشابه را توصیف می‌کنند، اعمال کنید. به این ترتیب، مثال‌ها رویکردی ثابت دارند و خواننده می‌تواند کارها را آسان‌تر پیدا کند.