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