تحتوي هذه الصفحة على تفاصيل مشروع كتابة فني مقبول ضمن "موسم المستندات" من Google.
ملخص المشروع
- مؤسسة البرامج المفتوحة المصدر:
- مشروع Tor
- الكاتب الفني:
- سواتي ثاكر
- اسم المشروع:
- إعادة كتابة صفحة دليل Tor
- طول المشروع:
- الجري الطويل (5 أشهر)
وصف المشروع
بعد مناقشة مع مرشدي TOR لمعرفة توقعاتهم من هذا المشروع، أقترح الأفكار التالية لإنشاء هيكل وتنسيق متسق لصفحة دليل TOR (https://2019.www.torproject.org/docs/tor-manual.html.en) من أجل تحويلها إلى مرجع مفيد وسريع للمستخدمين. سيكتمل هذا المشروع في غضون 3 أشهر ويتم تقسيم الأفكار التالية حسب الشهر.
الشهر الأول:
إنشاء جدول محتويات لهذه الصفحة. سيشتمل جدول الأعمال على موضوع نظرة عامة وعناوين لكل الفئات التسع لخيارات الضبط. بحلول نهاية هذا الشهر، سيتمكّن المستخدمون من الانتقال بسهولة إلى فئات الضبط المختلفة. سيبدو جدول المحتويات على النحو التالي:
- نظرة عامة - أضِف معلومات عن المكان الذي يحتفظ فيه TOR بإعدادات فئات الخيارات المختلفة هذه، إذا كانت جميعها في مكان واحد، والاسم والموقع التلقائي لملف الإعداد، والقواعد اللازمة لاستخدام خيارات الأوامر، وكيفية تعديل المستخدمين لهذه الخيارات. (يمكننا تضمين معلومات من النص التمهيدي ضمن موضوع تنسيق ملف الإعداد).
- الخيارات العامة
- خيارات العملاء
- خيارات الخادم
- خيارات خادم الدليل
- اختبار خيارات الشبكة
- خيارات تخفيف آثار الحرمان من الخدمة
- خيارات خادم مرجع الدليل
- خيارات الخدمة المخفية
- الخيارات غير الثابتة
الشهر 2:
يجب أن يكون الغرض من الصفحة اليدوية هو الإجابة بسرعة عن الأسئلة حول وظيفة كل خيار وكيفية ذلك. في الوقت الحالي، لا يتم توثيق الخيارات بتنسيق منظم ويتم عرض المعلومات المتعلقة بكل خيار في فقرات تجعل من الصعب العثور على المعلومات في لمحة. يجب إعادة تنظيم جميع المعلومات الحالية حول الخيارات باستخدام نموذج. بحلول نهاية هذا الشهر، سيكون لدينا تنسيق ثابت لتوثيق الخيارات الحالية وأي خيار جديد في المستقبل. بالإضافة إلى ذلك، سيسهّل هذا التنسيق استخدام دليل TOR كصفحات "رجال" في المستقبل.
- أولاً، أضف وصفًا موجزًا حول كل فئة خيار، مثل خيارات الخادم وخيارات العميل وما إلى ذلك. ستساعد الأوصاف المستخدمين على معرفة الخيارات التي يمكن توقعها ضمن كل فئة.
- أنشئ قالبًا لتحديد تنسيق ثابت لتوثيق كل خيار. أقترح تضمين الأقسام/الأقسام الفرعية التالية في النموذج.
- الاسم: اسم الخيار الذي يتم توثيقه. مثال: BandwidthBurst
- الملخص: يشير هذا المصطلح إلى ملخّص للشكل الذي تظهر به بنية سطر الأوامر للخيار. مثال: BandwidthBurst N بايت
- الوصف: يُرجى وصف ما يفعله خيار الإعداد والقيمة التلقائية. مثال: يمكنك استخدام هذا الخيار لتقييد الحد الأقصى لحجم حزمة الرمز المميز، الذي يُعرف أيضًا باسم وحدة تخزين البيانات، على عدد وحدات البايت المحدَّد في كل اتجاه. ويتم ضبط هذا الخيار تلقائيًا على 1 غيغابايت.
- قيمة الخيار: إدراج القيم التي يسمح بها الخيار ووصفها يُرجى وصف وظيفة كل قيمة بالتفصيل وكيف يجب أن يُدخل المستخدم القيم منها.
الشهر 3:
تتوفّر حاليًا 9 مجموعات/فئات من خيارات الضبط. ولتحسين إمكانية البحث وكمرجع سريع، يمكنك إنشاء صفحة فهرس تسرد خيارات التكوين مرتبة أبجديًا داخل كل فئة من الفئات التسعة. ويمكن بعد ذلك ترتيب هذه الفئات في أولوية استخدامها، حيث تظهر فئات الخيارات الأكثر استخدامًا في الأعلى.
في نهاية مدة 3 أشهر، يمكننا إنتاج دليل TOR مُجدَّد يمكن للمستخدمين استخدامه كمرجع سريع للمستخدمين لتعديل إعدادات الضبط في TOR.