इस पेज पर Google Docs के सीज़न के लिए स्वीकार किए गए एक तकनीकी लेखन प्रोजेक्ट की जानकारी है.
प्रोजेक्ट की खास जानकारी
- ओपन सोर्स संगठन:
- ब्राज़ीलियन रियाल
- तकनीकी लेखक:
- साहिबकौर
- प्रोजेक्ट का नाम:
- बीआरएल-कनेडियन डॉलर के लिए शुरुआती गाइड
- प्रोजेक्ट की अवधि:
- मानक अवधि (तीन महीने)
प्रोजेक्ट का विवरण
BRL-CAD के लिए बिगिनर गाइड
प्रोजेक्ट ऐब्स्ट्रैक्ट
इस प्रोजेक्ट का मकसद, उन उपयोगकर्ताओं के लिए दस्तावेज़ बनाना है जो न सिर्फ़ BRL-CAD के लिए नए हों, बल्कि ओपन-सोर्स के लिए भी नए हों.
यह प्रोजेक्ट क्यों
जब मैं पहली बार BRL-CAD की वेबसाइट पर गया और ओपन-सोर्स और BRL-CAD के लिए नया था, तो मैं एक ही बार में ढेर सारी जानकारी देखकर अभिभूत हो गई. लेकिन नीचे से मुझे पता था कि यहां सीखने के लिए बहुत कुछ है. इसलिए, मुझे अपने जैसे नए उपयोगकर्ताओं के लिए दस्तावेज़ बनाना था, ताकि वे इस कम्यूनिटी का ज़्यादा से ज़्यादा फ़ायदा पा सकें और आसानी से इसका इस्तेमाल शुरू कर सकें.
गोल
यह प्रोजेक्ट नए उपयोगकर्ताओं को टारगेट करेगा. यहां कुछ जानकारी दी गई है, जिसे मेरा दस्तावेज़ हासिल करना चाहता है: यह पक्का करने के लिए कि नए उपयोगकर्ता आराम से महसूस करें: यह दस्तावेज़ न सिर्फ़ BRL-CAD के लिए नए उपयोगकर्ताओं के लिए है, बल्कि ओपन-सोर्स में भी नए उपयोगकर्ताओं के लिए है.
इसके लिए, मुझे:
- दस्तावेज़ का फ़्लेश-किनकेड स्कोर कम से कम 50 से ज़्यादा न रखें. फ़्लेश-किनकेड के हिसाब से, स्कोर जितना ज़्यादा होगा, उसे समझना उतना ही आसान होगा. इसका रीडबिलिटी स्कोर ऑनलाइन देखा जा सकता है.
- बुलेट वाली या नंबर वाली सूचियों का इस्तेमाल करें, ताकि पाठक लंबे पैराग्राफ़ से ऊब न रहे या ध्यान न भटके.
- छोटे पैराग्राफ़ और वाक्यों का इस्तेमाल करें, क्योंकि लंबे वाक्यों को पढ़ने और समझने के लिए, मानसिक तौर पर ज़्यादा मेहनत करनी पड़ती है.
- सबटाइटल का इस्तेमाल करके, टेक्स्ट को अलग-अलग रखें. अच्छी तरह से बनाया गया दस्तावेज़: अच्छी तरह से बनाया गया दस्तावेज़, नए उपयोगकर्ताओं को गाइड करने में अहम भूमिका निभाता है. यह उन्हें खो जाने से रोकता है, उन्हें बताता है कि वे कहां हैं और क्या कर रहे हैं. इसे हासिल करने के लिए, मैंने एक मोटे तौर पर जानकारी देने वाला मैप तैयार किया है. इसकी मदद से, पहली बार इस्तेमाल करने वाले लोगों के लिए गाइड को व्यवस्थित तरीके से रिकॉर्ड किया जा सकता है.
प्रोजेक्ट का ब्यौरा
यह प्रोजेक्ट नए उपयोगकर्ताओं के लिए दस्तावेज़ लिखने पर फ़ोकस करता है, ताकि वे इस सॉफ़्टवेयर को आज़मा सकें.
नीचे दिए गए उदाहरण में बताया गया है कि मैं दस्तावेज़ को ज़्यादा जानकारी वाला कैसे बनाऊं.
बुनियादी जानकारी: BRL-CAD (इसे be-are-el-cad कहा जाता है), एक कंस्ट्रक्टिव सॉलिड जियोमेट्री (सीएसजी) सॉलिड मॉडलिंग डिज़ाइन (सीएडी) है. यह 3D कंप्यूटर-सहायता डिज़ाइन और ग्राफ़िक विज़ुअलाइज़ेशन के लिए एक शक्तिशाली, क्रॉस-प्लैटफ़ॉर्म, ओपन-सोर्स सॉलिड मॉडलिंग सिस्टम है. क्या आपको अपना सिर नहीं घूम रहा है? इसके बारे में जानते हैं. ओपन-सोर्स सॉफ़्टवेयर: ओपन सोर्स सॉफ़्टवेयर, सोर्स कोड वाला ऐसा सॉफ़्टवेयर होता है जिसकी कोई भी जांच कर सकता है, उसमें बदलाव कर सकता है, और उसे बेहतर बना सकता है. BRL-CAD एक ओपन-सोर्स सॉफ़्टवेयर है, जो आपके योगदान से BRL-सीएडी को बेहतर बनाने में मदद करता है! कंप्यूटर एडेड डिज़ाइन (सीएडी): आसान शब्दों में कहें, तो सीएडी, भौतिक वस्तुओं का दो या तीन डाइमेंशन वाला ग्राफ़िकल प्रज़ेंटेशन बनाने के लिए कंप्यूटर प्रोग्राम का इस्तेमाल है. ठोस मॉडलिंग सिस्टम: BRL-CAD, सॉलिड मॉडलिंग CAD पर फ़ोकस करता है. ठोस मॉडलिंग को, 3D स्पेस का पूरी तरह से ब्यौरा देने के साथ-साथ, भौतिक रूप से सटीक होने पर ज़ोर देकर ज्यामितीय मॉडलिंग के अन्य रूपों से अलग किया जाता है. यह किसी ऑब्जेक्ट को अंदरूनी और बाहरी दोनों तरीके से सिम्युलेट करता है. संरचनात्मक ठोस ज्यामिति (सीएसजी): सीएसजी, प्रिमिटिव के बीच बूलियन संक्रियाओं की शृंखला के रूप में जटिल मॉडल को दिखाने की अनुमति देता है. प्रतिनिधित्व के लिए इस्तेमाल की जाने वाली सबसे सरल ठोस वस्तुओं को प्रिमिटिव कहा जाता है. सीएसजी को बुनियादी स्तर पर समझने के लिए, यहां जाएं.
*जैसा कि प्रोजेक्ट आइडिया के ब्यौरे में बताया गया था: दस्तावेज़ में बुनियादी इंस्टॉलेशन, सुविधाओं की पूरी जानकारी, BRL-सीएडी के मॉडलिंग सिद्धांतों, प्रमुख टूल का बुनियादी इस्तेमाल, मॉडलिंग, इंपोर्ट/एक्सपोर्ट, विश्लेषण, और रेंडरिंग शामिल होगी.
मैं दस्तावेज़ के हर हिस्से को कवर करने का तरीका बताऊं. इसके बारे में कम शब्दों में जानकारी दी गई है.
- सामान्य इंस्टॉलेशन: मुझे BRL-CAD सॉफ़्टवेयर इंस्टॉल करने के लिए, ज़रूरी स्क्रीनशॉट के साथ सिलसिलेवार निर्देश जोड़ने होंगे. नए उपयोगकर्ताओं के लिए ट्यूटोरियल एक अच्छी जगह है, जहां से नए लोग शुरुआत कर सकते हैं. इनमें से कुछ चीज़ें मुझे नहीं मिल रही हैं:
- इस नए छात्र/छात्रा के ट्यूटोरियल के चरणों को बुलेट या नंबर नहीं दिया गया है. हर चरण के आखिर में स्क्रीनशॉट के साथ सिलसिलेवार निर्देश होने से, उपयोगकर्ताओं को ट्यूटोरियल देखने में दिलचस्पी बढ़ जाती है.
- सुविधाओं की पूरी जानकारी: इस सेक्शन में वे सभी चीज़ें शामिल होंगी जहां BRL-सीएडी के पास बेहतरीन चीज़ें दिखाने की ताकत है. इस हिस्से की तरफ़ लोगों का ध्यान खींचने के लिए, डायग्राम वाला तरीका बेहतर होगा.
- बीआरएल-सीएडी के मॉडलिंग के सिद्धांत: इस हिस्से के बारे में ज़्यादा जानकारी की ज़रूरत होगी. इसकी वजह यह है कि मॉडलिंग के इन सिद्धांतों को अच्छी तरह से समझने के बाद ही, लोग BRL-CAD को बेहतर तरीके से समझ पाएंगे.
- प्रमुख टूल का बुनियादी इस्तेमाल: इसके तहत, हमारे पास मुख्य टूल और उनके बुनियादी इस्तेमाल के अलग-अलग ट्यूटोरियल होंगे. इनमें सिलसिलेवार ट्यूटोरियल होंगे.
- एक्सपोर्ट/इंपोर्ट: उपयोगकर्ताओं को जियोमेट्री कन्वर्ज़न लाइब्रेरी के बारे में पता चलेगा. BRL-सीएडी के सबसे आम इस्तेमाल में से एक है, ज्यामिति को एक फ़ॉर्मैट से दूसरे फ़ॉर्मैट में बदलना. इस सेक्शन में, हम ग्राहक में बदले उपयोगकर्ताओं के एक्सपोर्ट और इंपोर्ट पर चर्चा करते हैं.
- रेंडरिंग: हम अपने सॉफ़्टवेयर में रेंडरिंग की बुनियादी बातों और इसकी ज़रूरत के बारे में बताएंगे. लोगों को यह भी पता चलेगा कि इमेज को ब्राज़ीलियन रियाल में इमेज कैसे रेंडर करना है.
इसके अलावा, इन बातों पर भी फ़ोकस किया जाता है:
- दस्तावेज़ की शुरुआत में इस सॉफ़्टवेयर के बारे में बुनियादी जानकारी मिलेगी.
- लोग इस ओपन-सोर्स कम्यूनिटी के साथ कैसे जुड़ सकते हैं; इस कम्यूनिटी में BRL-CAD ज़ूलिप चैट का लिंक दें.
- कम शब्दों में कहें, तो दस्तावेज़ को थोड़ा मज़ाक़िया बनाएं और नए उपयोगकर्ताओं से कहें कि वे बड़े-बड़े शब्दों से निराश न हों. मुझे BRL-CAD विकी के मुख्य पेज पर इस्तेमाल किया जाने वाला सहानुभूति वाला तरीका पसंद आया.
- इसमें कुछ शानदार चीज़ों के स्क्रीनशॉट होंगे, जिन्हें लोग इस सॉफ़्टवेयर का इस्तेमाल करके कर सकते हैं.
माइलस्टोन
जुलाई (प्रपोज़ल समीक्षा अवधि)
- मौजूदा ट्यूटोरियल देखने के दौरान, मैं सॉफ़्टवेयर और इसके विकी दस्तावेज़ों को बेहतर तरीके से समझूंगा.
- मैं मौजूदा दस्तावेज़ों में सुधार कर रही हूं.
1 अगस्त से 7 अगस्त (कम्यूनिटी बॉन्डिंग)
- मेंटॉर से प्रोजेक्ट के बारे में चर्चा करना.
- प्रोजेक्ट की जानकारी को बेहतर बनाएं.
- ज़रूरत पड़ने पर माइलस्टोन में ज़रूरी बदलाव करें.
8 अगस्त - 14 अगस्त
- डॉकबुक एक्सएमएल के बारे में जानकारी
15 अगस्त - 21 अगस्त
- “बीआरएल-सीएडी के बारे में बुनियादी जानकारी” के लिए दस्तावेज़ लिखना
- "बुनियादी इंस्टॉलेशन" के लिए, सिलसिलेवार निर्देश लिखना
22 अगस्त - 27 अगस्त
- BRL-सीएडी की अलग-अलग सुविधाओं के बारे में जानकारी हासिल करना और स्क्रीनशॉट के साथ उनकी जानकारी देना.
- किसी अलग पेज पर, अलग-अलग सुविधाओं के बारे में जानकारी दें.
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 में हिस्सा लेना एक बहुत अच्छा कदम है. एक लेखक के तौर पर, मैं इस ओपन-सोर्स समुदाय को दुनिया भर के नए उपयोगकर्ताओं के लिए ज़्यादा दिलचस्प और मददगार बनाने में योगदान दे सकता हूं.