इस पेज पर, तकनीकी लेखन वाले उस प्रोजेक्ट की जानकारी दी गई है जिसे Google Season of Docs के लिए स्वीकार किया गया है.
प्रोजेक्ट की खास जानकारी
- ओपन सोर्स संगठन:
- BRL-CAD
- टेक्निकल राइटर:
- sahibkaur
- प्रोजेक्ट का नाम:
- BRL-CAD का इस्तेमाल शुरू करने वालों के लिए गाइड
- प्रोजेक्ट की अवधि:
- स्टैंडर्ड अवधि (तीन महीने)
प्रोजेक्ट का विवरण
BRL-कैनेडियन डॉलर के बारे में नए क्रिएटर्स के लिए गाइड
प्रोजेक्ट का एब्सट्रैक्ट
इस प्रोजेक्ट का मकसद, उन उपयोगकर्ताओं के लिए दस्तावेज़ बनाना है जो न सिर्फ़ BRL-CAD के लिए नए हैं, बल्कि ओपन-सोर्स के लिए भी नए हैं.
यह प्रोजेक्ट क्यों
जब मैंने पहली बार BRL-CAD की वेबसाइट पर विज़िट किया, तो मुझे बहुत सारी जानकारी एक साथ दिखी. मुझे यह समझ नहीं आया कि यह जानकारी कहां से मिलेगी. हालांकि, मुझे पता था कि मुझे यहां बहुत कुछ सीखना है. इसलिए, मैंने अपने जैसे नए उपयोगकर्ताओं के लिए दस्तावेज़ बनाने का फ़ैसला लिया, ताकि वे इस कम्यूनिटी से ज़्यादा से ज़्यादा फ़ायदा ले सकें और आसानी से शुरुआत कर सकें.
लक्ष्य
यह प्रोजेक्ट नए उपयोगकर्ताओं को टारगेट करेगा. इसलिए, हमारे दस्तावेज़ के ज़रिए हम ये काम करना चाहते हैं: यह पक्का करने के लिए कि नए उपयोगकर्ता आसानी से काम कर सकें: यह दस्तावेज़ BRL-CAD के लिए नए उपयोगकर्ताओं के साथ-साथ ओपन-सोर्स के लिए भी नए उपयोगकर्ताओं के लिए है.
इसके लिए, मैं ये काम करूंगा/करूंगी:
- पक्का करें कि दस्तावेज़ का फ़्लेश-किनकैड स्कोर कम से कम 50 से ज़्यादा हो. फ़्लेश-किनकैड के हिसाब से, स्कोर जितना ज़्यादा होगा, कॉन्टेंट को समझना उतना ही आसान होगा. इसके लिए, पढ़ने में आसानी का स्कोर ऑनलाइन देखा जा सकता है.
- बुलेट पॉइंट या नंबर वाली सूचियों का इस्तेमाल करें, ताकि लंबे पैराग्राफ़ से पाठकों को बोर न किया जाए या उनका ध्यान न भटके.
- छोटे पैराग्राफ़ और वाक्यों का इस्तेमाल करें, क्योंकि लंबे वाक्यों को पढ़ने और समझने में ज़्यादा मेहनत करनी पड़ती है.
- टेक्स्ट को छोटे-छोटे हिस्सों में बांटने के लिए, उप-शीर्षकों का इस्तेमाल करें. बेहतर तरीके से स्ट्रक्चर किए गए दस्तावेज़: बेहतर तरीके से स्ट्रक्चर किए गए दस्तावेज़, नए उपयोगकर्ताओं के लिए दिशा-निर्देश देने में अहम भूमिका निभाते हैं. इससे उन्हें यह पता चलता है कि वे कहां जा रहे हैं और क्या कर रहे हैं. साथ ही, वे रास्ते में नहीं भटकते. इसके लिए, मैंने एक रफ़ माइंड मैप बनाया है. इसकी मदद से, हम शुरुआती लोगों के लिए इस गाइड को व्यवस्थित तरीके से तैयार कर पाएंगे.
प्रोजेक्ट का ब्यौरा
यह प्रोजेक्ट नए उपयोगकर्ताओं के लिए दस्तावेज़ लिखने पर फ़ोकस करता है, ताकि वे इस सॉफ़्टवेयर को इस्तेमाल कर सकें.
यहां एक उदाहरण दिया गया है, जिसमें बताया गया है कि मैं दस्तावेज़ को ज़्यादा जानकारी देने वाला कैसे बनाऊंगा.
बुनियादी जानकारी: BRL-CAD (उच्चारण: बी-एर-एल-कैड), कंप्यूटर-ऐडेड डिज़ाइन (सीएडी) का एक सॉलिड मॉडलिंग सॉफ़्टवेयर है. यह कंस्ट्रक्टिव सॉलिड ज्यामिति (सीएसजी) पर आधारित है. यह 3D कंप्यूटर-एडेड डिज़ाइन और ग्राफ़िक विज़ुअलाइज़ेशन के लिए एक शक्तिशाली, क्रॉस-प्लैटफ़ॉर्म, ओपन-सोर्स सॉलिड मॉडलिंग सिस्टम है. क्या आपको यह समझ नहीं आ रहा है? इसके बारे में जानते हैं. ओपन-सोर्स: ओपन सोर्स सॉफ़्टवेयर का सोर्स कोड ऐसा होता है जिसकी जांच, उसमें बदलाव, और उसे बेहतर बनाने का अधिकार सभी के पास होता है. BRL-CAD एक ओपन सोर्स सॉफ़्टवेयर है. इसमें योगदान देने और इसे पहले से बेहतर बनाने के लिए, आपका स्वागत है! कंप्यूटर ऐडेड डिज़ाइन (सीएडी): आसान शब्दों में, सीएडी का मतलब है कंप्यूटर प्रोग्राम का इस्तेमाल करके, फ़िज़िकल ऑब्जेक्ट की दो या तीन डाइमेंशन वाली ग्राफ़िकल इमेज बनाना. सॉलिड मॉडलिंग सिस्टम: BRL-CAD, सॉलिड मॉडलिंग सीएडी पर फ़ोकस करता है. सॉलिड मॉडलिंग, ज्यामितीय मॉडलिंग के अन्य तरीकों से अलग होती है. इसमें 3D स्पेस की पूरी जानकारी देने के साथ-साथ, सटीक जानकारी देने पर ज़्यादा ध्यान दिया जाता है. यह किसी ऑब्जेक्ट को अंदरूनी और बाहरी, दोनों तरह से सिम्युलेट करता है. कंस्ट्रक्टिव सॉलिड ज्यामिति (सीएसजी): सीएसजी की मदद से, प्राइमिटिव के बीच बूलियन ऑपरेशन की सीरीज़ के तौर पर कॉम्प्लेक्स मॉडल दिखाए जा सकते हैं. प्रॉडक्ट को दिखाने के लिए इस्तेमाल किए जाने वाले सबसे आसान सॉलिड ऑब्जेक्ट को प्रिमिटिव कहा जाता है. सीएसजी को बुनियादी तौर पर समझने के लिए, यहां जाएं.
*जैसा कि प्रोजेक्ट के आइडिया के ब्यौरे में बताया गया है: दस्तावेज़ में कम से कम, इंस्टॉलेशन के बुनियादी तरीके, सुविधाओं के बारे में पूरी जानकारी, BRL-CAD के मॉडलिंग के सिद्धांतों, मुख्य टूल के बुनियादी इस्तेमाल, मॉडलिंग, इंपोर्ट/एक्सपोर्ट, विश्लेषण, और रेंडरिंग के बारे में बताया जाएगा.
दस्तावेज़ के हर हिस्से के बारे में मुझे कम शब्दों में जानकारी दी गई है.
- इंस्टॉल करने का बुनियादी तरीका: मैं BRL-CAD सॉफ़्टवेयर को इंस्टॉल करने के लिए, सिलसिलेवार निर्देशों वाला ट्यूटोरियल जोड़ूंगा. साथ ही, ज़रूरी स्क्रीनशॉट भी जोड़ूंगा. नए उपयोगकर्ताओं के लिए ट्यूटोरियल, शुरुआत करने के लिए एक अच्छी जगह है. मुझे इनमें से कुछ चीज़ें नहीं मिल रही हैं:
- इस नए उपयोगकर्ता के लिए ट्यूटोरियल में दिए गए चरणों को बुलेट या नंबर में नहीं दिखाया गया है. हर चरण के आखिर में स्क्रीनशॉट के साथ, सिलसिलेवार निर्देश देने से, उपयोगकर्ता को ट्यूटोरियल में दिलचस्पी रखने की संभावना बढ़ जाती है.
- सुविधाओं के बारे में पूरी जानकारी: इस सेक्शन में वे सभी क्षेत्र शामिल होंगे जहां BRL-CAD का इस्तेमाल करके बेहतरीन काम किए जा सकते हैं. इस हिस्से पर ध्यान खींचने के लिए, डायग्राम का इस्तेमाल करना बेहतर होगा.
- BRL-CAD के मॉडलिंग के सिद्धांत: इस हिस्से के बारे में ज़्यादा जानकारी देनी होगी, क्योंकि मॉडलिंग के इन सिद्धांतों को समझने के बाद, उपयोगकर्ता BRL-CAD को बेहतर तरीके से समझ सकता है.
- मुख्य टूल का बुनियादी इस्तेमाल: इसके तहत, हम इन अहम टूल और उनके बुनियादी इस्तेमाल के बारे में अलग-अलग ट्यूटोरियल देंगे. ये सिलसिलेवार निर्देश वाले ट्यूटोरियल होंगे.
- एक्सपोर्ट/इंपोर्ट: उपयोगकर्ताओं को ज्यामिति कन्वर्ज़न लाइब्रेरी के बारे में पता चलेगा. BRL-CAD का सबसे आम इस्तेमाल, ज्यामिति को एक फ़ॉर्मैट से दूसरे फ़ॉर्मैट में बदलना है. इस सेक्शन में, हम एक्सपोर्ट और इंपोर्ट कन्वर्ज़न के बारे में जानकारी देंगे.
- रेंडरिंग: हम रेंडरिंग के बुनियादी सिद्धांतों और हमारे सॉफ़्टवेयर में इसकी ज़रूरत के बारे में बताएंगे. उपयोगकर्ताओं को BRL-CAD में इमेज रेंडर करने का तरीका भी पता चलेगा.
इसके अलावा, यहां दी गई बातों पर भी फ़ोकस किया जाता है:
- दस्तावेज़ की शुरुआत में, इस सॉफ़्टवेयर के बारे में बुनियादी जानकारी दी जाएगी.
- उपयोगकर्ता इस ओपन-सोर्स कम्यूनिटी से कैसे जुड़ सकते हैं; BRL-CAD zulip चैट का लिंक.
- दस्तावेज़ को थोड़ा हंसी-मज़ाक़ के अंदाज़ में लिखें. साथ ही, नए उपयोगकर्ताओं से कहें कि वे बड़े शब्दों से न घबराएं. मुझे BRL-CAD के विकी के मुख्य पेज पर इस्तेमाल किए गए सहानुभूति वाले तरीके पसंद आए.
- इसमें कुछ ऐसी शानदार चीज़ों के स्क्रीनशॉट होंगे जिन्हें उपयोगकर्ता इस सॉफ़्टवेयर का इस्तेमाल करके कर सकते हैं.
उपलब्धियां
जुलाई (प्रस्ताव की समीक्षा की अवधि)
- मौजूदा ट्यूटोरियल देखकर, मैं सॉफ़्टवेयर और उसके विकी दस्तावेज़ों के बारे में ज़्यादा जानूंगा.
- हम मौजूदा दस्तावेज़ों में सुधार करेंगे.
1 अगस्त से 7 अगस्त (कम्यूनिटी बॉन्डिंग)
- प्रोजेक्ट के बारे में मेंटॉर से बातचीत की जा रही है.
- प्रोजेक्ट की जानकारी को बेहतर बनाना.
- अगर ज़रूरत हो, तो माइलस्टोन में ज़रूरी बदलाव करें.
8 अगस्त से 14 अगस्त
- Docbook एक्सएमएल के बारे में जानकारी
15 से 21 अगस्त
- “BRL-CAD के बारे में बुनियादी जानकारी” के लिए दस्तावेज़ लिखना
- “बुनियादी इंस्टॉलेशन” के लिए सिलसिलेवार निर्देश वाला ट्यूटोरियल लिखना
22 अगस्त से 27 अगस्त
- BRL-CAD की अलग-अलग सुविधाओं के बारे में जानकारी और स्क्रीनशॉट के साथ उन्हें सूची में शामिल करना.
- अलग-अलग सुविधाओं के बारे में अलग पेज पर बताएं.
28 अगस्त से 3 सितंबर
- सुविधाओं के लिए, अलग-अलग दस्तावेज़ों पर काम करना जारी रखें.
4 सितंबर से 10 सितंबर
- मॉडलिंग के सिद्धांतों पर काम करना.
- मॉडलिंग के सभी सिद्धांतों के बारे में बताना.
11 सितंबर से 17 सितंबर
- मुख्य टूल के बुनियादी इस्तेमाल पर काम करें.
- हर टूल के बुनियादी इस्तेमाल को दस्तावेज़ में शामिल करने के लिए, आइडिया चुनें.
18 सितंबर से 24 सितंबर
- हर टूल के इस्तेमाल का दस्तावेज़ बनाना.
25 सितंबर से 1 अक्टूबर
- ट्यूटोरियल के लिए एक अच्छा मॉडल बनाने के लिए मॉडलिंग पर काम करें. साथ ही, उसका ड्राफ़्ट भी लिखें.
2 अक्टूबर से 8 अक्टूबर
- मॉडलिंग ड्राफ़्ट को बेहतर बनाएं.
2 अक्टूबर - 8 अक्टूबर
- एक्सपोर्ट और इंपोर्ट कन्वर्टर का अध्ययन करना.
9 अक्टूबर से 15 अक्टूबर
- एक्सपोर्ट और इंपोर्ट दस्तावेज़ तैयार करें.
- रेंडरिंग पर काम करना शुरू करें.
16 अक्टूबर से 22 अक्टूबर
- रेंडरिंग ट्यूटोरियल का दस्तावेज़ बनाना.
23 अक्टूबर से 29 अक्टूबर
- सभी दस्तावेज़ों की समीक्षा करना.
30 अक्टूबर से 5 नवंबर
- Docbook XML पर काम करना
6 नवंबर से 12 नवंबर
- मेंटॉर और कम्यूनिटी के अन्य सदस्यों से समीक्षा करने के लिए कहें और बदलावों पर काम करें.
- मेंटॉर के साथ बातचीत करना और आखिरी बदलाव करना.
12 नवंबर - 22 नवंबर
- प्रोसेस के बारे में चर्चा करना और उसमें बदलाव करना.
- दस्तावेज़ को अंतिम रूप दिया जा रहा है.
मेरे बारे में
मुझे स्कूल के दिनों से ही लिखने का शौक है. मैं स्कूल से घर आकर अपने पूरे दिन के बारे में लिखता/लिखती हूं. वह बात क्या है जिससे मेरा दिन बेहतर हुआ और खराब. मैं हमेशा अपनी गलतियों को लिखने और उन्हें सुधारने का काम करती रहती हूं.
वेब डिज़ाइनर के तौर पर ट्रेनिंग के दौरान, हमसे रोज़ जो कुछ भी सीखा जाता था उसे लिखने के लिए कहा जाता था. मैं उन समस्याओं और उनके समाधानों के बारे में बताऊंगा जिनका सामना मुझे करना पड़ा.
मैं हमेशा दूसरों की मदद करने के लिए तैयार रहता/रही हूं. स्कूल और कॉलेज के दिनों में, मैं खुद कुछ विषयों को समझने के बाद अपने दोस्तों को उनके बारे में बताती थी. GSoD में हिस्सा लेना एक बेहतरीन कदम है. इसकी मदद से, मैं एक लेखक के तौर पर इस ओपन-सोर्स कम्यूनिटी को दुनिया भर के नए उपयोगकर्ताओं के लिए ज़्यादा दिलचस्प और मददगार बनाने में योगदान दे सकता हूं.