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