هشدار! این ترجمه خیلی قدیمی است، لطفاً نسخه اصلی را ببینید.

مستندسازی

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

شروع ضربتی

در صورتی که کاربر جدید پروژه دبیان هستید به شما پیشنهاد میکنم از موارد زیر شروع به مطالعه نمایید :

با در دست داشتن اینها شما هنگامی که برای اولین بار دبیان را نصب می‌کنید پاسخ سولات زیادی را خواهید یافت و در کاربرد سیستم جدید دبیان به شما کمک‌های شایانی خواهد شد. . بعدها شاید بخواهید پیشتر روید :

در نهایت، مطمئن شوید که مرجع گنو/لینوکس را که شامل مهمترین دستورات سیستم عامل دبیان است را چاپ کرده و در دست دارید .

یکسری مستندات مفید دیگر نیز در این قسمت لیست شده است

انواع مستندات

اکثر مستنداتی که پروژه دبیان مورد استفاده قرار گرفته است در حقیقت برای گنو/لینوکس تدوین گردیده است. همچنین برخی مستندات وجود دارند که به صورت اختصاصی برای دبیان تولید گردیده‌اند این مستندات در دسته‌های کلی زیر عنوان می‌گردند :

راهنماها

راهنماها از حیص اینکه به تشریح موضوعات کلی و شکافتن آنها می‌پردازند، شبیه کتابها می‌باشند.

راهنماهای اختصاصی شده برای دبیان

لیست کامل راهنماها و مستندات مربوط به دبیان را میتوانید درصفحات مستندات پروژه دبیان بیابید.

همچنین راهنماهی متعددی وجود دارند که توسط کاربران برای گنو/لینوکس دبیان نوشته شده‌اند، و در قسمت کتابهای چاپ شده موجودند.

راهنماهای عمومی گنو/لینوکس

اکثر مستندات و راهنماهای محبوب و پر کاربرد لینوکس نصب لینوکس وشروع کار ، راهنمای کاربران لینوکس، راهنمای مدیران شبکه، راهنمای کاربران سیستمی و موارد دیگر می‌باشد.

مستندات لینوکس با مستندات LDP ‌هماهنگ است LDP همان پروژه مستندات لینوکس است. شما میتوانید یک سری کامل از راهنماهای LDP را در صفحات وب آنها بیابید، این مستندات هم به شکل چاپ شده و هم الکترونیکی موجودند.

چگونگی‌ها

مستندات چگونگی‌ها، همانگونه که از نامش پیداست، چگونگیانجام کار را تشریح کی‌کند، و اینگونه مستندات معمولا بر روی موضوع خاص‌تر تمرکز دارند .

برخی از مهمترین مستندات چگونگی در لینوکس عبارت است از :

پرسش‌های رایج

FAQ مخفف Frequently Asked Questions. پرسش‌های رایج مجموعه‌ای از پاسخ به سوالات مطرح شده می‌باشد.

مستند پرسش‌های رایج لینوکس .شامل طلاعات عمومی حول حوزه لینوکس است

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

لطفا به پرسش‌های رایج LDP جهت اطلاع بیشتر نگاهی بیاندازید

دیگر، مستندات کوتاهتر

اینگونه مستندات شامل دستورالعملهای سریعتر و کوتاهتری می‌شوند :

صفحات راهنماها
به صورت سنتی کلیه‌ی برنامه‌های بونیکس دارای صفحات راهنما می‌باشد، این راهنماها با استفاده از دستور man در دسترس کاربران قرار می‌گیرد. این راهنماها معمولا برای تازه‌ کارها بدون معنی است. شما می‌توانید صفحات وب موجود در رابطه با راهنماهای دبیان را مطالعه نمایید این مستندات در لینک You can search for and read the manual pages available in Debian https://manpages.debian.org/ موجود می‌باشند.
فایل‌های info
بسیاری از نرم‌افزارهای گنو از طریق فایل‌های info به جای صفحات راهنما مستند سازی شده‌اند. این فایلها شامل اطلاعات کاملی از خود نرم‌افزار، گزینه‌ها و نمونه‌های استفاده می‌باشند که از طریق دستور info در دسترس قرار می‌گیرند .
فایل‌های متنوع README
فایلهای مرا بخوانید خیلی رایجند — آنها به صورت متن ساده می‌باشند که یک موضوع را که معمولا هم یک بسته نرم‌افزاری است تشریح می‌کند. شما می‌توانید بسیاری از این فایل‌ها را در /usr/share/doc/ و زیر پوشه‌های دبیان بیابید. هربسته نرم‌افزاری یک پوشه شامل فایل‌های مرا بخوانید خود دارد که ممکن است شامل نمونه‌هایی از تغییرات نیز می‌باشد . توجه کنید که برای برنامه‌های بزرگتر مستندات ممولا در بسته‌های مجزایی گردآوری می‌شوند (تحت همان عنوانی که نام بسته دارد با این تفاوت که در انتهای نام آن عبارت -doc آورده می‌شود .)
کارتهای مرجع برای دسترسی سریع

کارتهای مرجع سریع مختصری در مورد اصل سیستم می‌باشند . معمولا، این کارتهای مرجع دستوراتی را که عموما مورد استفاده قرار می‌گیرند را بر روی یک کاغذ شامل می‌شود. برخی از دسته کارتها و مجموعه‌ها شامل موراد زیر می‌گردند :

کارت مرجع گنو/لینوکس دبیان
این کارت ، که میتواند بر روی یک صفحه معمولی چاپ گردد ، لیستی از مهمترین دستورات را به کاربران ارائه می‌کند و مرجع خوبی برای کاربران جدید دبیان است که می‌خواهند با این مفاهیم آشنا گردند. در نهایت دانش پایه‌ای در رابطه با کامپیوتر ، فایل‌ها شاخه‌ها و خط فرمان نیاز می‌باشد . کاربران تازه‌کار شاید بخواهند ابتدا در مورد مرجع دبیان بیشتر بدانند .

در صورتی که شما مطالب بالا را مطالع کرده اید و مشکلتان در رابطه با دبیان حل نگردیده است و یا راه‌حل مناسبی برای مشکلتان نیافته اید به صفحه پشتیبانی مراجعه نمایید.