این صفحه حاوی جزئیات یک پروژه نگارش فنی است که برای فصل اسناد Google پذیرفته شده است.
خلاصه پروژه
- سازمان منبع باز:
- پروژه Tor
- نویسنده فنی:
- سواتی تاکر
- نام پروژه:
- صفحه راهنمای Tor را بازنویسی کنید
- طول پروژه:
- دویدن طولانی مدت (5 ماه)
شرح پروژه
پس از بحث با مربیان TOR برای درک انتظارات آنها از این پروژه، من ایده های زیر را برای ایجاد یک ساختار و قالب ثابت برای صفحه راهنمای TOR پیشنهاد می کنم ( https://2019.www.torproject.org/docs/tor -manual.html.en ) به منظور تبدیل آن به یک مرجع مفید و سریع برای کاربران. این پروژه در مدت 3 ماه تکمیل می شود و ایده های زیر به تفکیک ماه تقسیم می شوند.
ماه 1:
یک فهرست مطالب برای این صفحه ایجاد کنید. TOC شامل یک موضوع کلی، و سرفصل های تمام 9 دسته گزینه های پیکربندی خواهد بود. تا پایان این ماه، کاربران می‌توانند به دسته‌های پیکربندی مختلف بر روی نوک انگشتان خود پیمایش کنند. TOC به شکل زیر خواهد بود:
- نمای کلی – اطلاعاتی در مورد اینکه TOR پیکربندی را برای این دسته‌بندی‌های گزینه‌های مختلف حفظ می‌کند، در صورتی که همگی در یک مکان هستند، نام و مکان پیش‌فرض فایل پیکربندی، قوانین استفاده از گزینه‌های فرمان، و اینکه کاربران چگونه می‌توانند این گزینه‌ها را تغییر دهند، اضافه کنید. (ما می توانیم اطلاعاتی را از متن مقدماتی در موضوع THE CONFIGURATION FILE FORMAT وارد کنیم).
- گزینه های عمومی
- گزینه های مشتری
- گزینه های سرور
- گزینه های سرور دایرکتوری
- تست گزینه های شبکه
- گزینه های کاهش خدمات انکار
- گزینه های سرور دایرکتوری
- گزینه های سرویس مخفی
- گزینه های غیر مداوم
ماه 2:
هدف از صفحه راهنما باید پاسخ سریع به سوالات در مورد اینکه هر گزینه چه کاری و چگونه انجام می دهد باشد. در حال حاضر، گزینه‌ها در قالب ساختاری مستند نشده‌اند و اطلاعات مربوط به هر گزینه در پاراگراف‌هایی ارائه می‌شود که یافتن اطلاعات را در یک نگاه دشوار می‌کند. تمام اطلاعات موجود در مورد گزینه ها باید با استفاده از یک الگو سازماندهی مجدد شوند. تا پایان این ماه، ما یک قالب ثابت برای مستندسازی گزینه‌های موجود و هر گزینه جدید در آینده خواهیم داشت. علاوه بر این، این فرمت استفاده از کتابچه راهنمای TOR را به عنوان صفحات "man" در آینده آسان می کند.
- ابتدا، توضیح مختصری در مورد هر دسته از گزینه‌ها، مانند گزینه‌های سرور، گزینه‌های مشتری و غیره اضافه کنید. توضیحات به کاربران کمک می کند تا بدانند در هر دسته چه گزینه هایی را باید انتظار داشته باشند.
- یک الگو برای تعریف یک قالب ثابت برای مستندسازی هر گزینه ایجاد کنید. پیشنهاد می‌کنم بخش‌ها/زیربخش‌های زیر در قالب گنجانده شوند.
- نام: نام گزینه ای که در حال مستند شدن است. مثال: BandwidthBurst
- خلاصه داستان: خلاصه ای از نحوی که دستور خط فرمان گزینه به نظر می رسد. مثال: BandwidthBurst N بایت
- توضیحات: توضیح دهید که گزینه پیکربندی چه کاری انجام می دهد، مقدار پیش فرض چیست. مثال: از این گزینه برای محدود کردن حداکثر اندازه سطل نشانه، که به عنوان busrt نیز شناخته می شود، به تعداد بایت معین در هر جهت، استفاده کنید. این گزینه پیش فرض 1 گیگابایت است.
- مقدار گزینه: مقادیری را که گزینه اجازه می دهد فهرست و توصیف کنید. با جزئیات توضیح دهید که هر مقدار چه کاری انجام می دهد و کاربر چگونه باید مقادیر را وارد کند.
ماه 3:
در حال حاضر، 9 گروه/دسته از گزینه های پیکربندی وجود دارد. برای افزایش قابلیت جستجو و به عنوان یک مرجع سریع، یک صفحه فهرست ایجاد کنید که گزینه های پیکربندی را به ترتیب حروف الفبا در هر یک از 9 دسته فهرست می کند. بنابراین، این دسته‌ها را می‌توان در اولویت استفاده از آنها مرتب کرد، در حالی که رایج‌ترین دسته از گزینه‌ها در بالا قرار دارند.
در پایان 3 ماه، ما می توانیم یک کتابچه راهنمای TOR بازسازی شده تولید کنیم که می تواند به عنوان یک مرجع سریع توسط کاربران برای تغییر تنظیمات پیکربندی در TOR استفاده شود.