इस पेज पर, तकनीकी लेखन वाले उस प्रोजेक्ट की जानकारी दी गई है जिसे Google Season of Docs के लिए स्वीकार किया गया है.
प्रोजेक्ट की खास जानकारी
- ओपन सोर्स संगठन:
- SciPy
- टेक्निकल राइटर:
- mkg33
- प्रोजेक्ट का नाम:
- उपयोगकर्ता के हिसाब से दस्तावेज़ और पूरी तरह से फिर से व्यवस्थित करना
- प्रोजेक्ट की अवधि:
- स्टैंडर्ड अवधि (तीन महीने)
प्रोजेक्ट का विवरण
वजह:
मेरा मकसद मौजूदा दस्तावेज़ों को फिर से तैयार करना है, ताकि अलग-अलग ज़रूरतों वाले उपयोगकर्ता आसानी से इन दस्तावेज़ों को ऐक्सेस कर सकें. यह बताने की ज़रूरत नहीं है कि किसी शोधकर्ता की दिलचस्पी बेहतर और बेहतर सुविधाओं में होती है. वहीं, किसी ऐसे उपयोगकर्ता को सिलसिलेवार निर्देश और डायग्राम पसंद आते हैं जिसके पास पहले से कोई विशेषज्ञता नहीं है.
निजी और पेशेवर वजहों से इस प्रोजेक्ट को करने में मेरी दिलचस्पी है: सबसे पहले, मैं SciPy में काफ़ी योगदान देना चाहती हूं, क्योंकि इससे मेरी अपनी रिसर्च को काफ़ी फ़ायदा हुआ है. दूसरी वजह यह है कि मुझे दूसरे सॉफ़्टवेयर में काफ़ी दस्तावेज़ नहीं मिले (या कम जानकारी उपलब्ध होती है). साथ ही, मुझे हमेशा लगता है कि अगर कोड का इस्तेमाल किया जाए, तो उपयोगकर्ता यह सीख सकते हैं कि कोड का इस्तेमाल कैसे करना है.
लक्ष्य:
मुझे कॉन्टेंट और ग्राफ़िक, दोनों के हिसाब से मौजूदा SciPy दस्तावेज़ को बेहतर बनाना है. इस समस्या को हल करने के लिए, मेरे तरीके की सबसे अहम विशेषता यह है कि इसमें उपयोगकर्ता सर्वे को डिप्लॉय और विश्लेषण किया जाता है. इसका मतलब है कि ऑनलाइन एक छोटा सर्वे किया जाता है, ताकि अलग-अलग उपयोगकर्ता दस्तावेज़ से जुड़ी अपनी ज़रूरतों के बारे में बता सकें. मेरा मानना है कि उनके सुझावों से हमें प्रेरणा मिलनी चाहिए. इनके बिना, हम उपयोगकर्ता के हिसाब से दस्तावेज़ कैसे बना सकते हैं?
प्रोजेक्ट को पूरा करने के लिए, पहले चरण में उपयोगकर्ता सर्वे को डिज़ाइन और उसका विश्लेषण किया जाएगा. साथ ही, मौजूदा दस्तावेज़ में मुझे जो स्टाइल से जुड़ी समस्याएं मिली हैं उन्हें हल किया जाएगा. उदाहरण के लिए, एक जैसी जानकारी न होना (उदाहरण के लिए: दो डाइमेंशन वाले ऐरे के साथ दो डाइमेंशन वाले ऐरे दिखना), ऐसे जटिल वाक्य जिन्हें फिर से लिखना चाहिए या कुछ सबपेजों में अंग्रेज़ी के वर्णमाला के क्रम का न होना. दूसरा चरण, ग्राफ़िकल गाइड के बारे में बताने पर फ़ोकस करेगा. इनमें काम के विषयों के हाइपरलिंक शामिल होंगे. ये निर्देश, सर्वे के नतीजों और कम्यूनिटी से जुड़े अन्य अनुरोधों के आधार पर दिए जाएंगे. आने वाले समय में, मुझे अलग-अलग तरह के उपयोगकर्ताओं के हिसाब से, बेहतर दस्तावेज़ उपलब्ध कराने हैं. इसके अलावा, मैं ट्यूटोरियल को भाषा और स्ट्रक्चर, दोनों के हिसाब से ज़्यादा बेहतर बनाने की कोशिश करूंगा. आखिर में, मेरा मकसद कम्यूनिटी की मौजूदा ज़रूरतों के आधार पर नए ट्यूटोरियल लिखना है.
उपयोगकर्ता सर्वे:
उपयोगकर्ता सर्वे के लिए, मेरा सुझाव है कि आप Google Forms का इस्तेमाल करें. ऐसा कई वजहों से करना चाहिए. सबसे पहले, Google Forms का इस्तेमाल बिना किसी शुल्क के किया जा सकता है. साथ ही, इसमें अनलिमिटेड फ़ंक्शन (जैसे, जवाब देने वाले लोगों की संख्या, सवाल वगैरह) उपलब्ध हैं. इसमें आकर्षक विज़ुअल फ़ॉर्म और सर्वे के सबसे काम के विकल्प (जैसे, पसंद के मुताबिक लीनियर स्केल, चेकबॉक्स, और कई विकल्प) मौजूद हैं. सबसे अहम बात यह है कि आंकड़ों के विश्लेषण के लिए, नतीजों को आसानी से एक्सपोर्ट किया जा सकता है. ऑनलाइन रिसर्च के आधार पर, ऐसा लगता है कि Google Forms, कम से कम अभी के लिए, सर्वे करने के लिए सबसे अच्छा मुफ़्त टूल है. कम गंभीर बात यह है कि Google के चलाए जा रहे किसी इनिशिएटिव में, Google के प्रॉडक्ट का इस्तेमाल करना एक अच्छा कदम होगा.
मैंने सैंपल सवालों के साथ एक शुरुआती सर्वे बनाया है. इसे https://docs.google.com/forms/d/e/1FAIpQLSeBAO0UFKDZyKpg2XzRslsLJVHU61ugjc18-2PVEabTQg2_6g/viewform पर ऐक्सेस किया जा सकता है. फ़ाइनल वर्शन में ज़्यादा से ज़्यादा 15 सवाल होने चाहिए. सटीक नतीजे पाने के लिए, मेरा सुझाव है कि हम मुख्य रूप से, एक से ज़्यादा विकल्प वाले सवाल, लीनियर स्केल, और कुछ चेकबॉक्स का इस्तेमाल करें. हालांकि, लीनियर स्केल को पूरे स्पेक्ट्रम जैसा नहीं होना चाहिए. इससे सिर्फ़ भ्रम पैदा होता है और नतीजों में ज़्यादा डिस्पर्सन (डेटा में बहुत ज़्यादा अंतर) हो सकता है. ज़्यादा से ज़्यादा दो ओपन-एंडेड सवाल होने चाहिए. ऐसा न होने पर, नतीजे बहुत अलग-अलग होंगे और वे काम के नहीं होंगे. मुझे लगता है कि बहुत ज़्यादा जवाब मिलने पर भी कोई समस्या नहीं होगी. इसकी वजह यह है कि आंकड़ों से जुड़े सॉफ़्टवेयर की मदद से, डेटा को आसानी से एक्सपोर्ट किया जा सकता है और उसका अपने-आप विश्लेषण किया जा सकता है. अगर जवाबों की संख्या बहुत ज़्यादा है, तो ओपन-एंड वाले सवालों का विश्लेषण करने में थोड़ा समय लग सकता है. हालांकि, मुझे लगता है कि यह बहुत मुश्किल नहीं होगा. आखिर, किसी सामान्य उपयोगकर्ता को दस्तावेज़ की स्थिति के बारे में कोई निबंध नहीं लिखना होता. सबसे खराब स्थिति में, कुछ जवाबों को आने वाले समय में विश्लेषण के लिए सेव किया जा सकता है.
ग्राफ़िक वाली गाइड:
ग्राफ़िकल गाइड (जिन्हें नेविगेशन टूल के तौर पर इस्तेमाल किया जाता है) के बारे में मेरा नज़रिया, इस लोकप्रिय प्रमेय पर आधारित है कि (ज़्यादातर) लोग टेक्स्ट के बजाय, आसानी से समझे जा सकने वाले विज़ुअल स्ट्रक्चर को बेहतर तरीके से प्रोसेस कर पाते हैं. इसके अलावा, विषय के हिसाब से बनाया गया डायग्राम, जिसमें एक-दूसरे से मिलते-जुलते विषयों को लाइन से जोड़ा गया हो, वह कम अनुभव वाले उपयोगकर्ताओं के लिए काफ़ी अहम है.
लागू करने की जानकारी के लिए, मेरा सुझाव है कि TikZ पैकेज का इस्तेमाल करें. सबसे पहले, यह एक बेहतरीन टूल है और ऐसा नहीं लगता कि इसे जल्द ही बंद किया जाएगा. यह अच्छी क्वालिटी का आउटपुट भी देता है और इसके अच्छे दस्तावेज़ तैयार किए जाते हैं. साथ ही, यह TeX StackExchange और दूसरे मुख्य फ़ोरम पर अक्सर पूछा जाता है. सबसे अहम बात यह है कि एचटीएमएल दस्तावेज़ के साथ TikZ फ़ाइल (ज़्यादा सटीक रूप से, कई हाइपरलिंक) का एक साथ इंटिग्रेट करने पर, अलग-अलग पैकेज मौजूद होने और एचटीएमएल में TikZ तस्वीर को एम्बेड करने (उदाहरण के लिए, TeX4ht) में सुधार करने की वजह से कोई खास समस्या सामने नहीं आती.
SciPy में गाइड को आने वाले समय में बनाए रखने की समस्या को आसानी से हल किया जा सकता है. इसके लिए, Overleaf (इससे साथ मिलकर काम करने में मदद मिलती है. साथ ही, तुरंत झलक देखने की सुविधा मिलती है) और पहले से तय किए गए टेंप्लेट का इस्तेमाल करें. ये टेंप्लेट मैं उपलब्ध कराऊंगा. आम तौर पर, ग्राफ़िक गाइड एक-दूसरे से काफ़ी अलग नहीं होती हैं. स्ट्रक्चर, कलर पैलेट, और आकार कम या ज़्यादा एक जैसे ही रहेंगे. इसलिए, बाद में आकार में बदलाव करना और उसे पसंद के मुताबिक बनाना आसान होगा.
(कृपया प्रस्ताव का पूरा वर्शन देखें - यह शेयर किए गए GSoD फ़ोल्डर में उपलब्ध है.)