इस पेज पर Google Docs के सीज़न के लिए स्वीकार किए गए एक तकनीकी लेखन प्रोजेक्ट की जानकारी है.
प्रोजेक्ट की खास जानकारी
- ओपन सोर्स संगठन:
- Tor प्रोजेक्ट
- तकनीकी लेखक:
- स्वाटी थाकर
- प्रोजेक्ट का नाम:
- Tor के मैन्युअल पेज को फिर से लिखें
- प्रोजेक्ट की अवधि:
- लंबे समय तक दौड़ना (पांच महीने)
प्रोजेक्ट का विवरण
इस प्रोजेक्ट से क्या उम्मीदें हैं, यह जानने के लिए टीओआर के मेंटॉर से चर्चा करने के बाद, मैंने इन आइडिया का सुझाव दिया है, ताकि टीओआर मैन्युअल पेज (https://2019.www.torproject.org/docs/tor-manual.html.en) का एक जैसा स्ट्रक्चर और फ़ॉर्मैट बनाया जा सके.इससे उपयोगकर्ताओं को तुरंत मदद और तुरंत मदद मिल सकेगी. यह प्रोजेक्ट तीन महीने में पूरा हो जाएगा और नीचे दिए गए आइडिया को महीने के हिसाब से बांटा जाएगा.
महीना 1:
इस पेज के लिए विषय सूची बनाएं. टीओसी में खास जानकारी का विषय और कॉन्फ़िगरेशन विकल्पों की सभी नौ कैटगरी के शीर्षक शामिल होंगे. इस महीने के आखिर तक उपयोगकर्ता, कॉन्फ़िगरेशन की अलग-अलग कैटगरी पर आसानी से नेविगेट कर पाएंगे. टीओसी कुछ ऐसा दिखेगा:
- खास जानकारी – यह जानकारी जोड़ें कि इन अलग-अलग विकल्प कैटगरी के लिए, TOR कॉन्फ़िगरेशन को कहां बनाए रखता है. अगर ये सभी विकल्प एक ही जगह पर हैं, तो कॉन्फ़िगरेशन फ़ाइल का नाम और डिफ़ॉल्ट जगह, कमांड के विकल्पों का इस्तेमाल करने के नियम, और उपयोगकर्ता इन विकल्पों को कैसे बदल सकते हैं. (हम कॉन्फ़िगरेशन फ़ाइल फ़ॉर्मैट विषय के तहत शुरुआती टेक्स्ट से जानकारी शामिल कर सकते हैं).
- सामान्य विकल्प
- क्लाइंट विकल्प
- सर्वर के विकल्प
- डायरेक्ट्री सर्वर के विकल्प
- नेटवर्क के विकल्पों की जांच करना
- सेवा में रुकावट न डालने के विकल्प
- डायरेक्ट्री अथॉरिटी के सर्वर के विकल्प
- सेवा के छिपे हुए विकल्प
- स्थायी विकल्प
दूसरा महीना:
मैन्युअल पेज का मकसद, इन सवालों के तुरंत जवाब देना होना चाहिए कि अलग-अलग विकल्प क्या करते हैं और कैसे. फ़िलहाल, विकल्पों को स्ट्रक्चर्ड फ़ॉर्मैट में दर्ज नहीं किया गया है. हर विकल्प के बारे में जानकारी पैराग्राफ़ में दी गई है. इससे एक नज़र में जानकारी ढूंढना मुश्किल हो जाता है. विकल्पों की सभी मौजूदा जानकारी को टेंप्लेट का इस्तेमाल करके फिर से व्यवस्थित करने की ज़रूरत है. इस महीने के आखिर तक, मौजूदा विकल्पों और आने वाले समय में किसी भी नए विकल्प को रिकॉर्ड करने के लिए, हमारे पास एक जैसा फ़ॉर्मैट होगा. इसके अलावा, इस फ़ॉर्मैट से टीओआर मैन्युअल को आने वाले समय में ‘मैन’ पेजों के तौर पर इस्तेमाल करना आसान हो जाएगा.
- सबसे पहले, विकल्प की हर कैटगरी के बारे में कम शब्दों में जानकारी दें. जैसे, सर्वर के विकल्प, क्लाइंट के विकल्प वगैरह. जानकारी से उपयोगकर्ताओं को यह जानने में मदद मिलेगी कि हर कैटगरी में कौनसे विकल्प देखने को मिलेंगे.
- टेंप्लेट बनाएं, ताकि हर विकल्प का दस्तावेज़ बनाने के लिए एक जैसा फ़ॉर्मैट बनाया जा सके. मेरा सुझाव है कि टेंप्लेट में नीचे दिए गए सेक्शन/सब-सेक्शन शामिल करें.
- नाम: उस विकल्प का नाम जिसे दस्तावेज़ में दर्ज किया जा रहा है. उदाहरण: बैंडविथ बर्स्ट
- सारांश: विकल्प का कमांड-लाइन सिंटैक्स कैसा दिखता है, इसकी खास जानकारी. उदाहरण: बैंडविथ बर्स्ट N बाइट
- ब्यौरा: बताएं कि कॉन्फ़िगरेशन विकल्प क्या करता है और डिफ़ॉल्ट वैल्यू क्या होती है. उदाहरण: इस विकल्प का इस्तेमाल करके, हर दिशा में दी गई बाइट की संख्या तक टोकन बकेट का ज़्यादा से ज़्यादा साइज़ (इसे Busrt भी कहा जाता है) भी सीमित किया जा सकता है. यह विकल्प डिफ़ॉल्ट रूप से 1 गीगाबाइट (जीबी) का होता है.
- विकल्प की वैल्यू: विकल्प से अनुमति देने वाली वैल्यू की सूची बनाएं और उनकी जानकारी दें. इस बारे में पूरी जानकारी दें कि हर वैल्यू क्या होती है और उपयोगकर्ता को वैल्यू कैसे डालनी चाहिए.
तीसरा महीना:
फ़िलहाल, कॉन्फ़िगरेशन के विकल्पों के नौ ग्रुप/कैटगरी उपलब्ध हैं. खोजने की क्षमता को बेहतर बनाने और एक क्विक रेफ़रंस के लिए, एक ऐसा इंडेक्स पेज बनाएं जिसमें नौ कैटगरी में से हर कैटगरी में, वर्णमाला के क्रम में कॉन्फ़िगरेशन के विकल्पों की सूची हो. इसके बाद, इन कैटगरी को उनके इस्तेमाल की प्राथमिकता के हिसाब से क्रम में लगाया जा सकता है. सबसे ज़्यादा इस्तेमाल होने वाली कैटगरी के विकल्प सबसे ऊपर होते हैं.
तीन महीने के बाद, हम नए जैसा किया गया TOR मैन्युअल बना सकते हैं. इसे उपयोगकर्ता, तुरंत रेफ़रंस के तौर पर टीओआर की कॉन्फ़िगरेशन सेटिंग में बदलाव करने के लिए इस्तेमाल कर सकते हैं.