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